diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 8b990e92..23719087 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -2,7 +2,7 @@ ## Overview -This repository contains the Python SDK for Azure Connectors. Code must follow Python best practices (PEP 8, PEP 484) and the team's conventions for async/await patterns, type safety, and API design. +This repository contains the Python SDK for Azure Connectors. Code must follow Python best practices (PEP 8, PEP 484) and the team's conventions for async-only APIs, type safety, and API design. ## Client Refresh and Review @@ -13,6 +13,9 @@ This repository contains the Python SDK for Azure Connectors. Code must follow P - Capture known response data directly in semantic variables, without redundant `result` aliases or duplicated conditions. Check the actual returned shape after regeneration; an item list is not a response dictionary. - Preserve nullable-response guards such as `response and response.get(...)`; they are not duplicate conditions. Test non-pageable consumers with `None`, empty dictionaries, and populated responses separately. Do not simplify conditions by matching text prefixes. - Execute changed samples with empty and nonempty mocked results and assert their output, including absence of caught-and-printed errors. Pagination tests must exercise continuation requests, later-page items, and termination, including an empty initial page with a next link. +- Generate one async-only client and its models in `azure.connectors.`. Do not add synchronous mirrors or a duplicate `.aio` catalog. +- Use unsuffixed operation names. Pageable operations return `AsyncItemPaged`; retained Location-backed long-running operations return `AsyncLROPoller` after awaiting `begin_*`. +- Keep direct connector imports and lazy package-root client exports. Do not eagerly import every generated module from package `__init__.py`. ## Quick Reference: Coding Style Rules @@ -397,31 +400,28 @@ When adding a new connector client to the SDK, use the **add-connector** skill ( ### Steps -1. **Create the connector module** in `src/azure/connectors/`: - - File name should match the connector API name (e.g., `office365.py`, `sharepointonline.py`) +1. **Generate one async-only root connector** using the live-download procedure in `GENERATION.md`: + - `src/azure/connectors/.py` owns the client, models, and trigger metadata + - Do not create a synchronous mirror or an `azure.connectors.aio` module -2. **Implement the client class** following existing patterns: - ```python - from azure.connectors.sdk import ConnectorClient - - class Office365Client(ConnectorClient): - """Client for Office 365 connector operations.""" - - async def send_email(self, ...) -> EmailResponse: - ... - ``` +2. **Verify direct imports** from the root connector module: -3. **Export from `__init__.py`** — add the new client to `src/azure/connectors/__init__.py` + ```python + from azure.connectors.office365 import Office365Client, SendEmailInput + ``` + +3. **Keep package exports lazy** — regenerate `src/azure/connectors/_client_registry.py` and `src/azure/connectors/__init__.pyi` with the connector inventory. Preserve the lazy loader in `src/azure/connectors/__init__.py`; do not add eager generated-client barrel imports or try/except imports that replace broken clients with `None`. 4. **Update `README.md`** — add the connector to the "Validated Connectors" table with status (`✅ E2E Validated` or `🔄 SDK Generated`) and test count -5. **Add unit tests** — create `test_.py` in `tests/` following the pattern of existing tests: - - Constructor tests - - Method tests with mocked responses - - Error handling tests - - Type serialization round-trips +5. **Add unit tests** — create `test_.py` in `tests/` for the root async client: + - Constructor options, `await client.close()`, and `async with` lifecycle + - Unsuffixed operations, mocked success and error responses, and serialization round-trips + - `AsyncItemPaged` iteration without awaiting construction, including continuation and empty pages + - Retained Location-backed operations: await `begin_*` for an `AsyncLROPoller`, then await `poller.result()` while the client remains open + - Direct imports and lazy package-root exports agree with the generated registry and type stub -6. **Create sample usage file** — create `sample_connector_usage_.py` in `samples/sample_connector_usage/` following the pattern of existing samples (port from .NET if available) +6. **Create one async sample** under `samples/sample_connector_usage/`. Use root connector imports, `azure.identity.aio` credentials, `async with`, and `await`. End the `__main__` guard with `asyncio.run(main())`, not an extra bare `main()` call. 7. **Update `samples/sample_connector_usage/README.md`** — add the new sample to the samples table @@ -439,10 +439,13 @@ When adding a new connector client to the SDK, use the **add-connector** skill ( - [ ] Client class has proper type hints on all public methods - [ ] Docstrings present on class and all public methods - [ ] Existing connector tests still pass (no regressions) -- [ ] New connector tests cover: constructor, mocked success, mocked error, exception handling -- [ ] Module exported in `__init__.py` +- [ ] New connector tests cover constructor options, async lifecycle, mocked responses, exceptions, and serialization +- [ ] One root module owns the async-only client, models, and trigger metadata; no sync or aio mirror exists +- [ ] Unsuffixed operations use `AsyncItemPaged` and awaited `AsyncLROPoller` contracts where applicable +- [ ] Generated client registry and package type stub match; package-root exports remain lazy and import failures propagate - [ ] README.md connector table updated -- [ ] Sample file created and compiles without errors +- [ ] One async sample imports public root types and compiles without errors +- [ ] Offline sample tests check output for empty and nonempty results and run the actual main guard without unawaited coroutine warnings - [ ] Samples README updated - [ ] CHANGELOG.md updated - [ ] Connection setup skill updated diff --git a/.github/skills/add-connector/SKILL.md b/.github/skills/add-connector/SKILL.md index ab9e9e22..e6571c99 100644 --- a/.github/skills/add-connector/SKILL.md +++ b/.github/skills/add-connector/SKILL.md @@ -1,6 +1,6 @@ --- name: add-connector -description: 'Add a new connector to the Azure Connectors Python SDK. USE WHEN: adding a new connector client, scaffolding connector files, creating unit tests, updating __init__.py exports, updating README status table, creating sample usage files. Covers the full workflow from connector file creation through test validation. NOT FOR: modifying existing connectors, connection setup, or trigger registration.' +description: 'Add a new connector to the Azure Connectors Python SDK. USE WHEN: adding a generated async-only root connector, creating async unit tests and samples, or updating connector documentation. Covers the full workflow from generation through validation. NOT FOR: modifying existing connectors, connection setup, or trigger registration.' argument-hint: 'Provide the connector name (e.g., "dynamics365", "servicenow")' --- @@ -17,8 +17,8 @@ Automates the complete workflow for adding a new connector to the Azure Connecto ## Prerequisites -- The connector module file (e.g., `dynamics365.py`) is provided or needs to be created -- The connector follows the `ConnectorClientBase` pattern +- The connector can be generated as one async root module +- The client follows the async `ConnectorClientBase` runtime patterns - A .NET sample exists to port to Python (optional) ## Procedure @@ -39,9 +39,11 @@ Collect the following details from the user: ### Step 2: Create/Verify Connector Module -Ensure the connector file exists at `src/azure/connectors/{connector_name}.py`. +Generate one async root module from CodefulSdkGenerator: -The connector must follow this structure: +- `src/azure/connectors/{connector_name}.py` + +The root connector owns models, metadata, and the async-only client: ```python # Copyright (c) Microsoft Corporation. All rights reserved. @@ -74,21 +76,22 @@ class {ClientClassName}(ConnectorClientBase): def connector_name(self) -> str: return "{connector_name}" - # ... async methods ... + # ... asynchronous unsuffixed methods ... ``` -### Step 3: Update `__init__.py` Exports - -Add the connector import to `src/azure/connectors/__init__.py`: +The module defines models, aliases, enums, and `TRIGGER_OPERATIONS`. Its client +uses `AsyncTokenCredential` and `AsyncHttpTransport`. Pageable operations return +`AsyncItemPaged` without awaiting construction. Await `begin_*` operations to +obtain an `AsyncLROPoller`. Do not create a synchronous mirror. -```python -try: - from .{connector_name} import {ClientClassName} -except (ImportError, NameError): - {ClientClassName} = None # type: ignore[assignment,misc] -``` +### Step 3: Keep Package Initializers Minimal -Also add to the `__all__` list if present. +Consumers import clients and models directly from each root connector module. +Regenerate `src/azure/connectors/_client_registry.py` and +`src/azure/connectors/__init__.pyi` with the connector inventory; do not hand-edit +generated package exports. Preserve the lazy loader in +`src/azure/connectors/__init__.py`. Do not add eager generated-client barrel +imports or try/except imports that replace failed clients with `None`. ### Step 4: Update README Connector Table @@ -113,9 +116,9 @@ from unittest.mock import AsyncMock, patch import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.{connector_name} import {ClientClassName} from azure.connectors.{connector_name} import ( - {ClientClassName}, - # Import all public dataclasses from the connector + {RequestModelName}, ) from azure.connectors.sdk import ConnectorException from tests.conftest import MockResponse @@ -197,7 +200,7 @@ class Test{ClientClassName}Lifecycle: with patch.object(client._http_client, 'close', new_callable=AsyncMock) as mock_close: await client.close() - mock_close.assert_called_once() + mock_close.assert_awaited_once() @pytest.mark.asyncio async def test_context_manager(self, mock_credential): @@ -209,14 +212,14 @@ class Test{ClientClassName}Lifecycle: ) as client: assert isinstance(client, {ClientClassName}) - mock_close.assert_called_once() + mock_close.assert_awaited_once() # Add test classes for each public method in the connector # Follow the pattern: # # class Test{MethodName}: -# """Tests for {method_name}_async method.""" +# """Tests for {method_name} on the root async client.""" # # @pytest.mark.asyncio # async def test_success(self, mock_credential): @@ -230,16 +233,26 @@ class Test{ClientClassName}Lifecycle: ``` **Required test categories:** + 1. **Initialization tests** — constructor, URL handling, options, error cases -2. **Lifecycle tests** — close(), context manager -3. **Method tests** — one class per public async method with: - - Success case with mocked response - - Parameter handling tests - - Error response handling +2. **Lifecycle tests** — `await client.close()`, `async with`, and awaited cleanup +3. **Method tests** — exercise root async operations with: + - Success cases with asynchronous mocked responses + - Keyword-only optional parameters and request controls + - Azure Core error response handling + - Models declared in the same root module + - `AsyncItemPaged` iteration without awaiting construction, including continuation requests, empty pages, later-page items, and termination + - Retained Location-backed operations: await `begin_*` for an `AsyncLROPoller`, then await `poller.result()` while the client remains open +4. **Export tests** — direct imports and lazy package-root clients match the generated registry and type stub; broken imports raise instead of returning `None` ### Step 6: Create Sample Usage File -Create `samples/sample_connector_usage/sample_connector_usage_{connector_name}.py`: +Create one async sample file: + +- `samples/sample_connector_usage/sample_connector_usage_{connector_name}.py` + +Use `azure.identity.aio.DefaultAzureCredential`, import the client from its root +connector module, and retain `async with` and `await`: ```python # Copyright (c) Microsoft Corporation. All rights reserved. @@ -268,9 +281,9 @@ import asyncio import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.{connector_name} import {ClientClassName} from azure.connectors.{connector_name} import ( - {ClientClassName}, - # Import relevant dataclasses for the examples + {RequestModelName}, ) # Connection runtime URL format: @@ -285,12 +298,12 @@ async def example_1_basic_operation(): """Example 1: Basic connector operation.""" print("\n=== Example 1: Basic Operation ===") - credential = DefaultAzureCredential() - - async with {ClientClassName}(CONNECTION_RUNTIME_URL, credential) as client: + async with DefaultAzureCredential() as credential, {ClientClassName}( + CONNECTION_RUNTIME_URL, credential + ) as client: try: # Call a basic read operation - result = await client.{example_method}_async() + result = await client.{example_method}() print(f"Result: {{result}}") @@ -304,12 +317,12 @@ async def example_2_advanced_operation(): """Example 2: Advanced connector operation.""" print("\n=== Example 2: Advanced Operation ===") - credential = DefaultAzureCredential() - - async with {ClientClassName}(CONNECTION_RUNTIME_URL, credential) as client: + async with DefaultAzureCredential() as credential, {ClientClassName}( + CONNECTION_RUNTIME_URL, credential + ) as client: try: # Call a write or complex operation - # result = await client.{another_method}_async(...) + # result = await client.{another_method}(...) print("Advanced operation completed") except ConnectorException as ex: @@ -338,10 +351,11 @@ if __name__ == "__main__": ``` **When porting from .NET:** + 1. Find the corresponding .NET sample -2. Translate each example method to Python async/await syntax +2. Create one asynchronous example under the conventional root sample path 3. Convert C# types to Python dataclasses -4. Use `async with` for client lifecycle +4. Use `async with` for client and credential lifecycle 5. Handle exceptions with `ConnectorException` ### Step 7: Update Samples README @@ -385,16 +399,19 @@ Supported SDK connector names: `arm`, `azuread`, ..., `{connector_name}`, ... (a ### Step 10: Run Tests -Execute the full test suite to validate: +Start with focused connector and lazy-export tests from the repository root: ```powershell -.\.venv\Scripts\python -m pytest tests/test_{connector_name}.py tests/test_code_quality.py -v --tb=short +$env:PYTHONPATH = (Join-Path $PWD "src") +.\.venv\Scripts\python -m pytest tests/test_{connector_name}.py tests/test_root_client_exports.py -v --tb=short ``` **Required checks:** -- [ ] All tests pass -- [ ] No import errors -- [ ] Code quality tests pass (imports, structure) + +- [ ] Focused tests pass against this checkout, not another editable installation +- [ ] Direct client/model imports work and resolve under this checkout's `src` directory +- [ ] Generated registry and type stub agree; package import does not eagerly load connectors +- [ ] Full tests and code quality checks pass before submitting the connector PR ### Step 11: Validate Sample Syntax @@ -403,30 +420,40 @@ python -m py_compile samples/sample_connector_usage/sample_connector_usage_{conn .\.venv\Scripts\python.exe -m flake8 samples/sample_connector_usage/sample_connector_usage_{connector_name}.py --max-line-length=100 ``` +Run the sample offline with empty and nonempty mocked responses and assert its +output contains no caught-and-printed errors. Test its actual parsed `__main__` +guard with the example functions mocked by `AsyncMock`, leaving `main()` and +`asyncio.run()` intact. Assert each example is awaited once and no unawaited +coroutine warning occurs. Keep only `asyncio.run(main())` in the guard. + ## Checklist Before completing, verify: - [ ] `src/azure/connectors/{connector_name}.py` exists with proper structure -- [ ] `src/azure/connectors/__init__.py` updated with try/except import +- [ ] One async-only root module owns the client, models, and trigger metadata; no sync or aio mirror exists +- [ ] Generated `_client_registry.py` and `__init__.pyi` agree with the connector inventory +- [ ] Package-root exports remain lazy; no eager barrel imports or failed-client `None` placeholders - [ ] `README.md` connector table updated with correct status and test count -- [ ] `tests/test_{connector_name}.py` created with comprehensive tests -- [ ] `samples/sample_connector_usage/sample_connector_usage_{connector_name}.py` created +- [ ] `tests/test_{connector_name}.py` covers async lifecycle, operations, serialization, and applicable `AsyncItemPaged` / `AsyncLROPoller` behavior +- [ ] One async sample exists at `samples/sample_connector_usage/sample_connector_usage_{connector_name}.py` - [ ] `samples/sample_connector_usage/README.md` updated - [ ] `CHANGELOG.md` updated with new connector in `[Unreleased]` section - [ ] `.github/skills/connection-setup/SKILL.md` Step 2 updated with connector API name - [ ] All tests pass - [ ] Sample file compiles without errors +- [ ] Offline sample checks cover empty and nonempty output and the actual main guard without unawaited coroutines ## Files Modified | File | Change | |------|--------| -| `src/azure/connectors/{connector_name}.py` | New connector module | -| `src/azure/connectors/__init__.py` | Add export | +| `src/azure/connectors/{connector_name}.py` | New async-only root connector module | +| `src/azure/connectors/_client_registry.py` | Regenerate the lazy client registry | +| `src/azure/connectors/__init__.pyi` | Regenerate package-root type exports | | `README.md` | Add to connector table | | `tests/test_{connector_name}.py` | New test file | -| `samples/sample_connector_usage/sample_connector_usage_{connector_name}.py` | New sample | +| `samples/sample_connector_usage/sample_connector_usage_{connector_name}.py` | One async sample | | `samples/sample_connector_usage/README.md` | Add to samples table | | `CHANGELOG.md` | Add to `[Unreleased]` section | | `.github/skills/connection-setup/SKILL.md` | Add connector name to Step 2 | @@ -435,7 +462,12 @@ Before completing, verify: ### Import Error in `__init__.py` -If the connector has undefined type references, the try/except wrapper handles it gracefully. The connector will be `None` until fixed. +The package root loads a client only when requested. Import failures must +propagate; never hide a broken connector behind a try/except import or assign +its client to `None`. Check direct connector imports, fix undefined references +in CodefulSdkGenerator, then regenerate the connector, registry, and type stub. +Do not hand-edit generated output or eagerly import all clients to bypass the +lazy loader. ### Test Discovery diff --git a/.github/skills/connection-setup/SKILL.md b/.github/skills/connection-setup/SKILL.md index eb3102da..640f8fb5 100644 --- a/.github/skills/connection-setup/SKILL.md +++ b/.github/skills/connection-setup/SKILL.md @@ -178,21 +178,29 @@ az rest --method GET --uri "$runtimeUrl/v2/datasets" --resource "https://apihub. ## Next Steps -- **SDK usage:** Use the connection runtime URL with a caller-owned async Azure credential: - ```python - from azure.identity.aio import DefaultAzureCredential - - from azure.connectors.office365 import Office365Client, SendEmailInput - - async with DefaultAzureCredential() as credential: - async with Office365Client(runtime_url, credential) as client: - await client.send_email_async( - input=SendEmailInput( - to="recipient@example.com", - subject="Hello", - body="Sent with Azure Connectors.", - ) - ) - ``` +### SDK Usage + +Use the connection runtime URL with a caller-owned async Azure credential. +Root clients are async-only: + +```python +from azure.identity.aio import DefaultAzureCredential + +from azure.connectors.office365 import Office365Client, SendEmailInput + +async with DefaultAzureCredential() as credential: + async with Office365Client(runtime_url, credential) as client: + await client.send_email( + input=SendEmailInput( + to="recipient@example.com", + subject="Hello", + body="Sent with Azure Connectors.", + ) + ) +``` + +Clients and models share the root connector module. Use `azure.identity.aio` +credentials and await unsuffixed operations. No synchronous mirror is provided. + - **Azure Functions triggers:** To register connector triggers (e.g., OnNewEmail, OnNewFile) for Azure Functions, use the [trigger-registration skill](../trigger-registration/SKILL.md). - **Azure Functions signatures:** For a complete mapping of trigger operations to Azure Functions signatures, see [Operations to Functions Signature Match](https://github.com/Azure/azure-functions-connector-extension/blob/main/docs/operations-functions-match.md). diff --git a/.github/skills/trigger-registration/SKILL.md b/.github/skills/trigger-registration/SKILL.md index 99b432d0..e3c2e65b 100644 --- a/.github/skills/trigger-registration/SKILL.md +++ b/.github/skills/trigger-registration/SKILL.md @@ -295,20 +295,21 @@ az functionapp log tail -g $resourceGroup -n $functionAppName ## Using the SDK for Actions (Beyond Triggers) -The `azure-connectors` package provides typed async clients for calling connector actions directly from Python applications. Generated clients require a caller-owned asynchronous Azure Identity credential or an `AzureKeyCredential`. +The `azure-connectors` package provides async-only root clients for calling connector actions directly from Python applications. Clients accept caller-owned `AsyncTokenCredential` or `AzureKeyCredential` credentials; no synchronous mirror is provided. ### Example: Send an email ```python from azure.identity.aio import DefaultAzureCredential -from azure.connectors.office365 import Office365Client, SendEmailInput +from azure.connectors.office365 import Office365Client +from azure.connectors.office365 import SendEmailInput async def main(connection_url: str): async with DefaultAzureCredential() as credential: async with Office365Client(connection_url, credential) as client: - await client.send_email_async( + await client.send_email( input=SendEmailInput( to="recipient@example.com", subject="Hello from Python SDK", @@ -330,7 +331,7 @@ async def list_items(connection_url: str): async with SharepointonlineClient(connection_url, credential) as client: items = [ item - async for item in client.get_items_async( + async for item in client.list_items( dataset="https://contoso.sharepoint.com/sites/MySite", table="MyList", ) @@ -342,7 +343,8 @@ async def list_items(connection_url: str): ### Authentication Options -Use `DefaultAzureCredential` or `ManagedIdentityCredential` from `azure.identity.aio` for token authentication. Use `AzureKeyCredential` from `azure.core.credentials` when the connection runtime expects an API key. The caller owns asynchronous credentials and must close them. +Use credentials from `azure.identity.aio`. Use `AzureKeyCredential` from `azure.core.credentials` when the connection runtime expects an API key. The caller owns async credentials and must close them with `async with` or `await credential.close()`. + ### E2E Validated Connectors | Connector | Package | Status | diff --git a/CHANGELOG.md b/CHANGELOG.md index f1c823e3..9240b001 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,25 +9,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added +- **Mapping-compatible model inputs** — generated request bodies and nested model fields now accept either generated dataclasses or arbitrary `Mapping` implementations. +- **Azure Core long-running operations** — generated Kusto and Plumsail operations with an HTTP 202 `Location` polling contract now use awaited `begin_*` methods returning `AsyncLROPoller`. Polling honors `Retry-After` and forwards operation request controls. - **Generated API documentation site** — adds a MkDocs Material reference for the core SDK and every shipped connector module, strict source-to-site coverage validation, and a GitHub Pages deployment workflow for `main`. - **Zoho ZeptoMail generated client** — adds five public mail-agent, send-mail, template-mail, and analytics actions. `SendTemplateMailInput.merge_key_detail` remains `List[Dict[str, Any]]` so fixed string fields and arbitrary non-string merge values stay representable. The malformed Swagger type `ReplyToAddresss` is exposed as `ReplyToAddress` without changing the `reply_to` wire field. ### Breaking Changes -- **Generated clients now use the asynchronous Azure Core pipeline** — every client requires a caller-owned `AsyncTokenCredential` or `AzureKeyCredential`. The legacy token-provider classes and `ConnectorClientOptions` have been removed; retry, timeout, transport, and policy settings are passed directly to the client. Operations also expose keyword-only `timeout`, `headers`, `client_request_id`, and `response_hook` controls. +- **Swagger-required model fields are now required constructor arguments** — generated dataclasses no longer default required properties to `None`. +- **Read collection operations now return Azure Core pagers** — bounded read collections without continuation metadata use `AsyncItemPaged`; mutation and action arrays remain eager operation payloads. +- **Client timeout configuration now uses `timeout`** — generated async + client constructors use the same keyword as per-operation request controls. +- **Location-backed operations now return pollers** — 44 Kusto and Plumsail operations move from immediate operation names to `begin_*`. Await the call and `poller.result()` while the connector client remains open. +- **Generated operations now use unsuffixed names** — async-only clients remain in `azure.connectors.`. Remove `_async` from operation calls while retaining `await`; no synchronous mirror is provided. +- **Pageable operations now return Azure Core pagers** — root clients return `AsyncItemPaged`. Pager construction is not awaited; use `async for` or `by_page(continuation_token=...)` for page boundaries. +- **Generated models have one owner** — import dataclasses, aliases, enums, and `TRIGGER_OPERATIONS` from the root `azure.connectors.` module alongside its async client. +- **Generated clients now use Azure Core pipelines** — clients require a caller-owned `AsyncTokenCredential` or `AzureKeyCredential`. The legacy token-provider classes and `ConnectorClientOptions` have been removed; retry, timeout, `AsyncHttpTransport`, and policy settings are passed directly to the client. Operations also expose keyword-only `timeout`, `headers`, `client_request_id`, and `response_hook` controls. - **Automatic retries are now method-safe by default** — `GET`, `HEAD`, `OPTIONS`, and `TRACE` retain configured retries. `POST`, `PUT`, `PATCH`, `DELETE`, and unknown methods make one attempt for transient responses and transport errors. Set `retry_unsafe_http_methods=True` directly on a generated client only when replay is acceptable; retry count, timeout, and backoff settings are also direct client keyword arguments. ([#85](https://github.com/Azure/connectors-python-sdk/issues/85)) -- Jira `list_issues_async` now exposes the live optional `fields` query parameter +- Jira `list_issues` now exposes the live optional `fields` query parameter instead of sending an internal `fields=*all` default. Pass `fields` and `next_page_token` by keyword; `fields` precedes the token in the generated signature. -- This regeneration propagates the async-iterator paging contract to 32 additional +- This regeneration propagates the Azure Core paging contract to 32 additional connectors, extending [Fix Dataverse list pagination (#84)](https://github.com/Azure/connectors-python-sdk/pull/84). - Pageable operations return items rather than response dictionaries. Consume them - with `async for`, or collect them with - `[item async for item in client.get_items_async(...)]`; samples use this contract. + Pageable operations return items rather than response dictionaries. Iterate + pagers with `async for`; samples use this contract. - Seismic Planner `CustomPropertyValues.localizations` now exposes `Dict[str, CustomPropertyDataDisplay]` instead of `Dict[str, Any]`. Callers can access typed values directly, such as `localizations["en-US"].name`. ([Azure/Connectors-NET-SDK#262](https://github.com/Azure/Connectors-NET-SDK/issues/262), AzureUX-BPM PR 17131877) -- Microsoft Dataverse `get_items_async` now returns an `AsyncIterator[dict[str, Any]]`. Callers must use `async for` instead of awaiting a single response dictionary; iteration preserves and follows `@odata.nextLink` until all rows are returned. ([Azure/Connectors-NET-SDK#208](https://github.com/Azure/Connectors-NET-SDK/issues/208), AzureUX-BPM PR 17086991) +- Microsoft Dataverse collection operations now return `AsyncItemPaged[dict[str, Any]]` from root clients. Iterate instead of awaiting a single response dictionary; paging preserves and follows `@odata.nextLink` until all rows are returned. ([Azure/Connectors-NET-SDK#208](https://github.com/Azure/Connectors-NET-SDK/issues/208), AzureUX-BPM PR 17086991) - Regenerated all 99 supported connector clients from current live managed connector metadata using the Azure Core contract generator. - Corrected generated parameter types across connector operations, including pagination values, numeric identifiers, and Boolean options. Callers must now pass the annotated `int` and `bool` values instead of string representations. @@ -35,6 +44,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- Generated async operations now document their arguments, return types, + connector operation IDs, and `ConnectorException` failure contract. +- Generated connector clients are available as lazy exports from `azure.connectors`, with matching package type stubs for static analysis. Prefer concrete connector-module imports in applications. +- Kept async-only root clients, aligned with the .NET connector SDK. This intentionally diverges from the Azure SDK synchronous-client guideline without reverting keyword-only options, Azure Core errors, paging, or polling. +- Updated the 99 root async samples to use unsuffixed operation names; there is no duplicate synchronous sample catalog. +- Updated the generated API reference and CI validation for one async client catalog and one core runtime section. - Made `azure-identity` a required runtime dependency so Azure Identity credentials and the shipped samples work with the default package installation. - Updated all connector samples to match generated method signatures and added literal-type validation to the sample contract checks. - Added focused success, route, request-body, response, and error coverage for newly generated operations. @@ -42,14 +57,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -- **Request timeout enforcement**: `timeout_seconds` and per-operation `timeout` - now bound the complete network operation, including retries, response loading, - and body reads across Azure Core async transports. Zero and negative values - disable SDK and transport deadlines. +- **Jira continuation tokens**: Treat next-page tokens as opaque values rather than continuation URLs. +- **Initial polling URLs**: Resolve relative initial `Location` headers against the initiating request URL. +- **Sample pager consumption**: Iterate async pagers directly instead of treating them as response envelopes or awaiting pager construction. +- **Collection response contracts**: Mutation and action arrays execute eagerly and preserve their response envelopes instead of delaying the request behind a pager. Primitive read collections now expose `AsyncItemPaged[str]` rather than dictionary item types. +- **Finite polling delays**: Non-finite `Retry-After` values such as `Infinity`, `NaN`, and numeric overflow now use the finite default polling interval. +- **Collection paging classification**: Explicit pageable responses now infer omitted item properties and follow continuation fields present in the response schema. Bounded read envelopes select their primary array over auxiliary array metadata and expose Azure-guideline `list_*` operations returning `AsyncItemPaged`; mutation and action arrays execute eagerly under their action names. +- **Caller continuation isolation**: Caller-provided `by_page()` continuation URLs now pass through the same origin normalization as service-provided next links, preventing authenticated requests from being sent to an arbitrary host. +- **HTTP DELETE contracts** — generated operations now preserve declared success payloads and ordinary HTTP 404 errors regardless of verb. Only explicitly curated resource deletions, currently ARM deployment deletion, treat an already absent target as idempotent success. +- **Orderful transaction responses** — `list_transactions` now preserves and returns the runtime JSON payload despite the managed connector Swagger omitting its response schema. +- **Relative continuation URLs** — pagers now resolve bare relative continuation links against the current page URL, preserving nested resource paths. +- **Azure Core exception compatibility**: `ConnectorException` now derives from `HttpResponseError` and exposes the failed response status, reason, headers, and body while preserving connector-specific operation and path details. +- **Generation provenance**: record the exact generator revision and source metadata for the complete 99-connector async catalog in the pull request. +- **Request timeout enforcement**: Client-level and per-operation `timeout` + configures Azure Core retry and transport deadlines. Async clients bound + the complete network operation, including response loading and body reads. + Blocking callbacks must bound their own execution. Zero and + negative values disable SDK and transport deadlines. - **Async transport compatibility**: Empty buffered responses now produce normal snapshots and connector errors without re-reading consumed streams. Injected transports receive only supported timeout options and close through their asynchronous lifecycle. +- **Default transport configuration**: Standard Azure Core transport options, + including `connection_verify` and `connection_cert`, now configure the owned + aiohttp transport instead of being ignored. - **Explicit Azure Core policy chains**: `per_call_policies` and `per_retry_policies` now compose with an explicit `policies` chain instead of being silently discarded. Per-retry extensions require an `AsyncRetryPolicy`, @@ -65,7 +96,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Generated caller-supplied and internal-default query values escape reserved characters, including `/`, so paths, URLs, and collection values remain within their intended query parameters. -- **Microsoft Dataverse**: Corrected `create_attachment_async()` to accept GUID/string row IDs instead of integers. +- **Microsoft Dataverse**: Corrected `create_attachment()` to accept GUID/string row IDs instead of integers. ## [0.5.0b1] - 2026-08-31 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 30d3d110..e6dff9a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,14 +99,14 @@ This project follows Python best practices documented in [.github/copilot-instru - **PEP 8** — Standard Python style guide (79 character line limit) - **Type hints** — All public API signatures must have type hints (PEP 484) -- **Async/await** — Use async patterns for all I/O operations +- **Async-only clients** — Use unsuffixed async operations in root connector modules - **Naming conventions:** - `snake_case` for functions, methods, variables - `PascalCase` for classes - `UPPER_SNAKE_CASE` for constants - `_snake_case` for private methods/attributes - **Docstrings** — Google-style docstrings for all public APIs -- **Context managers** — Use `async with` for client lifecycle management +- **Context managers** — Use `async with` for clients and caller-owned async credentials ### Automated Enforcement @@ -121,7 +121,7 @@ Run `flake8 src/ tests/` locally before pushing to catch style issues early. ## Generated Code -Connector client files in `src/azure/connectors/*.py` (except `sdk/` subpackage) are produced by an internal Microsoft code generator that is not publicly accessible at this time. **Do not submit pull requests that directly modify generated files** — changes will be overwritten the next time the code is regenerated. +Connector client files in `src/azure/connectors/*.py` are produced by an internal Microsoft code generator. Each root module contains an async client and its models. **Do not submit pull requests that directly modify generated files** — changes will be overwritten the next time the code is regenerated. If you find a bug or want to suggest an improvement in the generated code: @@ -132,7 +132,7 @@ If you find a bug or want to suggest an improvement in the generated code: **Files safe to modify:** -- `src/azure/connectors/sdk/*.py` — Core SDK infrastructure (not generated) +- `src/azure/connectors/sdk/*.py` — Async core SDK infrastructure (not generated) - `tests/*.py` — All test files - `samples/*.py` — Sample code - Documentation files (`.md` files) @@ -237,9 +237,9 @@ See the detailed guide in [.github/copilot-instructions.md](.github/copilot-inst Quick checklist: -1. Generate connector code using LogicAppsCompiler with `--python` flag +1. Generate one async root module using LogicAppsCompiler with `--pythonDirectClient` 2. Copy generated `.py` file to `src/azure/connectors/` -3. Update `__init__.py` exports +3. Regenerate the lazy client registry and root package type stubs 4. Add comprehensive unit tests 5. Add sample code to `samples/` 6. Update `README.md` and `ROADMAP.md` diff --git a/GENERATION.md b/GENERATION.md index f515862e..070105b1 100644 --- a/GENERATION.md +++ b/GENERATION.md @@ -7,9 +7,9 @@ This document describes how to generate typed Python connector clients using the The **CodefulSdkGenerator** tool generates typed Python clients from managed connector swagger definitions. The generated code provides: - **Type-safe contracts** - Dataclass models with proper JSON field mappings -- **Typed client classes** - Async methods for each connector action with comprehensive docstrings +- **Async-only clients** - One root module per connector with unsuffixed async operations; no synchronous mirror - **Authentication handling** - Caller-owned Azure Core token or key credentials -- **Async/await support** - Native asyncio integration through the Azure Core pipeline +- **Azure Core paging** - `AsyncItemPaged` for collection operations ## Prerequisites @@ -52,38 +52,39 @@ cd dotnet build .\src\tools\CodefulSdkGenerator\LogicAppsCompiler.Cli\LogicAppsCompiler.Cli.csproj -c Release ``` -The compiled executable will be at: +The compiled compiler assembly will be at: ```text -src\tools\CodefulSdkGenerator\LogicAppsCompiler.Cli\bin\Release\net8.0\LogicAppsCompiler.exe +src\tools\CodefulSdkGenerator\LogicAppsCompiler.Cli\bin\Release\net8.0\LogicAppsCompiler.dll ``` ## Generation Commands -Use the [live-download workflow](#live-regeneration-and-review) for every refresh -and review. The examples below show CLI argument forms, not permission to reuse -responses from an earlier run. +Fetch live definitions with an explicit subscription and region and a new empty +temporary response directory, as described below. Do not seed that directory +with saved responses or fixtures. ### Generate Python Client SDK (Recommended) -Generates typed async Python clients for calling connectors directly from Azure Functions: +Generates async-only Python clients in root connector modules: ```powershell # Generate all connectors -LogicAppsCompiler.exe --pythonDirectClient +dotnet LogicAppsCompiler.dll --pythonDirectClient # Generate specific connectors only -LogicAppsCompiler.exe --pythonDirectClient --connectors=office365,sharepointonline,teams +dotnet LogicAppsCompiler.dll --pythonDirectClient --connectors=office365,sharepointonline,teams # Example: Generate to this SDK repo's src/azure/connectors folder -LogicAppsCompiler.exe "/src/azure/connectors" --pythonDirectClient --connectors=office365 +dotnet LogicAppsCompiler.dll "/src/azure/connectors" --pythonDirectClient --connectors=office365 ``` **Output structure per connector:** -- `{connector}.py` - Combined dataclass models and client in one file (e.g., `office365.py`, `sharepointonline.py`) +- `{connector}.py` - Async client plus models, aliases, enums, and trigger metadata -**Note:** The CLI accepts one positional output directory. Use `--pythonDirectClient` for Python generation. +The CLI accepts one positional output directory. Use `--pythonDirectClient` +for Python generation. Do not generate an additional synchronous or aio catalog. ### Generate C# DirectClient SDK @@ -97,12 +98,12 @@ LogicAppsCompiler.exe --directClient --connectors=office365 LogicAppsCompiler.exe --directClient --language=csharp --connectors=office365 ``` -## Live Regeneration and Review +## Catalog Regeneration -Refresh existing clients from live managed connector definitions. Set the source -subscription and region explicitly, and use a new empty temporary `ARMCACHE_PATH` -for every run. The generator's cache is only a transport implementation detail; -never seed it from repository fixtures or reuse a previous run's responses. +To refresh connector contracts, set the source subscription and region +explicitly and use a new empty temporary `ARMCACHE_PATH`. Generate into an +isolated output directory so the complete result can be reviewed before it +replaces the committed client catalog. ```powershell $env:AZURE_SUBSCRIPTION_ID = "" @@ -114,7 +115,8 @@ $liveCachePath = Join-Path $env:TEMP ("connector-live-" + [guid]::NewGuid()) New-Item -ItemType Directory -Path $liveCachePath, $outputDirectory -Force | Out-Null try { $env:ARMCACHE_PATH = $liveCachePath - LogicAppsCompiler.exe $outputDirectory --directClient --language=python "--connectors=$connectorNames" + dotnet LogicAppsCompiler.dll $outputDirectory --directClient --language=python ` + "--connectors=$connectorNames" } finally { $env:ARMCACHE_PATH = $previousCachePath @@ -122,27 +124,39 @@ finally { } ``` -Check per-connector failures as well as the CLI exit code. Record the exact -generator revision, linked PR and its status, source subscription, region, and capture time. -Paired generator/SDK PRs show generated output from the active generator PR before -it merges. Label that source as unmerged; final SDK merge still requires upstream integration. -Do not add cache folders or replay scaffolding as part of a client refresh. - -Reviewers must fetch live definitions independently using their own new empty -temporary directory. Do not give the producer's responses to the reviewer as -generation inputs. Compare generated outputs after normalizing CRLF to LF; -investigate live differences instead of substituting cached inputs to make them match. +Record the full AzureUX-BPM generator revision and source metadata in the pull +request. Validate the complete 99-connector root inventory, the lazy client registry, and +package type stubs before committing the reviewed output. ### Pageable Results -Pageable operations expose async iterators. Iteration follows continuation links and -yields items directly; an empty response yields no items. Do not await a page envelope: +Read-collection operations return Azure Core pagers, including bounded read +collections without continuation metadata. Arrays returned by mutations and +other actions remain eager payloads. Pager iteration follows continuation links +when the contract provides them and yields items directly; an empty response +yields no items. Do not await pager construction: ```python -async for item in client.get_items_async(...): +async for item in client.list_items(...): process_item(item) ``` +Root clients return `AsyncItemPaged` and support +`by_page(continuation_token=...)`. Request controls and response hooks +apply to every page request. + +### Long-Running Operations + +Retained operations with an HTTP 202 `Location` polling contract use +`begin_*` methods. Root clients return `AsyncLROPoller[T]` after the `begin_*` +call is awaited. Resolve the final payload with `await poller.result()` while +the connector client remains open. + +The generator does not infer polling from HTTP 202 alone. Status-document +protocols, cancellation, and poller continuation tokens are not currently +generated. Request controls and response hooks apply to the initial request and +every polling request. + ### Consumer Review Checks - Capture known response collections directly in semantic names, such as @@ -166,14 +180,14 @@ async for item in client.get_items_async(...): # office365.py - Auto-generated Python DirectClient SDK # Do not edit this file directly. -from dataclasses import dataclass, field -from typing import Optional, List, Dict, Any +from dataclasses import dataclass, field as dataclass_field +from typing import Any, Dict, List, Mapping, Optional from datetime import datetime from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport -from azure.connectors.sdk import ConnectorClientBase +from azure.connectors.sdk import ConnectorClientBase, ConnectorResponseHook # ===== Types ===== @@ -181,13 +195,13 @@ from azure.connectors.sdk import ConnectorClientBase class GraphCalendarEventClientReceive: """Response for calendar event operations.""" - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """Event subject.""" - start: Optional[str] = None + start: Optional[str] = dataclass_field(default=None, kw_only=True) """Event start time (ISO 8601).""" - end: Optional[str] = None + end: Optional[str] = dataclass_field(default=None, kw_only=True) """Event end time (ISO 8601).""" # ... other fields @@ -203,7 +217,7 @@ class Office365Client(ConnectorClientBase): credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any, ): @@ -214,40 +228,42 @@ class Office365Client(ConnectorClientBase): super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, transport=transport, **kwargs, ) self._connection_runtime_url = connection_runtime_url.rstrip("/") - async def send_email_v2_async( + async def send_email( self, - to: str, - subject: str, - body: str, - from_address: Optional[str] = None, - cc: Optional[str] = None, - bcc: Optional[str] = None, - importance: Optional[str] = None, - is_html: bool = True + input: SendEmailInput | Mapping[str, Any], + *, + timeout: Optional[float] = None, + headers: Optional[Mapping[str, str]] = None, + client_request_id: Optional[str] = None, + response_hook: Optional[ConnectorResponseHook] = None, ) -> None: """ Send an email. Args: - to: Recipient email address(es), semicolon-separated - subject: Email subject - body: Email body (HTML or plain text) - from_address: Sender address (optional, defaults to mailbox owner) - cc: CC recipients, semicolon-separated - bcc: BCC recipients, semicolon-separated - importance: Email importance (Low, Normal, High) - is_html: Whether body is HTML + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. """ - # Generated implementation calls self._http_client.send_async(...) + # Generated implementation awaits self.http_client.send(...) # with proper serialization and error handling ``` +The root `office365.py` defines the async client and its models together. +Async-only intentionally diverges from the Azure SDK synchronous-client guideline, +aligned with the .NET connector SDK. Keep keyword-only optional parameters, +unsuffixed async operations, and Azure Core errors, paging, and polling; do not +restore the earlier preview signatures or add a synchronous mirror. + ### Key Patterns in Generated Code #### 1. Root Schema Aliases @@ -264,19 +280,27 @@ String and integer enums become `Literal` aliases, and array roots become typed #### 2. Dataclass Models -Connector object schemas are generated as dataclasses with optional fields: +Connector object schemas are generated as dataclasses. Swagger-required fields +are required constructor arguments; optional fields are keyword-only and +default to `None`: ```python @dataclass class FileMetadata: """Metadata for a file in SharePoint or OneDrive.""" - - id: Optional[str] = None - name: Optional[str] = None - path: Optional[str] = None - size: Optional[int] = None - created_time: Optional[datetime] = None - modified_time: Optional[datetime] = None + + id: str + name: Optional[str] = dataclass_field(default=None, kw_only=True) + path: Optional[str] = dataclass_field(default=None, kw_only=True) + size: Optional[int] = dataclass_field(default=None, kw_only=True) + created_time: Optional[datetime] = dataclass_field( + default=None, + kw_only=True, + ) + modified_time: Optional[datetime] = dataclass_field( + default=None, + kw_only=True, + ) ``` #### 3. Client Inheritance @@ -297,42 +321,35 @@ class SharepointonlineClient(ConnectorClientBase): ``` This inheritance provides: + - HTTP client with retry logic - Authentication through caller-owned Azure Core credentials -- Lifecycle management (async context manager, close) +- Lifecycle management through async context managers - Error handling with `ConnectorException` #### 4. Async Method Signatures -All connector actions are generated as async methods: +Operations use unsuffixed names and keyword-only optional parameters. Pageable +methods return their async pager without awaiting construction: ```python -async def get_items_async( +def list_items( self, dataset: str, table: str, + *, filter_query: Optional[str] = None, order_by: Optional[str] = None, - top: Optional[int] = None -) -> Dict[str, Any]: - """ - Get items from a SharePoint list. - - Args: - dataset: SharePoint site URL - table: List name or ID - filter_query: OData filter expression - order_by: OData orderBy expression - top: Maximum number of items to return - - Returns: - Dictionary with 'value' key containing list of items - """ + top: Optional[int] = None, +) -> AsyncItemPaged[dict[str, Any]]: + """Return the asynchronous item pager without awaiting construction.""" + ... ``` #### 5. Type Hints and Docstrings The generator produces: + - Full type hints for all parameters and return types - Docstrings from connector metadata - Optional parameter defaults @@ -342,22 +359,14 @@ The generator produces: After generating a new connector client: -1. **Copy the generated file** to `src/azure/connectors/`: +1. **Copy the generated module** to `src/azure/connectors/`: ```powershell Copy-Item "output\office365.py" "src\azure\connectors\office365.py" ``` -2. **Update `src/azure/connectors/__init__.py`** to export the client: - - ```python - from azure.connectors.office365 import Office365Client - - __all__ = [ - "Office365Client", - # ... other clients - ] - ``` +2. **Regenerate package-level artifacts.** The helper writes the lazy client + registry and root `.pyi` file. Do not edit them manually. 3. **Create unit tests** following the pattern in `tests/`: @@ -378,7 +387,10 @@ After generating a new connector client: pytest ``` -5. **Update documentation**: +5. **Create one async sample** under `samples/sample_connector_usage/` using + root connector imports and unsuffixed operation names. + +6. **Update documentation**: - Add connector to README.md validated connectors table - Update ROADMAP.md status - Add sample code to `samples/` directory @@ -463,12 +475,17 @@ Every generated connector client MUST satisfy these invariants before merge: ### 2. Response Status Checking (All Operations) - Every HTTP operation MUST capture the response and check the status code -- Non-2xx responses MUST raise `ConnectorException` with status code and message +- Non-2xx responses MUST raise `ConnectorException`, an Azure Core + `HttpResponseError`, with status code and message, except for explicitly + curated resource-delete operations whose contract treats HTTP 404 as an + idempotent success +- Operations with a declared 2xx response schema MUST deserialize and return + that payload regardless of the HTTP method - Void operations (DELETE, PATCH, fire-and-forget POST) MUST NOT discard the response unchecked **Correct pattern:** ```python -response = await self.http_client.send_async( +response = await self.http_client.send( method="DELETE", url=request_uri, ) @@ -485,13 +502,20 @@ if not (200 <= response.status < 300): **Incorrect pattern (MUST NOT pass review):** ```python -await self.http_client.send_async( # Result discarded - silent failures! +await self.http_client.send( # Result discarded - silent failures! method="DELETE", url=request_uri, ) ``` -**Validation:** The `test_no_unchecked_send_async_calls` test in `tests/test_code_quality.py` scans for unchecked `send_async` calls. Additionally, unit tests for void methods MUST assert that non-2xx responses raise `ConnectorException`. +The generator owns the narrow allow-list for resource-delete operations that +accept HTTP 404. Do not infer idempotent success from the `DELETE` verb alone; +connectors also use that verb for actions whose missing target is an error. + +The async root pattern awaits `send`. **Validation:** +`test_no_unchecked_send_calls` in `tests/test_code_quality.py` scans root +modules for discarded calls. Unit tests for void methods must also assert that +non-2xx responses raise `ConnectorException`. ### 3. Test Coverage @@ -506,7 +530,7 @@ await self.http_client.send_async( # Result discarded - silent failures! | POST with body | At least 1 test asserting body is forwarded + 1 error test | | PUT with body | At least 1 test asserting body is forwarded + 1 error test | | PATCH with body | At least 1 test asserting body is forwarded + 1 error test | -| DELETE | At least 1 success test + 1 error test verifying exception raised | +| DELETE | At least 1 success test + 1 error test verifying the exception; cover HTTP 404 as success only for explicitly allow-listed resource-delete operations (currently ARM `Deployments_Delete`) | **Connectors with >20 public methods** are not required to have a test class per method. Representative coverage — one test group per HTTP verb type used by the connector — satisfies the acceptance criteria, provided the body-forwarding and non-2xx paths are both covered. @@ -516,7 +540,8 @@ await self.http_client.send_async( # Result discarded - silent failures! - All public types (dataclasses) referenced by method signatures MUST be defined - No `# type: ignore` comments unless accompanied by a tracked issue link -- All optional parameters MUST have `Optional[T]` type hints and default values +- All optional parameters MUST have `Optional[T]` type hints and default values; + Swagger-required model fields MUST remain required constructor arguments ## Generator File Locations (BPM Repository) @@ -531,7 +556,10 @@ When fixing generator bugs (per the "fix the generator, not generated output" ru ### Key Differences from .NET Generator -The .NET SDK centralizes error handling in `ConnectorClientBase.CallConnectorAsync()` — this base method auto-throws on non-2xx for both value-returning and void operations. The Python emitter must explicitly generate the status check in each method body because Python's `http_client.send_async()` does not auto-raise. +The .NET SDK centralizes error handling in +`ConnectorClientBase.CallConnectorAsync()`. The Python emitter must explicitly +generate the status check in each async root method body because +`http_client.send()` does not auto-raise. **If you find a Python generator bug:** 1. Fix it in `DirectClientPythonCodeGenerator.cs` @@ -569,6 +597,13 @@ Track known generator issues here to prevent silent recurrence across releases. | Operation methods corrected Swagger spelling or split acronym letters | Fixed in generator | `docusign`, `github`, `googletasks`, `pdfco`, `salesforce`, `signinghub`, `slack`, `wordonlinebusiness`, `zohosign` | Fixed | Python applies deterministic acronym-aware snake_case and connector-scoped corrections for known malformed operation IDs. | | Colliding wire names dropped after Python normalization | Fixed in generator | `teams`, `shifts`, `todo` | Fixed | Distinct generated fields preserve both `id` and `@odata.id`; serializer tests set both values together. | | String-encoded integer enum tokens emitted as string literals | Fixed in generator | `etsy` | Fixed | Python now normalizes quoted enum tokens to the declared integer schema type. All Phase 6 and 7 clients were regenerated; only `etsy` changed. | +| Pageable item properties and bounded collection envelopes misclassified | Fixed in generator | `azuredigitaltwins`, `insightly`, `jira`, `documentdb`, `sql`, and other collection connectors | Fixed | Explicit pageable operations infer omitted item names and use recognized continuation fields present in the response schema. Bounded read envelopes select conventional primary arrays over auxiliary array metadata and emit `list_*` pagers, while mutation/action arrays remain eager. | +| Mutation arrays were lazy and primitive pagers used dictionary item types | Fixed in generator | `azuread`, `docusign`, `eventhubs`, `meetingroommap`, `mq`, `msgraphgroupsanduser`, `onedrive`, `powerbi`, `replicon`, `sendgrid`, `servicebus`, `yammer` | Fixed | Bounded mutation responses execute eagerly under action names and preserve response envelopes. Read collections retain primitive item types in async pagers. | +| Caller continuation URLs bypassed pagination origin normalization | Fixed in generator | All pageable connectors | Fixed | `by_page(continuation_token=...)` now routes caller tokens through the same URL resolver as service-provided next links before transport receives the request. | +| Typeless dynamic request models omitted mapping inputs | Fixed in generator | `docuware` | Fixed | Dynamic dataclass request annotations now accept either the generated model or `Mapping[str, Any]`. | +| Operation name used as a proxy for HTTP DELETE semantics | Fixed in generator | `arm`, `zohosign`, and other delete operations | Fixed | The generator uses a narrow operation-ID allow-list for resource-delete contracts that accept HTTP 404 (currently ARM `Deployments_Delete`). Other `DELETE` operations preserve ordinary failure behavior, and non-DELETE operations do so even when their names begin with `delete_`. | +| Successful response discarded when Swagger omits its schema | Fixed in generator | `orderful` | Fixed | The Python-specific `ListTransactions` override preserves the runtime JSON payload without changing other language emitters. | +| Bounded collection docs promised continuation URLs | Fixed in generator | 76 connectors, including `rss` and `sharepointonline` | Fixed | Single-page collection docs now match the emitted continuation metadata. URL-backed and opaque-token pager docs retain their distinct contracts; runtime behavior is unchanged. All 99 clients were regenerated. | | Create/update operations missing request body | [BPM #TBD](https://dev.azure.com/msazure/One/_workitems/edit/TBD) | Varies by connector | Investigation | Some POST/PATCH operations may drop body parameters | **Adding a new defect:** diff --git a/README.md b/README.md index 7aed8893..076d09ae 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,9 @@ Type-safe Python clients for [Azure connectors](https://learn.microsoft.com/conn Azure provides a rich ecosystem of [managed connectors](https://learn.microsoft.com/connectors/connector-reference/) that bridge your code to SaaS services, PaaS resources, and on-premises systems. Originally powering Azure Logic Apps and Power Automate, these connectors are now available as **standalone, strongly-typed Python clients** for any Python application — no workflow service required. -- **Async/await native** — Built on `aiohttp` with full async support for modern Python applications -- **Type-safe operations** — Generated async methods with type hints and comprehensive docstrings -- **Built-in authentication** — Managed identity, Azure Identity, and API key token providers +- **Async-only clients** — Import clients from `azure.connectors.`; there is no synchronous mirror +- **Type-safe operations** — Unsuffixed async operations expose type hints and comprehensive docstrings +- **Built-in authentication** — Async Azure Identity credentials, managed identity, and Azure Core API keys - **Resilient HTTP** — Configurable retries with exponential backoff for safe HTTP methods; unsafe methods make one attempt by default - **1,000+ connectors** — Any Azure managed connector available via API Hub can be generated @@ -44,10 +44,10 @@ Azure provides a rich ecosystem of [managed connectors](https://learn.microsoft. ▼ ┌─────────────────────────────────────┐ │ Generated Connector Clients │ -│ (office365.py, teams.py, etc.) │ +│ (async clients in root modules) │ │ │ -│ • Typed async methods per action │ -│ • Dataclass models from Swagger │ +│ • Matching unsuffixed operations │ +│ • Shared models from Swagger │ │ • Docstrings from connector meta │ └──────────────┬──────────────────────┘ │ depends on @@ -78,11 +78,9 @@ pip install azure-connectors[dev] ## Quick Start -### Example: Send an email with Office 365 +### Example: Send an email ```python -import asyncio - from azure.identity.aio import DefaultAzureCredential from azure.connectors.office365 import Office365Client, SendEmailInput @@ -93,19 +91,16 @@ async def send_email_example(): async with DefaultAzureCredential() as credential: async with Office365Client(connection_url, credential) as client: - await client.send_email_async( + await client.send_email( input=SendEmailInput( to="recipient@example.com", subject="Hello from Python SDK", body="

Sent with the Azure Connectors Python SDK.

", ) ) - - -asyncio.run(send_email_example()) ``` -### Example: List SharePoint items +### Example: List SharePoint items asynchronously ```python from azure.identity.aio import DefaultAzureCredential @@ -120,7 +115,7 @@ async def list_sharepoint_items(): async with SharepointonlineClient(connection_url, credential) as client: items = [ item - async for item in client.get_items_async( + async for item in client.list_items( dataset="https://contoso.sharepoint.com/sites/MySite", table="MyList", ) @@ -135,7 +130,8 @@ async def list_sharepoint_items(): ```python from azure.identity.aio import DefaultAzureCredential -from azure.connectors.teams import DynamicPostMessageRequest, TeamsClient +from azure.connectors.teams import TeamsClient +from azure.connectors.teams import DynamicPostMessageRequest async def post_teams_message(): @@ -143,7 +139,7 @@ async def post_teams_message(): async with DefaultAzureCredential() as credential: async with TeamsClient(connection_url, credential) as client: - await client.post_message_to_conversation_async( + await client.post_message_to_conversation( input=DynamicPostMessageRequest( additional_properties={ "body": { @@ -157,6 +153,36 @@ async def post_teams_message(): ) ``` +### Example: Wait for a long-running Kusto query + +Long-running operations use an Azure SDK-style `begin_*` method. Keep the +client open until the poller reaches its terminal response: + +```python +from azure.identity.aio import DefaultAzureCredential + +from azure.connectors.kusto import KustoClient, QueryAndListSchema + + +async def run_kusto_query(): + connection_url = "https://example.azure.com/connections/kusto" + + async with DefaultAzureCredential() as credential: + async with KustoClient(connection_url, credential) as client: + poller = await client.begin_list_kusto_results( + input=QueryAndListSchema( + cluster="https://contoso.kusto.windows.net", + db="Samples", + csl="StormEvents | take 5", + ) + ) + return await poller.result() +``` + +Await the `begin_*` method to create an `AsyncLROPoller`, then +`await poller.result()` waits for completion. See the +[long-running operations guide](docs/long-running-operations.md). + ### Retry safety By default, `GET`, `HEAD`, `OPTIONS`, and `TRACE` use the configured retry settings. `POST`, `PUT`, `PATCH`, `DELETE`, and other methods make one attempt after a transient response or transport error because the connector may already have completed the side effect. @@ -181,6 +207,7 @@ async def use_teams_client(connection_url: str): ``` `max_retry_attempts`, timeout, and backoff settings govern eligible retries. This is the same [cross-language retry-safety contract](https://github.com/Azure/Connectors-NET-SDK/blob/main/docs/retry-safety.md) as the .NET and Node.js SDKs. + ## Validated Connectors The following connectors have been generated and validated with comprehensive test coverage: @@ -313,7 +340,7 @@ Pass `client_id="your-client-id"` to `ManagedIdentityCredential` for a user-assi ### Azure Identity Credentials -Any asynchronous Azure Identity credential can be passed directly: +Clients accept caller-owned `AsyncTokenCredential` implementations: ```python from azure.identity.aio import DefaultAzureCredential @@ -324,7 +351,8 @@ credential = DefaultAzureCredential() client = Office365Client(connection_url, credential) ``` -The caller owns the credential and must close it. Prefer an `async with` credential context as shown above. +The caller owns the credential and must close it. Prefer `async with` for both +the credential and client, as shown in the quick start. ### API Key @@ -345,29 +373,26 @@ Pass retry, timeout, transport, and Azure Core policy settings directly to the g client = Office365Client( connection_url, credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, use_exponential_backoff=True, initial_retry_delay_seconds=1.0, ) ``` -`timeout_seconds` is one total network budget for each request, including +The client-level `timeout` sets a total network budget for each request, including retries, response loading, and body reads. Each generated operation also accepts keyword-only `timeout`, `headers`, `client_request_id`, and `response_hook` -request controls; `timeout` overrides that total budget for one operation. Set -either timeout to zero or a negative value to disable SDK and transport +request controls; the operation-level `timeout` overrides that total budget for +one operation. Set either timeout to zero or a negative value to disable SDK and transport deadlines for the selected requests. -Generated clients accept any Azure Core `AsyncHttpTransport`. The client closes -an injected transport through its asynchronous lifecycle; the caller retains -ownership of the credential. The SDK enforces the total request budget across -transports and applies transport-specific timeout options only when supported. -`per_call_policies` and `per_retry_policies` are composed with the default or an -explicit `policies` chain. An explicit chain using `per_retry_policies` must -contain an `AsyncRetryPolicy`. Explicit chains without a retry policy remain -supported; the SDK enforces positive total request deadlines without forwarding -retry-only options to the transport. +Clients accept Azure Core `AsyncHttpTransport` implementations and close injected +transports asynchronously; callers retain ownership of credentials. The SDK +applies transport-specific timeout options only when supported. Blocking callbacks +must bound their own execution; the SDK cannot interrupt them. `per_call_policies` +and `per_retry_policies` compose with the default or an explicit `policies` chain. +Per-retry extensions require `AsyncRetryPolicy`. ## Project Structure @@ -379,13 +404,20 @@ azure-connectors/ │ │ ├── http_client.py # Async pipeline and retry policies │ │ ├── response.py # Immutable response hook contracts │ │ └── exceptions.py # Exception types -│ ├── office365.py # Office 365 generated client +│ ├── office365.py # Async client and models │ ├── sharepointonline.py # SharePoint generated client │ └── teams.py # Teams generated client ├── tests/ # Comprehensive test suite ├── samples/ # Usage examples └── docs/ # Additional documentation ``` + +See [Migrate to unsuffixed async operations](docs/migration-sync-aio.md) for the +breaking changes from the earlier preview. Async-only is an intentional +divergence from the Azure SDK synchronous-client guideline, aligned with the +.NET connector SDK. This does not restore the old API: keyword-only options, +Azure Core errors, `AsyncItemPaged`, and `AsyncLROPoller` remain. + ## SDK-Type Bindings for Azure Functions The SDK supports **SDK-type bindings** for Python Function apps, allowing functions to bind to and return rich, strongly-typed objects instead of raw JSON payloads. This enables cleaner code and better IDE support with type hints. diff --git a/ROADMAP.md b/ROADMAP.md index 0075a94a..c63e2c47 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -12,7 +12,7 @@ This document tracks the development roadmap for the Azure Connectors Python SDK | Component | Status | |-----------|--------| -| Core SDK | ✅ Complete — Token providers, HTTP client, retry logic, async/await | +| Core SDK | ✅ Complete — Async Azure Core pipelines, credentials, retries, and paging | | Connectors | ✅ 99 connectors — See [README.md](README.md#validated-connectors) | | CI/CD | ✅ Complete — GitHub Actions for pytest, flake8, build | | PyPI Publishing | ✅ Complete — Release workflow ready | @@ -29,7 +29,7 @@ This document tracks the development roadmap for the Azure Connectors Python SDK - [x] Core SDK abstractions (`ConnectorClientBase`, `ConnectorHttpClient`) - [x] Azure Core credentials (async Azure Identity and API key) - [x] HTTP client with retry logic and exponential backoff -- [x] Async/await support throughout +- [x] Async-only root clients, aligned with the .NET connector SDK; no synchronous mirror - [x] Type hints and dataclass models - [x] Office 365 Outlook connector - [x] SharePoint Online connector @@ -252,7 +252,7 @@ Based on usage data, agentic solution value, and community requests: | Component | Status | Notes | |-----------|--------|-------| -| LogicAppsCompiler with `--python` flag | ✅ Available | BPM PR 15456622 | +| LogicAppsCompiler with `--pythonDirectClient` flag | ✅ Available | Async-only root connector modules | | Python output templates | ✅ Complete | Dataclasses, async methods | | Type hint generation | ✅ Complete | Full Python 3.10+ typing | | Docstring generation | ✅ Complete | From connector metadata | diff --git a/docs/api/index.md b/docs/api/index.md index 8c5da2af..132b3886 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -2,13 +2,24 @@ The API reference is generated from the current Python source on every documentation build. -## Core SDK +## Async core SDK -Core modules provide authentication, client lifecycle, HTTP behavior, serialization, options, exceptions, and trigger payload types. These modules are maintained by the SDK team. +Root core modules provide asynchronous client lifecycle, HTTP behavior, +serialization, exceptions, and trigger payload types. The root runtime is async-only. -## Connector modules +## Connector clients -Each shipped connector has its own generated module containing an asynchronous client and the request and response models reachable from that connector's contract. Connector pages are discovered automatically, so newly generated modules appear without a separate documentation allow-list. +Each shipped connector has an asynchronous root module containing its client and +the shared request and response declarations reachable from that connector's +contract. No separate aio catalog or synchronous mirror is provided. Import +clients and models from `azure.connectors.`. + +Pageable operations return `AsyncItemPaged` without awaiting construction. +Location-backed long-running operations return `AsyncLROPoller` from awaited +`begin_*` methods. + +Both API sections are discovered automatically, so new connector modules +appear without a separate documentation allow-list. Generated connector source is read-only. Corrections to generated signatures or docstrings must be made in the CodefulSdkGenerator and regenerated into this repository. diff --git a/docs/azure-sdk-guidelines.md b/docs/azure-sdk-guidelines.md new file mode 100644 index 00000000..001d93c0 --- /dev/null +++ b/docs/azure-sdk-guidelines.md @@ -0,0 +1,51 @@ +# Azure SDK guideline alignment + +This SDK follows the Azure SDK Design Guidelines for Python where they fit the +managed connector execution model. The table records intentional Phase 2 +decisions so future changes preserve the public contract. + +| Area | Decision | Status | +|---|---|---| +| Synchronous APIs | Provide async-only clients, aligned with the .NET connector SDK. Do not add a synchronous mirror. | Intentional deviation | +| Method names | Use unsuffixed async operation names. | Follow | +| Credentials | Accept caller-owned `AsyncTokenCredential` or `AzureKeyCredential`. | Follow | +| Transports | Accept Azure Core `AsyncHttpTransport` implementations. | Follow | +| Paging | Return `AsyncItemPaged` and support `by_page(continuation_token=...)`. | Follow | +| Models | Define wire models in each root connector module. | Project convention | +| Imports | Export clients lazily from package roots while retaining direct per-connector imports. | Follow | +| Errors | Derive connector service errors from Azure Core `HttpResponseError`. | Follow | +| Request options | Expose keyword-only `timeout`, `headers`, `client_request_id`, and `response_hook`. | Follow | +| Long-running operations | Return `AsyncLROPoller` for retained operations with an HTTP 202 `Location` contract. | Follow | +| API versions | Use each generated operation's managed-connector Swagger version; do not expose a client-level `api_version` override. | Intentional deviation | +| Return values | Return connector payloads directly rather than Azure Core `Response[T]` wrappers. | Intentional deviation | + +## Namespace shape + +```python +# Async client and models +from azure.connectors.office365 import Office365Client, SendEmailInput + +# Clients are also available as lazy package-root exports +from azure.connectors import Office365Client +``` + +Clients, models, type aliases, enums, and `TRIGGER_OPERATIONS` live in the same +root connector module. There is no separate aio client catalog. + +Location-backed operations use awaited `begin_*` calls. Azure +status-document protocols, poller continuation tokens, and cancellation are +not part of the current contract. + +Managed connectors can route operations to different service API versions +within one client. Generated operations therefore retain their Swagger-declared +internal version defaults instead of accepting one constructor-level +`api_version` that could override unrelated routes. + +## Compatibility policy + +Async-only does not restore the old preview API. Operations no longer use +`_async` suffixes, optional parameters and request controls remain keyword-only, +and Azure Core credentials, errors, pagers, and pollers remain. Package-root +exports are lazy so importing `azure.connectors` does not +load every generated module. See the [migration guide](migration-sync-aio.md) +for mechanical changes. diff --git a/docs/connection-setup.md b/docs/connection-setup.md index 98756e53..8033adf4 100644 --- a/docs/connection-setup.md +++ b/docs/connection-setup.md @@ -310,14 +310,24 @@ Add the runtime URL to your application settings: ## Authentication Modes -The generated connector clients (e.g., `Office365Client`, `TeamsClient`) authenticate to API Hub using Azure credentials. Each client offers two constructors that cover three authentication modes: +Generated connector clients authenticate to API Hub with caller-owned +`AsyncTokenCredential` or `AzureKeyCredential` credentials. Python clients are +async-only; import clients from their root connector modules. ### Mode 1: DefaultAzureCredential (Recommended for Local Development) -Uses the [DefaultAzureCredential](https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication/?tabs=command-line#defaultazurecredential) chain, which tries multiple sources automatically — Azure CLI, Visual Studio, environment variables, and managed identity. +Use the [DefaultAzureCredential](https://learn.microsoft.com/python/api/azure-identity/azure.identity.aio.defaultazurecredential) chain for local development and managed identity. -```csharp -var client = new Office365Client(connectionRuntimeUrl); +```python +from azure.identity.aio import DefaultAzureCredential + +from azure.connectors.office365 import Office365Client + + +async def use_connection(connection_runtime_url: str) -> None: + async with DefaultAzureCredential() as credential: + async with Office365Client(connection_runtime_url, credential) as client: + print(client.connector_name) ``` This is the simplest setup. Locally, it authenticates as your Azure CLI identity (`az login`), which must have an [access policy](#step-5-add-access-policy-for-clilocal-testing) on the connection for local testing. When deployed to Azure, it falls through to the app's managed identity, which must have an [access policy](#a5-add-access-policy-for-function-app-msi) on the connection. @@ -326,22 +336,28 @@ This is the simplest setup. Locally, it authenticates as your Azure CLI identity Uses `ManagedIdentityCredential` with no client ID, targeting the app's system-assigned identity. -```csharp -var client = new Office365Client( - connectionRuntimeUrl, - managedIdentityClientId: null); +```python +from azure.identity.aio import ManagedIdentityCredential + + +async def use_managed_identity(connection_runtime_url: str) -> None: + async with ManagedIdentityCredential() as credential: + async with Office365Client(connection_runtime_url, credential) as client: + print(client.connector_name) ``` -Pass `null` (or an empty string) for `managedIdentityClientId`. The Function App must have system-assigned managed identity enabled, and the identity must have an [access policy](#a5-add-access-policy-for-function-app-msi) on the connection. +Omit `client_id` for the system-assigned identity. The Function App must have +that identity enabled and grant it an [access policy](#a5-add-access-policy-for-function-app-msi). ### Mode 3: User-Assigned Managed Identity Uses `ManagedIdentityCredential` with a specific client ID, targeting a user-assigned managed identity attached to the app. -```csharp -var client = new Office365Client( - connectionRuntimeUrl, - managedIdentityClientId: ""); +```python +async def use_user_assigned_identity(connection_runtime_url: str) -> None: + async with ManagedIdentityCredential(client_id="") as credential: + async with Office365Client(connection_runtime_url, credential) as client: + print(client.connector_name) ``` Use this when multiple apps share a single identity, or when you need the identity to outlive any single app deployment. @@ -358,14 +374,19 @@ Use this when multiple apps share a single identity, or when you need the identi ### Custom Credentials -The primary constructor also accepts any `TokenCredential` directly, enabling advanced scenarios (e.g., certificate-based auth, chained credentials): +The constructor accepts any `AsyncTokenCredential`, including async chained +credentials. The caller must close the credential: + +```python +from azure.identity.aio import AzureCliCredential, ChainedTokenCredential, ManagedIdentityCredential -```csharp -var credential = new ChainedTokenCredential( - new ManagedIdentityCredential(), - new AzurePowerShellCredential()); -var client = new Office365Client(connectionRuntimeUrl, credential); +async def use_chained_credentials(connection_runtime_url: str) -> None: + async with ChainedTokenCredential( + ManagedIdentityCredential(), AzureCliCredential() + ) as credential: + async with Office365Client(connection_runtime_url, credential) as client: + print(client.connector_name) ``` --- diff --git a/docs/generated-contract.md b/docs/generated-contract.md new file mode 100644 index 00000000..3b8c89ae --- /dev/null +++ b/docs/generated-contract.md @@ -0,0 +1,61 @@ +# Generated connector contract + +Generated connector clients are committed artifacts produced by the BPM +CodefulSdkGenerator. Do not hand-edit generated files under `src/azure/connectors/`. + +## Async-only output + +One Python generation request emits one root module for every connector: + +```text +src/azure/connectors/.py # async client, models, and metadata +``` + +Each module must come from the recorded generator revision and connector +contract. There is no synchronous mirror or separate aio catalog. + +## Public invariants + +- Root operations are asynchronous except that + pageable methods construct and return their pager without being awaited. +- Clients expose unsuffixed operation names and keyword-only optional parameters + and request controls. +- Read-collection operations return `AsyncItemPaged`. This includes bounded read collections + without a continuation-link contract. Arrays returned by mutations and other + actions remain eager operation payloads. +- Dataclasses, type aliases, enums, and `TRIGGER_OPERATIONS` are declared in + the root connector module alongside the async client. +- Swagger-required dataclass properties are required constructor arguments; + only optional properties default to `None`. +- Each module defines an explicit `__all__`. +- Generated clients are available from their connector modules and as lazy + package-root exports. The generated registry and `.pyi` files keep runtime + discovery and static typing synchronized without eagerly importing every + connector module. +- Retained operations with an HTTP 202 `Location` response contract use + `begin_*` and return `AsyncLROPoller[T]` after awaiting the call. LRO classification + takes precedence over paging, and bare HTTP 202 responses remain ordinary. +- `ConnectorException` derives from Azure Core `HttpResponseError` while + retaining connector operation, path, status, and response-body details. + +Paging must preserve validation, connector error behavior, empty pages, +continuation links, request controls, and response hooks on every request. +Service links and caller-provided continuation tokens pass through the same URL +resolver. Links from a different origin are rebased onto the connection runtime +origin before the next request. + +The shipped catalog contains exactly 44 LRO methods: 5 in Kusto and 39 +in Plumsail. Internal Kusto retrieval helpers and superseded Plumsail revisions +remain filtered by the existing operation-retention rules. + +## Regeneration evidence + +Source Swagger files used during generation are not committed to this +repository. Record the exact generator commit and source metadata in the pull +request, then use the live-metadata workflow in `GENERATION.md` to refresh the +complete 99-connector async catalog. Review source metadata changes and generated output +together before committing regenerated clients. + +Before submission, verify the root catalog inventory, compile every generated +module, run connector and runtime tests, validate all 99 async samples, build +the documentation, and inspect the wheel and source distribution inventories. diff --git a/docs/index.md b/docs/index.md index ee04f986..06c9b05d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,11 +11,11 @@ Build type-safe Python integrations with Azure managed connectors for services s python -m pip install azure-connectors ``` -The SDK requires Python 3.10 or later and provides asynchronous connector clients, typed request models, generated schema classes, and Azure Identity integration. Connector operation responses are currently returned as dictionaries rather than generated model instances. +The SDK requires Python 3.10 or later and provides async-only root connector clients, typed models, and Azure Identity integration. Non-pageable responses return payload values; pageable operations return `AsyncItemPaged`. No synchronous mirror is provided, aligned with the .NET connector SDK. ## Create a client -Generated clients require a caller-owned asynchronous Azure Identity credential or an `AzureKeyCredential`. +Generated clients require a caller-owned `AsyncTokenCredential` or `AzureKeyCredential`. Import clients and models from the root connector module. Operations do not use an `_async` suffix. ```python from azure.identity.aio import DefaultAzureCredential @@ -26,15 +26,16 @@ from azure.connectors.office365 import Office365Client async def list_messages(connection_url: str) -> None: async with DefaultAzureCredential() as credential: async with Office365Client(connection_url, credential) as client: - messages = await client.get_emails_async( - folder_path="Inbox", - ) + messages = [message async for message in client.list_emails()] print(messages) ``` + Connector signatures are generated from their managed connector contracts. Consult the [API reference](api/index.md) for the exact client method and model names in the current branch. ## Next steps - [Set up a connector connection](connection-setup.md) +- [Migrate to unsuffixed async operations](migration-sync-aio.md) - [Browse the API reference](api/index.md) +- [Review the generated contract](generated-contract.md) - [Understand Azure Functions SDK-type bindings](sdk-type-bindings.md) diff --git a/docs/long-running-operations.md b/docs/long-running-operations.md new file mode 100644 index 00000000..df401f7a --- /dev/null +++ b/docs/long-running-operations.md @@ -0,0 +1,35 @@ +# Long-running operations + +Kusto and Plumsail operations that declare an HTTP 202 `Location` polling +contract use Azure Core pollers. Their generated method names begin with +`begin_`. + +## Asynchronous clients + +```python +from azure.connectors.kusto import KustoClient + + +async with KustoClient(connection_url, credential) as client: + poller = await client.begin_list_kusto_results(input=query) + result = await poller.result() +``` + +`AsyncLROPoller` starts polling when it is awaited through `result()`, `wait()`, +or the poller itself. + +## Polling behavior + +- HTTP 202 responses must provide a `Location` header. +- Polling requests use GET and honor numeric or HTTP-date `Retry-After` values. +- Relative and connector-backend polling URLs are routed through the + authenticated connection runtime origin. +- `timeout`, `headers`, `client_request_id`, and `response_hook` are forwarded + to the initial request and every poll request. `timeout` applies to each + network request, not the lifetime of the long-running operation. +- A non-202 success response completes the poller. Terminal non-success + responses raise `ConnectorException`. + +Keep the connector client open until polling completes. Poller continuation +tokens, cancellation, `Azure-AsyncOperation` status documents, and +`Operation-Location` final-resource protocols are not currently supported. diff --git a/docs/migration-sync-aio.md b/docs/migration-sync-aio.md new file mode 100644 index 00000000..2a5f4333 --- /dev/null +++ b/docs/migration-sync-aio.md @@ -0,0 +1,84 @@ +# Migrate to unsuffixed async operations + +Clients remain asynchronous at `azure.connectors.`, as in the +earlier preview. The SDK provides no synchronous mirror, an intentional +divergence from the Azure SDK guideline aligned with the .NET connector SDK. +Compatibility aliases for `_async` operation names are not provided. + +## Choose a client + +Import async clients and models from each root connector module. + +| Use case | Client import | Credential | +|---|---|---| +| Asynchronous code | `azure.connectors.` | `azure.core.credentials_async.AsyncTokenCredential` | + +Connections that expect API keys also accept `AzureKeyCredential`. + +## Update asynchronous code + +Keep the root client import and remove `_async` from operation names: + +```python +from azure.identity.aio import DefaultAzureCredential + +from azure.connectors.office365 import Office365Client, SendEmailInput + + +async def send_email(connection_url: str) -> None: + async with DefaultAzureCredential() as credential: + async with Office365Client(connection_url, credential) as client: + await client.send_email( + input=SendEmailInput( + to="recipient@example.com", + subject="Hello", + body="Sent with Azure Connectors.", + ) + ) +``` + +Before this release, the client was imported from +`azure.connectors.office365` and the operation was named `send_email_async`. + +## Keep the new request contract + +Async-only is not a return to the old signatures or response shapes: + +- Pass optional operation parameters and request controls by keyword. +- Replace legacy token providers and `ConnectorClientOptions` with caller-owned + `AsyncTokenCredential` or `AzureKeyCredential` and direct client options. +- Inject `AsyncHttpTransport` implementations. Clients close transports; + callers close their async credentials. +- Catch `ConnectorException` or its Azure Core base `HttpResponseError`. +- If you evaluated the intermediate dual-mode branch, replace + `azure.connectors.aio.` imports with `azure.connectors.`; + retain `await` and `async with`. + +## Migrate pageable operations + +Pageable operations no longer return `AsyncIterator`. They return Azure Core `AsyncItemPaged` +pagers and continue to yield connector items directly. + +```python +# Async: azure.core.async_paging.AsyncItemPaged +async for item in client.list_items(dataset=site_url, table=list_name): + process(item) +``` + +Do not await pager construction. Use `by_page(continuation_token=...)` when +page boundaries or a saved continuation token are required. + +## Removed preview forms + +- `_async` operation names; root asynchronous clients remain. +- Awaiting pageable operations as response dictionaries. +- Treating collected page items as a response envelope with a `value` field. + +Generated clients are also available as lazy exports from `azure.connectors`. +Prefer concrete connector-module imports so clients and models share one import +location. + +Location-backed Kusto and Plumsail operations now use `begin_*` methods. Root +clients return `AsyncLROPoller` after awaiting +the `begin_*` call. Resolve the terminal payload with `await poller.result()` and keep +the connector client open until polling completes. diff --git a/samples/sample_connector_usage/README.md b/samples/sample_connector_usage/README.md index a077d8de..961fe3f2 100644 --- a/samples/sample_connector_usage/README.md +++ b/samples/sample_connector_usage/README.md @@ -10,7 +10,8 @@ This directory contains samples demonstrating how to use the Azure Connectors SD ## Samples -Each sample file (`sample_connector_usage_*.py`) demonstrates a specific connector's operations. Run any sample with: +Each of the 99 connectors has one async sample in this directory. Clients and +models use root connector imports and unsuffixed operation names. Run a sample with: ```bash python sample_connector_usage_.py @@ -128,40 +129,48 @@ $env:OFFICE365_CONNECTION_URL = "https://[region].azure-apihub.net/apim/office36 export OFFICE365_CONNECTION_URL="https://[region].azure-apihub.net/apim/office365/[connection-id]" ``` -## Usage Pattern +## Usage Patterns -All connector clients follow the same async context manager pattern: +Root connector modules provide async-only clients and models. Use async +credentials and context managers: ```python import asyncio + from azure.identity.aio import DefaultAzureCredential + from azure.connectors import ConnectorException from azure.connectors. import Client +from azure.connectors. import CONNECTION_URL = "https://[region].azure-apihub.net/apim//[connection-id]" + async def main(): - credential = DefaultAzureCredential() - - async with Client(CONNECTION_URL, credential) as client: - try: - result = await client._async() - print(result) - except ConnectorException as ex: - print(f"Connector error: {ex}") + async with DefaultAzureCredential() as credential: + async with Client(CONNECTION_URL, credential) as client: + try: + result = await client.(()) + print(result) + except ConnectorException as ex: + print(f"Connector error: {ex}") + asyncio.run(main()) ``` +Pageable operations return `AsyncItemPaged`. Consume them with `async for`; +do not await pager construction. Await `begin_*` operations to obtain an +`AsyncLROPoller`, then await `poller.result()` while the client remains open. + ## Error Handling -The SDK provides structured error handling via `ConnectorException`: +The SDK provides structured error handling via `ConnectorException`, which +derives from Azure Core `HttpResponseError`: ```python -from azure.connectors import ConnectorException - try: - result = await client.some_operation_async() + result = await client.some_operation() except ConnectorException as ex: print(f"Status: {ex.status_code}, Message: {ex}") ``` @@ -170,12 +179,12 @@ except ConnectorException as ex: 1. Set up a connection in Azure Portal (see [connection-setup.md](../../docs/connection-setup.md)) 2. Set the connection runtime URL environment variable -3. Run the sample for your connector +3. Run the async sample for your connector 4. Use typed clients in your application 5. Deploy to Azure Functions or run locally ## Reference -- Python SDK: [PythonSDK/src/azure_workflows_connectors_sdk](../../src/azure_workflows_connectors_sdk) +- API Reference: [Azure Connectors Python SDK](https://azure.github.io/connectors-python-sdk/) - Generation Guide: [GENERATION.md](../../GENERATION.md) -- .NET Sample: [DotnetSDK/samples/SampleConnectorUsage](../../../DotnetSDK/samples/SampleConnectorUsage) +- Migration Guide: [Unsuffixed async operations](../../docs/migration-sync-aio.md) diff --git a/samples/sample_connector_usage/sample_connector_usage_arm.py b/samples/sample_connector_usage/sample_connector_usage_arm.py index c7512550..93322512 100644 --- a/samples/sample_connector_usage/sample_connector_usage_arm.py +++ b/samples/sample_connector_usage/sample_connector_usage_arm.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Resource Manager (ARM) Connector SDK Sample +Azure Resource Manager (ARM) sample for the Azure Connectors Python SDK -This sample demonstrates how to use the ARM connector SDK to interact +This sample demonstrates how to use the ARM client from the Azure Connectors Python SDK to interact with Azure Resource Manager APIs. Prerequisites: @@ -48,7 +48,7 @@ async def example_1_list_subscriptions(): async with ArmClient(CONNECTION_RUNTIME_URL, credential) as client: try: subscriptions = [ - item async for item in client.subscriptions_list_async() + item async for item in client.list_subscriptions() ] if subscriptions: @@ -78,7 +78,7 @@ async def example_2_list_subscriptions_with_details(): async with ArmClient(CONNECTION_RUNTIME_URL, credential) as client: try: subscriptions = [ - item async for item in client.subscriptions_list_async() + item async for item in client.list_subscriptions() ] if subscriptions: @@ -121,7 +121,7 @@ async def example_3_filter_enabled_subscriptions(): async with ArmClient(CONNECTION_RUNTIME_URL, credential) as client: try: subscriptions = [ - item async for item in client.subscriptions_list_async() + item async for item in client.list_subscriptions() ] if subscriptions: @@ -158,7 +158,7 @@ async def example_3_filter_enabled_subscriptions(): async def main(): """Run all examples.""" - print("Azure Resource Manager (ARM) Connector SDK - Sample Usage") + print("Azure Resource Manager (ARM) sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_azuread.py b/samples/sample_connector_usage/sample_connector_usage_azuread.py index a5f4fc42..be4c873e 100644 --- a/samples/sample_connector_usage/sample_connector_usage_azuread.py +++ b/samples/sample_connector_usage/sample_connector_usage_azuread.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure AD (Microsoft Entra ID) Connector SDK Sample +Azure AD (Microsoft Entra ID) sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure AD connector SDK. +This sample demonstrates how to use the Azure AD client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Azure AD connection @@ -24,8 +24,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.azuread import AzureadClient from azure.connectors.azuread import ( - AzureadClient, CreateOffice365GroupInput, CreateSecurityGroupInput, CreateGroupInput, @@ -63,7 +63,7 @@ async def example_1_create_office365_group(): mail_enabled=True, ) - result = await client.create_office365_group_async(input=input_data) + result = await client.create_office365_group(input=input_data) if result: print("Office 365 group created:") @@ -102,7 +102,7 @@ async def example_2_create_security_group(): mail_enabled=False, ) - result = await client.create_security_group_async(input=input_data) + result = await client.create_security_group(input=input_data) if result: print("Security group created:") @@ -145,7 +145,7 @@ async def example_3_create_group(): mail_enabled=bool(group_types), ) - result = await client.create_group_async(input=input_data) + result = await client.create_group(input=input_data) if result: print("Group created:") @@ -193,7 +193,7 @@ async def example_4_create_user(): }, ) - result = await client.create_user_async(input=input_data) + result = await client.create_user(input=input_data) if result: print("User created:") @@ -227,7 +227,7 @@ async def example_5_remove_member_from_group(): async with AzureadClient(CONNECTION_RUNTIME_URL, credential) as client: try: - await client.remove_member_from_group_async( + await client.remove_member_from_group( group_id=group_id, member_id=member_id, ) @@ -244,7 +244,7 @@ async def example_5_remove_member_from_group(): async def main(): """Run all examples.""" - print("Azure AD (Microsoft Entra ID) Connector SDK - Sample Usage") + print("Azure AD (Microsoft Entra ID) sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_azureautomation.py b/samples/sample_connector_usage/sample_connector_usage_azureautomation.py index a476fab1..7995501d 100644 --- a/samples/sample_connector_usage/sample_connector_usage_azureautomation.py +++ b/samples/sample_connector_usage/sample_connector_usage_azureautomation.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Automation Connector SDK Sample +Azure Automation sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Automation connector SDK +This sample demonstrates how to use the Azure Automation client from the Azure Connectors Python SDK to interact with Azure Automation accounts, runbooks, and jobs. Prerequisites: @@ -34,8 +34,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.azureautomation import AzureautomationClient from azure.connectors.azureautomation import ( - AzureautomationClient, CreateJobInput, CreateJobResponse, Subscription, @@ -99,7 +99,7 @@ async def example_2_create_job(): ) as client: try: # Create a new automation job - result = await client.create_job_async( + result = await client.create_job( input=CreateJobInput(properties={}), subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP_NAME, @@ -130,7 +130,7 @@ async def example_3_create_job_and_wait(): ) as client: try: # Create job with wait parameter to wait for completion - result = await client.create_job_async( + result = await client.create_job( input=CreateJobInput(properties={}), subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP_NAME, @@ -161,7 +161,7 @@ async def example_4_get_job_status(): ) as client: try: # Get status of a job - result = await client.get_status_of_job_async( + result = await client.get_status_of_job( subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP_NAME, automation_account=AUTOMATION_ACCOUNT, @@ -194,7 +194,7 @@ async def example_5_get_job_output(): ) as client: try: # Get output from a completed job - output = await client.get_job_output_async( + output = await client.get_job_output( subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP_NAME, automation_account=AUTOMATION_ACCOUNT, diff --git a/samples/sample_connector_usage/sample_connector_usage_azureblob.py b/samples/sample_connector_usage/sample_connector_usage_azureblob.py index 1b8846e0..999863cb 100644 --- a/samples/sample_connector_usage/sample_connector_usage_azureblob.py +++ b/samples/sample_connector_usage/sample_connector_usage_azureblob.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Blob Storage Connector SDK Sample +Azure Blob Storage sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Blob Storage connector SDK. +This sample demonstrates how to use the Azure Blob Storage client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Azure Blob Storage connection @@ -60,7 +60,7 @@ async def example_1_get_blob_metadata(): async with AzureblobClient(CONNECTION_RUNTIME_URL, credential) as client: - metadata = await client.get_file_metadata_by_path_async( + metadata = await client.get_file_metadata_by_path( dataset=STORAGE_ACCOUNT, path=blob_path, ) @@ -90,7 +90,7 @@ async def example_2_download_blob(): async with DefaultAzureCredential() as credential: async with AzureblobClient(CONNECTION_RUNTIME_URL, credential) as client: - content = await client.get_file_content_by_path_async( + content = await client.get_file_content_by_path( dataset=STORAGE_ACCOUNT, path=blob_path, ) @@ -128,7 +128,7 @@ async def example_3_upload_blob(): async with AzureblobClient(CONNECTION_RUNTIME_URL, credential) as client: try: - metadata = await client.create_file_async( + metadata = await client.create_file( input=blob_content.encode("utf-8"), dataset=STORAGE_ACCOUNT, folder_path=folder_path, @@ -157,7 +157,7 @@ async def example_4_list_blobs(): if not folder_id: print("Set TEST_FOLDER_ID environment variable to a folder identifier.") print("Example: $env:TEST_FOLDER_ID = 'JTJmbXljb250YWluZXI=' (base64 encoded path)") - print("Or use list_root_folder_async to list root container blobs.") + print("Or use list_root_folder to list root container blobs.") # Try listing root folder instead print("\nListing root folder blobs instead...") @@ -165,7 +165,7 @@ async def example_4_list_blobs(): async with AzureblobClient(CONNECTION_RUNTIME_URL, credential) as client: try: - blobs = [item async for item in client.list_root_folder_async( + blobs = [item async for item in client.list_root_folder( dataset=STORAGE_ACCOUNT, )] @@ -190,7 +190,7 @@ async def example_4_list_blobs(): async with AzureblobClient(CONNECTION_RUNTIME_URL, credential) as client: try: - blobs = [item async for item in client.list_folder_async( + blobs = [item async for item in client.list_folder( dataset=STORAGE_ACCOUNT, id=folder_id, )] @@ -220,14 +220,14 @@ async def example_5_delete_blob(): if not blob_id: print("Set TEST_BLOB_ID environment variable to a blob identifier.") print("Example: $env:TEST_BLOB_ID = 'JTJmbXljb250YWluZXIlMmZmaWxlLnR4dA=='") - print("You can get blob IDs from the list_folder_async response.") + print("You can get blob IDs from the list_folder response.") return async with DefaultAzureCredential() as credential: async with AzureblobClient(CONNECTION_RUNTIME_URL, credential) as client: try: - await client.delete_file_async( + await client.delete_file( dataset=STORAGE_ACCOUNT, id=blob_id, ) @@ -242,7 +242,7 @@ async def example_5_delete_blob(): async def main(): """Run all examples.""" - print("Azure Blob Storage Connector SDK - Sample Usage") + print("Azure Blob Storage sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_azuredatafactory.py b/samples/sample_connector_usage/sample_connector_usage_azuredatafactory.py index 55c60ac8..5975a1b1 100644 --- a/samples/sample_connector_usage/sample_connector_usage_azuredatafactory.py +++ b/samples/sample_connector_usage/sample_connector_usage_azuredatafactory.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Data Factory Connector SDK Sample +Azure Data Factory sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Data Factory connector SDK +This sample demonstrates how to use the Azure Data Factory client from the Azure Connectors Python SDK to create, monitor, and cancel pipeline runs. Prerequisites: @@ -30,8 +30,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.azuredatafactory import AzuredatafactoryClient from azure.connectors.azuredatafactory import ( - AzuredatafactoryClient, ParameterValueSpecification, CreatePipelineRunResponse, PipelineRun, @@ -71,7 +71,7 @@ async def example_1_create_pipeline_run(): ) # Create the pipeline run - result = await client.create_pipeline_run_async( + result = await client.create_pipeline_run( input=parameters, subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP, @@ -111,7 +111,7 @@ async def example_2_get_pipeline_run_status(run_id: str): ) as client: try: # Get the pipeline run status - result = await client.get_pipeline_run_async( + result = await client.get_pipeline_run( subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP, data_factory_name=DATA_FACTORY_NAME, @@ -154,7 +154,7 @@ async def example_3_cancel_pipeline_run(run_id: str): ) as client: try: # Cancel the pipeline run - await client.cancel_pipeline_run_async( + await client.cancel_pipeline_run( subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP, data_factory_name=DATA_FACTORY_NAME, diff --git a/samples/sample_connector_usage/sample_connector_usage_azuredigitaltwins.py b/samples/sample_connector_usage/sample_connector_usage_azuredigitaltwins.py index 28d75ac8..672050ac 100644 --- a/samples/sample_connector_usage/sample_connector_usage_azuredigitaltwins.py +++ b/samples/sample_connector_usage/sample_connector_usage_azuredigitaltwins.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Digital Twins Connector SDK Sample +Azure Digital Twins sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Digital Twins connector SDK +This sample demonstrates how to use the Azure Digital Twins client from the Azure Connectors Python SDK to manage digital twins, models, relationships, and queries. Prerequisites: @@ -32,8 +32,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.azuredigitaltwins import AzuredigitaltwinsClient from azure.connectors.azuredigitaltwins import ( - AzuredigitaltwinsClient, QueryTwinsInput, SendTelemetryInput, TwinRelationship, @@ -59,7 +59,7 @@ async def example_1_list_models(): ) as client: try: # List all models - models = [item async for item in client.list_models_async( + models = [item async for item in client.list_models( include_model_definition="true" )] @@ -88,7 +88,7 @@ async def example_2_get_twin(): ) as client: try: # Get a twin by ID - result = await client.get_twin_by_id_async(twinid=twin_id) + result = await client.get_twin_by_id(twinid=twin_id) if result: print(f"Twin ID: {result.get('$dtId', 'Unknown')}") @@ -122,7 +122,7 @@ async def example_3_query_twins(): query_input = QueryTwinsInput( query="SELECT * FROM digitaltwins" ) - result = await client.query_twins_async(input=query_input) + result = await client.query_twins(input=query_input) if result and result.get("value"): print(f"Query results: {result['value']}") @@ -151,7 +151,7 @@ async def example_4_list_relationships(): ) as client: try: # List outgoing relationships - outgoing = [item async for item in client.list_relationships_async(twinid=twin_id)] + outgoing = [item async for item in client.list_relationships(twinid=twin_id)] if outgoing: print(f"Outgoing relationships from {twin_id}:") @@ -162,7 +162,7 @@ async def example_4_list_relationships(): print(f"No outgoing relationships from {twin_id}") # List incoming relationships - incoming = [item async for item in client.list_incoming_relationships_async( + incoming = [item async for item in client.list_incoming_relationships( twinid=twin_id )] @@ -195,7 +195,7 @@ async def example_5_send_telemetry(): telemetry = SendTelemetryInput( value='{"temperature": 72.5, "humidity": 45}' ) - await client.send_telemetry_async( + await client.send_telemetry( input=telemetry, twinid=twin_id ) diff --git a/samples/sample_connector_usage/sample_connector_usage_azureeventgrid.py b/samples/sample_connector_usage/sample_connector_usage_azureeventgrid.py index 2d7c0bbc..5dbb0a34 100644 --- a/samples/sample_connector_usage/sample_connector_usage_azureeventgrid.py +++ b/samples/sample_connector_usage/sample_connector_usage_azureeventgrid.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Event Grid Connector SDK Sample +Azure Event Grid sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Event Grid connector SDK. +This sample demonstrates how to use the Azure Event Grid client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with an Azure Event Grid connection @@ -26,8 +26,8 @@ import os from azure.identity.aio import DefaultAzureCredential +from azure.connectors.azureeventgrid import AzureeventgridClient from azure.connectors.azureeventgrid import ( - AzureeventgridClient, EventRequest, ) @@ -46,8 +46,8 @@ async def example_1_list_subscriptions(): async with DefaultAzureCredential() as credential: async with AzureeventgridClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.subscriptions_list_async() - subscriptions = result.get("value", []) if result else [] + items = [item async for item in client.list_subscriptions()] + subscriptions = items print(f"Found {len(subscriptions)} subscription(s).") for subscription in subscriptions[:10]: @@ -63,8 +63,8 @@ async def example_2_list_topic_types(): async with DefaultAzureCredential() as credential: async with AzureeventgridClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.topic_types_list_async() - topic_types = result.get("value", []) if result else [] + items = [item async for item in client.list_topic_types()] + topic_types = items print(f"Found {len(topic_types)} topic type(s).") for topic_type in topic_types[:10]: diff --git a/samples/sample_connector_usage/sample_connector_usage_azureiotcentral.py b/samples/sample_connector_usage/sample_connector_usage_azureiotcentral.py index 6ad184e5..f5e9b155 100644 --- a/samples/sample_connector_usage/sample_connector_usage_azureiotcentral.py +++ b/samples/sample_connector_usage/sample_connector_usage_azureiotcentral.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure IoT Central Connector SDK Sample +Azure IoT Central sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure IoT Central connector SDK. +This sample demonstrates how to use the Azure IoT Central client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with an Azure IoT Central connection @@ -28,8 +28,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.azureiotcentral import AzureiotcentralClient from azure.connectors.azureiotcentral import ( - AzureiotcentralClient, DeviceGroup, ) @@ -52,7 +52,7 @@ async def example_1_list_devices(): async with AzureiotcentralClient(CONNECTION_RUNTIME_URL, credential) as client: devices = [ - item async for item in client.devices_list_async( + item async for item in client.list_devices( application=APPLICATION ) ] @@ -72,7 +72,7 @@ async def example_2_list_device_groups(): async with AzureiotcentralClient(CONNECTION_RUNTIME_URL, credential) as client: device_groups = [ - item async for item in client.device_groups_list_async( + item async for item in client.list_device_groups( application=APPLICATION ) ] @@ -98,8 +98,11 @@ async def example_3_create_device_group(): async with AzureiotcentralClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.device_groups_set_async( - input=DeviceGroup(display_name="SDK sample group"), + result = await client.device_groups_set( + input=DeviceGroup( + display_name="SDK sample group", + filter="status = 'registered'", + ), device_group_id=device_group_id, application=APPLICATION, ) diff --git a/samples/sample_connector_usage/sample_connector_usage_azuremonitorlogs.py b/samples/sample_connector_usage/sample_connector_usage_azuremonitorlogs.py index 65c05518..94280c4c 100644 --- a/samples/sample_connector_usage/sample_connector_usage_azuremonitorlogs.py +++ b/samples/sample_connector_usage/sample_connector_usage_azuremonitorlogs.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Monitor Logs Connector SDK Sample +Azure Monitor Logs sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Monitor Logs connector SDK. +This sample demonstrates how to use the Azure Monitor Logs client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Azure Monitor Logs access @@ -29,8 +29,8 @@ try: from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException + from azure.connectors.azuremonitorlogs import AzuremonitorlogsClient from azure.connectors.azuremonitorlogs import ( - AzuremonitorlogsClient, QueryDataInput, VisualizeQueryInput, ) @@ -71,11 +71,11 @@ async def example_list_discovery_values(): async with AzuremonitorlogsClient(CONNECTION_RUNTIME_URL, credential) as client: try: - subscriptions = [item async for item in client.list_subscriptions_async()] + subscriptions = [item async for item in client.list_subscriptions()] count = len(subscriptions) if subscriptions else 0 print(f"Found {count} subscriptions.") - resource_groups = [item async for item in client.list_resource_groups_async( + resource_groups = [item async for item in client.list_resource_groups( subscriptions=SUBSCRIPTION_ID )] rg_count = len(resource_groups) if resource_groups else 0 @@ -98,9 +98,10 @@ async def example_run_query(): request = QueryDataInput( query="Heartbeat | take 5", timerangetype="SetInQuery", + timerange={}, ) - result = await client.query_data_async( + result = await client.query_data( input=request, subscriptions=SUBSCRIPTION_ID, resourcegroups=RESOURCE_GROUP, @@ -134,9 +135,10 @@ async def example_visualize_query(): "| order by TimeGenerated asc" ), timerangetype="SetInQuery", + timerange={}, ) - result = await client.visualize_query_async( + result = await client.visualize_query( input=request, subscriptions=SUBSCRIPTION_ID, resourcegroups=RESOURCE_GROUP, diff --git a/samples/sample_connector_usage/sample_connector_usage_azurequeues.py b/samples/sample_connector_usage/sample_connector_usage_azurequeues.py index cf091bdf..ccc753a9 100644 --- a/samples/sample_connector_usage/sample_connector_usage_azurequeues.py +++ b/samples/sample_connector_usage/sample_connector_usage_azurequeues.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Storage Queues Connector SDK Sample +Azure Storage Queues sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Storage Queues connector SDK +This sample demonstrates how to use the Azure Storage Queues client from the Azure Connectors Python SDK to interact with Azure Storage Queue messages. Prerequisites: @@ -57,21 +57,17 @@ async def example_1_list_queues(): async with AzurequeuesClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.list_queues_async( + items = [item async for item in client.list_queues( storage_account_name=STORAGE_ACCOUNT - ) + )] - if result: + if items: print(f"Queues in storage account '{STORAGE_ACCOUNT}':") - # Result may be a list or dict with queue names - if isinstance(result, list): - for queue in result: - if isinstance(queue, dict): - print(f" - {queue.get('name', queue)}") - else: - print(f" - {queue}") - elif isinstance(result, dict): - print(f" Response: {result}") + for queue in items: + if isinstance(queue, dict): + print(f" - {queue.get('name', queue)}") + else: + print(f" - {queue}") else: print("No queues found or empty response.") @@ -96,7 +92,7 @@ async def example_2_create_queue(): async with AzurequeuesClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.put_queue_async( + result = await client.put_queue( storage_account_name=STORAGE_ACCOUNT, queue_name=new_queue_name ) @@ -127,7 +123,7 @@ async def example_3_put_message(): try: message_input = "Hello from Azure Connectors SDK for Python!" - await client.put_message_async( + await client.put_message( input=message_input, storage_account_name=STORAGE_ACCOUNT, queue_name=QUEUE_NAME @@ -156,7 +152,7 @@ async def example_4_get_messages(): async with AzurequeuesClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_messages_async( + result = await client.get_messages( storage_account_name=STORAGE_ACCOUNT, queue_name=QUEUE_NAME, numofmessages="5", # Get up to 5 messages @@ -206,7 +202,7 @@ async def example_5_delete_message(): async with AzurequeuesClient(CONNECTION_RUNTIME_URL, credential) as client: try: - await client.delete_message_async( + await client.delete_message( storage_account_name=STORAGE_ACCOUNT, queue_name=QUEUE_NAME, message_id=message_id, @@ -223,7 +219,7 @@ async def example_5_delete_message(): async def main(): """Run all examples.""" - print("Azure Storage Queues Connector SDK - Sample Usage") + print("Azure Storage Queues sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_azuretables.py b/samples/sample_connector_usage/sample_connector_usage_azuretables.py index b3ff375a..97963383 100644 --- a/samples/sample_connector_usage/sample_connector_usage_azuretables.py +++ b/samples/sample_connector_usage/sample_connector_usage_azuretables.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Storage Tables Connector SDK Sample +Azure Storage Tables sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Storage Tables connector SDK +This sample demonstrates how to use the Azure Storage Tables client from the Azure Connectors Python SDK to interact with Azure Table Storage. Prerequisites: @@ -28,9 +28,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.azuretables import AzuretablesClient from azure.connectors.azuretables import ( - AzuretablesClient, - CreateTableInput, CreateEntityInput, ) @@ -61,20 +60,18 @@ async def example_1_list_tables(): async with AzuretablesClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_tables_async( - storage_account_name=STORAGE_ACCOUNT - ) - - if result: + tables = [ + table + async for table in client.list_tables( + storage_account_name=STORAGE_ACCOUNT + ) + ] + + if tables: print(f"Tables in storage account '{STORAGE_ACCOUNT}':") - # Response contains 'value' with list of tables - tables = result.get("value", []) - if tables: - for table in tables: - table_name = table.get("TableName", table) - print(f" - {table_name}") - else: - print(" No tables found.") + for table in tables: + table_name = table.get("TableName", table) + print(f" - {table_name}") else: print("No tables found or empty response.") @@ -99,14 +96,9 @@ async def example_2_create_table(): async with AzuretablesClient(CONNECTION_RUNTIME_URL, credential) as client: try: - # Create table input with table name in additional_properties - table_input = CreateTableInput( - additional_properties={"TableName": new_table_name} - ) - - result = await client.create_table_async( - input=table_input, - storage_account_name=STORAGE_ACCOUNT + result = await client.create_table( + input=new_table_name, + storage_account_name=STORAGE_ACCOUNT, ) print(f"Table '{new_table_name}' created successfully.") @@ -146,7 +138,7 @@ async def example_3_create_entity(): } ) - result = await client.create_entity_async( + result = await client.create_entity( input=entity_input, storage_account_name=STORAGE_ACCOUNT, table_name=TABLE_NAME @@ -180,7 +172,7 @@ async def example_4_get_entities(): async with AzuretablesClient(CONNECTION_RUNTIME_URL, credential) as client: try: # Query entities with optional filter - entities = [item async for item in client.get_entities_async( + entities = [item async for item in client.list_entities( storage_account_name=STORAGE_ACCOUNT, table_name=TABLE_NAME, # Optional: filter entities @@ -226,7 +218,7 @@ async def example_5_get_entity(): async with AzuretablesClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_entity_async( + result = await client.get_entity( storage_account_name=STORAGE_ACCOUNT, table_name=TABLE_NAME, partition_key=partition_key, @@ -260,7 +252,7 @@ async def example_5_get_entity(): async def main(): """Run all examples.""" - print("Azure Storage Tables Connector SDK - Sample Usage") + print("Azure Storage Tables sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_azurevm.py b/samples/sample_connector_usage/sample_connector_usage_azurevm.py index 1b222a53..3025d63b 100644 --- a/samples/sample_connector_usage/sample_connector_usage_azurevm.py +++ b/samples/sample_connector_usage/sample_connector_usage_azurevm.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure VM Connector SDK Sample +Azure VM sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure VM connector SDK to manage +This sample demonstrates how to use the Azure VM client from the Azure Connectors Python SDK to manage virtual machines and VM scale sets. Prerequisites: @@ -50,7 +50,7 @@ async def example_1_get_virtual_machine(): async with AzurevmClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.virtual_machine_get_async( + result = await client.virtual_machine_get( subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP, virtual_machine_name=VM_NAME @@ -78,7 +78,7 @@ async def example_2_start_virtual_machine(): async with AzurevmClient(CONNECTION_RUNTIME_URL, credential) as client: try: - await client.virtual_machine_start_async( + await client.virtual_machine_start( subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP, virtual_machine_name=VM_NAME @@ -101,7 +101,7 @@ async def example_3_deallocate_virtual_machine(): async with AzurevmClient(CONNECTION_RUNTIME_URL, credential) as client: try: - await client.virtual_machine_deallocate_async( + await client.virtual_machine_deallocate( subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP, virtual_machine_name=VM_NAME @@ -124,7 +124,7 @@ async def example_4_restart_virtual_machine(): async with AzurevmClient(CONNECTION_RUNTIME_URL, credential) as client: try: - await client.virtual_machine_restart_async( + await client.virtual_machine_restart( subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP, virtual_machine_name=VM_NAME @@ -146,7 +146,7 @@ async def example_5_get_vm_in_scale_set(): async with AzurevmClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.virtual_machine_in_scale_set_get_async( + result = await client.virtual_machine_in_scale_set_get( subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP, virtual_machine_scale_set_name=VMSS_NAME, @@ -177,7 +177,7 @@ async def example_6_scale_set_operations(): try: # Start VM in scale set print(f"Starting VMSS instance {VMSS_INSTANCE_ID}...") - await client.virtual_machine_in_scale_set_start_async( + await client.virtual_machine_in_scale_set_start( subscription_id=SUBSCRIPTION_ID, resource_group_name=RESOURCE_GROUP, virtual_machine_scale_set_name=VMSS_NAME, @@ -186,11 +186,11 @@ async def example_6_scale_set_operations(): print("Start command sent") # Other available operations (commented out): - # - virtual_machine_in_scale_set_deallocate_async - # - virtual_machine_in_scale_set_power_off_async - # - virtual_machine_in_scale_set_restart_async - # - virtual_machine_in_scale_set_redeploy_async - # - virtual_machine_in_scale_set_reimage_async + # - virtual_machine_in_scale_set_deallocate + # - virtual_machine_in_scale_set_power_off + # - virtual_machine_in_scale_set_restart + # - virtual_machine_in_scale_set_redeploy + # - virtual_machine_in_scale_set_reimage except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_box.py b/samples/sample_connector_usage/sample_connector_usage_box.py index c0d3db71..7f12678d 100644 --- a/samples/sample_connector_usage/sample_connector_usage_box.py +++ b/samples/sample_connector_usage/sample_connector_usage_box.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Box Connector SDK Sample +Box sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Box connector SDK. +This sample demonstrates how to use the Box client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Box connection @@ -42,11 +42,11 @@ async def example_1_list_root_folder(): async with DefaultAzureCredential() as credential: async with BoxClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.list_root_folder_async() + items = [item async for item in client.list_root_folder()] - if result and "value" in result: - print(f"Found {len(result['value'])} items in root folder:") - for item in result["value"][:10]: + if items: + print(f"Found {len(items)} items in root folder:") + for item in items[:10]: icon = "[DIR]" if item.get("IsFolder") else "[FILE]" print(f" {icon} {item.get('Name', 'N/A')}") else: @@ -66,7 +66,7 @@ async def example_2_get_file_metadata_by_path(): async with BoxClient(CONNECTION_RUNTIME_URL, credential) as client: try: - metadata = await client.get_file_metadata_by_path_async(path=file_path) + metadata = await client.get_file_metadata_by_path(path=file_path) if metadata: print(f"Name: {metadata.get('Name', 'N/A')}") @@ -89,7 +89,7 @@ async def example_3_create_file(): async with BoxClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.create_file_async( + result = await client.create_file( input=b"Hello from azure-connectors Box sample!", folder_path=destination_folder, name=destination_name, @@ -116,8 +116,7 @@ async def example_4_list_folder_for_polling(): async with BoxClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.list_folder_async(id=folder_id) - items = result.get("value", []) if result else [] + items = [item async for item in client.list_folder(id=folder_id)] print(f"Folder listing returned {len(items)} item(s).") print("Persist item IDs or timestamps to implement polling with this action client.") except ConnectorException as ex: diff --git a/samples/sample_connector_usage/sample_connector_usage_campfire.py b/samples/sample_connector_usage/sample_connector_usage_campfire.py index 40e68e06..e8f73fc5 100644 --- a/samples/sample_connector_usage/sample_connector_usage_campfire.py +++ b/samples/sample_connector_usage/sample_connector_usage_campfire.py @@ -1,7 +1,7 @@ """ -Campfire Connector SDK Sample +Campfire sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Campfire connector SDK. +This sample demonstrates how to use the Campfire client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Campfire connection @@ -38,7 +38,7 @@ async def example_1_list_accounts() -> None: async with DefaultAzureCredential() as credential: async with CampfireClient(CONNECTION_RUNTIME_URL, credential) as client: - accounts = await client.list_accounts_async() + accounts = [item async for item in client.list_accounts()] print(f"Accounts: {accounts}") @@ -48,7 +48,7 @@ async def example_2_list_rooms() -> None: async with DefaultAzureCredential() as credential: async with CampfireClient(CONNECTION_RUNTIME_URL, credential) as client: - rooms = await client.list_rooms_async(account="ACCOUNT_ID") + rooms = [item async for item in client.list_rooms(account="ACCOUNT_ID")] print(f"Rooms: {rooms}") @@ -58,10 +58,10 @@ async def example_3_create_message() -> None: async with DefaultAzureCredential() as credential: async with CampfireClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.create_message_async( + result = await client.create_message( room_id="ROOM_ID", account="ACCOUNT_ID", - message="Hello from the Campfire connector SDK.", + message="Hello from the Campfire client in the Azure Connectors Python SDK.", ) print(f"Create message result: {result}") @@ -72,7 +72,7 @@ async def example_4_get_user() -> None: async with DefaultAzureCredential() as credential: async with CampfireClient(CONNECTION_RUNTIME_URL, credential) as client: - user = await client.get_user_async(user_id=12345, account="ACCOUNT_ID") + user = await client.get_user(user_id=12345, account="ACCOUNT_ID") print(f"User: {user}") @@ -83,7 +83,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Campfire Connector SDK - Sample Usage") + print("Campfire sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_clicksendsms.py b/samples/sample_connector_usage/sample_connector_usage_clicksendsms.py index d0983e2e..fc0bda18 100644 --- a/samples/sample_connector_usage/sample_connector_usage_clicksendsms.py +++ b/samples/sample_connector_usage/sample_connector_usage_clicksendsms.py @@ -1,7 +1,7 @@ """ -ClickSend SMS Connector SDK Sample +ClickSend SMS sample for the Azure Connectors Python SDK -This sample demonstrates how to use the ClickSend SMS connector SDK. +This sample demonstrates how to use the ClickSend SMS client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a ClickSend SMS connection @@ -24,8 +24,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.clicksendsms import ClicksendsmsClient from azure.connectors.clicksendsms import ( - ClicksendsmsClient, CreateListInput, SmsSendInput, ) @@ -42,12 +42,12 @@ async def example_1_send_sms() -> None: async with DefaultAzureCredential() as credential: async with ClicksendsmsClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.sms_send_async( + result = await client.sms_send( input=SmsSendInput( messages=[ { "to": "+61411111111", - "body": "Hello from the ClickSend SMS connector SDK.", + "body": "Hello from the ClickSend SMS client in the Azure Connectors Python SDK.", } ], ), @@ -61,7 +61,7 @@ async def example_2_get_contact_lists() -> None: async with DefaultAzureCredential() as credential: async with ClicksendsmsClient(CONNECTION_RUNTIME_URL, credential) as client: - lists = await client.get_contact_lists_async(page=1, limit=10) + lists = await client.get_contact_lists(page=1, limit=10) print(f"Contact lists: {lists}") @@ -71,7 +71,7 @@ async def example_3_create_list() -> None: async with DefaultAzureCredential() as credential: async with ClicksendsmsClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.create_list_async( + result = await client.create_list( input=CreateListInput(list_name="My New List"), ) print(f"Created list: {result}") @@ -83,7 +83,7 @@ async def example_4_search_contact_lists() -> None: async with DefaultAzureCredential() as credential: async with ClicksendsmsClient(CONNECTION_RUNTIME_URL, credential) as client: - results = await client.search_contact_list_async(q="friends") + results = await client.search_contact_list(q="friends") print(f"Search results: {results}") @@ -94,7 +94,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("ClickSend SMS Connector SDK - Sample Usage") + print("ClickSend SMS sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_cloudconvert.py b/samples/sample_connector_usage/sample_connector_usage_cloudconvert.py index 1530954f..7f32b69e 100644 --- a/samples/sample_connector_usage/sample_connector_usage_cloudconvert.py +++ b/samples/sample_connector_usage/sample_connector_usage_cloudconvert.py @@ -1,4 +1,4 @@ -"""CloudConvert connector SDK sample.""" +"""CloudConvert sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -21,7 +21,7 @@ async def main() -> None: async with DefaultAzureCredential() as credential: try: async with CloudconvertClient(CONNECTION_RUNTIME_URL, credential) as client: - options = await client.get_convert_options_async() + options = await client.get_convert_options() print(f"Conversion options: {options}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_cloudmersiveconvert.py b/samples/sample_connector_usage/sample_connector_usage_cloudmersiveconvert.py index 55f9be37..0c8f2e71 100644 --- a/samples/sample_connector_usage/sample_connector_usage_cloudmersiveconvert.py +++ b/samples/sample_connector_usage/sample_connector_usage_cloudmersiveconvert.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Cloudmersive Convert Connector SDK Sample +Cloudmersive Convert sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Cloudmersive Convert connector SDK. +This sample demonstrates how to use the Cloudmersive Convert client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Cloudmersive Convert connection @@ -27,8 +27,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.cloudmersiveconvert import CloudmersiveconvertClient from azure.connectors.cloudmersiveconvert import ( - CloudmersiveconvertClient, GetDocxBodyRequest, ScreenshotRequest, ) @@ -50,7 +50,7 @@ async def example_1_convert_url_to_pdf(): url="https://www.example.com", ) - result = await client.convert_web_url_to_pdf_async(input=request) + result = await client.convert_web_url_to_pdf(input=request) print(f"Converted PDF byte length: {len(result) if result else 0}") @@ -72,7 +72,7 @@ async def example_2_get_docx_body(): input_file_url="https://example.com/document.docx", ) - result = await client.edit_document_docx_body_async(input=request) + result = await client.edit_document_docx_body(input=request) print(f"DOCX body result: {result}") diff --git a/samples/sample_connector_usage/sample_connector_usage_commondataservice.py b/samples/sample_connector_usage/sample_connector_usage_commondataservice.py index 28f2a7ac..03af2dda 100644 --- a/samples/sample_connector_usage/sample_connector_usage_commondataservice.py +++ b/samples/sample_connector_usage/sample_connector_usage_commondataservice.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Microsoft Dataverse (Common Data Service) Connector SDK Sample +Microsoft Dataverse (Common Data Service) sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Microsoft Dataverse connector SDK. +This sample demonstrates how to use the Microsoft Dataverse client from the Azure Connectors Python SDK. This connector was formerly known as Common Data Service (legacy). Prerequisites: @@ -31,8 +31,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.commondataservice import CommondataserviceClient from azure.connectors.commondataservice import ( - CommondataserviceClient, PostItemInput, PatchItemInput, ) @@ -61,11 +61,11 @@ async def example_1_list_datasets(): async with CommondataserviceClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_data_sets_async() + items = [item async for item in client.list_data_sets()] - if result and result.get("value"): - print(f"Found {len(result['value'])} datasets:") - for dataset in result["value"][:5]: + if items: + print(f"Found {len(items)} datasets:") + for dataset in items[:5]: print(f" - {dataset.get('Name', dataset.get('DisplayName', 'N/A'))}") else: print("No datasets found") @@ -89,7 +89,7 @@ async def example_2_list_accounts(): try: accounts = [ account - async for account in client.get_items_async( + async for account in client.list_items( dataset=DATASET, table="accounts", filter="statecode eq 0", # Active accounts only @@ -122,7 +122,7 @@ async def example_3_get_account_by_id(): async with CommondataserviceClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_item_async( + result = await client.get_item( dataset=DATASET, table="accounts", id=account_id, @@ -157,7 +157,7 @@ async def example_4_create_account(): } ) - result = await client.post_item_async( + result = await client.post_item( input=new_account, dataset=DATASET, table="accounts", @@ -192,7 +192,7 @@ async def example_5_update_account(): } ) - await client.patch_item_async( + await client.patch_item( input=update_data, dataset=DATASET, table="accounts", @@ -218,7 +218,7 @@ async def example_6_create_attachment(): async with CommondataserviceClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.create_attachment_async( + result = await client.create_attachment( input=b"Sample attachment content", dataset=DATASET, table="accounts", @@ -245,7 +245,7 @@ async def example_7_get_table_metadata(): async with CommondataserviceClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_table_async( + result = await client.get_table( dataset=DATASET, table="accounts", ) diff --git a/samples/sample_connector_usage/sample_connector_usage_documentdb.py b/samples/sample_connector_usage/sample_connector_usage_documentdb.py index 66891a9e..9ba54339 100644 --- a/samples/sample_connector_usage/sample_connector_usage_documentdb.py +++ b/samples/sample_connector_usage/sample_connector_usage_documentdb.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Cosmos DB (DocumentDB) Connector SDK Sample +Azure Cosmos DB (DocumentDB) sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Cosmos DB connector SDK +This sample demonstrates how to use the Azure Cosmos DB client from the Azure Connectors Python SDK to query documents in Cosmos DB containers. Note: The connector name "documentdb" reflects the original Azure DocumentDB @@ -66,7 +66,7 @@ async def example_1_query_all_documents(): async with DocumentdbClient(CONNECTION_RUNTIME_URL, credential) as client: try: - documents = [item async for item in client.query_documents_async( + documents = [item async for item in client.list_query_documents( cosmos_db_account_name=COSMOS_DB_ACCOUNT, database_id=DATABASE_ID, container_id=CONTAINER_ID, @@ -103,7 +103,7 @@ async def example_2_query_with_filter(): async with DocumentdbClient(CONNECTION_RUNTIME_URL, credential) as client: try: # Query with WHERE clause - adjust field names for your schema - documents = [item async for item in client.query_documents_async( + documents = [item async for item in client.list_query_documents( cosmos_db_account_name=COSMOS_DB_ACCOUNT, database_id=DATABASE_ID, container_id=CONTAINER_ID, @@ -139,7 +139,7 @@ async def example_3_query_with_pagination(): async with DocumentdbClient(CONNECTION_RUNTIME_URL, credential) as client: try: # The iterator follows continuation links until all pages are consumed. - documents = [item async for item in client.query_documents_async( + documents = [item async for item in client.list_query_documents( cosmos_db_account_name=COSMOS_DB_ACCOUNT, database_id=DATABASE_ID, container_id=CONTAINER_ID, @@ -180,7 +180,7 @@ async def example_4_query_with_partition_key(): async with DocumentdbClient(CONNECTION_RUNTIME_URL, credential) as client: try: # Query within a specific partition - documents = [item async for item in client.query_documents_async( + documents = [item async for item in client.list_query_documents( cosmos_db_account_name=COSMOS_DB_ACCOUNT, database_id=DATABASE_ID, container_id=CONTAINER_ID, @@ -215,7 +215,7 @@ async def example_5_query_with_consistency(): try: # Query with Session consistency (common for read-your-writes) # Valid levels: Strong, BoundedStaleness, Session, Eventual - documents = [item async for item in client.query_documents_async( + documents = [item async for item in client.list_query_documents( cosmos_db_account_name=COSMOS_DB_ACCOUNT, database_id=DATABASE_ID, container_id=CONTAINER_ID, @@ -240,7 +240,7 @@ async def example_5_query_with_consistency(): async def main(): """Run all examples.""" - print("Azure Cosmos DB (DocumentDB) Connector SDK - Sample Usage") + print("Azure Cosmos DB (DocumentDB) sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_docusign.py b/samples/sample_connector_usage/sample_connector_usage_docusign.py index 64f5d521..dd3d7f67 100644 --- a/samples/sample_connector_usage/sample_connector_usage_docusign.py +++ b/samples/sample_connector_usage/sample_connector_usage_docusign.py @@ -1,7 +1,7 @@ """ -DocuSign Connector SDK Sample +DocuSign sample for the Azure Connectors Python SDK -This sample demonstrates how to use the DocuSign connector SDK. +This sample demonstrates how to use the DocuSign client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with DocuSign connection @@ -38,8 +38,8 @@ async def example_1_get_login_accounts() -> list[dict]: async with DefaultAzureCredential() as credential: async with DocusignClient(CONNECTION_RUNTIME_URL, credential) as client: - accounts_response = await client.get_login_accounts_async() - accounts = accounts_response.get("accounts", []) if accounts_response else [] + accounts_response = [item async for item in client.list_login_accounts()] + accounts = accounts_response print(f"Found {len(accounts)} accounts") for account in accounts[:10]: @@ -54,12 +54,14 @@ async def example_2_search_envelopes(account_id: str) -> None: async with DefaultAzureCredential() as credential: async with DocusignClient(CONNECTION_RUNTIME_URL, credential) as client: - envelopes_response = await client.search_list_envelopes_async( + envelopes_response = await client.search_list_envelopes( account_id=account_id, top=5, ) - envelopes = envelopes_response.get("value", []) if envelopes_response else [] + envelopes = ( + envelopes_response.get("value", []) if envelopes_response else [] + ) print(f"Found {len(envelopes)} envelopes") for envelope in envelopes[:5]: print(f" - {envelope.get('envelopeId')} ({envelope.get('status')})") @@ -72,7 +74,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("DocuSign Connector SDK - Sample Usage") + print("DocuSign sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_docuware.py b/samples/sample_connector_usage/sample_connector_usage_docuware.py index d3789bea..593300a2 100644 --- a/samples/sample_connector_usage/sample_connector_usage_docuware.py +++ b/samples/sample_connector_usage/sample_connector_usage_docuware.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -DocuWare Connector SDK Sample +DocuWare sample for the Azure Connectors Python SDK -This sample demonstrates how to use the DocuWare connector SDK. +This sample demonstrates how to use the DocuWare client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a DocuWare connection @@ -27,8 +27,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.docuware import DocuwareClient from azure.connectors.docuware import ( - DocuwareClient, SearchForDocumentsInFileCabinetInput, ) @@ -45,11 +45,11 @@ async def example_1_get_file_cabinets(): async with DocuwareClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_file_cabinets_async( + items = [item async for item in client.list_file_cabinets( file_cabinet_type="", - ) + )] - print(f"File cabinets result: {result}") + print(f"File cabinets result: {items}") except ConnectorException as ex: print(f"Connector error: {ex}") @@ -67,7 +67,7 @@ async def example_2_search_documents(): try: request = SearchForDocumentsInFileCabinetInput() - result = await client.search_for_documents_in_file_cabinet_async( + result = await client.search_for_documents_in_file_cabinet( input=request, file_cabinet="", search_dialog_id="", diff --git a/samples/sample_connector_usage/sample_connector_usage_dropbox.py b/samples/sample_connector_usage/sample_connector_usage_dropbox.py index 04c3cf77..7f5c075d 100644 --- a/samples/sample_connector_usage/sample_connector_usage_dropbox.py +++ b/samples/sample_connector_usage/sample_connector_usage_dropbox.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Dropbox Connector SDK Sample +Dropbox sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Dropbox connector SDK. +This sample demonstrates how to use the Dropbox client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Dropbox connection @@ -42,11 +42,11 @@ async def example_1_list_root_folder(): async with DefaultAzureCredential() as credential: async with DropboxClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.list_root_folder_async() + items = [item async for item in client.list_root_folder()] - if result and "value" in result: - print(f"Found {len(result['value'])} items in root folder:") - for item in result["value"][:10]: + if items: + print(f"Found {len(items)} items in root folder:") + for item in items[:10]: icon = "[DIR]" if item.get("IsFolder") else "[FILE]" print(f" {icon} {item.get('Name', 'N/A')}") else: @@ -66,7 +66,7 @@ async def example_2_get_file_metadata_by_path(): async with DropboxClient(CONNECTION_RUNTIME_URL, credential) as client: try: - metadata = await client.get_file_metadata_by_path_async(path=file_path) + metadata = await client.get_file_metadata_by_path(path=file_path) if metadata: print(f"Name: {metadata.get('Name', 'N/A')}") @@ -89,7 +89,7 @@ async def example_3_create_file(): async with DropboxClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.create_file_async( + result = await client.create_file( input=b"Hello from azure-connectors Dropbox sample!", folder_path=destination_folder, name=destination_name, @@ -116,8 +116,7 @@ async def example_4_list_folder_for_polling(): async with DropboxClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.list_folder_async(id=folder_id) - items = result.get("value", []) if result else [] + items = [item async for item in client.list_folder(id=folder_id)] print(f"Folder listing returned {len(items)} item(s).") print("Persist item IDs or timestamps to implement polling with this action client.") except ConnectorException as ex: diff --git a/samples/sample_connector_usage/sample_connector_usage_dynamicsax.py b/samples/sample_connector_usage/sample_connector_usage_dynamicsax.py index c57d10f3..1db28a73 100644 --- a/samples/sample_connector_usage/sample_connector_usage_dynamicsax.py +++ b/samples/sample_connector_usage/sample_connector_usage_dynamicsax.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Dynamics 365 for Finance and Operations (Dynamics AX) Connector SDK Sample +Dynamics 365 for Finance and Operations (Dynamics AX) sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Dynamics AX connector SDK. +This sample demonstrates how to use the Dynamics AX client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Dynamics AX connection @@ -28,8 +28,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.dynamicsax import DynamicsaxClient from azure.connectors.dynamicsax import ( - DynamicsaxClient, PostItemInput, ) @@ -51,8 +51,8 @@ async def example_1_list_instances(): async with DefaultAzureCredential() as credential: async with DynamicsaxClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.get_data_sets_async() - datasets = result.get("value", []) if result else [] + items = [item async for item in client.list_data_sets()] + datasets = items print(f"Found {len(datasets)} instance(s).") for dataset in datasets[:10]: @@ -70,8 +70,8 @@ async def example_2_list_tables(): async with DefaultAzureCredential() as credential: async with DynamicsaxClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.get_tables_async(dataset=DATASET) - tables = result.get("value", []) if result else [] + items = [item async for item in client.list_tables(dataset=DATASET)] + tables = items print(f"Found {len(tables)} table(s).") for table in tables[:10]: @@ -94,7 +94,7 @@ async def example_3_create_record(): try: record = PostItemInput() record.additional_properties = {"Name": "SDK Sample"} - result = await client.post_item_async( + result = await client.post_item( input=record, dataset=DATASET, table=table, diff --git a/samples/sample_connector_usage/sample_connector_usage_elfsquaddata.py b/samples/sample_connector_usage/sample_connector_usage_elfsquaddata.py index bfbaa6c9..dc602c44 100644 --- a/samples/sample_connector_usage/sample_connector_usage_elfsquaddata.py +++ b/samples/sample_connector_usage/sample_connector_usage_elfsquaddata.py @@ -1,4 +1,4 @@ -"""Elfsquad Data connector SDK sample.""" +"""Elfsquad Data sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -28,7 +28,7 @@ async def main() -> None: CONNECTION_RUNTIME_URL, credential, ) as client: - entities = [item async for item in client.get_entities_async( + entities = [item async for item in client.list_entities( entity_name=ENTITY_NAME, top=10, )] diff --git a/samples/sample_connector_usage/sample_connector_usage_etsy.py b/samples/sample_connector_usage/sample_connector_usage_etsy.py index c31a6b9f..a3bc4f78 100644 --- a/samples/sample_connector_usage/sample_connector_usage_etsy.py +++ b/samples/sample_connector_usage/sample_connector_usage_etsy.py @@ -1,4 +1,4 @@ -"""Etsy connector SDK sample.""" +"""Etsy sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -21,7 +21,7 @@ async def main() -> None: async with DefaultAzureCredential() as credential: try: async with EtsyClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.ping_async() + result = await client.ping() print(f"Result: {result}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_eventbrite.py b/samples/sample_connector_usage/sample_connector_usage_eventbrite.py index bf251561..68c7ffd8 100644 --- a/samples/sample_connector_usage/sample_connector_usage_eventbrite.py +++ b/samples/sample_connector_usage/sample_connector_usage_eventbrite.py @@ -1,4 +1,4 @@ -"""Eventbrite connector SDK sample.""" +"""Eventbrite sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -21,7 +21,7 @@ async def main() -> None: async with DefaultAzureCredential() as credential: try: async with EventbriteClient(CONNECTION_RUNTIME_URL, credential) as client: - categories = await client.get_categories_async() + categories = [item async for item in client.list_categories()] print(f"Categories: {categories}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_eventhubs.py b/samples/sample_connector_usage/sample_connector_usage_eventhubs.py index 9d5bc0ef..d4c23c8a 100644 --- a/samples/sample_connector_usage/sample_connector_usage_eventhubs.py +++ b/samples/sample_connector_usage/sample_connector_usage_eventhubs.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Event Hubs Connector SDK Sample +Azure Event Hubs sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Event Hubs connector SDK +This sample demonstrates how to use the Azure Event Hubs client from the Azure Connectors Python SDK to send and receive events from Azure Event Hubs. Prerequisites: @@ -28,10 +28,9 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.eventhubs import EventhubsClient from azure.connectors.eventhubs import ( - EventhubsClient, SendEvent, - SendEventsInput, ) # Connection runtime URL format: @@ -71,7 +70,7 @@ async def example_1_send_event(): } ) - await client.send_event_async( + await client.send_event( input=event, event_hub_name=EVENT_HUB_NAME ) @@ -110,7 +109,7 @@ async def example_2_send_event_with_partition_key(): } ) - await client.send_event_async( + await client.send_event( input=event, event_hub_name=EVENT_HUB_NAME, partition_key=partition_key @@ -138,35 +137,30 @@ async def example_3_send_batch_events(): async with EventhubsClient(CONNECTION_RUNTIME_URL, credential) as client: try: # Create batch with multiple events - batch_input = SendEventsInput( - additional_properties={ - "events": [ - { - "contentData": json.dumps({"id": 1, "name": "Event 1"}), - "properties": {"index": "1"} - }, - { - "contentData": json.dumps({"id": 2, "name": "Event 2"}), - "properties": {"index": "2"} - }, - { - "contentData": json.dumps({"id": 3, "name": "Event 3"}), - "properties": {"index": "3"} - } - ] - } - ) - - await client.send_events_async( + batch_input = [ + SendEvent( + content_data=json.dumps({"id": 1, "name": "Event 1"}), + properties={"index": "1"}, + ), + SendEvent( + content_data=json.dumps({"id": 2, "name": "Event 2"}), + properties={"index": "2"}, + ), + SendEvent( + content_data=json.dumps({"id": 3, "name": "Event 3"}), + properties={"index": "3"}, + ), + ] + + await client.send_events( input=batch_input, event_hub_name=EVENT_HUB_NAME, partition_key=os.environ.get("EVENTHUBS_PARTITION_KEY", "partition-1") ) - events = batch_input.additional_properties.get("events", []) - print(f"Batch of {len(events)} events sent to '{EVENT_HUB_NAME}':") - for i, evt in enumerate(events, 1): - print(f" {i}. {evt.get('contentData', 'N/A')[:40]}...") + print(f"Batch of {len(batch_input)} events sent to '{EVENT_HUB_NAME}':") + for i, event in enumerate(batch_input, 1): + print(f" {i}. {event.content_data[:40]}...") except ConnectorException as ex: print(f"Connector error (status {ex.status_code}): {ex}") @@ -182,8 +176,8 @@ async def example_4_list_event_hubs(): async with EventhubsClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_event_hubs_async() - print(f"Event Hubs: {result}") + items = [item async for item in client.list_event_hubs()] + print(f"Event Hubs: {items}") except ConnectorException as ex: print(f"Connector error (status {ex.status_code}): {ex}") @@ -203,10 +197,10 @@ async def example_5_list_consumer_groups(): async with EventhubsClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_consumer_groups_async( + items = [item async for item in client.list_consumer_groups( event_hub_name=EVENT_HUB_NAME - ) - print(f"Consumer groups for '{EVENT_HUB_NAME}': {result}") + )] + print(f"Consumer groups for '{EVENT_HUB_NAME}': {items}") except ConnectorException as ex: print(f"Connector error (status {ex.status_code}): {ex}") @@ -216,7 +210,7 @@ async def example_5_list_consumer_groups(): async def main(): """Run all examples.""" - print("Azure Event Hubs Connector SDK - Sample Usage") + print("Azure Event Hubs sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_excelonline.py b/samples/sample_connector_usage/sample_connector_usage_excelonline.py index 4d0e6a22..e3475c30 100644 --- a/samples/sample_connector_usage/sample_connector_usage_excelonline.py +++ b/samples/sample_connector_usage/sample_connector_usage_excelonline.py @@ -7,9 +7,9 @@ from azure.identity.aio import DefaultAzureCredential +from azure.connectors.excelonline import ExcelonlineClient from azure.connectors.excelonline import ( CreateWorksheetInput, - ExcelonlineClient, Item, ) @@ -26,26 +26,26 @@ async def main() -> None: async with DefaultAzureCredential() as credential: async with ExcelonlineClient(connection_url, credential) as client: - worksheets = await client.get_all_worksheets_async( + worksheets = [item async for item in client.list_all_worksheets( drive=drive_id, file=file_id, - ) + )] print("worksheets", worksheets) - tables = await client.get_tables_async( + tables = [item async for item in client.list_tables( drive=drive_id, file=file_id, - ) + )] print("tables", tables) - new_sheet = await client.create_worksheet_async( + new_sheet = await client.create_worksheet( input=CreateWorksheetInput(name="SampleSheet"), drive=drive_id, file=file_id, ) print("created worksheet", new_sheet) - row = await client.add_row_async( + row = await client.add_row( input=Item(dynamic_properties={"Name": "Sample Item", "Value": 100}), drive=drive_id, file=file_id, diff --git a/samples/sample_connector_usage/sample_connector_usage_excelonlinebusiness.py b/samples/sample_connector_usage/sample_connector_usage_excelonlinebusiness.py index 0cb93ce9..048cbe3c 100644 --- a/samples/sample_connector_usage/sample_connector_usage_excelonlinebusiness.py +++ b/samples/sample_connector_usage/sample_connector_usage_excelonlinebusiness.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Excel Online (Business) Connector SDK Sample +Excel Online (Business) sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Excel Online Business connector SDK +This sample demonstrates how to use the Excel Online Business client from the Azure Connectors Python SDK to work with Excel files stored in SharePoint document libraries. Prerequisites: @@ -29,8 +29,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.excelonlinebusiness import ExcelonlinebusinessClient from azure.connectors.excelonlinebusiness import ( - ExcelonlinebusinessClient, TableToCreate, Item, ) @@ -71,7 +71,7 @@ async def example_1_list_table_rows(): async with ExcelonlinebusinessClient(CONNECTION_RUNTIME_URL, credential) as client: try: - rows = [item async for item in client.get_items_async( + rows = [item async for item in client.list_items( drive=DRIVE_ID, file=FILE_ID, table=TABLE_NAME, @@ -114,7 +114,7 @@ async def example_2_get_specific_row(): async with ExcelonlinebusinessClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_item_async( + result = await client.get_item( drive=DRIVE_ID, file=FILE_ID, table=TABLE_NAME, @@ -151,14 +151,14 @@ async def example_3_list_workbook_comments(): async with ExcelonlinebusinessClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_comments_async( + items = [item async for item in client.list_comments( drive=DRIVE_ID, file=FILE_ID, source=SOURCE_URL if SOURCE_URL else None, - ) + )] - if result and "value" in result: - comments = result["value"] + if items: + comments = items print(f"Found {len(comments)} comment(s):") for comment in comments[:5]: comment_id = comment.get("id", "N/A") @@ -202,7 +202,7 @@ async def example_4_create_table(): columns_names=column_names if column_names else None, ) - result = await client.create_table_async( + result = await client.create_table( input=table_input, drive=DRIVE_ID, file=FILE_ID, @@ -251,7 +251,7 @@ async def example_5_update_row(): } ) - result = await client.patch_item_async( + result = await client.patch_item( input=update_data, drive=DRIVE_ID, file=FILE_ID, @@ -277,7 +277,7 @@ async def example_5_update_row(): async def main(): """Run all examples.""" - print("Excel Online (Business) Connector SDK - Sample Usage") + print("Excel Online (Business) sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_formstackforms.py b/samples/sample_connector_usage/sample_connector_usage_formstackforms.py index 6d4c6c43..d486acbb 100644 --- a/samples/sample_connector_usage/sample_connector_usage_formstackforms.py +++ b/samples/sample_connector_usage/sample_connector_usage_formstackforms.py @@ -1,4 +1,4 @@ -"""Formstack Forms connector SDK sample.""" +"""Formstack Forms sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -24,7 +24,7 @@ async def main() -> None: CONNECTION_RUNTIME_URL, credential, ) as client: - forms = await client.get_available_forms_async() + forms = await client.get_available_forms() print(f"Forms: {forms}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_freshservice.py b/samples/sample_connector_usage/sample_connector_usage_freshservice.py index 0c81eb30..ed672658 100644 --- a/samples/sample_connector_usage/sample_connector_usage_freshservice.py +++ b/samples/sample_connector_usage/sample_connector_usage_freshservice.py @@ -1,7 +1,7 @@ """ -Freshservice Connector SDK Sample +Freshservice sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Freshservice connector SDK. +This sample demonstrates how to use the Freshservice client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Freshservice connection @@ -24,10 +24,10 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.freshservice import FreshserviceClient from azure.connectors.freshservice import ( AddNoteRequest, CreateTicketRequest, - FreshserviceClient, UpdateTicketRequest, ) @@ -51,7 +51,7 @@ async def example_1_create_ticket() -> None: status="2", ) - created = await client.create_ticket_async(input=request) + created = await client.create_ticket(input=request) ticket = created.get("ticket", {}) if created else {} print(f"Created ticket: {ticket.get('id')}") @@ -64,7 +64,7 @@ async def example_2_update_ticket() -> None: async with FreshserviceClient(CONNECTION_RUNTIME_URL, credential) as client: request = UpdateTicketRequest(priority="3", status="3") - updated = await client.update_ticket_async(input=request, ticket_id=1) + updated = await client.update_ticket(input=request, ticket_id=1) ticket = updated.get("ticket", {}) if updated else {} print(f"Updated ticket: {ticket.get('id')}") @@ -80,7 +80,7 @@ async def example_3_add_note() -> None: private=True, ) - note = await client.add_note_async(input=request, ticket_id=1) + note = await client.add_note(input=request, ticket_id=1) conversation = note.get("conversation", {}) if note else {} print(f"Added note: {conversation.get('id')}") @@ -92,7 +92,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Freshservice Connector SDK - Sample Usage") + print("Freshservice sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_ftp.py b/samples/sample_connector_usage/sample_connector_usage_ftp.py index a2ada01b..a1fa0ba0 100644 --- a/samples/sample_connector_usage/sample_connector_usage_ftp.py +++ b/samples/sample_connector_usage/sample_connector_usage_ftp.py @@ -21,17 +21,17 @@ async def main() -> None: async with DefaultAzureCredential() as credential: async with FtpClient(connection_url, credential) as client: - root_listing = await client.list_root_folder_async() + root_listing = [item async for item in client.list_root_folder()] print("root listing", root_listing) - created = await client.create_file_async( + created = await client.create_file( input=b"hello from azure-connectors ftp sample", folder_path=folder_path, name=file_name, ) print("created file", created) - folder_items = await client.list_folder_async(id=folder_path) + folder_items = [item async for item in client.list_folder(id=folder_path)] print("folder items available for polling", folder_items) diff --git a/samples/sample_connector_usage/sample_connector_usage_github.py b/samples/sample_connector_usage/sample_connector_usage_github.py index 7cb5fdfb..2d6cf96c 100644 --- a/samples/sample_connector_usage/sample_connector_usage_github.py +++ b/samples/sample_connector_usage/sample_connector_usage_github.py @@ -1,7 +1,7 @@ """ -GitHub Connector SDK Sample +GitHub sample for the Azure Connectors Python SDK -This sample demonstrates how to use the GitHub connector SDK. +This sample demonstrates how to use the GitHub client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with GitHub connection @@ -24,7 +24,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.github import GithubClient, IssueBasicDetailsModel +from azure.connectors.github import GithubClient +from azure.connectors.github import IssueBasicDetailsModel # Connection runtime URL format: @@ -38,7 +39,7 @@ async def example_1_get_authenticated_user() -> None: async with DefaultAzureCredential() as credential: async with GithubClient(CONNECTION_RUNTIME_URL, credential) as client: - user = await client.get_user_async() + user = await client.get_user() print(f"Authenticated as: {user.get('login') if user else 'unknown'}") @@ -48,14 +49,14 @@ async def example_2_list_issues(repository_owner: str, repository_name: str) -> async with DefaultAzureCredential() as credential: async with GithubClient(CONNECTION_RUNTIME_URL, credential) as client: - issues = await client.get_issues_async( + issues = [item async for item in client.list_issues( repository_owner=repository_owner, repository_name=repository_name, state="open", per_page=5, - ) + )] - issue_list = issues if isinstance(issues, list) else [] + issue_list = issues print(f"Found {len(issue_list)} issues") for issue in issue_list[:5]: print(f" - #{issue.get('number')}: {issue.get('title')}") @@ -71,7 +72,7 @@ async def example_3_create_issue(repository_owner: str, repository_name: str) -> title="SDK sample issue", body="Created from github Python SDK sample.", ) - created = await client.create_issue_async( + created = await client.create_issue( input=request, repository_owner=repository_owner, repository_name=repository_name, @@ -91,7 +92,7 @@ async def main() -> None: repository_owner = "octocat" repository_name = "hello-world" - print("GitHub Connector SDK - Sample Usage") + print("GitHub sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_googlecalendar.py b/samples/sample_connector_usage/sample_connector_usage_googlecalendar.py index 1d91b4e5..11c9df76 100644 --- a/samples/sample_connector_usage/sample_connector_usage_googlecalendar.py +++ b/samples/sample_connector_usage/sample_connector_usage_googlecalendar.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Google Calendar Connector SDK Sample +Google Calendar sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Google Calendar connector SDK. +This sample demonstrates how to use the Google Calendar client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Google Calendar connection @@ -27,8 +27,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.googlecalendar import GooglecalendarClient from azure.connectors.googlecalendar import ( - GooglecalendarClient, RequestEvent, ) @@ -47,9 +47,8 @@ async def example_1_list_calendars(): async with DefaultAzureCredential() as credential: async with GooglecalendarClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.list_calendars_async(min_access_role="reader") + items = [item async for item in client.list_calendars(min_access_role="reader")] - items = result.get("items", []) if result else [] print(f"Found {len(items)} calendar(s).") for calendar in items[:10]: print(f" - {calendar.get('summary', 'N/A')} ({calendar.get('id', 'N/A')})") @@ -67,9 +66,9 @@ async def example_2_list_events(): async with DefaultAzureCredential() as credential: async with GooglecalendarClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.list_events_async(calendar_id=calendar_id) + items = [item async for item in client.list_events(calendar_id=calendar_id)] - events = result.get("items", []) if result else [] + events = items print(f"Found {len(events)} event(s) in calendar '{calendar_id}'.") for event in events[:10]: print(f" - {event.get('summary', 'N/A')} ({event.get('id', 'N/A')})") @@ -97,7 +96,7 @@ async def example_3_create_event(): status="confirmed", ) - created = await client.create_event_async(input=payload, calendar_id=calendar_id) + created = await client.create_event(input=payload, calendar_id=calendar_id) if created: print(f"Created event id: {created.get('id', 'N/A')}") else: @@ -119,13 +118,12 @@ async def example_4_list_events_for_polling(): async with GooglecalendarClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.list_events_async( + items = [item async for item in client.list_events( calendar_id=calendar_id, time_min="2026-07-09T00:00:00Z", time_max="2026-07-10T00:00:00Z", - ) - events = result.get("items", []) if result else [] - print(f"Time-window query returned {len(events)} event(s).") + )] + print(f"Time-window query returned {len(items)} event(s).") print("Persist event IDs and update times to implement change polling.") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_googledrive.py b/samples/sample_connector_usage/sample_connector_usage_googledrive.py index bf648757..0e50eb53 100644 --- a/samples/sample_connector_usage/sample_connector_usage_googledrive.py +++ b/samples/sample_connector_usage/sample_connector_usage_googledrive.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Google Drive Connector SDK Sample +Google Drive sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Google Drive connector SDK. +This sample demonstrates how to use the Google Drive client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Google Drive connection @@ -44,11 +44,11 @@ async def example_1_list_root_folder(): async with DefaultAzureCredential() as credential: async with GoogledriveClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.list_root_folder_async() + items = [item async for item in client.list_root_folder()] - if result and "value" in result: - print(f"Found {len(result['value'])} items in root folder:") - for item in result["value"][:10]: + if items: + print(f"Found {len(items)} items in root folder:") + for item in items[:10]: icon = "[DIR]" if item.get("IsFolder") else "[FILE]" print(f" {icon} {item.get('Name', 'N/A')}") else: @@ -68,7 +68,7 @@ async def example_2_get_file_metadata_by_path(): async with GoogledriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: - metadata = await client.get_file_metadata_by_path_async(path=file_path) + metadata = await client.get_file_metadata_by_path(path=file_path) if metadata: print(f"Name: {metadata.get('Name', 'N/A')}") @@ -91,7 +91,7 @@ async def example_3_create_file(): async with GoogledriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.create_file_async( + result = await client.create_file( input=b"Hello from azure-connectors Google Drive sample!", folder_id=destination_folder, name=destination_name, @@ -118,11 +118,11 @@ async def example_4_list_drive_items_for_sheet_selection(): async with GoogledriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.list_folder_async(id=folder_id) + items = [item async for item in client.list_folder(id=folder_id)] - if result and "value" in result: - print(f"Found {len(result['value'])} Drive item(s):") - for item in result["value"]: + if items: + print(f"Found {len(items)} Drive item(s):") + for item in items: print(f" - {item.get('Name', 'N/A')}") else: print("No Drive items returned.") diff --git a/samples/sample_connector_usage/sample_connector_usage_googletasks.py b/samples/sample_connector_usage/sample_connector_usage_googletasks.py index 9e2258a7..26a7927e 100644 --- a/samples/sample_connector_usage/sample_connector_usage_googletasks.py +++ b/samples/sample_connector_usage/sample_connector_usage_googletasks.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Google Tasks Connector SDK Sample +Google Tasks sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Google Tasks connector SDK. +This sample demonstrates how to use the Google Tasks client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Google Tasks connection @@ -27,8 +27,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.googletasks import GoogletasksClient from azure.connectors.googletasks import ( - GoogletasksClient, TRIGGER_OPERATIONS, TaskCreate, TaskListCreate, @@ -49,8 +49,7 @@ async def example_1_list_task_lists(): async with DefaultAzureCredential() as credential: async with GoogletasksClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.list_task_lists_async() - items = result.get("items", []) if result else [] + items = [item async for item in client.list_task_lists()] print(f"Found {len(items)} task list(s).") for task_list in items[:10]: @@ -65,7 +64,7 @@ async def example_2_create_task_list_and_task(): async with GoogletasksClient(CONNECTION_RUNTIME_URL, credential) as client: try: - list_result = await client.create_task_list_async( + list_result = await client.create_task_list( input=TaskListCreate(title="SDK Sample List"), ) task_list_id = list_result.get("id") if list_result else None @@ -74,7 +73,7 @@ async def example_2_create_task_list_and_task(): print("Task list creation returned no id.") return - task_result = await client.create_task_async( + task_result = await client.create_task( input=TaskCreate( title="Follow up sample", notes="Created by azure-connectors sample.", diff --git a/samples/sample_connector_usage/sample_connector_usage_impexium.py b/samples/sample_connector_usage/sample_connector_usage_impexium.py index e524b739..6dded305 100644 --- a/samples/sample_connector_usage/sample_connector_usage_impexium.py +++ b/samples/sample_connector_usage/sample_connector_usage_impexium.py @@ -1,4 +1,4 @@ -"""Impexium connector SDK sample.""" +"""Impexium sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -21,7 +21,10 @@ async def main() -> None: async with DefaultAzureCredential() as credential: try: async with ImpexiumClient(CONNECTION_RUNTIME_URL, credential) as client: - countries = await client.list_all_countries_async(page_number=1) + countries = [ + country + async for country in client.list_all_countries(page_number=1) + ] print(f"Countries: {countries}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_infusionsoft.py b/samples/sample_connector_usage/sample_connector_usage_infusionsoft.py index 38b42270..2eff34eb 100644 --- a/samples/sample_connector_usage/sample_connector_usage_infusionsoft.py +++ b/samples/sample_connector_usage/sample_connector_usage_infusionsoft.py @@ -1,7 +1,7 @@ """ -Infusionsoft (Keap) Connector SDK Sample +Infusionsoft (Keap) sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Infusionsoft connector SDK. +This sample demonstrates how to use the Infusionsoft client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Infusionsoft connection @@ -24,7 +24,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.infusionsoft import CreateTaskRequest, InfusionsoftClient +from azure.connectors.infusionsoft import InfusionsoftClient +from azure.connectors.infusionsoft import CreateTaskRequest # Connection runtime URL format: @@ -38,8 +39,8 @@ async def example_1_list_tasks() -> None: async with DefaultAzureCredential() as credential: async with InfusionsoftClient(CONNECTION_RUNTIME_URL, credential) as client: - response = await client.list_tasks_async() - tasks = response.get("tasks", []) if response else [] + response = [item async for item in client.list_tasks()] + tasks = response print(f"Found {len(tasks)} tasks") for task in tasks[:5]: @@ -58,7 +59,7 @@ async def example_2_create_task() -> None: priority=1, ) - created = await client.create_task_async(input=request) + created = await client.create_task(input=request) print(f"Created task: {created.get('id') if created else 'n/a'}") @@ -73,7 +74,7 @@ async def example_3_update_task() -> None: description="Updated from the infusionsoft SDK sample.", ) - updated = await client.update_task_async(input=request, id=1) + updated = await client.update_task(input=request, id=1) print(f"Updated task: {updated.get('id') if updated else 'n/a'}") @@ -84,7 +85,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Infusionsoft (Keap) Connector SDK - Sample Usage") + print("Infusionsoft (Keap) sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_insightly.py b/samples/sample_connector_usage/sample_connector_usage_insightly.py index 15aa4fd0..c28adc8e 100644 --- a/samples/sample_connector_usage/sample_connector_usage_insightly.py +++ b/samples/sample_connector_usage/sample_connector_usage_insightly.py @@ -1,7 +1,7 @@ """ -Insightly Connector SDK Sample +Insightly sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Insightly connector SDK. +This sample demonstrates how to use the Insightly client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Insightly connection @@ -24,7 +24,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.insightly import InsightlyClient, TaskRequest +from azure.connectors.insightly import InsightlyClient +from azure.connectors.insightly import TaskRequest # Connection runtime URL format: @@ -38,8 +39,8 @@ async def example_1_list_tasks() -> None: async with DefaultAzureCredential() as credential: async with InsightlyClient(CONNECTION_RUNTIME_URL, credential) as client: - response = await client.list_tasks_async() - tasks = response.get("tasks", []) if response else [] + response = [item async for item in client.list_tasks()] + tasks = response print(f"Found {len(tasks)} tasks") for task in tasks[:5]: @@ -52,8 +53,8 @@ async def example_2_list_contacts() -> None: async with DefaultAzureCredential() as credential: async with InsightlyClient(CONNECTION_RUNTIME_URL, credential) as client: - response = await client.list_contacts_async() - contacts = response.get("contacts", []) if response else [] + response = [item async for item in client.list_contacts()] + contacts = response print(f"Found {len(contacts)} contacts") for contact in contacts[:5]: @@ -72,9 +73,11 @@ async def example_3_add_task() -> None: t_i_t_l_e="SDK sample task", d_e_t_a_i_l_s="Created from insightly SDK sample.", s_t_a_t_u_s="NOT STARTED", + c_o_m_p_l_e_t_e_d=False, + p_u_b_l_i_c_l_y_v_i_s_i_b_l_e=False, ) - created = await client.add_task_async(input=request) + created = await client.add_task(input=request) print(f"Created task: {created.get('TASK_ID') if created else 'n/a'}") @@ -85,7 +88,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Insightly Connector SDK - Sample Usage") + print("Insightly sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_jedoxodatahub.py b/samples/sample_connector_usage/sample_connector_usage_jedoxodatahub.py index 8c82d180..2b9d38b8 100644 --- a/samples/sample_connector_usage/sample_connector_usage_jedoxodatahub.py +++ b/samples/sample_connector_usage/sample_connector_usage_jedoxodatahub.py @@ -1,4 +1,4 @@ -"""Jedox OData Hub connector SDK sample.""" +"""Jedox OData Hub sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -24,7 +24,7 @@ async def main() -> None: CONNECTION_RUNTIME_URL, credential, ) as client: - databases = await client.databases_async() + databases = [item async for item in client.list_databases()] print(f"Databases: {databases}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_jira.py b/samples/sample_connector_usage/sample_connector_usage_jira.py index 48dafddb..07567cf4 100644 --- a/samples/sample_connector_usage/sample_connector_usage_jira.py +++ b/samples/sample_connector_usage/sample_connector_usage_jira.py @@ -1,7 +1,7 @@ """ -Jira Connector SDK Sample +Jira sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Jira connector SDK. +This sample demonstrates how to use the Jira client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Jira connection @@ -24,7 +24,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.jira import JiraClient, CreateIssueInput +from azure.connectors.jira import JiraClient +from azure.connectors.jira import CreateIssueInput # Connection runtime URL format: @@ -38,12 +39,8 @@ async def example_1_list_resources() -> list[dict]: async with DefaultAzureCredential() as credential: async with JiraClient(CONNECTION_RUNTIME_URL, credential) as client: - resources_response = await client.list_resources_async() - resources = ( - resources_response - if isinstance(resources_response, list) - else resources_response.get("value", []) if resources_response else [] - ) + resources_response = [item async for item in client.list_resources()] + resources = resources_response print(f"Found {len(resources)} resources") for resource in resources[:5]: @@ -60,9 +57,9 @@ async def example_2_list_issues(cloud_id: str) -> None: async with JiraClient(CONNECTION_RUNTIME_URL, credential) as client: del cloud_id - issues_response = await client.list_issues_async() + issues_response = [item async for item in client.list_issues()] - issues = issues_response.get("issues", []) if issues_response else [] + issues = issues_response print(f"Found {len(issues)} issues") for issue in issues[:5]: print(f" - {issue.get('key')}: {issue.get('fields', {}).get('summary')}") @@ -97,7 +94,7 @@ async def example_3_create_issue(cloud_id: str) -> None: } ) - created = await client.create_issue_async( + created = await client.create_issue( input=request, project_key="PROJ", issue_type_ids="10001", @@ -112,7 +109,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Jira Connector SDK - Sample Usage") + print("Jira sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_keyvault.py b/samples/sample_connector_usage/sample_connector_usage_keyvault.py index 4886dced..1d934064 100644 --- a/samples/sample_connector_usage/sample_connector_usage_keyvault.py +++ b/samples/sample_connector_usage/sample_connector_usage_keyvault.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Key Vault Connector SDK Sample +Azure Key Vault sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Key Vault connector SDK to +This sample demonstrates how to use the Azure Key Vault client from the Azure Connectors Python SDK to manage keys and secrets. Prerequisites: @@ -25,8 +25,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.keyvault import KeyvaultClient from azure.connectors.keyvault import ( - KeyvaultClient, KeyEncryptInput, KeyDecryptInput, ) @@ -51,10 +51,9 @@ async def example_1_list_keys(): async with KeyvaultClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.list_keys_async() + keys = [key async for key in client.list_keys()] - if result and result.get("value"): - keys = result["value"] + if keys: print(f"Found {len(keys)} keys:") for key in keys: print(f" - {key.get('name')} (enabled: {key.get('is_enabled')})") @@ -75,7 +74,7 @@ async def example_2_get_key_metadata(): async with KeyvaultClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_key_metadata_async(key_name=KEY_NAME) + result = await client.get_key_metadata(key_name=KEY_NAME) if result: print(f"Key Name: {result.get('name')}") @@ -110,7 +109,7 @@ async def example_3_encrypt_decrypt(): algorithm="RSA-OAEP", raw_data=plaintext ) - encrypt_result = await client.encrypt_data_async( + encrypt_result = await client.encrypt_data( input=encrypt_input, key_name=KEY_NAME ) @@ -124,7 +123,7 @@ async def example_3_encrypt_decrypt(): algorithm="RSA-OAEP", encrypted_data=encrypted ) - decrypt_result = await client.decrypt_data_async( + decrypt_result = await client.decrypt_data( input=decrypt_input, key_name=KEY_NAME ) @@ -147,10 +146,9 @@ async def example_4_list_secrets(): async with KeyvaultClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.list_secrets_async() + secrets = [secret async for secret in client.list_secrets()] - if result and result.get("value"): - secrets = result["value"] + if secrets: print(f"Found {len(secrets)} secrets:") for _ in secrets: print(" - [REDACTED]") @@ -171,7 +169,7 @@ async def example_5_get_secret(): async with KeyvaultClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_secret_async(secret_name=SECRET_NAME) + result = await client.get_secret(secret_name=SECRET_NAME) if result: print(f"Secret Name: {result.get('name')}") @@ -197,7 +195,7 @@ async def example_6_get_secret_metadata(): async with KeyvaultClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_secret_metadata_async( + result = await client.get_secret_metadata( secret_name=SECRET_NAME ) diff --git a/samples/sample_connector_usage/sample_connector_usage_kusto.py b/samples/sample_connector_usage/sample_connector_usage_kusto.py index 8c83ef4c..cb0dd950 100644 --- a/samples/sample_connector_usage/sample_connector_usage_kusto.py +++ b/samples/sample_connector_usage/sample_connector_usage_kusto.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Kusto (Azure Data Explorer) Connector SDK Sample +Kusto (Azure Data Explorer) sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Kusto connector SDK. +This sample demonstrates how to use the Kusto client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Kusto (Azure Data Explorer) cluster @@ -29,8 +29,8 @@ try: from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException + from azure.connectors.kusto import KustoClient from azure.connectors.kusto import ( - KustoClient, QueryAndListSchema, ControlCommandAndListSchema, QueryAndVisualizeSchema, @@ -82,7 +82,8 @@ async def example_1_simple_kql_query(): csl=query, ) - results = await client.list_kusto_results_async(input=query_request) + poller = await client.begin_list_kusto_results(input=query_request) + results = await poller.result() if results and 'value' in results: print(f"Query executed successfully. Found {len(results['value'])} rows:") @@ -117,7 +118,8 @@ async def example_2_aggregation_query(): csl=query, ) - results = await client.list_kusto_results_async(input=query_request) + poller = await client.begin_list_kusto_results(input=query_request) + results = await poller.result() if results and 'value' in results: print("Top 5 states by event count:") @@ -156,7 +158,8 @@ async def example_3_time_based_filtering(): csl=query, ) - results = await client.list_kusto_results_async(input=query_request) + poller = await client.begin_list_kusto_results(input=query_request) + results = await poller.result() if results and 'value' in results: print("Top 5 event types in the last year:") @@ -194,9 +197,10 @@ async def example_4_visualize_results(): chart_type="Time Chart", ) - chart = await client.run_kusto_query_and_visualize_results_async( + poller = await client.begin_run_kusto_query_and_visualize_results( input=visualize_request ) + chart = await poller.result() if chart: print("Chart data generated successfully") @@ -231,9 +235,10 @@ async def example_5_control_command(): csl=command, ) - results = await client.list_kusto_show_command_results_async( + poller = await client.begin_list_kusto_show_command_results( input=command_request ) + results = await poller.result() if results and 'value' in results: print(f"Found {len(results['value'])} tables in database '{KUSTO_DATABASE}':") @@ -266,9 +271,10 @@ async def example_6_table_schema(): csl=command, ) - results = await client.list_kusto_show_command_results_async( + poller = await client.begin_list_kusto_show_command_results( input=command_request ) + results = await poller.result() if results and 'value' in results and len(results['value']) > 0: print(f"Schema for table '{KUSTO_TABLE}':") @@ -316,7 +322,8 @@ async def example_7_statistical_analysis(): csl=query, ) - results = await client.list_kusto_results_async(input=query_request) + poller = await client.begin_list_kusto_results(input=query_request) + results = await poller.result() if results and 'value' in results and len(results['value']) > 0: stats = results['value'][0] @@ -351,7 +358,8 @@ async def example_8_error_handling(): csl=query, ) - results = await client.list_kusto_results_async(input=query_request) + poller = await client.begin_list_kusto_results(input=query_request) + results = await poller.result() print(f"Unexpected success: {results}") except ConnectorException as ex: @@ -364,7 +372,7 @@ async def example_8_error_handling(): async def main(): """Run all examples.""" - print("Kusto (Azure Data Explorer) Connector SDK - Sample Usage") + print("Kusto (Azure Data Explorer) sample usage for the Azure Connectors Python SDK") print("=" * 60) print() diff --git a/samples/sample_connector_usage/sample_connector_usage_mailchimp.py b/samples/sample_connector_usage/sample_connector_usage_mailchimp.py index 0fa27e4e..5e145e78 100644 --- a/samples/sample_connector_usage/sample_connector_usage_mailchimp.py +++ b/samples/sample_connector_usage/sample_connector_usage_mailchimp.py @@ -1,7 +1,7 @@ """ -Mailchimp Connector SDK Sample +Mailchimp sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Mailchimp connector SDK. +This sample demonstrates how to use the Mailchimp client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Mailchimp connection @@ -24,8 +24,10 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.mailchimp import MailchimpClient from azure.connectors.mailchimp import ( - MailchimpClient, + CampaignDefaults, + Contact, NewListRequest, NewMemberInListRequest, ) @@ -42,7 +44,7 @@ async def example_1_list_campaigns() -> None: async with DefaultAzureCredential() as credential: async with MailchimpClient(CONNECTION_RUNTIME_URL, credential) as client: - campaigns = await client.get_campaigns_async() + campaigns = [item async for item in client.list_campaigns()] print(f"Campaigns: {campaigns}") @@ -52,7 +54,7 @@ async def example_2_get_lists() -> None: async with DefaultAzureCredential() as credential: async with MailchimpClient(CONNECTION_RUNTIME_URL, credential) as client: - lists = await client.get_lists_async(count=10, offset=0) + lists = await client.get_lists(count=10, offset=0) print(f"Lists: {lists}") @@ -62,10 +64,26 @@ async def example_3_new_list() -> None: async with DefaultAzureCredential() as credential: async with MailchimpClient(CONNECTION_RUNTIME_URL, credential) as client: - new_list = await client.newlist_async( + new_list = await client.newlist( input=NewListRequest( name="SDK sample list", permission_reminder="You signed up via the SDK sample.", + contact=Contact( + company="Contoso", + address1="1 Microsoft Way", + city="Redmond", + state="WA", + zip="98052", + country="US", + phone="425-555-0100", + ), + campaign_defaults=CampaignDefaults( + from_name="SDK Sample", + from_email="sample@example.com", + subject="Welcome", + language="en", + ), + email_type_option=True, ), ) print(f"Created list: {new_list}") @@ -77,7 +95,7 @@ async def example_4_add_member() -> None: async with DefaultAzureCredential() as credential: async with MailchimpClient(CONNECTION_RUNTIME_URL, credential) as client: - member = await client.addmember_async( + member = await client.addmember( input=NewMemberInListRequest( email_address="sample.user@example.com", status="subscribed", @@ -94,7 +112,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Mailchimp Connector SDK - Sample Usage") + print("Mailchimp sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_meetingroommap.py b/samples/sample_connector_usage/sample_connector_usage_meetingroommap.py index edc113de..9a8b6de1 100644 --- a/samples/sample_connector_usage/sample_connector_usage_meetingroommap.py +++ b/samples/sample_connector_usage/sample_connector_usage_meetingroommap.py @@ -1,4 +1,4 @@ -"""Meeting Room Map connector SDK sample.""" +"""Meeting Room Map sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -24,7 +24,7 @@ async def main() -> None: CONNECTION_RUNTIME_URL, credential, ) as client: - categories = await client.get_categories_async() + categories = [item async for item in client.list_categories()] print(f"Categories: {categories}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_microsoftbookings.py b/samples/sample_connector_usage/sample_connector_usage_microsoftbookings.py index ac6fbc91..cea9f0eb 100644 --- a/samples/sample_connector_usage/sample_connector_usage_microsoftbookings.py +++ b/samples/sample_connector_usage/sample_connector_usage_microsoftbookings.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Microsoft Bookings Connector SDK Sample +Microsoft Bookings sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Microsoft Bookings connector SDK to +This sample demonstrates how to use the Microsoft Bookings client from the Azure Connectors Python SDK to manage booking businesses and appointment webhooks. Prerequisites: @@ -25,8 +25,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.microsoftbookings import MicrosoftbookingsClient from azure.connectors.microsoftbookings import ( - MicrosoftbookingsClient, CreateAppointmentInput, UpdateAppointmentInput, CancelAppointmentInput, @@ -60,10 +60,10 @@ async def example_1_list_booking_businesses(): async with MicrosoftbookingsClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.list_bookings_business_user_as_admin_async() + items = [item async for item in client.list_bookings_business_user_as_admin()] - if result and result.get("mailboxes"): - mailboxes = result["mailboxes"] + if items: + mailboxes = items print(f"Found {len(mailboxes)} booking business(es):") for mailbox in mailboxes: print(f" - {mailbox.get('display_name')}") diff --git a/samples/sample_connector_usage/sample_connector_usage_microsoftforms.py b/samples/sample_connector_usage/sample_connector_usage_microsoftforms.py index 35f71912..50547985 100644 --- a/samples/sample_connector_usage/sample_connector_usage_microsoftforms.py +++ b/samples/sample_connector_usage/sample_connector_usage_microsoftforms.py @@ -1,7 +1,7 @@ """ -Microsoft Forms Connector SDK Sample +Microsoft Forms sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Microsoft Forms connector SDK. +This sample demonstrates how to use the Microsoft Forms client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Microsoft Forms connection @@ -40,8 +40,7 @@ async def example_1_list_forms() -> list[dict]: async with DefaultAzureCredential() as credential: async with MicrosoftformsClient(CONNECTION_RUNTIME_URL, credential) as client: - forms_response = await client.list_forms_async() - forms = forms_response.get("value", []) if forms_response else [] + forms = [form async for form in client.list_forms()] print(f"Found {len(forms)} forms") for form in forms[:5]: @@ -56,7 +55,7 @@ async def example_2_get_form_details(form_id: str) -> None: async with DefaultAzureCredential() as credential: async with MicrosoftformsClient(CONNECTION_RUNTIME_URL, credential) as client: - details = await client.get_form_details_by_id_async(form_id=form_id) + details = await client.get_form_details_by_id(form_id=form_id) if not details: print("No details returned") @@ -74,7 +73,7 @@ async def example_3_get_questions(form_id: str) -> None: async with DefaultAzureCredential() as credential: async with MicrosoftformsClient(CONNECTION_RUNTIME_URL, credential) as client: - await client.get_questions_async(form_id=form_id) + await client.get_questions(form_id=form_id) print("Question metadata request completed.") @@ -85,7 +84,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Microsoft Forms Connector SDK - Sample Usage") + print("Microsoft Forms sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_monday.py b/samples/sample_connector_usage/sample_connector_usage_monday.py index 7ffe7bdc..bb308d07 100644 --- a/samples/sample_connector_usage/sample_connector_usage_monday.py +++ b/samples/sample_connector_usage/sample_connector_usage_monday.py @@ -1,7 +1,7 @@ """ -Monday.com Connector SDK Sample +Monday.com sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Monday.com connector SDK. +This sample demonstrates how to use the Monday.com client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Monday.com connection @@ -24,11 +24,11 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.monday import MondayClient from azure.connectors.monday import ( CreateBoardInput, CreateItemInput, DynamicResponseGetSingleColumnSchema, - MondayClient, UpdateItemColumnInput, ) @@ -44,7 +44,7 @@ async def example_1_create_board() -> None: async with DefaultAzureCredential() as credential: async with MondayClient(CONNECTION_RUNTIME_URL, credential) as client: - board = await client.create_board_async( + board = await client.create_board( input=CreateBoardInput( workspace_id="123456", board_name="SDK sample board", @@ -60,7 +60,7 @@ async def example_2_create_item() -> None: async with DefaultAzureCredential() as credential: async with MondayClient(CONNECTION_RUNTIME_URL, credential) as client: - item = await client.create_item_async( + item = await client.create_item( input=CreateItemInput( workspace_id="123456", board_id="789012", @@ -78,7 +78,7 @@ async def example_3_update_item_column() -> None: async with DefaultAzureCredential() as credential: async with MondayClient(CONNECTION_RUNTIME_URL, credential) as client: - updated = await client.update_item_column_async( + updated = await client.update_item_column( input=UpdateItemColumnInput( workspace_id="123456", board_id="789012", @@ -99,7 +99,7 @@ async def example_4_list_workspaces() -> None: async with DefaultAzureCredential() as credential: async with MondayClient(CONNECTION_RUNTIME_URL, credential) as client: - workspaces = await client.get_workspaces_async() + workspaces = await client.get_workspaces() print(f"Workspaces: {workspaces}") @@ -110,7 +110,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Monday.com Connector SDK - Sample Usage") + print("Monday.com sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_mq.py b/samples/sample_connector_usage/sample_connector_usage_mq.py index c444da11..8efd7ff3 100644 --- a/samples/sample_connector_usage/sample_connector_usage_mq.py +++ b/samples/sample_connector_usage/sample_connector_usage_mq.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -IBM MQ Connector SDK Sample +IBM MQ sample for the Azure Connectors Python SDK -This sample demonstrates how to use the IBM MQ connector SDK. +This sample demonstrates how to use the IBM MQ client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with IBM MQ connection @@ -27,8 +27,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.mq import MqClient from azure.connectors.mq import ( - MqClient, SendValidDataOptions, SingleGetValidOptions, MultipleGetValidOptions, @@ -63,7 +63,7 @@ async def example_1_send_message(): queue=DEFAULT_QUEUE, ) - result = await client.send_async(input=options) + result = await client.send(input=options) if result: print("Message sent successfully:") @@ -91,7 +91,7 @@ async def example_2_browse_message(): include_info="true", ) - result = await client.read_async(input=options) + result = await client.read(input=options) if result: print("Browsed message:") @@ -125,11 +125,12 @@ async def example_3_browse_messages_batch(): include_info="true", ) - result = await client.read_all_async(input=options) + result = await client.read_all(input=options) + items = result.get("value", []) if result else [] - if result and isinstance(result, list): - print(f"Browsed {len(result)} messages:") - for i, msg in enumerate(result[:5]): # Show first 5 + if items: + print(f"Browsed {len(items)} messages:") + for i, msg in enumerate(items[:5]): # Show first 5 msg_id = msg.get("messageId", "N/A") data = msg.get("messageData", "") preview = data[:50] if data else "(empty)" @@ -156,7 +157,7 @@ async def example_4_receive_message(): include_info="true", ) - result = await client.receive_async(input=options) + result = await client.receive(input=options) if result: print("Received message (removed from queue):") @@ -186,7 +187,7 @@ async def example_5_delete_message(): queue=DEFAULT_QUEUE, ) - result = await client.delete_async(input=options) + result = await client.delete(input=options) if result: print("Deleted message:") @@ -203,7 +204,7 @@ async def example_5_delete_message(): async def main(): """Run all examples.""" - print("IBM MQ Connector SDK - Sample Usage") + print("IBM MQ sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_msgraphgroupsanduser.py b/samples/sample_connector_usage/sample_connector_usage_msgraphgroupsanduser.py index e987426a..455c4a93 100644 --- a/samples/sample_connector_usage/sample_connector_usage_msgraphgroupsanduser.py +++ b/samples/sample_connector_usage/sample_connector_usage_msgraphgroupsanduser.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -MS Graph Groups & Users Connector SDK Sample +MS Graph Groups & Users sample for the Azure Connectors Python SDK -This sample demonstrates how to use the MS Graph Groups & Users connector SDK. +This sample demonstrates how to use the MS Graph Groups & Users client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with MS Graph Groups & Users connection @@ -44,11 +44,11 @@ async def example_1_list_users(): async with MsgraphgroupsanduserClient(CONNECTION_RUNTIME_URL, credential) as client: try: - users = await client.list_users_async() + users = [user async for user in client.list_users()] - if users and "value" in users: - print(f"Found {len(users['value'])} users:") - for user in users["value"][:5]: # Show first 5 + if users: + print(f"Found {len(users)} users:") + for user in users[:5]: # Show first 5 display_name = user.get("displayName", "Unknown") user_principal = user.get("userPrincipalName", "N/A") print(f" - {display_name} ({user_principal})") @@ -71,15 +71,18 @@ async def example_2_list_groups(): async with MsgraphgroupsanduserClient(CONNECTION_RUNTIME_URL, credential) as client: try: - groups = await client.list_groups_by_display_name_search_async( - search=search_term, - ) + groups = [ + group + async for group in client.list_groups_by_display_name_search( + search=search_term, + ) + ] search_display = search_term or "(all)" - if groups and "value" in groups: + if groups: print(f"Search: {search_display}") - print(f"Found {len(groups['value'])} groups:") - for group in groups["value"][:5]: # Show first 5 + print(f"Found {len(groups)} groups:") + for group in groups[:5]: # Show first 5 display_name = group.get("displayName", "Unknown") group_id = group.get("id", "N/A") mail = group.get("mail", "No email") @@ -109,7 +112,7 @@ async def example_3_get_group_properties(): async with MsgraphgroupsanduserClient(CONNECTION_RUNTIME_URL, credential) as client: try: - group = await client.get_group_properties_async(group_id=group_id) + group = await client.get_group_properties(group_id=group_id) if group: print(f"Group properties for '{group.get('displayName', 'Unknown')}':") @@ -142,13 +145,16 @@ async def example_4_list_group_members(): async with MsgraphgroupsanduserClient(CONNECTION_RUNTIME_URL, credential) as client: try: - members = await client.list_direct_group_members_async( - group_id=group_id, - ) - - if members and "value" in members: - print(f"Found {len(members['value'])} members:") - for member in members["value"][:5]: # Show first 5 + members = [ + member + async for member in client.list_direct_group_members( + group_id=group_id, + ) + ] + + if members: + print(f"Found {len(members)} members:") + for member in members[:5]: # Show first 5 display_name = member.get("displayName", "Unknown") member_type = member.get("@odata.type", "Unknown type") print(f" - {display_name} ({member_type})") @@ -169,11 +175,11 @@ async def example_5_list_subscribed_skus(): async with MsgraphgroupsanduserClient(CONNECTION_RUNTIME_URL, credential) as client: try: - skus = await client.list_subscribed_skus_async() + skus = [sku async for sku in client.list_subscribed_skus()] - if skus and "value" in skus: - print(f"Found {len(skus['value'])} subscribed SKUs:") - for sku in skus["value"][:5]: # Show first 5 + if skus: + print(f"Found {len(skus)} subscribed SKUs:") + for sku in skus[:5]: # Show first 5 sku_part_number = sku.get("skuPartNumber", "Unknown") consumed = sku.get("consumedUnits", 0) print(f" - {sku_part_number} (Consumed: {consumed} units)") @@ -188,7 +194,7 @@ async def example_5_list_subscribed_skus(): async def main(): """Run all examples.""" - print("MS Graph Groups & Users Connector SDK - Sample Usage") + print("MS Graph Groups & Users sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_office365.py b/samples/sample_connector_usage/sample_connector_usage_office365.py index d1da234a..02cc0a4c 100644 --- a/samples/sample_connector_usage/sample_connector_usage_office365.py +++ b/samples/sample_connector_usage/sample_connector_usage_office365.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Office365 Connector SDK Sample +Office365 sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Office365 connector SDK. +This sample demonstrates how to use the Office365 client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Office365 connection @@ -26,9 +26,9 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.office365 import Office365Client from azure.connectors.office365 import ( DraftEmailInput, - Office365Client, SendEmailInput, ) @@ -48,16 +48,16 @@ async def example_1_get_outlook_categories(): async with Office365Client(CONNECTION_RUNTIME_URL, credential) as client: try: - categories = await client.get_outlook_category_names_async() + categories = [item async for item in client.list_outlook_category_names()] - if categories and 'value' in categories: - print(f"Found {len(categories['value'])} Outlook categories:") - for category in categories['value'][:5]: + if categories: + print(f"Found {len(categories)} Outlook categories:") + for category in categories[:5]: display_name = category.get('DisplayName', 'Unknown') color = category.get('Color', 'N/A') print(f" - {display_name} (Color: {color})") else: - print("No categories found or unexpected response format.") + print("No categories found.") except ConnectorException as ex: print(f"Connector error: {ex}") @@ -77,14 +77,14 @@ async def example_2_send_email(): try: email = SendEmailInput( to=to_address, - subject="Test Email from Office365 Connector SDK", + subject="Test Email from the Azure Connectors Python SDK", body=( "

This is a test email sent from the " - "Python Office365 Connector SDK.

" + "Azure Connectors Python SDK.

" ), ) - await client.send_email_async(email) + await client.send_email(email) print(f"Email sent successfully to {to_address}") print("Note: Set TEST_EMAIL_TO environment variable to send to a real address") @@ -102,11 +102,11 @@ async def example_3_get_emails(): async with Office365Client(CONNECTION_RUNTIME_URL, credential) as client: try: - emails = await client.get_emails_async() + emails = [item async for item in client.list_emails()] - if emails and 'value' in emails: - print(f"Found {len(emails['value'])} emails:") - for email in emails['value']: + if emails: + print(f"Found {len(emails)} emails:") + for email in emails: subject = email.get('Subject', 'No Subject') from_addr = email.get('From', 'Unknown') received = email.get('DateTimeReceived', 'Unknown') @@ -114,7 +114,7 @@ async def example_3_get_emails(): print(f" From: {from_addr}") print(f" Received: {received}") else: - print("No emails found or unexpected response format.") + print("No emails found.") except ConnectorException as ex: print(f"Connector error: {ex}") @@ -138,14 +138,14 @@ async def example_4_draft_and_send_email(): body="

This email was created as a draft first.

", ) - draft_response = await client.draft_email_async(draft) + draft_response = await client.draft_email(draft) print("Draft created successfully") if draft_response and 'Id' in draft_response: message_id = draft_response['Id'] print(f"Draft message ID: {message_id}") - await client.send_draft_email_async(message_id=message_id) + await client.send_draft_email(message_id=message_id) print(f"Draft email sent successfully to {to_address}") else: print("Draft created but no ID returned.") @@ -166,7 +166,7 @@ async def example_5_error_handling(): try: # Attempt to get an email with an invalid ID invalid_message_id = "invalid-message-id-12345" - email = await client.get_email_async(message_id=invalid_message_id) + email = await client.get_email(message_id=invalid_message_id) print(f"Unexpected success: {email}") except ConnectorException as ex: @@ -179,7 +179,7 @@ async def example_5_error_handling(): async def main(): """Run all examples.""" - print("Office365 Connector SDK - Sample Usage") + print("Office365 sample usage for the Azure Connectors Python SDK") print("=" * 50) print() diff --git a/samples/sample_connector_usage/sample_connector_usage_office365groups.py b/samples/sample_connector_usage/sample_connector_usage_office365groups.py index d504ec30..a9755cb6 100644 --- a/samples/sample_connector_usage/sample_connector_usage_office365groups.py +++ b/samples/sample_connector_usage/sample_connector_usage_office365groups.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Office 365 Groups Connector SDK Sample +Office 365 Groups sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Office 365 Groups connector SDK +This sample demonstrates how to use the Office 365 Groups client from the Azure Connectors Python SDK for group management and calendar operations. Prerequisites: @@ -25,8 +25,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.office365groups import Office365groupsClient from azure.connectors.office365groups import ( - Office365groupsClient, UpdateCalendarEventHTMLRequest, ) @@ -46,7 +46,7 @@ async def example_1_list_groups(): async with Office365groupsClient(CONNECTION_RUNTIME_URL, credential) as client: try: - groups = [item async for item in client.list_groups_async(top=10)] + groups = [item async for item in client.list_groups(top=10)] if groups: print(f"Found {len(groups)} groups:") @@ -73,7 +73,7 @@ async def example_2_list_group_members(): async with Office365groupsClient(CONNECTION_RUNTIME_URL, credential) as client: try: members = [ - item async for item in client.list_group_members_async( + item async for item in client.list_group_members( group_id=GROUP_ID ) ] @@ -99,10 +99,9 @@ async def example_3_list_owned_groups(): async with Office365groupsClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.list_owned_groups_async() + groups = [group async for group in client.list_owned_groups()] - if result and "value" in result: - groups = result["value"] + if groups: print(f"You own or belong to {len(groups)} groups:") for group in groups[:5]: print(f" - {group.get('displayName', 'N/A')}") @@ -146,7 +145,7 @@ async def example_4_create_group_event(): } ) - result = await client.create_calendar_event_async( + result = await client.create_calendar_event( input=event_input, group_id=GROUP_ID ) @@ -176,7 +175,7 @@ async def example_5_add_member_to_group(): async with Office365groupsClient(CONNECTION_RUNTIME_URL, credential) as client: try: - await client.add_member_to_group_async( + await client.add_member_to_group( group_id=GROUP_ID, user_upn=USER_UPN ) @@ -198,7 +197,7 @@ async def example_6_list_deleted_groups(): async with Office365groupsClient(CONNECTION_RUNTIME_URL, credential) as client: try: groups = [ - item async for item in client.list_deleted_groups_async() + item async for item in client.list_deleted_groups() ] if groups: diff --git a/samples/sample_connector_usage/sample_connector_usage_office365groupsmail.py b/samples/sample_connector_usage/sample_connector_usage_office365groupsmail.py index 8ecced12..22150a3e 100644 --- a/samples/sample_connector_usage/sample_connector_usage_office365groupsmail.py +++ b/samples/sample_connector_usage/sample_connector_usage_office365groupsmail.py @@ -24,15 +24,15 @@ async def main() -> None: async with Office365groupsmailClient(connection_url, credential) as client: conversations = [ conversation - async for conversation in client.list_conversations_async( + async for conversation in client.list_conversations( group_id=group_id ) ] conversation_count = len(conversations) print(f"Found {conversation_count} conversation(s) in group '{group_id}'.") - groups = await client.list_groups_async() - group_count = len((groups or {}).get("value", [])) + groups = [group async for group in client.list_groups()] + group_count = len(groups) print(f"Current user is in {group_count} Office 365 group(s).") diff --git a/samples/sample_connector_usage/sample_connector_usage_office365users.py b/samples/sample_connector_usage/sample_connector_usage_office365users.py index 064b7331..d51078e5 100644 --- a/samples/sample_connector_usage/sample_connector_usage_office365users.py +++ b/samples/sample_connector_usage/sample_connector_usage_office365users.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Office 365 Users Connector SDK Sample +Office 365 Users sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Office 365 Users connector SDK. +This sample demonstrates how to use the Office 365 Users client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Office 365 Users connection @@ -44,7 +44,7 @@ async def example_1_get_my_profile(): async with Office365usersClient(CONNECTION_RUNTIME_URL, credential) as client: try: - profile = await client.my_profile_async() + profile = await client.my_profile() if profile: print("My Profile:") @@ -76,7 +76,7 @@ async def example_2_get_user_profile(): async with Office365usersClient(CONNECTION_RUNTIME_URL, credential) as client: try: - profile = await client.user_profile_async(id=user_id) + profile = await client.user_profile(id=user_id) if profile: print(f"User Profile for '{user_id}':") @@ -108,7 +108,7 @@ async def example_3_get_manager(): async with Office365usersClient(CONNECTION_RUNTIME_URL, credential) as client: try: - manager = await client.manager_async(id=user_id) + manager = await client.manager(id=user_id) if manager: print(f"Manager for '{user_id}':") @@ -138,12 +138,12 @@ async def example_4_get_direct_reports(): async with Office365usersClient(CONNECTION_RUNTIME_URL, credential) as client: try: - reports = await client.direct_reports_async(id=user_id) + reports = [item async for item in client.list_direct_reports(id=user_id)] - if reports and "value" in reports: + if reports: print(f"Direct reports for '{user_id}':") - print(f" Found {len(reports['value'])} reports") - for report in reports["value"][:5]: # Show first 5 + print(f" Found {len(reports)} reports") + for report in reports[:5]: # Show first 5 display_name = report.get("displayName", "N/A") job_title = report.get("jobTitle", "N/A") print(f" - {display_name} ({job_title})") @@ -170,7 +170,7 @@ async def example_5_search_users(): async with Office365usersClient(CONNECTION_RUNTIME_URL, credential) as client: try: - results = [item async for item in client.search_user_async( + results = [item async for item in client.list_search_user( search_term=search_term, top=10, )] @@ -193,7 +193,7 @@ async def example_5_search_users(): async def main(): """Run all examples.""" - print("Office 365 Users Connector SDK - Sample Usage") + print("Office 365 Users sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_onedrive.py b/samples/sample_connector_usage/sample_connector_usage_onedrive.py index 68cc2839..b0bd6998 100644 --- a/samples/sample_connector_usage/sample_connector_usage_onedrive.py +++ b/samples/sample_connector_usage/sample_connector_usage_onedrive.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -OneDrive Connector SDK Sample +OneDrive sample for the Azure Connectors Python SDK -This sample demonstrates how to use the OneDrive connector SDK. +This sample demonstrates how to use the OneDrive client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with OneDrive connection @@ -41,11 +41,11 @@ async def example_1_list_root_folder(): async with DefaultAzureCredential() as credential: async with OnedriveClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.list_root_folder_async() + items = [item async for item in client.list_root_folder()] - if result and "value" in result: - print(f"Found {len(result['value'])} items in root folder:") - for item in result["value"][:10]: # Show first 10 + if items: + print(f"Found {len(items)} items in root folder:") + for item in items[:10]: # Show first 10 item_type = "📁" if item.get("IsFolder") else "📄" print(f" {item_type} {item.get('Name', 'N/A')}") else: @@ -66,7 +66,7 @@ async def example_2_get_file_metadata(): async with OnedriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: - metadata = await client.get_file_metadata_by_path_async(path=file_path) + metadata = await client.get_file_metadata_by_path(path=file_path) if metadata: print(f"File Metadata for '{file_path}':") @@ -94,7 +94,7 @@ async def example_3_download_file(): async with OnedriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: - content = await client.get_file_content_by_path_async(path=file_path) + content = await client.get_file_content_by_path(path=file_path) if content: print(f"Downloaded {len(content)} bytes") @@ -117,7 +117,7 @@ async def example_4_list_folder(): folder_id = os.environ.get("TEST_FOLDER_ID", "") if not folder_id: print("Set TEST_FOLDER_ID environment variable to a folder ID.") - print("You can get folder IDs from list_root_folder_async results.") + print("You can get folder IDs from list_root_folder results.") return async with DefaultAzureCredential() as credential: @@ -125,7 +125,7 @@ async def example_4_list_folder(): async with OnedriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: entries = [ - item async for item in client.list_folder_async(id=folder_id) + item async for item in client.list_folder(id=folder_id) ] if entries: @@ -155,15 +155,15 @@ async def example_5_search_files(): async with OnedriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.find_files_async( + items = [item async for item in client.list_find_files( id=folder_id, query=search_query, find_mode="search" - ) + )] - if result and "value" in result: - print(f"Found {len(result['value'])} files matching '{search_query}':") - for item in result["value"]: + if items: + print(f"Found {len(items)} files matching '{search_query}':") + for item in items: print(f" 📄 {item.get('Name', 'N/A')}") else: print(f"No files found matching '{search_query}'.") @@ -184,7 +184,7 @@ async def example_6_create_share_link(): async with OnedriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.create_share_link_async( + result = await client.create_share_link( id=file_id, type_="view" # "view" or "edit" ) @@ -212,21 +212,23 @@ async def example_7_file_tags(): async with OnedriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: # Get existing tags - tags_result = await client.get_file_tags_async(id=file_id) + tags_items = [item async for item in client.list_file_tags(id=file_id)] - if tags_result and "tags" in tags_result: - print(f"Current tags: {', '.join(tags_result['tags'])}") + if tags_items: + print(f"Current tags: {tags_items}") else: print("No tags found on file.") # Add a new tag print("Adding tag 'sdk-sample'...") - await client.add_file_tag_async(id=file_id, tag="sdk-sample") + added_tags = await client.add_file_tag(id=file_id, tag="sdk-sample") + if added_tags: + print(f"Add tag result: {added_tags}") # Get updated tags - tags_result = await client.get_file_tags_async(id=file_id) - if tags_result and "tags" in tags_result: - print(f"Updated tags: {', '.join(tags_result['tags'])}") + tags_items = [item async for item in client.list_file_tags(id=file_id)] + if tags_items: + print(f"Updated tags: {tags_items}") except ConnectorException as e: print(f"Error managing tags: {e}") @@ -246,7 +248,7 @@ async def example_8_copy_file(): async with OnedriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.copy_drive_file_async( + result = await client.copy_drive_file( id=file_id, destination=dest_folder, overwrite=False @@ -275,7 +277,7 @@ async def main(): print(f"$env:ONEDRIVE_CONNECTION_URL = '{url_example}'") return - print("OneDrive Connector SDK Sample") + print("OneDrive sample for the Azure Connectors Python SDK") print("=" * 50) print(f"Connection URL: {CONNECTION_RUNTIME_URL[:50]}...") diff --git a/samples/sample_connector_usage/sample_connector_usage_onedriveforbusiness.py b/samples/sample_connector_usage/sample_connector_usage_onedriveforbusiness.py index eac3ba7a..2ce7d230 100644 --- a/samples/sample_connector_usage/sample_connector_usage_onedriveforbusiness.py +++ b/samples/sample_connector_usage/sample_connector_usage_onedriveforbusiness.py @@ -1,6 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. -"""OneDrive for Business Connector SDK sample.""" +"""OneDrive for Business sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -19,8 +19,8 @@ async def example_list_root_folder() -> None: async with DefaultAzureCredential() as credential: async with OnedriveforbusinessClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.list_root_folder_async() - values = result.get("value", []) if result else [] + items = [item async for item in client.list_root_folder()] + values = items print(f"Found {len(values)} items in root folder.") @@ -30,7 +30,7 @@ async def example_get_file_metadata() -> None: async with DefaultAzureCredential() as credential: async with OnedriveforbusinessClient(CONNECTION_RUNTIME_URL, credential) as client: - metadata = await client.get_file_metadata_by_path_async(path=file_path) + metadata = await client.get_file_metadata_by_path(path=file_path) if metadata: print(f"Name: {metadata.get('name')}, Size: {metadata.get('size')} bytes") else: @@ -47,7 +47,7 @@ async def example_create_share_link() -> None: async with DefaultAzureCredential() as credential: async with OnedriveforbusinessClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.create_share_link_async(id=file_id, type_="view") + result = await client.create_share_link(id=file_id, type_="view") if result: print(f"Share URL: {result.get('webUrl')}") else: diff --git a/samples/sample_connector_usage/sample_connector_usage_onenote.py b/samples/sample_connector_usage/sample_connector_usage_onenote.py index a625e651..8b569233 100644 --- a/samples/sample_connector_usage/sample_connector_usage_onenote.py +++ b/samples/sample_connector_usage/sample_connector_usage_onenote.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -OneNote Connector SDK Sample +OneNote sample for the Azure Connectors Python SDK -This sample demonstrates how to use the OneNote connector SDK +This sample demonstrates how to use the OneNote client from the Azure Connectors Python SDK for notebook, section, and page operations. Prerequisites: @@ -25,8 +25,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.onenote import OnenoteClient from azure.connectors.onenote import ( - OnenoteClient, CreateSectionRequest, ) @@ -46,10 +46,10 @@ async def example_1_list_notebooks(): async with OnenoteClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_notebooks_async() + items = [item async for item in client.list_notebooks()] - if result and "value" in result: - notebooks = result["value"] + if items: + notebooks = items print(f"Found {len(notebooks)} notebooks:") for nb in notebooks[:5]: print(f" - {nb.get('fileName', 'N/A')} (key: {nb.get('key', 'N/A')})") @@ -73,12 +73,12 @@ async def example_2_list_sections(): async with OnenoteClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_sections_in_notebook_async( + items = [item async for item in client.list_sections_in_notebook( notebook_key=NOTEBOOK_KEY - ) + )] - if result and "value" in result: - sections = result["value"] + if items: + sections = items print(f"Found {len(sections)} sections:") for section in sections[:5]: print(f" - {section.get('name', 'N/A')} (id: {section.get('id', 'N/A')})") @@ -103,7 +103,7 @@ async def example_3_get_pages_in_section(): async with OnenoteClient(CONNECTION_RUNTIME_URL, credential) as client: try: - pages = [item async for item in client.get_pages_in_section_async( + pages = [item async for item in client.list_pages_in_section( notebook_key=NOTEBOOK_KEY, section_id=SECTION_ID )] @@ -134,7 +134,7 @@ async def example_4_create_section(): try: section_request = CreateSectionRequest(name="SDK Test Section") - result = await client.create_section_in_notebook_async( + result = await client.create_section_in_notebook( input=section_request, notebook_key=NOTEBOOK_KEY ) @@ -165,7 +165,7 @@ async def example_5_create_quick_note(): "

Created via Azure Connectors Python SDK

" ) - result = await client.create_page_in_quick_notes_async(input=page_input) + result = await client.create_page_in_quick_notes(input=page_input) if result: print("Quick note created successfully!") @@ -193,7 +193,7 @@ async def example_6_get_page_content(): async with OnenoteClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_page_content_async( + result = await client.get_page_content( notebook_key=NOTEBOOK_KEY, section_id=SECTION_ID, page_id=PAGE_ID, diff --git a/samples/sample_connector_usage/sample_connector_usage_orderful.py b/samples/sample_connector_usage/sample_connector_usage_orderful.py index d1901bd7..a2c14f28 100644 --- a/samples/sample_connector_usage/sample_connector_usage_orderful.py +++ b/samples/sample_connector_usage/sample_connector_usage_orderful.py @@ -1,4 +1,4 @@ -"""Orderful connector SDK sample.""" +"""Orderful sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -21,7 +21,7 @@ async def main() -> None: async with DefaultAzureCredential() as credential: try: async with OrderfulClient(CONNECTION_RUNTIME_URL, credential) as client: - await client.list_transactions_async() + await client.list_transactions() print("Transactions requested.") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_outlook.py b/samples/sample_connector_usage/sample_connector_usage_outlook.py index 11078a59..d0463859 100644 --- a/samples/sample_connector_usage/sample_connector_usage_outlook.py +++ b/samples/sample_connector_usage/sample_connector_usage_outlook.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Outlook.com Connector SDK Sample +Outlook.com sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Outlook connector SDK +This sample demonstrates how to use the Outlook client from the Azure Connectors Python SDK to interact with Outlook.com calendars, contacts, and email. Note: This connector is for Outlook.com (personal Microsoft accounts). @@ -29,8 +29,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.outlook import OutlookClient from azure.connectors.outlook import ( - OutlookClient, ClientSendHtmlMessage, ) @@ -50,10 +50,10 @@ async def example_1_list_calendars(): async with OutlookClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.calendar_get_tables_async() + items = [item async for item in client.list_calendar_get_tables()] - if result: - calendars = result.get("value", []) + if items: + calendars = items print(f"Found {len(calendars)} calendar(s):") for cal in calendars: name = cal.get("Name", cal.get("name", "N/A")) @@ -81,10 +81,10 @@ async def example_2_list_contact_folders(): async with OutlookClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.contact_get_tables_async() + items = [item async for item in client.list_contact_get_tables()] - if result: - folders = result.get("value", []) + if items: + folders = items print(f"Found {len(folders)} contact folder(s):") for folder in folders: name = folder.get("Name", folder.get("name", "N/A")) @@ -114,13 +114,13 @@ async def example_3_get_calendar_events(): async with OutlookClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.calendar_get_items_async( + items = [item async for item in client.list_calendar_get_items( table=calendar_id, top=5 # Get up to 5 events - ) + )] - if result: - events = result.get("value", []) + if items: + events = items print(f"Found {len(events)} event(s) in calendar:") for event in events[:5]: subject = event.get("Subject", event.get("subject", "N/A")) @@ -147,13 +147,13 @@ async def example_4_get_contacts(): async with OutlookClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.contact_get_items_async( + items = [item async for item in client.list_contact_get_items( table=folder_id, top=10 # Get up to 10 contacts - ) + )] - if result: - contacts = result.get("value", []) + if items: + contacts = items print(f"Found {len(contacts)} contact(s):") for contact in contacts[:5]: display_name = contact.get("DisplayName", "N/A") @@ -196,7 +196,7 @@ async def example_5_send_email(): importance="Normal" ) - await client.send_email_async(input=email) + await client.send_email(input=email) print("Email sent successfully!") print(f" To: {recipient}") @@ -210,7 +210,7 @@ async def example_5_send_email(): async def main(): """Run all examples.""" - print("Outlook.com Connector SDK - Sample Usage") + print("Outlook.com sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_pdfco.py b/samples/sample_connector_usage/sample_connector_usage_pdfco.py index 2a50c507..b8e5e50d 100644 --- a/samples/sample_connector_usage/sample_connector_usage_pdfco.py +++ b/samples/sample_connector_usage/sample_connector_usage_pdfco.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -PDF.co Connector SDK Sample +PDF.co sample for the Azure Connectors Python SDK -This sample demonstrates how to use the PDF.co connector SDK. +This sample demonstrates how to use the PDF.co client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a PDF.co connection @@ -27,8 +27,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.pdfco import PdfcoClient from azure.connectors.pdfco import ( - PdfcoClient, HtmlToPdfInput, UrlToPdfInput, ) @@ -50,7 +50,7 @@ async def example_1_html_to_pdf(): html="

Hello from PDF.co

", ) - result = await client.html_to_pdf_async(input=request) + result = await client.html_to_pdf(input=request) print(f"HTML to PDF result: {result}") @@ -72,7 +72,7 @@ async def example_2_url_to_pdf(): url="https://example.com", ) - result = await client.url_to_pdf_async(input=request) + result = await client.url_to_pdf(input=request) print(f"URL to PDF result: {result}") diff --git a/samples/sample_connector_usage/sample_connector_usage_pipedrive.py b/samples/sample_connector_usage/sample_connector_usage_pipedrive.py index 2052656b..deca4c0f 100644 --- a/samples/sample_connector_usage/sample_connector_usage_pipedrive.py +++ b/samples/sample_connector_usage/sample_connector_usage_pipedrive.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Pipedrive Connector SDK Sample +Pipedrive sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Pipedrive connector SDK. +This sample demonstrates how to use the Pipedrive client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Pipedrive connection @@ -25,10 +25,10 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.pipedrive import PipedriveClient from azure.connectors.pipedrive import ( AddDealRequest, - PipedriveClient, -) + ) # Connection runtime URL format: # https://[region].azure-apihub.net/apim/pipedrive/[connection-id] @@ -46,9 +46,9 @@ async def example_1_list_deals(): async with PipedriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.list_deals_async() + items = [item async for item in client.list_deals()] - deals = (result or {}).get("data", []) if isinstance(result, dict) else [] + deals = items print(f"Found {len(deals)} deal(s).") except ConnectorException as ex: @@ -65,7 +65,7 @@ async def example_2_get_deal(): async with PipedriveClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_deal_async(deal_id=1) + result = await client.get_deal(deal_id=1) print(f"Deal: {result}") except ConnectorException as ex: @@ -86,7 +86,7 @@ async def example_3_add_deal(): title="Sample deal", ) - result = await client.add_deal_async(input=new_deal) + result = await client.add_deal(input=new_deal) print(f"Created deal: {result}") except ConnectorException as ex: diff --git a/samples/sample_connector_usage/sample_connector_usage_planner.py b/samples/sample_connector_usage/sample_connector_usage_planner.py index a085942b..d0521fe4 100644 --- a/samples/sample_connector_usage/sample_connector_usage_planner.py +++ b/samples/sample_connector_usage/sample_connector_usage_planner.py @@ -1,7 +1,7 @@ """ -Microsoft Planner Connector SDK Sample +Microsoft Planner sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Planner connector SDK. +This sample demonstrates how to use the Planner client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Planner connection @@ -21,8 +21,8 @@ import asyncio import os from azure.identity.aio import DefaultAzureCredential +from azure.connectors.planner import PlannerClient from azure.connectors.planner import ( - PlannerClient, CreateTaskRequest, CreateBucketInput, UpdateTaskRequest, @@ -45,7 +45,7 @@ async def example_1_list_my_tasks(): try: tasks = [ - task async for task in client.list_my_tasks_async() + task async for task in client.list_my_tasks() ] if tasks: @@ -67,11 +67,11 @@ async def example_2_list_group_plans(group_id: str): client = PlannerClient(CONNECTION_RUNTIME_URL, credential) try: - plans = await client.list_group_plans_async(group_id=group_id) + plans = [plan async for plan in client.list_group_plans(group_id=group_id)] - if plans and plans.get('value'): - print(f"Found {len(plans.get('value', []))} plans in group") - for plan in plans.get('value', [])[:5]: # Show first 5 + if plans: + print(f"Found {len(plans)} plans in group") + for plan in plans[:5]: # Show first 5 print(f" - {plan.get('title')} ({plan.get('id')})") else: print("No plans found in group") @@ -89,14 +89,14 @@ async def example_3_get_task_details(task_id: str): try: # Get basic task info - task = await client.get_task_async(id=task_id) + task = await client.get_task(id=task_id) if task: print(f"Task: {task.get('title')}") print(f" - Percent Complete: {task.get('percentComplete')}%") print(f" - Created: {task.get('createdDateTime')}") # Get detailed task info - details = await client.get_task_details_async(id=task_id) + details = await client.get_task_details(id=task_id) if details: print(f" - Description: {details.get('description', 'No description')}") @@ -118,7 +118,7 @@ async def example_4_create_bucket(group_id: str, plan_id: str): plan_id=plan_id ) - bucket = await client.create_bucket_async(input=bucket_input) + bucket = await client.create_bucket(input=bucket_input) if bucket: print(f"Created bucket: {bucket.get('name')} ({bucket.get('id')})") @@ -141,10 +141,10 @@ async def example_5_create_and_update_task(group_id: str, plan_id: str, bucket_i plan_id=plan_id, bucket_id=bucket_id, title="Sample Task from SDK", - priority=5 # Medium priority + priority=5, # Medium priority ) - task = await client.create_task_async(input=task_input) + task = await client.create_task(input=task_input) if task: task_id = task.get('id') @@ -153,16 +153,16 @@ async def example_5_create_and_update_task(group_id: str, plan_id: str, bucket_i # Update the task update_input = UpdateTaskRequest( title="Updated Sample Task", - percent_complete=50 + percent_complete=50, ) - updated = await client.update_task_async(input=update_input, id=task_id) + updated = await client.update_task(input=update_input, id=task_id) if updated: print("Updated task to 50% complete") # Clean up - delete the task - await client.delete_task_async(id=task_id) + await client.delete_task(id=task_id) print("Deleted task") except Exception as ex: @@ -177,7 +177,7 @@ async def example_6_get_plan_details(plan_id: str): client = PlannerClient(CONNECTION_RUNTIME_URL, credential) try: - details = await client.get_plan_details_async(id=plan_id) + details = await client.get_plan_details(id=plan_id) if details: print(f"Plan ID: {details.get('id')}") @@ -194,7 +194,7 @@ async def example_6_get_plan_details(plan_id: str): async def main(): """Run all examples""" - print("Planner Connector SDK - Sample Usage") + print("Planner sample usage for the Azure Connectors Python SDK") print("=" * 50) print() diff --git a/samples/sample_connector_usage/sample_connector_usage_plivo.py b/samples/sample_connector_usage/sample_connector_usage_plivo.py index 02f702d1..b1c8e437 100644 --- a/samples/sample_connector_usage/sample_connector_usage_plivo.py +++ b/samples/sample_connector_usage/sample_connector_usage_plivo.py @@ -1,4 +1,4 @@ -"""Plivo connector SDK sample.""" +"""Plivo sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -6,7 +6,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.plivo import PlivoClient, SMS +from azure.connectors.plivo import PlivoClient +from azure.connectors.plivo import SMS CONNECTION_RUNTIME_URL = os.environ.get("PLIVO_CONNECTION_URL", "") @@ -16,7 +17,7 @@ async def send_sms() -> None: """Send an SMS message.""" async with DefaultAzureCredential() as credential: async with PlivoClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.send_sms_async( + result = await client.send_sms( input=SMS( src="15550000000", dst="15551111111", @@ -31,7 +32,10 @@ async def list_messages() -> None: """List messages for an account.""" async with DefaultAzureCredential() as credential: async with PlivoClient(CONNECTION_RUNTIME_URL, credential) as client: - messages = await client.list_messages_async(auth_id="PLIVO_AUTH_ID") + messages = [ + message + async for message in client.list_messages(auth_id="PLIVO_AUTH_ID") + ] print(f"Messages: {messages}") diff --git a/samples/sample_connector_usage/sample_connector_usage_plumsail.py b/samples/sample_connector_usage/sample_connector_usage_plumsail.py index 175cef69..1a084ede 100644 --- a/samples/sample_connector_usage/sample_connector_usage_plumsail.py +++ b/samples/sample_connector_usage/sample_connector_usage_plumsail.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Plumsail Connector SDK Sample +Plumsail sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Plumsail connector SDK. +This sample demonstrates how to use the Plumsail client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Plumsail connection @@ -27,8 +27,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.plumsail import PlumsailClient from azure.connectors.plumsail import ( - PlumsailClient, Pdf2TextRequest, ) @@ -45,7 +45,7 @@ async def example_1_get_profile(): async with PlumsailClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.profiles_me_get_async() + result = await client.profiles_me_get() print(f"Profile result: {result}") @@ -68,9 +68,10 @@ async def example_2_extract_text_from_pdf(): result_type="Raw", ) - result = await client.flow_v1_documents_jobs_extract_text_from_pdf_async( + poller = await client.begin_flow_v1_documents_jobs_extract_text_from_pdf( input=request, ) + result = await poller.result() print(f"Extracted text result: {result}") diff --git a/samples/sample_connector_usage/sample_connector_usage_powerbi.py b/samples/sample_connector_usage/sample_connector_usage_powerbi.py index 207fd6c3..3fcccdcd 100644 --- a/samples/sample_connector_usage/sample_connector_usage_powerbi.py +++ b/samples/sample_connector_usage/sample_connector_usage_powerbi.py @@ -1,7 +1,7 @@ """ -Power BI Connector SDK Sample +Power BI sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Power BI connector SDK. +This sample demonstrates how to use the Power BI client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Power BI connection @@ -38,8 +38,8 @@ async def example_1_list_groups() -> list[dict]: async with DefaultAzureCredential() as credential: async with PowerbiClient(CONNECTION_RUNTIME_URL, credential) as client: - groups_response = await client.list_groups_async() - groups = groups_response.get("value", []) if groups_response else [] + groups_response = [item async for item in client.list_groups()] + groups = groups_response print(f"Found {len(groups)} groups") for group in groups[:5]: @@ -54,8 +54,8 @@ async def example_2_list_datasets(group_id: str) -> list[dict]: async with DefaultAzureCredential() as credential: async with PowerbiClient(CONNECTION_RUNTIME_URL, credential) as client: - datasets_response = await client.list_datasets_async(groupid=group_id) - datasets = datasets_response.get("value", []) if datasets_response else [] + datasets_response = [item async for item in client.list_datasets(groupid=group_id)] + datasets = datasets_response print(f"Found {len(datasets)} datasets in group '{group_id}'") for dataset in datasets[:5]: @@ -70,7 +70,7 @@ async def example_3_refresh_dataset(group_id: str, dataset_id: str) -> None: async with DefaultAzureCredential() as credential: async with PowerbiClient(CONNECTION_RUNTIME_URL, credential) as client: - await client.refresh_dataset_async(groupid=group_id, datasetid=dataset_id) + await client.refresh_dataset(groupid=group_id, datasetid=dataset_id) print(f"Refresh requested for dataset '{dataset_id}'") @@ -81,7 +81,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Power BI Connector SDK - Sample Usage") + print("Power BI sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_projectplace.py b/samples/sample_connector_usage/sample_connector_usage_projectplace.py index 5ebace40..e08833be 100644 --- a/samples/sample_connector_usage/sample_connector_usage_projectplace.py +++ b/samples/sample_connector_usage/sample_connector_usage_projectplace.py @@ -1,7 +1,7 @@ """ -Projectplace Connector SDK Sample +Projectplace sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Projectplace connector SDK. +This sample demonstrates how to use the Projectplace client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Projectplace connection @@ -24,11 +24,11 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.projectplace import ProjectplaceClient from azure.connectors.projectplace import ( CreateCardInput, MoveCardInput, - ProjectplaceClient, -) + ) # Connection runtime URL format: @@ -42,7 +42,7 @@ async def example_1_list_boards() -> None: async with DefaultAzureCredential() as credential: async with ProjectplaceClient(CONNECTION_RUNTIME_URL, credential) as client: - boards = await client.list_boards_async() + boards = [item async for item in client.list_boards()] print(f"Boards: {boards}") @@ -52,7 +52,7 @@ async def example_2_create_card() -> None: async with DefaultAzureCredential() as credential: async with ProjectplaceClient(CONNECTION_RUNTIME_URL, credential) as client: - card = await client.create_card_async( + card = await client.create_card( input=CreateCardInput( column_id=123456, title="SDK sample card", @@ -69,7 +69,7 @@ async def example_3_move_card() -> None: async with DefaultAzureCredential() as credential: async with ProjectplaceClient(CONNECTION_RUNTIME_URL, credential) as client: - card = await client.move_card_async( + card = await client.move_card( input=MoveCardInput(card_id=123456, column_id=654321), board_id=789012, ) @@ -83,7 +83,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Projectplace Connector SDK - Sample Usage") + print("Projectplace sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_replicon.py b/samples/sample_connector_usage/sample_connector_usage_replicon.py index 33f69528..e778b060 100644 --- a/samples/sample_connector_usage/sample_connector_usage_replicon.py +++ b/samples/sample_connector_usage/sample_connector_usage_replicon.py @@ -1,4 +1,4 @@ -"""Replicon connector SDK sample.""" +"""Replicon sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -21,7 +21,7 @@ async def main() -> None: async with DefaultAzureCredential() as credential: try: async with RepliconClient(CONNECTION_RUNTIME_URL, credential) as client: - endpoint = await client.get_my_tenant_endpoint_details_async() + endpoint = await client.get_my_tenant_endpoint_details() print(f"Tenant endpoint: {endpoint}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_revai.py b/samples/sample_connector_usage/sample_connector_usage_revai.py index c692c2f1..52aaa071 100644 --- a/samples/sample_connector_usage/sample_connector_usage_revai.py +++ b/samples/sample_connector_usage/sample_connector_usage_revai.py @@ -1,4 +1,4 @@ -"""Rev.ai connector SDK sample.""" +"""Rev.ai sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -6,7 +6,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.revai import RevaiClient, TranscriptionInput +from azure.connectors.revai import RevaiClient +from azure.connectors.revai import TranscriptionInput CONNECTION_RUNTIME_URL = os.environ.get("REVAI_CONNECTION_URL", "") @@ -16,7 +17,7 @@ async def get_account() -> None: """Get account information.""" async with DefaultAzureCredential() as credential: async with RevaiClient(CONNECTION_RUNTIME_URL, credential) as client: - account = await client.account_get_async() + account = await client.account_get() print(f"Account: {account}") @@ -24,10 +25,11 @@ async def submit_transcription() -> None: """Submit an audio file for transcription.""" async with DefaultAzureCredential() as credential: async with RevaiClient(CONNECTION_RUNTIME_URL, credential) as client: - job = await client.transcription_async( + job = await client.transcription( input=TranscriptionInput( source_config={"url": "https://example.com/audio.wav"}, metadata="connector-sdk-sample", + notification_config={"url": "https://example.com/webhook"}, ), ) print(f"Transcription job: {job}") diff --git a/samples/sample_connector_usage/sample_connector_usage_rss.py b/samples/sample_connector_usage/sample_connector_usage_rss.py index b7094b94..48ced8b6 100644 --- a/samples/sample_connector_usage/sample_connector_usage_rss.py +++ b/samples/sample_connector_usage/sample_connector_usage_rss.py @@ -20,18 +20,17 @@ async def main() -> None: async with DefaultAzureCredential() as credential: async with RssClient(connection_url, credential) as client: - items = await client.list_feed_items_async( + items = [item async for item in client.list_feed_items( feed_url=feed_url, since_property="PublishDate", - ) + )] print(f"Retrieved {len(items or [])} item(s) from '{feed_url}'.") - latest_items = await client.list_feed_items_async( + latest_items = [item async for item in client.list_feed_items( feed_url=feed_url, since_property="PublishDate", - ) - values = (latest_items or {}).get("value", []) - print(f"Polling query returned {len(values)} item(s).") + )] + print(f"Polling query returned {len(latest_items)} item(s).") if __name__ == "__main__": diff --git a/samples/sample_connector_usage/sample_connector_usage_salesforce.py b/samples/sample_connector_usage/sample_connector_usage_salesforce.py index 44b3445a..9402192f 100644 --- a/samples/sample_connector_usage/sample_connector_usage_salesforce.py +++ b/samples/sample_connector_usage/sample_connector_usage_salesforce.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Salesforce Connector SDK Sample +Salesforce sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Salesforce connector SDK. +This sample demonstrates how to use the Salesforce client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Salesforce connection @@ -26,7 +26,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.salesforce import ExecuteSoqlQueryParameters, SalesforceClient +from azure.connectors.salesforce import SalesforceClient +from azure.connectors.salesforce import ExecuteSoqlQueryParameters # Connection runtime URL format: # https://[region].azure-apihub.net/apim/salesforce/[connection-id] @@ -44,7 +45,7 @@ async def example_1_get_tables(): async with SalesforceClient(CONNECTION_RUNTIME_URL, credential) as client: try: - tables = [item async for item in client.get_tables_async()] + tables = [item async for item in client.list_tables()] if tables: print(f"Found {len(tables)} table(s):") @@ -70,7 +71,7 @@ async def example_2_get_records(): async with SalesforceClient(CONNECTION_RUNTIME_URL, credential) as client: try: - records = [item async for item in client.get_items_async( + records = [item async for item in client.list_items( table="account", top=5, select="Id,Name,Phone", @@ -103,7 +104,7 @@ async def example_3_execute_soql(): query_input = ExecuteSoqlQueryParameters( query="SELECT Id, Name FROM Account LIMIT 5", ) - result = await client.execute_soql_query_async(input=query_input) + result = await client.execute_soql_query(input=query_input) if result: records = result.get("records", []) diff --git a/samples/sample_connector_usage/sample_connector_usage_seismicplanner.py b/samples/sample_connector_usage/sample_connector_usage_seismicplanner.py index a37e224a..350eabdd 100644 --- a/samples/sample_connector_usage/sample_connector_usage_seismicplanner.py +++ b/samples/sample_connector_usage/sample_connector_usage_seismicplanner.py @@ -1,4 +1,4 @@ -"""Seismic Planner connector SDK sample.""" +"""Seismic Planner sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -25,7 +25,10 @@ async def main() -> None: CONNECTION_RUNTIME_URL, credential, ) as client: - projects = await client.get_projects_async(space_id=SPACE_ID) + projects = [ + project + async for project in client.list_projects(space_id=SPACE_ID) + ] print(f"Projects: {projects}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_sendgrid.py b/samples/sample_connector_usage/sample_connector_usage_sendgrid.py index 9b68e576..bc45e4b7 100644 --- a/samples/sample_connector_usage/sample_connector_usage_sendgrid.py +++ b/samples/sample_connector_usage/sample_connector_usage_sendgrid.py @@ -1,7 +1,7 @@ """ -SendGrid Connector SDK Sample +SendGrid sample for the Azure Connectors Python SDK -This sample demonstrates how to use the SendGrid connector SDK. +This sample demonstrates how to use the SendGrid client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a SendGrid connection @@ -24,10 +24,10 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.sendgrid import SendgridClient from azure.connectors.sendgrid import ( EmailRequest, - SendgridClient, -) + ) # Connection runtime URL format: @@ -41,12 +41,13 @@ async def example_1_send_email() -> None: async with DefaultAzureCredential() as credential: async with SendgridClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.send_email_async( + result = await client.send_email( input=EmailRequest( from_="sender@example.com", to="recipient@example.com", subject="Hello from the SDK sample", - text="This message was sent via the SendGrid connector SDK.", + text="This message was sent via the SendGrid client from the Azure Connectors Python SDK.", + ishtml=False, ), ) print(f"Send result: {result}") @@ -58,7 +59,7 @@ async def example_2_list_recipient_lists() -> None: async with DefaultAzureCredential() as credential: async with SendgridClient(CONNECTION_RUNTIME_URL, credential) as client: - lists = await client.list_recipient_lists_async() + lists = [item async for item in client.list_recipient_lists()] print(f"Recipient lists: {lists}") @@ -68,7 +69,7 @@ async def example_3_list_recipients() -> None: async with DefaultAzureCredential() as credential: async with SendgridClient(CONNECTION_RUNTIME_URL, credential) as client: - recipients = await client.list_recipients_async() + recipients = [item async for item in client.list_recipients()] print(f"Recipients: {recipients}") @@ -78,7 +79,7 @@ async def example_4_get_bounce() -> None: async with DefaultAzureCredential() as credential: async with SendgridClient(CONNECTION_RUNTIME_URL, credential) as client: - bounce = await client.get_bounce_async(email="recipient@example.com") + bounce = [item async for item in client.list_bounce(email="recipient@example.com")] print(f"Bounce: {bounce}") @@ -89,7 +90,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("SendGrid Connector SDK - Sample Usage") + print("SendGrid sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_servicebus.py b/samples/sample_connector_usage/sample_connector_usage_servicebus.py index 74ba5bf1..1e923b6d 100644 --- a/samples/sample_connector_usage/sample_connector_usage_servicebus.py +++ b/samples/sample_connector_usage/sample_connector_usage_servicebus.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Service Bus Connector SDK Sample +Azure Service Bus sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Azure Service Bus connector SDK +This sample demonstrates how to use the Azure Service Bus client from the Azure Connectors Python SDK to send and receive messages from Azure Service Bus queues and topics. Prerequisites: @@ -30,8 +30,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.servicebus import ServicebusClient from azure.connectors.servicebus import ( - ServicebusClient, ServiceBusMessage, ) @@ -74,7 +74,7 @@ async def example_1_send_message_to_queue(): correlation_id="corr-abc-123" ) - await client.send_message_async( + await client.send_message( input=message, entity_name=QUEUE_NAME ) @@ -102,11 +102,11 @@ async def example_2_receive_message_from_queue(): async with ServicebusClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_messages_from_queue_with_peek_lock_async( + items = [item async for item in client.list_messages_from_queue_with_peek_lock( queue_name=QUEUE_NAME, max_message_count=1, - ) - messages = result.get("value", []) if result else [] + )] + messages = items if messages: message = messages[0] @@ -137,11 +137,11 @@ async def example_3_receive_with_peek_lock(): async with ServicebusClient(CONNECTION_RUNTIME_URL, credential) as client: try: # Receive message with peek-lock (message is locked, not removed) - result = await client.get_messages_from_queue_with_peek_lock_async( + items = [item async for item in client.list_messages_from_queue_with_peek_lock( queue_name=QUEUE_NAME, max_message_count=1, - ) - messages = result.get("value", []) if result else [] + )] + messages = items if messages: message = messages[0] @@ -155,7 +155,7 @@ async def example_3_receive_with_peek_lock(): # Complete the message (remove from queue) if lock_token: - await client.complete_message_in_queue_async( + await client.complete_message_in_queue( queue_name=QUEUE_NAME, lock_token=lock_token, ) @@ -181,11 +181,11 @@ async def example_4_receive_and_abandon(): async with ServicebusClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_messages_from_queue_with_peek_lock_async( + items = [item async for item in client.list_messages_from_queue_with_peek_lock( queue_name=QUEUE_NAME, max_message_count=1, - ) - messages = result.get("value", []) if result else [] + )] + messages = items if messages: message = messages[0] @@ -195,7 +195,7 @@ async def example_4_receive_and_abandon(): # Abandon the message (return to queue for retry) if lock_token: - await client.abandon_message_in_queue_async( + await client.abandon_message_in_queue( queue_name=QUEUE_NAME, lock_token=lock_token, ) @@ -232,7 +232,7 @@ async def example_5_send_message_to_topic(): label="user-event" ) - await client.send_message_async( + await client.send_message( input=message, entity_name=TOPIC_NAME ) @@ -258,12 +258,12 @@ async def example_6_receive_from_topic_subscription(): async with ServicebusClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_messages_from_topic_with_peek_lock_async( + items = [item async for item in client.list_messages_from_topic_with_peek_lock( topic_name=TOPIC_NAME, subscription_name=SUBSCRIPTION_NAME, max_message_count=1, - ) - messages = result.get("value", []) if result else [] + )] + messages = items if messages: message = messages[0] @@ -291,11 +291,11 @@ async def example_7_dead_letter_message(): async with ServicebusClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_messages_from_queue_with_peek_lock_async( + items = [item async for item in client.list_messages_from_queue_with_peek_lock( queue_name=QUEUE_NAME, max_message_count=1, - ) - messages = result.get("value", []) if result else [] + )] + messages = items if messages: message = messages[0] @@ -305,7 +305,7 @@ async def example_7_dead_letter_message(): # Move to dead-letter queue if lock_token: - await client.dead_letter_message_in_queue_async( + await client.dead_letter_message_in_queue( queue_name=QUEUE_NAME, lock_token=lock_token, dead_letter_reason="Processing failed", @@ -333,11 +333,11 @@ async def example_8_batch_receive(): async with ServicebusClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_messages_from_queue_with_peek_lock_async( + items = [item async for item in client.list_messages_from_queue_with_peek_lock( queue_name=QUEUE_NAME, max_message_count=5, - ) - messages = result.get("value", []) if result else [] + )] + messages = items if messages: print(f"Received {len(messages)} messages from '{QUEUE_NAME}':") diff --git a/samples/sample_connector_usage/sample_connector_usage_sharepoint.py b/samples/sample_connector_usage/sample_connector_usage_sharepoint.py index 30db7371..c83d442e 100644 --- a/samples/sample_connector_usage/sample_connector_usage_sharepoint.py +++ b/samples/sample_connector_usage/sample_connector_usage_sharepoint.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -SharePoint Online Connector SDK Sample +SharePoint Online sample for the Azure Connectors Python SDK -This sample demonstrates how to use the SharePoint Online connector SDK. +This sample demonstrates how to use the SharePoint Online client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with SharePoint Online connection @@ -30,11 +30,11 @@ try: from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException + from azure.connectors.sharepointonline import SharepointonlineClient from azure.connectors.sharepointonline import ( PatchItemInput, PostItemInput, - SharepointonlineClient, - ) + ) IMPORTS_AVAILABLE = True except ImportError as import_error: IMPORTS_AVAILABLE = False @@ -63,16 +63,16 @@ async def example_1_get_lists(): async with SharepointonlineClient(CONNECTION_RUNTIME_URL, credential) as client: try: - lists = await client.get_tables_async(dataset=SHAREPOINT_SITE_URL) + lists = [item async for item in client.list_tables(dataset=SHAREPOINT_SITE_URL)] - if lists and 'value' in lists: - print(f"Found {len(lists['value'])} lists and libraries:") - for list_item in lists['value'][:5]: + if lists: + print(f"Found {len(lists)} lists and libraries:") + for list_item in lists[:5]: display_name = list_item.get('DisplayName', 'Unknown') name = list_item.get('Name', 'Unknown') print(f" - {display_name} ({name})") else: - print("No lists found or unexpected response format.") + print("No lists found.") except ConnectorException as ex: print(f"Connector error: {ex}") @@ -91,7 +91,7 @@ async def example_2_get_list_items(): async with SharepointonlineClient(CONNECTION_RUNTIME_URL, credential) as client: try: - items = [item async for item in client.get_items_async( + items = [item async for item in client.list_items( dataset=SHAREPOINT_SITE_URL, table=list_name, )] @@ -129,7 +129,7 @@ async def example_3_create_list_item(): additional_properties={'Title': 'Test Task from Python SDK'}, ) - created = await client.post_item_async( + created = await client.post_item( dataset=SHAREPOINT_SITE_URL, table=list_name, input=new_item, @@ -141,7 +141,7 @@ async def example_3_create_list_item(): print(f"Title: {created.get('Title', 'N/A')}") # Clean up: delete the item we just created - await client.delete_item_async( + await client.delete_item( dataset=SHAREPOINT_SITE_URL, table=list_name, id=int(item_id), @@ -173,7 +173,7 @@ async def example_4_update_list_item(): new_item = PostItemInput( additional_properties={'Title': 'Task to Update'}, ) - created = await client.post_item_async( + created = await client.post_item( dataset=SHAREPOINT_SITE_URL, table=list_name, input=new_item, @@ -183,7 +183,7 @@ async def example_4_update_list_item(): # READ print("Reading item...") - item = await client.get_item_async( + item = await client.get_item( dataset=SHAREPOINT_SITE_URL, table=list_name, id=int(item_id), @@ -195,7 +195,7 @@ async def example_4_update_list_item(): updates = PatchItemInput( additional_properties={'Title': 'Updated Task Title'}, ) - await client.patch_item_async( + await client.patch_item( dataset=SHAREPOINT_SITE_URL, table=list_name, id=int(item_id), @@ -203,7 +203,7 @@ async def example_4_update_list_item(): ) # Verify update - updated_item = await client.get_item_async( + updated_item = await client.get_item( dataset=SHAREPOINT_SITE_URL, table=list_name, id=int(item_id), @@ -212,7 +212,7 @@ async def example_4_update_list_item(): # DELETE print("Deleting item...") - await client.delete_item_async( + await client.delete_item( dataset=SHAREPOINT_SITE_URL, table=list_name, id=int(item_id), @@ -239,7 +239,7 @@ async def example_5_query_with_filters(): # Create some test items first print("Creating test items...") for i in range(3): - await client.post_item_async( + await client.post_item( dataset=SHAREPOINT_SITE_URL, table=list_name, input=PostItemInput( @@ -250,7 +250,7 @@ async def example_5_query_with_filters(): # Query with filters print("\nQuerying items (ordered by creation date, top 5)...") - items = [item async for item in client.get_items_async( + items = [item async for item in client.list_items( dataset=SHAREPOINT_SITE_URL, table=list_name, filter=None, @@ -264,12 +264,14 @@ async def example_5_query_with_filters(): title = item.get('Title', 'No Title') created = item.get('Created', 'Unknown') print(f" - {title} (Created: {created})") + else: + print("No items found.") # Clean up test items print("\nCleaning up test items...") for item in items[:3]: if 'Test Item' in item.get('Title', ''): - await client.delete_item_async( + await client.delete_item( dataset=SHAREPOINT_SITE_URL, table=list_name, id=int(item['Id']), @@ -293,28 +295,28 @@ async def example_6_file_operations(): try: # List root folder print("Listing root folder...") - root_folder = await client.list_root_folder_async(dataset=SHAREPOINT_SITE_URL) + root_folder = [item async for item in client.list_root_folder(dataset=SHAREPOINT_SITE_URL)] - if root_folder and 'value' in root_folder: - print(f"Found {len(root_folder['value'])} items in root folder:") - for item in root_folder['value'][:5]: + if root_folder: + print(f"Found {len(root_folder)} items in root folder:") + for item in root_folder[:5]: name = item.get('Name', 'Unknown') is_folder = item.get('IsFolder', False) item_type = 'Folder' if is_folder else 'File' print(f" - {name} ({item_type})") else: - print("Root folder is empty or unexpected response format.") + print("Root folder is empty.") # List a specific folder (Shared Documents is common) print("\nListing 'Shared Documents' folder...") - folder = await client.list_folder_async( + folder = [item async for item in client.list_folder( dataset=SHAREPOINT_SITE_URL, id='/Shared Documents', - ) + )] - if folder and 'value' in folder: - print(f"Found {len(folder['value'])} items in Shared Documents:") - for item in folder['value'][:5]: + if folder: + print(f"Found {len(folder)} items in Shared Documents:") + for item in folder[:5]: name = item.get('Name', 'Unknown') is_folder = item.get('IsFolder', False) size = item.get('Size', 0) @@ -342,7 +344,7 @@ async def example_7_error_handling(): invalid_item_id = 99999 list_name = os.environ.get("TEST_LIST_NAME", "Tasks") - item = await client.get_item_async( + item = await client.get_item( dataset=SHAREPOINT_SITE_URL, table=list_name, id=invalid_item_id, @@ -359,7 +361,7 @@ async def example_7_error_handling(): async def main(): """Run all examples.""" - print("SharePoint Online Connector SDK - Sample Usage") + print("SharePoint Online sample usage for the Azure Connectors Python SDK") print("=" * 50) print() diff --git a/samples/sample_connector_usage/sample_connector_usage_shifts.py b/samples/sample_connector_usage/sample_connector_usage_shifts.py index 49b179b0..29235cc6 100644 --- a/samples/sample_connector_usage/sample_connector_usage_shifts.py +++ b/samples/sample_connector_usage/sample_connector_usage_shifts.py @@ -1,7 +1,7 @@ """ -Shifts Connector SDK Sample +Shifts sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Shifts connector SDK. +This sample demonstrates how to use the Shifts client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Shifts connection @@ -38,8 +38,7 @@ async def example_1_list_teams() -> list[dict]: async with DefaultAzureCredential() as credential: async with ShiftsClient(CONNECTION_RUNTIME_URL, credential) as client: - teams_response = await client.get_all_teams_async() - teams = teams_response.get("value", []) if teams_response else [] + teams = [team async for team in client.list_all_teams()] print(f"Found {len(teams)} teams") for team in teams[:10]: @@ -54,7 +53,7 @@ async def example_2_get_schedule(team_id: str) -> None: async with DefaultAzureCredential() as credential: async with ShiftsClient(CONNECTION_RUNTIME_URL, credential) as client: - schedule = await client.get_schedule_async(team_id=team_id) + schedule = await client.get_schedule(team_id=team_id) if not schedule: print("No schedule returned") @@ -71,7 +70,7 @@ async def example_3_list_shifts(team_id: str) -> None: async with DefaultAzureCredential() as credential: async with ShiftsClient(CONNECTION_RUNTIME_URL, credential) as client: - shifts_response = [item async for item in client.list_shifts_async(team_id=team_id, top=10)] + shifts_response = [item async for item in client.list_shifts(team_id=team_id, top=10)] shifts = shifts_response if shifts_response else [] print(f"Found {len(shifts)} shifts") @@ -86,7 +85,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Shifts Connector SDK - Sample Usage") + print("Shifts sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_signinghub.py b/samples/sample_connector_usage/sample_connector_usage_signinghub.py index ab7e9f0c..2f5b39e3 100644 --- a/samples/sample_connector_usage/sample_connector_usage_signinghub.py +++ b/samples/sample_connector_usage/sample_connector_usage_signinghub.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -SigningHub Connector SDK Sample +SigningHub sample for the Azure Connectors Python SDK -This sample demonstrates how to use the SigningHub connector SDK. +This sample demonstrates how to use the SigningHub client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a SigningHub connection @@ -27,9 +27,10 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.signinghub import SigninghubClient from azure.connectors.signinghub import ( - SigninghubClient, CheckBoxFieldRequest, + FieldDimension, ) # Connection runtime URL format: @@ -45,12 +46,12 @@ async def example_1_get_contacts(): async with SigninghubClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.contacts_get_async( + items = [item async for item in client.list_contacts_get( record_per_page=10, page_no=1, - ) + )] - print(f"Contacts result: {result}") + print(f"Contacts result: {items}") except ConnectorException as ex: print(f"Connector error: {ex}") @@ -66,9 +67,16 @@ async def example_2_add_check_box_field(): async with SigninghubClient(CONNECTION_RUNTIME_URL, credential) as client: try: - request = CheckBoxFieldRequest() + request = CheckBoxFieldRequest( + order=1, + page_no=1, + dimensions=FieldDimension(x=120.0, y=220.0, width=18.0, height=18.0), + field_name="Approve", + value="false", + validation_rule="none", + ) - result = await client.checkbox_add_check_box_async( + result = await client.checkbox_add_check_box( input=request, package_id=12345, document_id=67890, @@ -90,7 +98,7 @@ async def example_3_delete_attachment(): async with SigninghubClient(CONNECTION_RUNTIME_URL, credential) as client: try: - await client.attachment_delete_attachment_async( + await client.attachment_delete_attachment( package_id=12345, document_id=67890, attachment_id=13579, diff --git a/samples/sample_connector_usage/sample_connector_usage_slack.py b/samples/sample_connector_usage/sample_connector_usage_slack.py index 4937b4b2..b71787f8 100644 --- a/samples/sample_connector_usage/sample_connector_usage_slack.py +++ b/samples/sample_connector_usage/sample_connector_usage_slack.py @@ -1,7 +1,7 @@ """ -Slack Connector SDK Sample +Slack sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Slack connector SDK. +This sample demonstrates how to use the Slack client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Slack connection @@ -24,7 +24,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.slack import PostMessageRequest, SlackClient +from azure.connectors.slack import SlackClient +from azure.connectors.slack import PostMessageRequest # Connection runtime URL format: @@ -38,7 +39,7 @@ async def example_1_list_channels() -> None: async with DefaultAzureCredential() as credential: async with SlackClient(CONNECTION_RUNTIME_URL, credential) as client: - channels_response = [item async for item in client.list_channels_async()] + channels_response = [item async for item in client.list_channels()] channels = channels_response if channels_response else [] print(f"Found {len(channels)} channels") @@ -52,7 +53,7 @@ async def example_2_create_channel() -> None: async with DefaultAzureCredential() as credential: async with SlackClient(CONNECTION_RUNTIME_URL, credential) as client: - created = await client.create_channel_async( + created = await client.create_channel( name="sdk-sample-channel", is_private=False, ) @@ -70,9 +71,9 @@ async def example_3_post_message() -> None: channel="#general", text="Hello from Slack Python SDK sample", ) - posted = await client.post_message_async(input=payload) + posted = await client.post_message(input=payload) print( - f"Posted: ok={posted.get('ok') if posted else None}, " + f"Posted result: {posted}; " f"ts={posted.get('ts') if posted else None}" ) @@ -84,7 +85,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Slack Connector SDK - Sample Usage") + print("Slack sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_smtp.py b/samples/sample_connector_usage/sample_connector_usage_smtp.py index f3a6e983..4f0f34f6 100644 --- a/samples/sample_connector_usage/sample_connector_usage_smtp.py +++ b/samples/sample_connector_usage/sample_connector_usage_smtp.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -SMTP Connector SDK Sample +SMTP sample for the Azure Connectors Python SDK -This sample demonstrates how to use the SMTP connector SDK. +This sample demonstrates how to use the SMTP client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with SMTP connection @@ -25,8 +25,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.smtp import SmtpClient from azure.connectors.smtp import ( - SmtpClient, Email, Attachment, ) @@ -63,7 +63,7 @@ async def example_1_send_basic_email(): body="Hello! This is a test email sent via the Azure Connectors SDK for Python.", ) - await client.send_email_async(input=email) + await client.send_email(input=email) print("Email sent successfully:") print(f" From: {sender}") @@ -106,7 +106,7 @@ async def example_2_send_email_with_cc_bcc(): body="This email demonstrates CC and BCC functionality.", ) - await client.send_email_async(input=email) + await client.send_email(input=email) print("Email sent successfully:") print(f" From: {sender}") @@ -169,7 +169,7 @@ async def example_3_send_html_email(): body=html_body.strip(), ) - await client.send_email_async(input=email) + await client.send_email(input=email) print("HTML email sent successfully:") print(f" From: {sender}") @@ -217,7 +217,7 @@ async def example_4_send_email_with_attachment(): attachments=[attachment], ) - await client.send_email_async(input=email) + await client.send_email(input=email) print("Email with attachment sent successfully:") print(f" From: {sender}") @@ -257,7 +257,7 @@ async def example_5_send_email_with_options(): delivery_receipt=sender, ) - await client.send_email_async(input=email) + await client.send_email(input=email) print("Email with options sent successfully:") print(f" From: {sender}") @@ -274,7 +274,7 @@ async def example_5_send_email_with_options(): async def main(): """Run all examples.""" - print("SMTP Connector SDK - Sample Usage") + print("SMTP sample usage for the Azure Connectors Python SDK") print("=" * 60) if not CONNECTION_RUNTIME_URL: diff --git a/samples/sample_connector_usage/sample_connector_usage_sql.py b/samples/sample_connector_usage/sample_connector_usage_sql.py index c57c6b4d..05df873e 100644 --- a/samples/sample_connector_usage/sample_connector_usage_sql.py +++ b/samples/sample_connector_usage/sample_connector_usage_sql.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -SQL Server Connector SDK Sample +SQL Server sample for the Azure Connectors Python SDK -This sample demonstrates how to use the SQL Server connector SDK. +This sample demonstrates how to use the SQL Server client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a SQL Server connection @@ -27,8 +27,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.sql import SqlClient from azure.connectors.sql import ( - SqlClient, ExecuteProcedureInput, PatchItemInput, PostItemInput, @@ -55,24 +55,29 @@ async def example_1_list_servers_and_databases(): async with DefaultAzureCredential() as credential: async with SqlClient(CONNECTION_RUNTIME_URL, credential) as client: - servers = await client.get_servers_async() - server_values = servers.get("value", []) if servers else [] + servers = [item async for item in client.list_servers()] + server_values = servers print(f"Found {len(server_values)} server(s).") if not SERVER: print("Set SQL_SERVER to list databases and tables.") return - databases = await client.get_databases_async(server=SERVER) - database_values = databases.get("value", []) if databases else [] + databases = [item async for item in client.list_databases(server=SERVER)] + database_values = databases print(f"Found {len(database_values)} database(s) on '{SERVER}'.") if not DATABASE: print("Set SQL_DATABASE to list tables.") return - tables = await client.get_tables_async(server=SERVER, database=DATABASE) - table_values = tables.get("value", []) if tables else [] + table_values = [ + table + async for table in client.list_tables( + server=SERVER, + database=DATABASE, + ) + ] print(f"Found {len(table_values)} table(s) in '{DATABASE}'.") for table in table_values[:10]: print(f" - {table.get('DisplayName', table.get('Name', 'N/A'))}") @@ -90,7 +95,7 @@ async def example_2_read_rows(): async with SqlClient(CONNECTION_RUNTIME_URL, credential) as client: try: - rows = [item async for item in client.get_items_async( + rows = [item async for item in client.list_items( server=SERVER, database=DATABASE, table=TABLE, @@ -114,7 +119,7 @@ async def example_3_insert_update_delete_row(): async with SqlClient(CONNECTION_RUNTIME_URL, credential) as client: try: - inserted = await client.post_item_async( + inserted = await client.post_item( input=PostItemInput( additional_properties={"Name": "Contoso", "Status": "Active"}, ), @@ -128,7 +133,7 @@ async def example_3_insert_update_delete_row(): if not row_id: return - await client.patch_item_async( + await client.patch_item( input=PatchItemInput(additional_properties={"Status": "Updated"}), server=SERVER, database=DATABASE, @@ -137,7 +142,7 @@ async def example_3_insert_update_delete_row(): ) print(f"Updated row id: {row_id}") - await client.delete_item_async( + await client.delete_item( server=SERVER, database=DATABASE, table=TABLE, @@ -160,7 +165,7 @@ async def example_4_query_and_procedures(): async with SqlClient(CONNECTION_RUNTIME_URL, credential) as client: try: - query_result = await client.execute_pass_through_native_query_async( + query_result = await client.execute_pass_through_native_query( input=SqlPassThroughNativeQueryBody(query="SELECT TOP 1 * FROM sys.tables"), server=SERVER, database=DATABASE, @@ -168,17 +173,17 @@ async def example_4_query_and_procedures(): result_sets = (query_result or {}).get("resultSets", {}) print(f"Query returned {len(result_sets)} result set(s).") - procedures = await client.get_procedures_v2_async( + procedures = [item async for item in client.list_procedures_v2( server=SERVER, database=DATABASE, - ) - procedure_values = procedures.get("value", []) if procedures else [] + )] + procedure_values = procedures print(f"Found {len(procedure_values)} stored procedure(s).") if procedure_values: procedure_name = procedure_values[0].get("Name") if procedure_name: - await client.execute_procedure_async( + await client.execute_procedure( input=ExecuteProcedureInput(), server=SERVER, database=DATABASE, diff --git a/samples/sample_connector_usage/sample_connector_usage_starmind.py b/samples/sample_connector_usage/sample_connector_usage_starmind.py index 8aa5c7e2..29ead0ec 100644 --- a/samples/sample_connector_usage/sample_connector_usage_starmind.py +++ b/samples/sample_connector_usage/sample_connector_usage_starmind.py @@ -1,4 +1,4 @@ -"""Starmind connector SDK sample.""" +"""Starmind sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -6,7 +6,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.starmind import FindExpertsInput, StarmindClient +from azure.connectors.starmind import StarmindClient +from azure.connectors.starmind import FindExpertsInput CONNECTION_RUNTIME_URL = os.environ.get("STARMIND_CONNECTION_URL", "") @@ -16,7 +17,7 @@ async def find_questions() -> None: """Find questions matching a query.""" async with DefaultAzureCredential() as credential: async with StarmindClient(CONNECTION_RUNTIME_URL, credential) as client: - questions = await client.find_questions_async( + questions = await client.find_questions( query="distributed systems", limit=10, ) @@ -27,7 +28,7 @@ async def find_experts() -> None: """Find experts for a topic.""" async with DefaultAzureCredential() as credential: async with StarmindClient(CONNECTION_RUNTIME_URL, credential) as client: - experts = await client.find_experts_async( + experts = await client.find_experts( input=FindExpertsInput(text_query="distributed systems"), ) print(f"Experts: {experts}") diff --git a/samples/sample_connector_usage/sample_connector_usage_starrezrestv1.py b/samples/sample_connector_usage/sample_connector_usage_starrezrestv1.py index 62a007ff..37814c20 100644 --- a/samples/sample_connector_usage/sample_connector_usage_starrezrestv1.py +++ b/samples/sample_connector_usage/sample_connector_usage_starrezrestv1.py @@ -1,4 +1,4 @@ -"""StarRez REST V1 connector SDK sample.""" +"""StarRez REST V1 sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -6,7 +6,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.starrezrestv1 import SelectBookingInput, Starrezrestv1Client +from azure.connectors.starrezrestv1 import Starrezrestv1Client +from azure.connectors.starrezrestv1 import SelectBookingInput CONNECTION_RUNTIME_URL = os.environ.get("STARREZRESTV1_CONNECTION_URL", "") @@ -24,12 +25,13 @@ async def main() -> None: CONNECTION_RUNTIME_URL, credential, ) as client: - bookings = await client.select_booking_async( + bookings = [item async for item in client.list_select_booking( input=SelectBookingInput( return_empty_array_on_no_result=True, page_size=10, + page_index=1, ) - ) + )] print(f"Bookings: {bookings}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_tallyfy.py b/samples/sample_connector_usage/sample_connector_usage_tallyfy.py index 6d894195..41c06c7b 100644 --- a/samples/sample_connector_usage/sample_connector_usage_tallyfy.py +++ b/samples/sample_connector_usage/sample_connector_usage_tallyfy.py @@ -1,4 +1,4 @@ -"""Tallyfy connector SDK sample.""" +"""Tallyfy sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -6,7 +6,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.tallyfy import CreateRunInput, TallyfyClient +from azure.connectors.tallyfy import TallyfyClient +from azure.connectors.tallyfy import CreateRunInput CONNECTION_RUNTIME_URL = os.environ.get("TALLYFY_CONNECTION_URL", "") @@ -16,7 +17,7 @@ async def list_organizations() -> None: """List organizations available to the current user.""" async with DefaultAzureCredential() as credential: async with TallyfyClient(CONNECTION_RUNTIME_URL, credential) as client: - organizations = await client.get_user_organizations_async() + organizations = await client.get_user_organizations() print(f"Organizations: {organizations}") @@ -24,7 +25,7 @@ async def create_run() -> None: """Create a run from a checklist.""" async with DefaultAzureCredential() as credential: async with TallyfyClient(CONNECTION_RUNTIME_URL, credential) as client: - run = await client.create_run_async( + run = await client.create_run( input=CreateRunInput( name="Quarterly review", checklist_id="CHECKLIST_ID", diff --git a/samples/sample_connector_usage/sample_connector_usage_teams.py b/samples/sample_connector_usage/sample_connector_usage_teams.py index 484d6aee..0dd5d6d1 100644 --- a/samples/sample_connector_usage/sample_connector_usage_teams.py +++ b/samples/sample_connector_usage/sample_connector_usage_teams.py @@ -1,7 +1,7 @@ """ -Microsoft Teams Connector SDK Sample +Microsoft Teams sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Teams connector SDK. +This sample demonstrates how to use the Teams client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Teams connection @@ -32,10 +32,10 @@ async def example_1_list_joined_teams(): client = TeamsClient(CONNECTION_RUNTIME_URL, credential) try: - teams = await client.get_all_teams_async() + teams = [team async for team in client.list_all_teams()] - print(f"Found {len(teams.get('value', []))} teams") - for team in teams.get('value', [])[:3]: # Show first 3 + print(f"Found {len(teams)} teams") + for team in teams[:3]: # Show first 3 print(f" - {team.get('displayName')} ({team.get('id')})") except Exception as ex: @@ -50,10 +50,10 @@ async def example_2_list_associated_teams(): client = TeamsClient(CONNECTION_RUNTIME_URL, credential) try: - teams = await client.get_all_associated_teams_async() + teams = [team async for team in client.list_all_associated_teams()] - print(f"Found {len(teams.get('value', []))} associated teams") - for team in teams.get('value', [])[:3]: # Show first 3 + print(f"Found {len(teams)} associated teams") + for team in teams[:3]: # Show first 3 print(f" - {team.get('displayName')}") except Exception as ex: @@ -62,7 +62,7 @@ async def example_2_list_associated_teams(): async def main(): """Run all examples""" - print("Teams Connector SDK - Sample Usage") + print("Teams sample usage for the Azure Connectors Python SDK") print("=" * 50) print() diff --git a/samples/sample_connector_usage/sample_connector_usage_textrequest.py b/samples/sample_connector_usage/sample_connector_usage_textrequest.py index e66cb0c1..61ef6f49 100644 --- a/samples/sample_connector_usage/sample_connector_usage_textrequest.py +++ b/samples/sample_connector_usage/sample_connector_usage_textrequest.py @@ -1,7 +1,7 @@ """ -TextRequest Connector SDK Sample +TextRequest sample for the Azure Connectors Python SDK -This sample demonstrates how to use the TextRequest connector SDK. +This sample demonstrates how to use the TextRequest client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a TextRequest connection @@ -24,11 +24,11 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.textrequest import TextrequestClient from azure.connectors.textrequest import ( CreateContactInput, SendMessageByPhoneNumberInput, - TextrequestClient, -) + ) # Connection runtime URL format: @@ -45,9 +45,9 @@ async def example_1_send_message() -> None: async with DefaultAzureCredential() as credential: async with TextrequestClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.send_message_by_phone_number_async( + result = await client.send_message_by_phone_number( input=SendMessageByPhoneNumberInput( - body="Hello from the TextRequest connector SDK.", + body="Hello from the TextRequest client in the Azure Connectors Python SDK.", sender_name="Support Team", ), dashboard_id=DASHBOARD_ID, @@ -62,11 +62,14 @@ async def example_2_get_conversations() -> None: async with DefaultAzureCredential() as credential: async with TextrequestClient(CONNECTION_RUNTIME_URL, credential) as client: - conversations = await client.get_conversations_async( - dashboard_id=DASHBOARD_ID, - page=1, - page_size=20, - ) + conversations = [ + conversation + async for conversation in client.list_conversations( + dashboard_id=DASHBOARD_ID, + page=1, + page_size=20, + ) + ] print(f"Conversations: {conversations}") @@ -76,7 +79,7 @@ async def example_3_create_contact() -> None: async with DefaultAzureCredential() as credential: async with TextrequestClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.create_contact_async( + result = await client.create_contact( input=CreateContactInput( first_name="Ada", last_name="Lovelace", @@ -94,7 +97,13 @@ async def example_4_get_dashboards() -> None: async with DefaultAzureCredential() as credential: async with TextrequestClient(CONNECTION_RUNTIME_URL, credential) as client: - dashboards = await client.get_dashboards_async(page=1, page_size=20) + dashboards = [ + dashboard + async for dashboard in client.list_dashboards( + page=1, + page_size=20, + ) + ] print(f"Dashboards: {dashboards}") @@ -105,7 +114,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("TextRequest Connector SDK - Sample Usage") + print("TextRequest sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_ticketmaster.py b/samples/sample_connector_usage/sample_connector_usage_ticketmaster.py index 5dab6ca8..bf7028ca 100644 --- a/samples/sample_connector_usage/sample_connector_usage_ticketmaster.py +++ b/samples/sample_connector_usage/sample_connector_usage_ticketmaster.py @@ -1,4 +1,4 @@ -"""Ticketmaster connector SDK sample.""" +"""Ticketmaster sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -21,7 +21,7 @@ async def main() -> None: async with DefaultAzureCredential() as credential: try: async with TicketmasterClient(CONNECTION_RUNTIME_URL, credential) as client: - attractions = await client.attractions_get_async() + attractions = await client.attractions_get() print(f"Attractions: {attractions}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_todo.py b/samples/sample_connector_usage/sample_connector_usage_todo.py index 2398c3dd..85bbe743 100644 --- a/samples/sample_connector_usage/sample_connector_usage_todo.py +++ b/samples/sample_connector_usage/sample_connector_usage_todo.py @@ -1,7 +1,7 @@ """ -Microsoft To Do Connector SDK Sample +Microsoft To Do sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Microsoft To Do connector SDK. +This sample demonstrates how to use the Microsoft To Do client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Microsoft To Do connection @@ -24,7 +24,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.todo import CreateToDo, CreateToDoList, TodoClient, UpdateToDo +from azure.connectors.todo import TodoClient +from azure.connectors.todo import CreateToDo, CreateToDoList, UpdateToDo # Connection runtime URL format: @@ -38,8 +39,8 @@ async def example_1_list_lists() -> list[dict]: async with DefaultAzureCredential() as credential: async with TodoClient(CONNECTION_RUNTIME_URL, credential) as client: - lists_response = await client.get_all_todo_lists_async() - lists = lists_response.get("value", []) if lists_response else [] + lists_response = [item async for item in client.list_all_todo_lists()] + lists = lists_response print(f"Found {len(lists)} lists") for todo_list in lists[:10]: @@ -55,7 +56,7 @@ async def example_2_create_list() -> str | None: async with DefaultAzureCredential() as credential: async with TodoClient(CONNECTION_RUNTIME_URL, credential) as client: request = CreateToDoList(display_name="SDK Sample List") - created = await client.create_to_do_list_async(input=request) + created = await client.create_to_do_list(input=request) if not created: print("No list was created") @@ -73,7 +74,7 @@ async def example_3_create_and_update_todo(list_id: str) -> None: async with DefaultAzureCredential() as credential: async with TodoClient(CONNECTION_RUNTIME_URL, credential) as client: create_request = CreateToDo(title="SDK sample task", status="notStarted") - created_todo = await client.create_to_do_async(input=create_request, folder_id=list_id) + created_todo = await client.create_to_do(input=create_request, folder_id=list_id) if not created_todo: print("No to-do item returned from create operation") @@ -86,7 +87,7 @@ async def example_3_create_and_update_todo(list_id: str) -> None: return update_request = UpdateToDo(title="SDK sample task (updated)", status="inProgress") - updated_todo = await client.update_to_do_async( + updated_todo = await client.update_to_do( input=update_request, folder_id=list_id, id=todo_id, @@ -101,7 +102,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Microsoft To Do Connector SDK - Sample Usage") + print("Microsoft To Do sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_trello.py b/samples/sample_connector_usage/sample_connector_usage_trello.py index 82044146..ed1f93bc 100644 --- a/samples/sample_connector_usage/sample_connector_usage_trello.py +++ b/samples/sample_connector_usage/sample_connector_usage_trello.py @@ -1,7 +1,7 @@ """ -Trello Connector SDK Sample +Trello sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Trello connector SDK. +This sample demonstrates how to use the Trello client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Trello connection @@ -24,7 +24,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.trello import CreateBoard, CreateCard, CreateList, TrelloClient +from azure.connectors.trello import TrelloClient +from azure.connectors.trello import CreateBoard, CreateCard, CreateList # Connection runtime URL format: @@ -38,7 +39,7 @@ async def example_1_list_boards() -> None: async with DefaultAzureCredential() as credential: async with TrelloClient(CONNECTION_RUNTIME_URL, credential) as client: - boards = await client.list_boards_simple_async() + boards = [item async for item in client.list_boards_simple()] print(f"Boards: {boards}") @@ -48,10 +49,10 @@ async def example_2_create_board() -> None: async with DefaultAzureCredential() as credential: async with TrelloClient(CONNECTION_RUNTIME_URL, credential) as client: - board = await client.create_board_async( + board = await client.create_board( input=CreateBoard( name="SDK sample board", - desc="Created from the Trello connector SDK sample.", + desc="Created by the Trello client in the Azure Connectors Python SDK.", default_lists="false", ) ) @@ -64,7 +65,7 @@ async def example_3_create_list() -> None: async with DefaultAzureCredential() as credential: async with TrelloClient(CONNECTION_RUNTIME_URL, credential) as client: - created_list = await client.create_list_async( + created_list = await client.create_list( input=CreateList( name="SDK sample list", id_board="board-id", @@ -80,11 +81,11 @@ async def example_4_create_card() -> None: async with DefaultAzureCredential() as credential: async with TrelloClient(CONNECTION_RUNTIME_URL, credential) as client: - card = await client.create_card_async( + card = await client.create_card( input=CreateCard( id_list="list-id", name="SDK sample card", - desc="Created from the Trello connector SDK sample.", + desc="Created by the Trello client in the Azure Connectors Python SDK.", ), board_id="board-id", ) @@ -98,7 +99,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Trello Connector SDK - Sample Usage") + print("Trello sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_twitter.py b/samples/sample_connector_usage/sample_connector_usage_twitter.py index 4d4f944e..460264b1 100644 --- a/samples/sample_connector_usage/sample_connector_usage_twitter.py +++ b/samples/sample_connector_usage/sample_connector_usage_twitter.py @@ -1,4 +1,4 @@ -"""Twitter connector SDK sample.""" +"""Twitter sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -16,10 +16,10 @@ async def list_user_timeline() -> None: """List recent posts from a user's timeline.""" async with DefaultAzureCredential() as credential: async with TwitterClient(CONNECTION_RUNTIME_URL, credential) as client: - timeline = await client.user_timeline_async( + timeline = [item async for item in client.list_user_timeline( user_name="Azure", max_results=10, - ) + )] print(f"Timeline: {timeline}") @@ -27,10 +27,10 @@ async def search_posts() -> None: """Search recent posts.""" async with DefaultAzureCredential() as credential: async with TwitterClient(CONNECTION_RUNTIME_URL, credential) as client: - results = await client.search_tweet_async( + results = [item async for item in client.list_search_tweet( search_query="Azure Logic Apps", max_results=10, - ) + )] print(f"Search results: {results}") diff --git a/samples/sample_connector_usage/sample_connector_usage_typeform.py b/samples/sample_connector_usage/sample_connector_usage_typeform.py index 26b42d66..3aac2c14 100644 --- a/samples/sample_connector_usage/sample_connector_usage_typeform.py +++ b/samples/sample_connector_usage/sample_connector_usage_typeform.py @@ -1,4 +1,4 @@ -"""Typeform connector SDK sample.""" +"""Typeform sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -21,7 +21,7 @@ async def main() -> None: async with DefaultAzureCredential() as credential: try: async with TypeformClient(CONNECTION_RUNTIME_URL, credential) as client: - forms = await client.list_forms_async() + forms = [form async for form in client.list_forms()] print(f"Forms: {forms}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_universalprint.py b/samples/sample_connector_usage/sample_connector_usage_universalprint.py index 100b777d..591aa63b 100644 --- a/samples/sample_connector_usage/sample_connector_usage_universalprint.py +++ b/samples/sample_connector_usage/sample_connector_usage_universalprint.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Universal Print Connector SDK Sample +Universal Print sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Universal Print connector SDK. +This sample demonstrates how to use the Universal Print client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Universal Print connection @@ -44,9 +44,9 @@ async def example_1_list_recent_shares(): async with UniversalprintClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.list_recent_shares_async() + items = [item async for item in client.list_recent_shares()] - shares = (result or {}).get("value", []) if isinstance(result, dict) else [] + shares = items print(f"Found {len(shares)} recent printer share(s).") for share in shares: print(f" - {share}") @@ -68,7 +68,7 @@ async def example_2_print_file(): async with UniversalprintClient(CONNECTION_RUNTIME_URL, credential) as client: try: - await client.print_file_async( + await client.print_file( input=pdf_file_path.read_bytes(), printer="your-printer-share-id", file_name=pdf_file_path.name, diff --git a/samples/sample_connector_usage/sample_connector_usage_waywedo.py b/samples/sample_connector_usage/sample_connector_usage_waywedo.py index 800942b9..6ec9b2c7 100644 --- a/samples/sample_connector_usage/sample_connector_usage_waywedo.py +++ b/samples/sample_connector_usage/sample_connector_usage_waywedo.py @@ -1,4 +1,4 @@ -"""Way We Do connector SDK sample.""" +"""Way We Do sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -21,7 +21,7 @@ async def main() -> None: async with DefaultAzureCredential() as credential: try: async with WaywedoClient(CONNECTION_RUNTIME_URL, credential) as client: - checklists = await client.find_checklist_async() + checklists = [item async for item in client.list_find_checklist()] print(f"Checklists: {checklists}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_wdatp.py b/samples/sample_connector_usage/sample_connector_usage_wdatp.py index 5ce8043e..2caa5eff 100644 --- a/samples/sample_connector_usage/sample_connector_usage_wdatp.py +++ b/samples/sample_connector_usage/sample_connector_usage_wdatp.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Windows Defender ATP (Microsoft Defender for Endpoint) Connector SDK Sample +Windows Defender ATP (Microsoft Defender for Endpoint) sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Windows Defender ATP connector SDK +This sample demonstrates how to use the Windows Defender ATP client from the Azure Connectors Python SDK to interact with Microsoft Defender for Endpoint for security operations. Prerequisites: @@ -26,8 +26,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.wdatp import WdatpClient from azure.connectors.wdatp import ( - WdatpClient, AdvancedHuntingInput, PatchAlertInput, ) @@ -48,7 +48,7 @@ async def example_1_list_alerts(): async with WdatpClient(CONNECTION_RUNTIME_URL, credential) as client: try: - alerts = [item async for item in client.get_alerts_async( + alerts = [item async for item in client.list_alerts( top=5, orderby="alertCreationTime desc" )] @@ -77,7 +77,7 @@ async def example_2_get_machines(): async with WdatpClient(CONNECTION_RUNTIME_URL, credential) as client: try: machines = [ - item async for item in client.get_machines_async(top=10) + item async for item in client.list_machines(top=10) ] if machines: @@ -108,7 +108,7 @@ async def example_3_advanced_hunting(): query = "DeviceInfo | take 5 | project DeviceName, OSPlatform, PublicIP" input_data = AdvancedHuntingInput(query=query) - result = await client.advanced_hunting_async(input=input_data) + result = await client.advanced_hunting(input=input_data) if result and result.get("results"): print(f"Query returned {len(result['results'])} results:") @@ -147,7 +147,7 @@ async def example_4_update_alert(): classification="TruePositive" ) - result = await client.patch_alert_async( + result = await client.patch_alert( input=input_data, alert_id=alert_id ) @@ -177,7 +177,7 @@ async def example_5_get_file_stats(): async with WdatpClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_file_stats_async(file_id=file_sha1) + result = await client.get_file_stats(file_id=file_sha1) print(f"File statistics for {file_sha1}:") print(f" Global prevalence: {result.get('globallyPrevalence', 'N/A')}") @@ -198,7 +198,7 @@ async def example_6_machine_actions(): async with WdatpClient(CONNECTION_RUNTIME_URL, credential) as client: try: - machine_actions = [item async for item in client.get_machine_actions_async( + machine_actions = [item async for item in client.list_machine_actions( top=5, orderby="creationDateTimeUtc desc" )] @@ -227,7 +227,7 @@ async def example_7_investigations(): async with WdatpClient(CONNECTION_RUNTIME_URL, credential) as client: try: investigations = [ - item async for item in client.get_investigations_async(top=5) + item async for item in client.list_investigations(top=5) ] if investigations: diff --git a/samples/sample_connector_usage/sample_connector_usage_webex.py b/samples/sample_connector_usage/sample_connector_usage_webex.py index b7669fed..43d660f7 100644 --- a/samples/sample_connector_usage/sample_connector_usage_webex.py +++ b/samples/sample_connector_usage/sample_connector_usage_webex.py @@ -1,7 +1,7 @@ """ -Webex Connector SDK Sample +Webex sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Webex connector SDK. +This sample demonstrates how to use the Webex client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Webex connection @@ -24,11 +24,11 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.webex import WebexClient from azure.connectors.webex import ( CreateSpaceInput, SendMessageInput, - WebexClient, -) + ) # Connection runtime URL format: @@ -42,10 +42,10 @@ async def example_1_send_message() -> None: async with DefaultAzureCredential() as credential: async with WebexClient(CONNECTION_RUNTIME_URL, credential) as client: - result = await client.send_message_async( + result = await client.send_message( input=SendMessageInput( room_id="ROOM_ID", - text="Hello from the Webex connector SDK.", + text="Hello from the Webex client in the Azure Connectors Python SDK.", ), ) print(f"Send result: {result}") @@ -57,7 +57,7 @@ async def example_2_get_spaces() -> None: async with DefaultAzureCredential() as credential: async with WebexClient(CONNECTION_RUNTIME_URL, credential) as client: - spaces = await client.get_spaces_async() + spaces = [item async for item in client.list_spaces()] print(f"Spaces: {spaces}") @@ -67,7 +67,7 @@ async def example_3_create_space() -> None: async with DefaultAzureCredential() as credential: async with WebexClient(CONNECTION_RUNTIME_URL, credential) as client: - space = await client.create_space_async( + space = await client.create_space( input=CreateSpaceInput(title="My New Space"), ) print(f"Created space: {space}") @@ -79,7 +79,7 @@ async def example_4_get_my_own_details() -> None: async with DefaultAzureCredential() as credential: async with WebexClient(CONNECTION_RUNTIME_URL, credential) as client: - me = await client.get_my_own_details_async() + me = await client.get_my_own_details() print(f"My details: {me}") @@ -90,7 +90,7 @@ async def main() -> None: print("Set it to your connection runtime URL from Azure Portal.") return - print("Webex Connector SDK - Sample Usage") + print("Webex sample usage for the Azure Connectors Python SDK") print("=" * 50) try: diff --git a/samples/sample_connector_usage/sample_connector_usage_wordonlinebusiness.py b/samples/sample_connector_usage/sample_connector_usage_wordonlinebusiness.py index 4f9f6fa6..1ca6149c 100644 --- a/samples/sample_connector_usage/sample_connector_usage_wordonlinebusiness.py +++ b/samples/sample_connector_usage/sample_connector_usage_wordonlinebusiness.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Word Online (Business) Connector SDK Sample +Word Online (Business) sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Word Online (Business) connector SDK. +This sample demonstrates how to use the Word Online (Business) client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with Word Online (Business) connection @@ -25,8 +25,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.wordonlinebusiness import WordonlinebusinessClient from azure.connectors.wordonlinebusiness import ( - WordonlinebusinessClient, CreateFileItemInput, ContentBody, ) @@ -65,7 +65,7 @@ async def example_1_populate_word_template(): } ) - result = await client.create_file_item_async( + result = await client.create_file_item( input=input_data, source=SOURCE, drive=DRIVE, @@ -97,7 +97,7 @@ async def example_2_create_word_document(): "It can include multiple paragraphs and formatting." ) - result = await client.create_word_file_with_content_async( + result = await client.create_word_file_with_content( input=content, file_name="MyDocument.docx" ) @@ -127,7 +127,7 @@ async def example_3_create_word_document_without_filename(): try: content = ContentBody(content="Auto-generated document content.") - result = await client.create_word_file_with_content_async(input=content) + result = await client.create_word_file_with_content(input=content) if result: print(f"Document created: {result}") @@ -151,7 +151,7 @@ async def example_4_convert_word_to_pdf(): async with WordonlinebusinessClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_file_pdf_async( + result = await client.get_file_pdf( source=SOURCE, drive=DRIVE, file=FILE @@ -176,7 +176,7 @@ async def example_5_convert_with_sensitivity_labels(): async with WordonlinebusinessClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_file_pdf_async( + result = await client.get_file_pdf( source=SOURCE, drive=DRIVE, file=FILE, diff --git a/samples/sample_connector_usage/sample_connector_usage_wordpress.py b/samples/sample_connector_usage/sample_connector_usage_wordpress.py index 88e29287..1c7b07c0 100644 --- a/samples/sample_connector_usage/sample_connector_usage_wordpress.py +++ b/samples/sample_connector_usage/sample_connector_usage_wordpress.py @@ -1,4 +1,4 @@ -"""WordPress connector SDK sample.""" +"""WordPress sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -6,7 +6,8 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException -from azure.connectors.wordpress import CreatePostModel, WordpressClient +from azure.connectors.wordpress import WordpressClient +from azure.connectors.wordpress import CreatePostModel CONNECTION_RUNTIME_URL = os.environ.get("WORDPRESS_CONNECTION_URL", "") @@ -16,7 +17,7 @@ async def list_sites() -> None: """List WordPress sites available to the connection.""" async with DefaultAzureCredential() as credential: async with WordpressClient(CONNECTION_RUNTIME_URL, credential) as client: - sites = await client.list_sites_async() + sites = [item async for item in client.list_sites()] print(f"Sites: {sites}") @@ -24,7 +25,7 @@ async def create_post() -> None: """Create a draft WordPress post.""" async with DefaultAzureCredential() as credential: async with WordpressClient(CONNECTION_RUNTIME_URL, credential) as client: - post = await client.create_async( + post = await client.create( input=CreatePostModel( title="Generated connector sample", content="Created with the Azure Connectors Python SDK.", diff --git a/samples/sample_connector_usage/sample_connector_usage_yammer.py b/samples/sample_connector_usage/sample_connector_usage_yammer.py index 3ff626c7..1d75713b 100644 --- a/samples/sample_connector_usage/sample_connector_usage_yammer.py +++ b/samples/sample_connector_usage/sample_connector_usage_yammer.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Yammer (Viva Engage) Connector SDK Sample +Yammer (Viva Engage) sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Yammer connector SDK to interact with +This sample demonstrates how to use the Yammer client from the Azure Connectors Python SDK to interact with Viva Engage (formerly Yammer) networks, groups, messages, and users. Prerequisites: @@ -25,8 +25,8 @@ import os from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.yammer import YammerClient from azure.connectors.yammer import ( - YammerClient, PostOperationRequest, ) @@ -46,7 +46,7 @@ async def example_1_get_networks(): async with YammerClient(CONNECTION_RUNTIME_URL, credential) as client: try: - networks = await client.get_networks_async() + networks = [item async for item in client.list_networks()] if networks: print(f"Found {len(networks)} network(s):") @@ -70,7 +70,7 @@ async def example_2_get_groups(): async with YammerClient(CONNECTION_RUNTIME_URL, credential) as client: try: # Get only groups the user belongs to - groups = await client.get_groups_async(mine=1) + groups = [item async for item in client.list_groups(mine=1)] if groups: print(f"Found {len(groups)} group(s):") @@ -95,7 +95,7 @@ async def example_3_get_messages(): try: # Get recent messages (limit to 10) messages = [ - item async for item in client.get_all_messages_async(limit=10) + item async for item in client.list_all_messages(limit=10) ] if messages: @@ -121,7 +121,7 @@ async def example_4_get_following_feed(): async with YammerClient(CONNECTION_RUNTIME_URL, credential) as client: try: messages = [ - item async for item in client.get_messages_following_async( + item async for item in client.list_messages_following( limit=5 ) ] @@ -156,7 +156,7 @@ async def example_5_post_message(): title="SDK Test Message" ) - result = await client.post_message_async(input=message) + result = await client.post_message(input=message) if result: print("Message posted successfully!") @@ -181,7 +181,7 @@ async def example_6_get_user_details(): try: # Replace with an actual user ID user_id = 123456789 - user = await client.get_user_details_by_id_async(user_id=user_id) + user = await client.get_user_details_by_id(user_id=user_id) if user: print("User details:") diff --git a/samples/sample_connector_usage/sample_connector_usage_zendesk.py b/samples/sample_connector_usage/sample_connector_usage_zendesk.py index c605279a..4647fa7b 100644 --- a/samples/sample_connector_usage/sample_connector_usage_zendesk.py +++ b/samples/sample_connector_usage/sample_connector_usage_zendesk.py @@ -1,9 +1,9 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Zendesk Connector SDK Sample +Zendesk sample for the Azure Connectors Python SDK -This sample demonstrates how to use the Zendesk connector SDK. +This sample demonstrates how to use the Zendesk client from the Azure Connectors Python SDK. Prerequisites: 1. Azure subscription with a Zendesk connection @@ -25,10 +25,10 @@ from azure.identity.aio import DefaultAzureCredential from azure.connectors import ConnectorException +from azure.connectors.zendesk import ZendeskClient from azure.connectors.zendesk import ( Item, - ZendeskClient, -) + ) # Connection runtime URL format: # https://[region].azure-apihub.net/apim/zendesk/[connection-id] @@ -46,9 +46,9 @@ async def example_1_get_tables(): async with ZendeskClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.get_tables_async() + items = [item async for item in client.list_tables()] - tables = (result or {}).get("value", []) if isinstance(result, dict) else [] + tables = items print(f"Found {len(tables)} table(s).") for table in tables: print(f" - {table}") @@ -67,7 +67,7 @@ async def example_2_get_items(): async with ZendeskClient(CONNECTION_RUNTIME_URL, credential) as client: try: - items = [item async for item in client.get_items_async( + items = [item async for item in client.list_items( table="tickets", top=10, )] @@ -95,7 +95,7 @@ async def example_3_create_item(): }, ) - result = await client.post_item_async(input=new_item, table="tickets") + result = await client.post_item(input=new_item, table="tickets") print(f"Created item: {result}") except ConnectorException as ex: @@ -112,12 +112,12 @@ async def example_4_search_articles(): async with ZendeskClient(CONNECTION_RUNTIME_URL, credential) as client: try: - result = await client.search_articles_async( + items = [item async for item in client.list_search_articles( query="password reset", locale="en-us", - ) + )] - articles = (result or {}).get("results", []) if isinstance(result, dict) else [] + articles = items print(f"Found {len(articles)} article(s).") except ConnectorException as ex: diff --git a/samples/sample_connector_usage/sample_connector_usage_zeptomail.py b/samples/sample_connector_usage/sample_connector_usage_zeptomail.py index 9f81cabb..8de0d3ef 100644 --- a/samples/sample_connector_usage/sample_connector_usage_zeptomail.py +++ b/samples/sample_connector_usage/sample_connector_usage_zeptomail.py @@ -1,4 +1,4 @@ -"""Zoho ZeptoMail connector SDK sample.""" +"""Zoho ZeptoMail sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -24,7 +24,7 @@ async def main() -> None: CONNECTION_RUNTIME_URL, credential, ) as client: - mail_agents = await client.get_mail_agent_async() + mail_agents = await client.get_mail_agent() print(f"Mail agents: {mail_agents}") except ConnectorException as ex: print(f"Connector error: {ex}") diff --git a/samples/sample_connector_usage/sample_connector_usage_zohosign.py b/samples/sample_connector_usage/sample_connector_usage_zohosign.py index 51794978..1691f768 100644 --- a/samples/sample_connector_usage/sample_connector_usage_zohosign.py +++ b/samples/sample_connector_usage/sample_connector_usage_zohosign.py @@ -1,6 +1,6 @@ # Copyright (c) Microsoft Corporation. All rights reserved. -"""Zoho Sign connector SDK sample.""" +"""Zoho Sign sample for the Azure Connectors Python SDK.""" import asyncio import os @@ -19,7 +19,7 @@ async def list_templates() -> None: """List available Zoho Sign templates.""" async with DefaultAzureCredential() as credential: async with ZohosignClient(CONNECTION_RUNTIME_URL, credential) as client: - templates = await client.get_templates_async() + templates = [item async for item in client.list_templates()] print(f"Templates: {templates}") @@ -31,7 +31,7 @@ async def get_document() -> None: async with DefaultAzureCredential() as credential: async with ZohosignClient(CONNECTION_RUNTIME_URL, credential) as client: - document = await client.get_document_async(request_id=int(REQUEST_ID)) + document = await client.get_document(request_id=int(REQUEST_ID)) print(f"Document: {document}") diff --git a/scripts/generate_api_reference.py b/scripts/generate_api_reference.py index 0c45f93f..87e2dd2c 100644 --- a/scripts/generate_api_reference.py +++ b/scripts/generate_api_reference.py @@ -107,12 +107,16 @@ def _generate_reference() -> None: navigation = mkdocs_gen_files.Nav() navigation["Home"] = "index.md" navigation[("Guides", "Connection setup")] = "connection-setup.md" + navigation[("Guides", "Long-running operations")] = "long-running-operations.md" + navigation[("Guides", "Async operation migration")] = "migration-sync-aio.md" navigation[("Guides", "SDK-type bindings")] = "sdk-type-bindings.md" + navigation[("Design", "Azure SDK guidelines")] = "azure-sdk-guidelines.md" + navigation[("Design", "Generated contract")] = "generated-contract.md" navigation[("API reference",)] = "api/index.md" sections = ( ("Core SDK", "core", PACKAGE_ROOT / "sdk", "azure.connectors.sdk"), - ("Connectors", "connectors", PACKAGE_ROOT, "azure.connectors"), + ("Async connectors", "connectors", PACKAGE_ROOT, "azure.connectors"), ) for navigation_title, section, directory, package_name in sections: diff --git a/scripts/validate_api_docs.py b/scripts/validate_api_docs.py index 697e4b01..39acaa5b 100644 --- a/scripts/validate_api_docs.py +++ b/scripts/validate_api_docs.py @@ -64,6 +64,10 @@ def validate_api_docs(site_directory: Path) -> list[str]: errors.extend(_format_difference(f"Missing {section} API pages", expected - actual)) errors.extend(_format_difference(f"Unexpected {section} API pages", actual - expected)) + for section in ("core-aio", "connectors-aio"): + if (api_directory / section).exists(): + errors.append(f"Obsolete dual-mode API section: '{section}'. Build a clean site.") + return errors @@ -92,7 +96,8 @@ def main() -> int: core_count = len(_source_module_names(PACKAGE_ROOT / "sdk")) print( "API documentation validation passed: " - f"{core_count} core modules and {connector_count} connector modules.", + f"{core_count} async core modules and " + f"{connector_count} async connector modules.", ) return 0 diff --git a/scripts/validate_connector_samples.py b/scripts/validate_connector_samples.py index 98b1bb03..aa8d9c54 100644 --- a/scripts/validate_connector_samples.py +++ b/scripts/validate_connector_samples.py @@ -17,6 +17,8 @@ from types import ModuleType, UnionType from typing import Any, Literal, Union, get_args, get_origin, get_type_hints +from azure.core.async_paging import AsyncItemPaged + @dataclass(frozen=True) class ValidationIssue: @@ -37,15 +39,34 @@ def __init__(self, path: Path, modules: dict[str, ModuleType]) -> None: self.imported_symbols: dict[str, Any] = {} self.client_variables: dict[str, type[Any]] = {} self.variable_types: dict[str, type[Any]] = {} + self.credential_modes: dict[str, str] = {} self.scoped_async_credentials: set[int] = set() + self.awaited_calls: set[int] = set() self.issues: list[ValidationIssue] = [] def visit_ImportFrom(self, node: ast.ImportFrom) -> None: """Resolve imports from concrete connector modules.""" module_name = node.module or "" + if module_name in {"azure.identity", "azure.identity.aio"}: + mode = "async" if module_name.endswith(".aio") else "sync" + for imported_name in node.names: + if imported_name.name == "DefaultAzureCredential": + local_name = imported_name.asname or imported_name.name + self.credential_modes[local_name] = mode + if mode == "sync": + self._add_issue( + node, + "connector samples require azure.identity.aio credentials", + ) + return + if not module_name.startswith("azure.connectors"): return + if module_name.startswith(("azure.connectors.aio", "azure.connectors.sdk.aio")): + self._add_issue(node, "import async clients from root connector modules, not aio") + return + module = self.modules.get(module_name) if module is None: self._add_issue(node, f"connector module '{module_name}' does not exist") @@ -139,13 +160,32 @@ def visit_AsyncWith(self, node: ast.AsyncWith) -> None: if ( isinstance(item.context_expr, ast.Call) and isinstance(item.context_expr.func, ast.Name) - and item.context_expr.func.id == "DefaultAzureCredential" + and self.credential_modes.get(item.context_expr.func.id) == "async" ): self.scoped_async_credentials.add(id(item.context_expr)) client_type = self._client_type_from_expression(item.context_expr) - if client_type is not None and isinstance(item.optional_vars, ast.Name): - self.client_variables[item.optional_vars.id] = client_type + if client_type is not None: + if not self._is_async_client(client_type): + self._add_issue( + item.context_expr, + "connector samples require an asynchronous client", + ) + elif isinstance(item.optional_vars, ast.Name): + self.client_variables[item.optional_vars.id] = client_type + self.generic_visit(node) + + def visit_With(self, node: ast.With) -> None: + """Reject synchronous context management for generated clients.""" + for item in node.items: + client_type = self._client_type_from_expression(item.context_expr) + if client_type is not None: + self._add_issue( + item.context_expr, + "asynchronous connector clients must use an async context manager", + ) + if isinstance(item.optional_vars, ast.Name): + self.client_variables[item.optional_vars.id] = client_type self.generic_visit(node) def visit_ListComp(self, node: ast.ListComp) -> None: @@ -172,6 +212,10 @@ def _visit_comprehension( client_variables = self.client_variables.copy() try: for generator in node.generators: + self._validate_pageable_iteration( + generator.iter, + is_async=bool(generator.is_async), + ) self.visit(generator.iter) for target in ast.walk(generator.target): if isinstance(target, ast.Name) and isinstance(target.ctx, ast.Store): @@ -193,10 +237,24 @@ def visit_Await(self, node: ast.Await) -> None: """Reject awaiting a generated pageable operation instead of iterating it.""" call = node.value if isinstance(call, ast.Call) and isinstance(call.func, ast.Attribute): + self.awaited_calls.add(id(call)) client_type = self._client_type_for_receiver(call.func.value) method = getattr(client_type, call.func.attr, None) - if inspect.isasyncgenfunction(method): + pageable_type = self._get_pageable_type(method) + if pageable_type is AsyncItemPaged: self._add_issue(node, f"'{call.func.attr}' must be consumed with async for") + elif method is not None and not inspect.iscoroutinefunction(method): + self._add_issue(node, f"synchronous method '{call.func.attr}' cannot be awaited") + self.generic_visit(node) + + def visit_AsyncFor(self, node: ast.AsyncFor) -> None: + """Require asynchronous iteration only for asynchronous pagers.""" + self._validate_pageable_iteration(node.iter, is_async=True) + self.generic_visit(node) + + def visit_For(self, node: ast.For) -> None: + """Require synchronous iteration only for synchronous pagers.""" + self._validate_pageable_iteration(node.iter, is_async=False) self.generic_visit(node) def visit_BoolOp(self, node: ast.BoolOp) -> None: @@ -211,13 +269,17 @@ def visit_Call(self, node: ast.Call) -> None: """Validate generated model construction and client method calls.""" if ( isinstance(node.func, ast.Name) - and node.func.id == "DefaultAzureCredential" - and id(node) not in self.scoped_async_credentials + and node.func.id in self.credential_modes ): - self._add_issue( - node, - "DefaultAzureCredential must use an async context manager", - ) + credential_mode = self.credential_modes[node.func.id] + if ( + credential_mode == "async" + and id(node) not in self.scoped_async_credentials + ): + self._add_issue( + node, + "asynchronous DefaultAzureCredential must use an async context manager", + ) if isinstance(node.func, ast.Name): target = self.imported_symbols.get(node.func.id) @@ -235,6 +297,14 @@ def visit_Call(self, node: ast.Call) -> None: ) else: self._validate_signature(node, method, include_instance=True) + if ( + inspect.iscoroutinefunction(method) + and id(node) not in self.awaited_calls + ): + self._add_issue( + node, + f"asynchronous method '{method_name}' must be awaited", + ) else: receiver_type = self._infer_static_type(node.func.value) if receiver_type in {list, dict, set, tuple} and not hasattr( @@ -262,6 +332,53 @@ def _client_type_for_receiver(self, node: ast.AST) -> type[Any] | None: return self.client_variables.get(node.id) return self._client_type_from_expression(node) + @staticmethod + def _is_async_client(client_type: type[Any]) -> bool: + """Recognize async lifecycle without depending on a module namespace.""" + return inspect.iscoroutinefunction(getattr(client_type, "__aenter__", None)) + + @staticmethod + def _get_pageable_type(method: Any) -> type[Any] | None: + """Resolve the Azure Core pager type returned by a generated method.""" + if method is None: + return None + + try: + method_module = importlib.import_module(method.__module__) + return_annotation = get_type_hints( + method, + globalns=vars(method_module), + ).get("return") + except (NameError, TypeError): + return_annotation = inspect.signature(method).return_annotation + + return_origin = get_origin(return_annotation) or return_annotation + if return_origin is AsyncItemPaged: + return return_origin + return None + + def _validate_pageable_iteration( + self, + expression: ast.AST, + *, + is_async: bool, + ) -> None: + """Validate that a generated pager uses its matching iteration mode.""" + if not isinstance(expression, ast.Call) or not isinstance( + expression.func, + ast.Attribute, + ): + return + + client_type = self._client_type_for_receiver(expression.func.value) + method = getattr(client_type, expression.func.attr, None) + pageable_type = self._get_pageable_type(method) + if pageable_type is AsyncItemPaged and not is_async: + self._add_issue( + expression, + f"'{expression.func.attr}' must be consumed with async for", + ) + def _infer_static_type(self, node: ast.AST) -> type[Any] | None: """Infer the type of a literal, simple name, environment value, or cast.""" if isinstance(node, ast.Name): @@ -501,7 +618,9 @@ def load_connector_modules(source_root: Path) -> dict[str, ModuleType]: modules: dict[str, ModuleType] = { "azure.connectors": connector_package, } - for module_path in sorted((source_root / "azure" / "connectors").glob("*.py")): + connector_root = source_root / "azure" / "connectors" + module_paths = connector_root.glob("*.py") + for module_path in sorted(module_paths): if module_path.name == "__init__.py": continue @@ -522,10 +641,25 @@ def validate_samples(repo_root: Path) -> tuple[list[Path], list[ValidationIssue] source_root = repo_root / "src" sys.path.insert(0, str(source_root)) modules = load_connector_modules(source_root) - sample_paths = sorted( - (repo_root / "samples" / "sample_connector_usage").glob("*.py") - ) + sample_root = repo_root / "samples" / "sample_connector_usage" + sample_paths = sorted(sample_root.glob("sample_connector_usage_*.py")) issues: list[ValidationIssue] = [] + for obsolete_path in sorted((sample_root / "aio").glob("sample_connector_usage_*.py")): + issues.append( + ValidationIssue( + obsolete_path, + 1, + "remove the duplicate aio sample; keep one async root sample", + ) + ) + + connector_root = source_root / "azure" / "connectors" + expected_connectors = { + f"azure.connectors.{path.stem}" + for path in connector_root.glob("*.py") + if not path.stem.startswith("_") + } + sampled_connectors: dict[str, Path] = {} for sample_path in sample_paths: module_name = f"sample_validation_{sample_path.stem}" @@ -571,6 +705,22 @@ def validate_samples(repo_root: Path) -> tuple[list[Path], list[ValidationIssue] visitor = SampleVisitor(sample_path, modules) visitor.visit(tree) issues.extend(visitor.issues) + connector_imports = { + node.module + for node in ast.walk(tree) + if isinstance(node, ast.ImportFrom) and node.module in expected_connectors + } + for connector_name in connector_imports: + if connector_name in sampled_connectors: + issues.append( + ValidationIssue(sample_path, 1, f"duplicate sample for '{connector_name}'") + ) + sampled_connectors[connector_name] = sample_path + + for connector_name in sorted(expected_connectors - sampled_connectors.keys()): + issues.append( + ValidationIssue(sample_root, 1, f"missing async sample for '{connector_name}'") + ) return sample_paths, issues diff --git a/src/azure/connectors/__init__.py b/src/azure/connectors/__init__.py index 7edc931a..a3700973 100644 --- a/src/azure/connectors/__init__.py +++ b/src/azure/connectors/__init__.py @@ -1,586 +1,45 @@ # Copyright (c) Microsoft Corporation. All rights reserved. -""" -Azure Connectors SDK for Python. +"""Shared runtime contracts for the Azure Connectors SDK for Python.""" -This package provides infrastructure for calling Azure Connectors -from Python applications, including authentication, HTTP clients, and -strongly-typed generated connector clients. -""" +from importlib import import_module +from typing import Any +from ._client_registry import CLIENT_REGISTRY from .sdk.client_base import ConnectorClientBase from .sdk.exceptions import ConnectorException from .sdk.http_client import ConnectorHttpClient, ConnectorResponse from .sdk.response import ConnectorResponseHook, ConnectorResponseSnapshot -from .sdk.trigger_payload import TriggerCallbackPayload, TriggerCallbackBody +from .sdk.trigger_payload import TriggerCallbackBody, TriggerCallbackPayload -# Generated connector clients — some may have import errors from incomplete -# code generation (e.g., undefined type references). Wrap each import so -# a single broken connector doesn't prevent the SDK core from loading. -# See: https://github.com/Azure/connectors-python-sdk/issues/13 -try: - from .arm import ArmClient -except (ImportError, NameError): - ArmClient = None # type: ignore[assignment,misc] -try: - from .azureautomation import AzureautomationClient -except (ImportError, NameError): - AzureautomationClient = None # type: ignore[assignment,misc] -try: - from .azuredatafactory import AzuredatafactoryClient -except (ImportError, NameError): - AzuredatafactoryClient = None # type: ignore[assignment,misc] -try: - from .azuredigitaltwins import AzuredigitaltwinsClient -except (ImportError, NameError): - AzuredigitaltwinsClient = None # type: ignore[assignment,misc] -try: - from .kusto import KustoClient -except (ImportError, NameError): - KustoClient = None # type: ignore[assignment,misc] -try: - from .office365 import Office365Client -except (ImportError, NameError): - Office365Client = None # type: ignore[assignment,misc] -try: - from .sharepointonline import SharepointonlineClient -except (ImportError, NameError): - SharepointonlineClient = None # type: ignore[assignment,misc] -try: - from .teams import TeamsClient -except (ImportError, NameError): - TeamsClient = None # type: ignore[assignment,misc] -try: - from .msgraphgroupsanduser import MsgraphgroupsanduserClient -except (ImportError, NameError): - MsgraphgroupsanduserClient = None # type: ignore[assignment,misc] -try: - from .office365users import Office365usersClient -except (ImportError, NameError): - Office365usersClient = None # type: ignore[assignment,misc] -try: - from .office365groups import Office365groupsClient -except (ImportError, NameError): - Office365groupsClient = None # type: ignore[assignment,misc] -try: - from .office365groupsmail import Office365groupsmailClient -except (ImportError, NameError): - Office365groupsmailClient = None # type: ignore[assignment,misc] -try: - from .azureblob import AzureblobClient -except (ImportError, NameError): - AzureblobClient = None # type: ignore[assignment,misc] -try: - from .box import BoxClient -except (ImportError, NameError): - BoxClient = None # type: ignore[assignment,misc] -try: - from .dropbox import DropboxClient -except (ImportError, NameError): - DropboxClient = None # type: ignore[assignment,misc] -try: - from .mq import MqClient -except (ImportError, NameError): - MqClient = None # type: ignore[assignment,misc] -try: - from .onedrive import OnedriveClient -except (ImportError, NameError): - OnedriveClient = None # type: ignore[assignment,misc] -try: - from .onedriveforbusiness import OnedriveforbusinessClient -except (ImportError, NameError): - OnedriveforbusinessClient = None # type: ignore[assignment,misc] -try: - from .onenote import OnenoteClient -except (ImportError, NameError): - OnenoteClient = None # type: ignore[assignment,misc] -try: - from .planner import PlannerClient -except (ImportError, NameError): - PlannerClient = None # type: ignore[assignment,misc] -try: - from .azuread import AzureadClient -except (ImportError, NameError): - AzureadClient = None # type: ignore[assignment,misc] -try: - from .smtp import SmtpClient -except (ImportError, NameError): - SmtpClient = None # type: ignore[assignment,misc] -try: - from .excelonlinebusiness import ExcelonlinebusinessClient -except (ImportError, NameError): - ExcelonlinebusinessClient = None # type: ignore[assignment,misc] -try: - from .excelonline import ExcelonlineClient -except (ImportError, NameError): - ExcelonlineClient = None # type: ignore[assignment,misc] -try: - from .azurequeues import AzurequeuesClient -except (ImportError, NameError): - AzurequeuesClient = None # type: ignore[assignment,misc] -try: - from .azuretables import AzuretablesClient -except (ImportError, NameError): - AzuretablesClient = None # type: ignore[assignment,misc] -try: - from .azurevm import AzurevmClient -except (ImportError, NameError): - AzurevmClient = None # type: ignore[assignment,misc] -try: - from .documentdb import DocumentdbClient -except (ImportError, NameError): - DocumentdbClient = None # type: ignore[assignment,misc] -try: - from .eventhubs import EventhubsClient -except (ImportError, NameError): - EventhubsClient = None # type: ignore[assignment,misc] -try: - from .ftp import FtpClient -except (ImportError, NameError): - FtpClient = None # type: ignore[assignment,misc] -try: - from .keyvault import KeyvaultClient -except (ImportError, NameError): - KeyvaultClient = None # type: ignore[assignment,misc] -try: - from .microsoftbookings import MicrosoftbookingsClient -except (ImportError, NameError): - MicrosoftbookingsClient = None # type: ignore[assignment,misc] -try: - from .outlook import OutlookClient -except (ImportError, NameError): - OutlookClient = None # type: ignore[assignment,misc] -try: - from .commondataservice import CommondataserviceClient -except (ImportError, NameError): - CommondataserviceClient = None # type: ignore[assignment,misc] -try: - from .servicebus import ServicebusClient -except (ImportError, NameError): - ServicebusClient = None # type: ignore[assignment,misc] -try: - from .wdatp import WdatpClient -except (ImportError, NameError): - WdatpClient = None # type: ignore[assignment,misc] -try: - from .wordonlinebusiness import WordonlinebusinessClient -except (ImportError, NameError): - WordonlinebusinessClient = None # type: ignore[assignment,misc] -try: - from .yammer import YammerClient -except (ImportError, NameError): - YammerClient = None # type: ignore[assignment,misc] -try: - from .azuremonitorlogs import AzuremonitorlogsClient -except (ImportError, NameError): - AzuremonitorlogsClient = None # type: ignore[assignment,misc] +__version__ = "0.5.0b1" -try: - from .docusign import DocusignClient -except (ImportError, NameError): - DocusignClient = None # type: ignore[assignment,misc] -try: - from .github import GithubClient -except (ImportError, NameError): - GithubClient = None # type: ignore[assignment,misc] +def __getattr__(name: str) -> Any: + """Load a generated connector client when requested from the package root.""" + module_name = CLIENT_REGISTRY.get(name) + if module_name is None: + raise AttributeError(f"Module '{__name__}' has no attribute '{name}'.") -try: - from .googlecalendar import GooglecalendarClient -except (ImportError, NameError): - GooglecalendarClient = None # type: ignore[assignment,misc] + client_type = getattr(import_module(f".{module_name}", __name__), name) + globals()[name] = client_type + return client_type -try: - from .googletasks import GoogletasksClient -except (ImportError, NameError): - GoogletasksClient = None # type: ignore[assignment,misc] -try: - from .googledrive import GoogledriveClient -except (ImportError, NameError): - GoogledriveClient = None # type: ignore[assignment,misc] +def __dir__() -> list[str]: + """List core exports and lazily available connector clients.""" + return sorted(set(globals()) | CLIENT_REGISTRY.keys()) -try: - from .jira import JiraClient -except (ImportError, NameError): - JiraClient = None # type: ignore[assignment,misc] - -try: - from .microsoftforms import MicrosoftformsClient -except (ImportError, NameError): - MicrosoftformsClient = None # type: ignore[assignment,misc] - -try: - from .powerbi import PowerbiClient -except (ImportError, NameError): - PowerbiClient = None # type: ignore[assignment,misc] - -try: - from .rss import RssClient -except (ImportError, NameError): - RssClient = None # type: ignore[assignment,misc] - -try: - from .salesforce import SalesforceClient -except (ImportError, NameError): - SalesforceClient = None # type: ignore[assignment,misc] - -try: - from .shifts import ShiftsClient -except (ImportError, NameError): - ShiftsClient = None # type: ignore[assignment,misc] - -try: - from .slack import SlackClient -except (ImportError, NameError): - SlackClient = None # type: ignore[assignment,misc] - -try: - from .todo import TodoClient -except (ImportError, NameError): - TodoClient = None # type: ignore[assignment,misc] - -try: - from .insightly import InsightlyClient -except (ImportError, NameError): - InsightlyClient = None # type: ignore[assignment,misc] - -try: - from .infusionsoft import InfusionsoftClient -except (ImportError, NameError): - InfusionsoftClient = None # type: ignore[assignment,misc] - -try: - from .freshservice import FreshserviceClient -except (ImportError, NameError): - FreshserviceClient = None # type: ignore[assignment,misc] - -try: - from .monday import MondayClient -except (ImportError, NameError): - MondayClient = None # type: ignore[assignment,misc] - -try: - from .projectplace import ProjectplaceClient -except (ImportError, NameError): - ProjectplaceClient = None # type: ignore[assignment,misc] - -try: - from .mailchimp import MailchimpClient -except (ImportError, NameError): - MailchimpClient = None # type: ignore[assignment,misc] - -try: - from .sendgrid import SendgridClient -except (ImportError, NameError): - SendgridClient = None # type: ignore[assignment,misc] - -try: - from .webex import WebexClient -except (ImportError, NameError): - WebexClient = None # type: ignore[assignment,misc] -try: - from .campfire import CampfireClient -except (ImportError, NameError): - CampfireClient = None # type: ignore[assignment,misc] -try: - from .clicksendsms import ClicksendsmsClient -except (ImportError, NameError): - ClicksendsmsClient = None # type: ignore[assignment,misc] -try: - from .textrequest import TextrequestClient -except (ImportError, NameError): - TextrequestClient = None # type: ignore[assignment,misc] - -try: - from .twitter import TwitterClient -except (ImportError, NameError): - TwitterClient = None # type: ignore[assignment,misc] - -try: - from .wordpress import WordpressClient -except (ImportError, NameError): - WordpressClient = None # type: ignore[assignment,misc] - -try: - from .plivo import PlivoClient -except (ImportError, NameError): - PlivoClient = None # type: ignore[assignment,misc] - -try: - from .revai import RevaiClient -except (ImportError, NameError): - RevaiClient = None # type: ignore[assignment,misc] - -try: - from .starmind import StarmindClient -except (ImportError, NameError): - StarmindClient = None # type: ignore[assignment,misc] - -try: - from .tallyfy import TallyfyClient -except (ImportError, NameError): - TallyfyClient = None # type: ignore[assignment,misc] - -try: - from .universalprint import UniversalprintClient -except (ImportError, NameError): - UniversalprintClient = None # type: ignore[assignment,misc] - -try: - from .azureeventgrid import AzureeventgridClient -except (ImportError, NameError): - AzureeventgridClient = None # type: ignore[assignment,misc] - -try: - from .azureiotcentral import AzureiotcentralClient -except (ImportError, NameError): - AzureiotcentralClient = None # type: ignore[assignment,misc] - -try: - from .cloudmersiveconvert import CloudmersiveconvertClient -except (ImportError, NameError): - CloudmersiveconvertClient = None # type: ignore[assignment,misc] - -try: - from .dynamicsax import DynamicsaxClient -except (ImportError, NameError): - DynamicsaxClient = None # type: ignore[assignment,misc] - -try: - from .pdfco import PdfcoClient -except (ImportError, NameError): - PdfcoClient = None # type: ignore[assignment,misc] - -try: - from .plumsail import PlumsailClient -except (ImportError, NameError): - PlumsailClient = None # type: ignore[assignment,misc] - -try: - from .sql import SqlClient -except (ImportError, NameError): - SqlClient = None # type: ignore[assignment,misc] - -try: - from .zendesk import ZendeskClient -except (ImportError, NameError): - ZendeskClient = None # type: ignore[assignment,misc] - -try: - from .pipedrive import PipedriveClient -except (ImportError, NameError): - PipedriveClient = None # type: ignore[assignment,misc] - -try: - from .trello import TrelloClient -except (ImportError, NameError): - TrelloClient = None # type: ignore[assignment,misc] - -try: - from .docuware import DocuwareClient -except (ImportError, NameError): - DocuwareClient = None # type: ignore[assignment,misc] - -try: - from .signinghub import SigninghubClient -except (ImportError, NameError): - SigninghubClient = None # type: ignore[assignment,misc] - -try: - from .zohosign import ZohosignClient -except (ImportError, NameError): - ZohosignClient = None # type: ignore[assignment,misc] - -try: - from .zeptomail import ZeptomailClient -except (ImportError, NameError): - ZeptomailClient = None # type: ignore[assignment,misc] - -try: - from .eventbrite import EventbriteClient -except (ImportError, NameError): - EventbriteClient = None # type: ignore[assignment,misc] - -try: - from .formstackforms import FormstackformsClient -except (ImportError, NameError): - FormstackformsClient = None # type: ignore[assignment,misc] - -try: - from .typeform import TypeformClient -except (ImportError, NameError): - TypeformClient = None # type: ignore[assignment,misc] - -try: - from .ticketmaster import TicketmasterClient -except (ImportError, NameError): - TicketmasterClient = None # type: ignore[assignment,misc] - -try: - from .seismicplanner import SeismicplannerClient -except (ImportError, NameError): - SeismicplannerClient = None # type: ignore[assignment,misc] - -try: - from .waywedo import WaywedoClient -except (ImportError, NameError): - WaywedoClient = None # type: ignore[assignment,misc] - -try: - from .meetingroommap import MeetingroommapClient -except (ImportError, NameError): - MeetingroommapClient = None # type: ignore[assignment,misc] - -try: - from .starrezrestv1 import Starrezrestv1Client -except (ImportError, NameError): - Starrezrestv1Client = None # type: ignore[assignment,misc] - -try: - from .replicon import RepliconClient -except (ImportError, NameError): - RepliconClient = None # type: ignore[assignment,misc] - -try: - from .etsy import EtsyClient -except (ImportError, NameError): - EtsyClient = None # type: ignore[assignment,misc] - -try: - from .elfsquaddata import ElfsquaddataClient -except (ImportError, NameError): - ElfsquaddataClient = None # type: ignore[assignment,misc] - -try: - from .impexium import ImpexiumClient -except (ImportError, NameError): - ImpexiumClient = None # type: ignore[assignment,misc] - -try: - from .jedoxodatahub import JedoxodatahubClient -except (ImportError, NameError): - JedoxodatahubClient = None # type: ignore[assignment,misc] - -try: - from .orderful import OrderfulClient -except (ImportError, NameError): - OrderfulClient = None # type: ignore[assignment,misc] - -try: - from .cloudconvert import CloudconvertClient -except (ImportError, NameError): - CloudconvertClient = None # type: ignore[assignment,misc] - -__version__ = '0.5.0b1' __all__ = [ - 'ConnectorClientBase', - 'ConnectorException', - 'ConnectorHttpClient', - 'ConnectorResponse', - 'ConnectorResponseHook', - 'ConnectorResponseSnapshot', - 'TriggerCallbackPayload', - 'TriggerCallbackBody', - 'ArmClient', - 'AzureautomationClient', - 'AzuredatafactoryClient', - 'AzuredigitaltwinsClient', - 'KustoClient', - 'Office365Client', - 'SharepointonlineClient', - 'TeamsClient', - 'MsgraphgroupsanduserClient', - 'Office365usersClient', - 'Office365groupsClient', - 'Office365groupsmailClient', - 'AzureblobClient', - 'BoxClient', - 'DropboxClient', - 'MqClient', - 'OnedriveClient', - 'OnedriveforbusinessClient', - 'OnenoteClient', - 'PlannerClient', - 'AzureadClient', - 'SmtpClient', - 'ExcelonlineClient', - 'ExcelonlinebusinessClient', - 'AzurequeuesClient', - 'AzuretablesClient', - 'AzurevmClient', - 'DocumentdbClient', - 'EventhubsClient', - 'FtpClient', - 'KeyvaultClient', - 'MicrosoftbookingsClient', - 'OutlookClient', - 'CommondataserviceClient', - 'ServicebusClient', - 'WdatpClient', - 'WordonlinebusinessClient', - 'YammerClient', - "AzuremonitorlogsClient", - "DocusignClient", - "GithubClient", - "GooglecalendarClient", - "GoogletasksClient", - "GoogledriveClient", - "JiraClient", - "MicrosoftformsClient", - "PowerbiClient", - "RssClient", - "SalesforceClient", - "ShiftsClient", - "SlackClient", - "TodoClient", - "InsightlyClient", - "InfusionsoftClient", - "FreshserviceClient", - "MondayClient", - "ProjectplaceClient", - "MailchimpClient", - "SendgridClient", - "WebexClient", - "CampfireClient", - "ClicksendsmsClient", - "TextrequestClient", - "TwitterClient", - "WordpressClient", - "PlivoClient", - "RevaiClient", - "StarmindClient", - "TallyfyClient", - "UniversalprintClient", - "AzureeventgridClient", - "AzureiotcentralClient", - "CloudmersiveconvertClient", - "DynamicsaxClient", - "PdfcoClient", - "PlumsailClient", - "SqlClient", - "ZendeskClient", - "PipedriveClient", - "TrelloClient", - "DocuwareClient", - "SigninghubClient", - "ZohosignClient", - "ZeptomailClient", - "EventbriteClient", - "FormstackformsClient", - "TypeformClient", - "TicketmasterClient", - "SeismicplannerClient", - "WaywedoClient", - "MeetingroommapClient", - "Starrezrestv1Client", - "RepliconClient", - "EtsyClient", - "ElfsquaddataClient", - "ImpexiumClient", - "JedoxodatahubClient", - "OrderfulClient", - "CloudconvertClient", + "ConnectorClientBase", + "ConnectorException", + "ConnectorHttpClient", + "ConnectorResponse", + "ConnectorResponseHook", + "ConnectorResponseSnapshot", + "TriggerCallbackBody", + "TriggerCallbackPayload", + *CLIENT_REGISTRY, ] diff --git a/src/azure/connectors/__init__.pyi b/src/azure/connectors/__init__.pyi new file mode 100644 index 00000000..c6e34833 --- /dev/null +++ b/src/azure/connectors/__init__.pyi @@ -0,0 +1,116 @@ +# ------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# ------------------------------------------------------------ + +"""Generated type declarations for package-root exports. Do not edit.""" + +from .sdk.client_base import ConnectorClientBase as ConnectorClientBase +from .sdk.exceptions import ConnectorException as ConnectorException +from .sdk.http_client import ConnectorHttpClient as ConnectorHttpClient +from .sdk.http_client import ConnectorResponse as ConnectorResponse +from .sdk.response import ConnectorResponseHook as ConnectorResponseHook +from .sdk.response import ConnectorResponseSnapshot as ConnectorResponseSnapshot +from .sdk.trigger_payload import TriggerCallbackBody as TriggerCallbackBody +from .sdk.trigger_payload import TriggerCallbackPayload as TriggerCallbackPayload +from .arm import ArmClient as ArmClient +from .azuread import AzureadClient as AzureadClient +from .azureautomation import AzureautomationClient as AzureautomationClient +from .azureblob import AzureblobClient as AzureblobClient +from .azuredatafactory import AzuredatafactoryClient as AzuredatafactoryClient +from .azuredigitaltwins import AzuredigitaltwinsClient as AzuredigitaltwinsClient +from .azureeventgrid import AzureeventgridClient as AzureeventgridClient +from .azureiotcentral import AzureiotcentralClient as AzureiotcentralClient +from .azuremonitorlogs import AzuremonitorlogsClient as AzuremonitorlogsClient +from .azurequeues import AzurequeuesClient as AzurequeuesClient +from .azuretables import AzuretablesClient as AzuretablesClient +from .azurevm import AzurevmClient as AzurevmClient +from .box import BoxClient as BoxClient +from .campfire import CampfireClient as CampfireClient +from .clicksendsms import ClicksendsmsClient as ClicksendsmsClient +from .cloudconvert import CloudconvertClient as CloudconvertClient +from .cloudmersiveconvert import CloudmersiveconvertClient as CloudmersiveconvertClient +from .commondataservice import CommondataserviceClient as CommondataserviceClient +from .documentdb import DocumentdbClient as DocumentdbClient +from .docusign import DocusignClient as DocusignClient +from .docuware import DocuwareClient as DocuwareClient +from .dropbox import DropboxClient as DropboxClient +from .dynamicsax import DynamicsaxClient as DynamicsaxClient +from .elfsquaddata import ElfsquaddataClient as ElfsquaddataClient +from .etsy import EtsyClient as EtsyClient +from .eventbrite import EventbriteClient as EventbriteClient +from .eventhubs import EventhubsClient as EventhubsClient +from .excelonline import ExcelonlineClient as ExcelonlineClient +from .excelonlinebusiness import ExcelonlinebusinessClient as ExcelonlinebusinessClient +from .formstackforms import FormstackformsClient as FormstackformsClient +from .freshservice import FreshserviceClient as FreshserviceClient +from .ftp import FtpClient as FtpClient +from .github import GithubClient as GithubClient +from .googlecalendar import GooglecalendarClient as GooglecalendarClient +from .googledrive import GoogledriveClient as GoogledriveClient +from .googletasks import GoogletasksClient as GoogletasksClient +from .impexium import ImpexiumClient as ImpexiumClient +from .infusionsoft import InfusionsoftClient as InfusionsoftClient +from .insightly import InsightlyClient as InsightlyClient +from .jedoxodatahub import JedoxodatahubClient as JedoxodatahubClient +from .jira import JiraClient as JiraClient +from .keyvault import KeyvaultClient as KeyvaultClient +from .kusto import KustoClient as KustoClient +from .mailchimp import MailchimpClient as MailchimpClient +from .meetingroommap import MeetingroommapClient as MeetingroommapClient +from .microsoftbookings import MicrosoftbookingsClient as MicrosoftbookingsClient +from .microsoftforms import MicrosoftformsClient as MicrosoftformsClient +from .monday import MondayClient as MondayClient +from .mq import MqClient as MqClient +from .msgraphgroupsanduser import MsgraphgroupsanduserClient as MsgraphgroupsanduserClient +from .office365 import Office365Client as Office365Client +from .office365groups import Office365groupsClient as Office365groupsClient +from .office365groupsmail import Office365groupsmailClient as Office365groupsmailClient +from .office365users import Office365usersClient as Office365usersClient +from .onedrive import OnedriveClient as OnedriveClient +from .onedriveforbusiness import OnedriveforbusinessClient as OnedriveforbusinessClient +from .onenote import OnenoteClient as OnenoteClient +from .orderful import OrderfulClient as OrderfulClient +from .outlook import OutlookClient as OutlookClient +from .pdfco import PdfcoClient as PdfcoClient +from .pipedrive import PipedriveClient as PipedriveClient +from .planner import PlannerClient as PlannerClient +from .plivo import PlivoClient as PlivoClient +from .plumsail import PlumsailClient as PlumsailClient +from .powerbi import PowerbiClient as PowerbiClient +from .projectplace import ProjectplaceClient as ProjectplaceClient +from .replicon import RepliconClient as RepliconClient +from .revai import RevaiClient as RevaiClient +from .rss import RssClient as RssClient +from .salesforce import SalesforceClient as SalesforceClient +from .seismicplanner import SeismicplannerClient as SeismicplannerClient +from .sendgrid import SendgridClient as SendgridClient +from .servicebus import ServicebusClient as ServicebusClient +from .sharepointonline import SharepointonlineClient as SharepointonlineClient +from .shifts import ShiftsClient as ShiftsClient +from .signinghub import SigninghubClient as SigninghubClient +from .slack import SlackClient as SlackClient +from .smtp import SmtpClient as SmtpClient +from .sql import SqlClient as SqlClient +from .starmind import StarmindClient as StarmindClient +from .starrezrestv1 import Starrezrestv1Client as Starrezrestv1Client +from .tallyfy import TallyfyClient as TallyfyClient +from .teams import TeamsClient as TeamsClient +from .textrequest import TextrequestClient as TextrequestClient +from .ticketmaster import TicketmasterClient as TicketmasterClient +from .todo import TodoClient as TodoClient +from .trello import TrelloClient as TrelloClient +from .twitter import TwitterClient as TwitterClient +from .typeform import TypeformClient as TypeformClient +from .universalprint import UniversalprintClient as UniversalprintClient +from .waywedo import WaywedoClient as WaywedoClient +from .wdatp import WdatpClient as WdatpClient +from .webex import WebexClient as WebexClient +from .wordonlinebusiness import WordonlinebusinessClient as WordonlinebusinessClient +from .wordpress import WordpressClient as WordpressClient +from .yammer import YammerClient as YammerClient +from .zendesk import ZendeskClient as ZendeskClient +from .zeptomail import ZeptomailClient as ZeptomailClient +from .zohosign import ZohosignClient as ZohosignClient + +__version__: str +__all__: list[str] diff --git a/src/azure/connectors/_client_registry.py b/src/azure/connectors/_client_registry.py new file mode 100644 index 00000000..013529cd --- /dev/null +++ b/src/azure/connectors/_client_registry.py @@ -0,0 +1,110 @@ +# ------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# ------------------------------------------------------------ + +"""Generated registry of public connector clients. Do not edit.""" + +from typing import Final + + +CLIENT_REGISTRY: Final[dict[str, str]] = { + "ArmClient": "arm", + "AzureadClient": "azuread", + "AzureautomationClient": "azureautomation", + "AzureblobClient": "azureblob", + "AzuredatafactoryClient": "azuredatafactory", + "AzuredigitaltwinsClient": "azuredigitaltwins", + "AzureeventgridClient": "azureeventgrid", + "AzureiotcentralClient": "azureiotcentral", + "AzuremonitorlogsClient": "azuremonitorlogs", + "AzurequeuesClient": "azurequeues", + "AzuretablesClient": "azuretables", + "AzurevmClient": "azurevm", + "BoxClient": "box", + "CampfireClient": "campfire", + "ClicksendsmsClient": "clicksendsms", + "CloudconvertClient": "cloudconvert", + "CloudmersiveconvertClient": "cloudmersiveconvert", + "CommondataserviceClient": "commondataservice", + "DocumentdbClient": "documentdb", + "DocusignClient": "docusign", + "DocuwareClient": "docuware", + "DropboxClient": "dropbox", + "DynamicsaxClient": "dynamicsax", + "ElfsquaddataClient": "elfsquaddata", + "EtsyClient": "etsy", + "EventbriteClient": "eventbrite", + "EventhubsClient": "eventhubs", + "ExcelonlineClient": "excelonline", + "ExcelonlinebusinessClient": "excelonlinebusiness", + "FormstackformsClient": "formstackforms", + "FreshserviceClient": "freshservice", + "FtpClient": "ftp", + "GithubClient": "github", + "GooglecalendarClient": "googlecalendar", + "GoogledriveClient": "googledrive", + "GoogletasksClient": "googletasks", + "ImpexiumClient": "impexium", + "InfusionsoftClient": "infusionsoft", + "InsightlyClient": "insightly", + "JedoxodatahubClient": "jedoxodatahub", + "JiraClient": "jira", + "KeyvaultClient": "keyvault", + "KustoClient": "kusto", + "MailchimpClient": "mailchimp", + "MeetingroommapClient": "meetingroommap", + "MicrosoftbookingsClient": "microsoftbookings", + "MicrosoftformsClient": "microsoftforms", + "MondayClient": "monday", + "MqClient": "mq", + "MsgraphgroupsanduserClient": "msgraphgroupsanduser", + "Office365Client": "office365", + "Office365groupsClient": "office365groups", + "Office365groupsmailClient": "office365groupsmail", + "Office365usersClient": "office365users", + "OnedriveClient": "onedrive", + "OnedriveforbusinessClient": "onedriveforbusiness", + "OnenoteClient": "onenote", + "OrderfulClient": "orderful", + "OutlookClient": "outlook", + "PdfcoClient": "pdfco", + "PipedriveClient": "pipedrive", + "PlannerClient": "planner", + "PlivoClient": "plivo", + "PlumsailClient": "plumsail", + "PowerbiClient": "powerbi", + "ProjectplaceClient": "projectplace", + "RepliconClient": "replicon", + "RevaiClient": "revai", + "RssClient": "rss", + "SalesforceClient": "salesforce", + "SeismicplannerClient": "seismicplanner", + "SendgridClient": "sendgrid", + "ServicebusClient": "servicebus", + "SharepointonlineClient": "sharepointonline", + "ShiftsClient": "shifts", + "SigninghubClient": "signinghub", + "SlackClient": "slack", + "SmtpClient": "smtp", + "SqlClient": "sql", + "StarmindClient": "starmind", + "Starrezrestv1Client": "starrezrestv1", + "TallyfyClient": "tallyfy", + "TeamsClient": "teams", + "TextrequestClient": "textrequest", + "TicketmasterClient": "ticketmaster", + "TodoClient": "todo", + "TrelloClient": "trello", + "TwitterClient": "twitter", + "TypeformClient": "typeform", + "UniversalprintClient": "universalprint", + "WaywedoClient": "waywedo", + "WdatpClient": "wdatp", + "WebexClient": "webex", + "WordonlinebusinessClient": "wordonlinebusiness", + "WordpressClient": "wordpress", + "YammerClient": "yammer", + "ZendeskClient": "zendesk", + "ZeptomailClient": "zeptomail", + "ZohosignClient": "zohosign", +} diff --git a/src/azure/connectors/arm.py b/src/azure/connectors/arm.py index a6c63a42..68240fd6 100644 --- a/src/azure/connectors/arm.py +++ b/src/azure/connectors/arm.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,60 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "ArmClient", + "AliasPathType", + "AliasType", + "BasicDependency", + "DebugSetting", + "Dependency", + "Deployment", + "DeploymentExportResult", + "DeploymentExtended", + "DeploymentListResult", + "DeploymentOperation", + "DeploymentOperationProperties", + "DeploymentOperationsListResult", + "DeploymentProperties", + "DeploymentPropertiesExtended", + "DeploymentValidateResult", + "ExportTemplateRequest", + "GenericResource", + "HttpMessage", + "Identity", + "Location", + "LocationListResult", + "ObjectWithoutType", + "ParametersLink", + "Plan", + "Provider", + "ProviderListResult", + "ProviderResourceType", + "ProviderResourcesInvokeInput", + "ProviderResourcesInvokeResponse", + "ResourceGroup", + "ResourceGroupExportResult", + "ResourceGroupListResult", + "ResourceGroupProperties", + "ResourceListResult", + "ResourceManagementErrorWithDetails", + "ResourcesInvokeInput", + "ResourcesInvokeResponse", + "Sku", + "Subscription", + "SubscriptionListResult", + "SubscriptionPolicies", + "TagCount", + "TagDetails", + "TagValue", + "TagsListResult", + "TargetResource", + "TemplateLink", +] + # Type Definitions @@ -29,7 +82,12 @@ class LocationListResult: Response for Lists the subscription locations """ - value: Optional[List[Location]] = None + value: Optional[ + List[Location | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The locations.""" @@ -39,34 +97,39 @@ class Subscription: Response for Read a subscription """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000. """ - subscription_id: Optional[str] = field( + subscription_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subscriptionId"}, ) """The subscription Id.""" - tenant_id: Optional[str] = field( + tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tenantId"}, ) """The tenant Id.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The subscription display name.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The subscription state.""" - subscription_policies: Optional[SubscriptionPolicies] = field( + subscription_policies: Optional[SubscriptionPolicies | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subscriptionPolicies"}, ) - authorization_source: Optional[str] = field( + authorization_source: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "authorizationSource"}, ) """ @@ -82,10 +145,16 @@ class SubscriptionListResult: Response for List subscriptions """ - value: Optional[List[Subscription]] = None + value: Optional[ + List[Subscription | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The subscriptions.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -97,11 +166,16 @@ class DeploymentExtended: Response for Read a template deployment """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the deployment.""" - name: Optional[str] = None + name: str """The name of the deployment.""" - properties: Optional[DeploymentPropertiesExtended] = None + properties: Optional[ + DeploymentPropertiesExtended | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -110,8 +184,18 @@ class DeploymentValidateResult: Response for Validate a template deployment """ - error: Optional[ResourceManagementErrorWithDetails] = None - properties: Optional[DeploymentPropertiesExtended] = None + error: Optional[ + ResourceManagementErrorWithDetails | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + properties: Optional[ + DeploymentPropertiesExtended | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -120,7 +204,7 @@ class DeploymentExportResult: Response for Export deployment template """ - template: Optional[Dict[str, Any]] = None + template: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The template content.""" @@ -130,10 +214,16 @@ class DeploymentListResult: Response for List template deployments """ - value: Optional[List[DeploymentExtended]] = None + value: Optional[ + List[DeploymentExtended | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of deployments.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -145,14 +235,20 @@ class DeploymentOperation: Response for Read a template deployment operation """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Full deployment operation id.""" - operation_id: Optional[str] = field( + operation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "operationId"}, ) """Deployment operation id.""" - properties: Optional[DeploymentOperationProperties] = None + properties: Optional[ + DeploymentOperationProperties | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -161,10 +257,16 @@ class DeploymentOperationsListResult: Response for Lists template deployment operations """ - value: Optional[List[DeploymentOperation]] = None + value: Optional[ + List[DeploymentOperation | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of deployments.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -176,17 +278,21 @@ class Provider: Response for Unregister resource provider """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The provider id.""" - namespace: Optional[str] = None + namespace: Optional[str] = dataclass_field(default=None, kw_only=True) """The namespace of the provider.""" - registration_state: Optional[str] = field( + registration_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "registrationState"}, ) """The registration state of the provider.""" - resource_types: Optional[List[ProviderResourceType]] = field( + resource_types: Optional[ + List[ProviderResourceType | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceTypes"}, ) """The collection of provider resource types.""" @@ -198,10 +304,16 @@ class ProviderListResult: Response for List resource providers """ - value: Optional[List[Provider]] = None + value: Optional[ + List[Provider | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of resource providers.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -213,10 +325,16 @@ class ResourceListResult: Response for List resources by resource group """ - value: Optional[List[GenericResource]] = None + value: Optional[ + List[GenericResource | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of resources.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -228,26 +346,32 @@ class ResourceGroup: Response for Read a resource group """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY). """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The Name of the resource group.""" - location: Optional[str] = None + location: str """ The location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. """ - managed_by: Optional[str] = field( + managed_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managedBy"}, ) """Id of the resource that manages this resource group.""" - tags: Optional[Dict[str, str]] = None + tags: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True) """The tags attached to the resource group.""" - properties: Optional[ResourceGroupProperties] = None + properties: Optional[ + ResourceGroupProperties | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -256,9 +380,14 @@ class ResourceGroupExportResult: Response for Export a resource group template """ - template: Optional[Dict[str, Any]] = None + template: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The template content.""" - error: Optional[ResourceManagementErrorWithDetails] = None + error: Optional[ + ResourceManagementErrorWithDetails | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -267,10 +396,16 @@ class ResourceGroupListResult: Response for List resource groups """ - value: Optional[List[ResourceGroup]] = None + value: Optional[ + List[ResourceGroup | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of resource groups.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -282,27 +417,32 @@ class GenericResource: Response for Read a resource """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Resource Id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Resource name""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Resource type""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """Resource location""" - tags: Optional[Dict[str, str]] = None + tags: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True) """Resource tags""" - plan: Optional[Plan] = None - kind: Optional[str] = None + plan: Optional[Plan | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + kind: Optional[str] = dataclass_field(default=None, kw_only=True) """The kind of the resource.""" - managed_by: Optional[str] = field( + managed_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managedBy"}, ) """Id of the resource that manages this resource.""" - sku: Optional[Sku] = None - identity: Optional[Identity] = None - properties: Optional[Dict[str, Any]] = None + sku: Optional[Sku | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + identity: Optional[Identity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + properties: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The resource properties.""" @@ -312,7 +452,7 @@ class ResourcesInvokeInput: Invoke resource operation """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -325,7 +465,7 @@ class ResourcesInvokeResponse: Response for Invoke resource operation """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -338,7 +478,7 @@ class ProviderResourcesInvokeInput: Invoke resource operation in provider """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -351,7 +491,7 @@ class ProviderResourcesInvokeResponse: Response for Invoke resource operation in provider """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -364,14 +504,15 @@ class TagValue: Response for Create or update a subscription resource tag value """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The tag ID.""" - tag_value: Optional[str] = field( + tag_value: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tagValue"}, ) """The tag value.""" - count: Optional[TagCount] = None + count: Optional[TagCount | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -380,15 +521,21 @@ class TagDetails: Response for Create or update a subscription resource tag name """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The tag ID.""" - tag_name: Optional[str] = field( + tag_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tagName"}, ) """The tag name.""" - count: Optional[TagCount] = None - values: Optional[List[TagValue]] = None + count: Optional[TagCount | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + values: Optional[ + List[TagValue | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of tag values.""" @@ -398,10 +545,16 @@ class TagsListResult: Response for List subscription resource tags """ - value: Optional[List[TagDetails]] = None + value: Optional[ + List[TagDetails | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of tags.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -413,26 +566,28 @@ class Location: Definition: Location """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The fully qualified Id of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus. """ - subscription_id: Optional[str] = field( + subscription_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subscriptionId"}, ) """The subscription Id.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The location name.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The display name of the location.""" - latitude: Optional[str] = None + latitude: Optional[str] = dataclass_field(default=None, kw_only=True) """The latitude of the location.""" - longitude: Optional[str] = None + longitude: Optional[str] = dataclass_field(default=None, kw_only=True) """The longitude of the location.""" @@ -442,8 +597,9 @@ class SubscriptionPolicies: Definition: SubscriptionPolicies """ - location_placement_id: Optional[str] = field( + location_placement_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "locationPlacementId"}, ) """ @@ -451,13 +607,15 @@ class SubscriptionPolicies: visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions. """ - quota_id: Optional[str] = field( + quota_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "quotaId"}, ) """The subscription quota Id.""" - spending_limit: Optional[str] = field( + spending_limit: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spendingLimit"}, ) """The subscription spending limit.""" @@ -469,10 +627,11 @@ class TemplateLink: Definition: TemplateLink """ - uri: Optional[str] = None + uri: str """URI referencing the template.""" - content_version: Optional[str] = field( + content_version: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentVersion"}, ) """If included it must match the ContentVersion in the template.""" @@ -484,10 +643,11 @@ class ParametersLink: Definition: ParametersLink """ - uri: Optional[str] = None + uri: str """URI referencing the template.""" - content_version: Optional[str] = field( + content_version: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentVersion"}, ) """If included it must match the ContentVersion in the template.""" @@ -499,28 +659,31 @@ class DeploymentProperties: Definition: DeploymentProperties """ - template: Optional[Dict[str, Any]] = None + template: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ The template content. It can be a JObject or a well formed JSON string. Use only one of Template or TemplateLink. """ - template_link: Optional[TemplateLink] = field( + template_link: Optional[TemplateLink | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "templateLink"}, ) - parameters: Optional[Dict[str, Any]] = None + parameters: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ Deployment parameters. It can be a JObject or a well formed JSON string. Use only one of Parameters or ParametersLink. """ - parameters_link: Optional[ParametersLink] = field( + parameters_link: Optional[ParametersLink | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parametersLink"}, ) - mode: Optional[str] = None + mode: str """The deployment mode.""" - debug_setting: Optional[DebugSetting] = field( + debug_setting: Optional[DebugSetting | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "debugSetting"}, ) @@ -531,8 +694,9 @@ class DebugSetting: Definition: DebugSetting """ - detail_level: Optional[str] = field( + detail_level: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "detailLevel"}, ) """The debug detail level.""" @@ -544,7 +708,12 @@ class Deployment: Definition: Deployment """ - properties: Optional[DeploymentProperties] = None + properties: Optional[ + DeploymentProperties | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -553,13 +722,13 @@ class ResourceManagementErrorWithDetails: Definition: ResourceManagementErrorWithDetails """ - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """The error code returned from the server.""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """The error message returned from the server.""" - target: Optional[str] = None + target: Optional[str] = dataclass_field(default=None, kw_only=True) """The target of the error.""" - details: Optional[List[Dict[str, Any]]] = None + details: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Validation error.""" @@ -569,10 +738,11 @@ class AliasPathType: Definition: AliasPathType """ - path: Optional[str] = None + path: Optional[str] = dataclass_field(default=None, kw_only=True) """The path of an alias.""" - api_versions: Optional[List[str]] = field( + api_versions: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "apiVersions"}, ) """The api versions.""" @@ -584,9 +754,14 @@ class AliasType: Definition: AliasType """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The alias name.""" - paths: Optional[List[AliasPathType]] = None + paths: Optional[ + List[AliasPathType | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The paths for an alias.""" @@ -596,23 +771,35 @@ class ProviderResourceType: Definition: ProviderResourceType """ - resource_type: Optional[str] = field( + resource_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceType"}, ) """The resource type.""" - locations: Optional[List[ObjectWithoutType]] = None + locations: Optional[ + List[ObjectWithoutType | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """ The collection of locations where this resource type can be created in. """ - aliases: Optional[List[AliasType]] = None + aliases: Optional[ + List[AliasType | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The aliases that are supported by this resource type.""" - api_versions: Optional[List[str]] = field( + api_versions: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "apiVersions"}, ) """The api version.""" - properties: Optional[Dict[str, str]] = None + properties: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True) """The properties.""" @@ -622,15 +809,17 @@ class BasicDependency: Definition: BasicDependency """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the dependency.""" - resource_type: Optional[str] = field( + resource_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceType"}, ) """The dependency resource type.""" - resource_name: Optional[str] = field( + resource_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceName"}, ) """The dependency resource name.""" @@ -642,20 +831,23 @@ class Dependency: Definition: Dependency """ - depends_on: Optional[List[BasicDependency]] = field( + depends_on: Optional[List[BasicDependency | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dependsOn"}, ) """The list of dependencies.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the dependency.""" - resource_type: Optional[str] = field( + resource_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceType"}, ) """The dependency resource type.""" - resource_name: Optional[str] = field( + resource_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceName"}, ) """The dependency resource name.""" @@ -667,40 +859,55 @@ class DeploymentPropertiesExtended: Definition: DeploymentPropertiesExtended """ - provisioning_state: Optional[str] = field( + provisioning_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "provisioningState"}, ) """The state of the provisioning.""" - correlation_id: Optional[str] = field( + correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "correlationId"}, ) """The correlation ID of the deployment.""" - timestamp: Optional[str] = None + timestamp: Optional[str] = dataclass_field(default=None, kw_only=True) """The timestamp of the template deployment.""" - outputs: Optional[Dict[str, Any]] = None + outputs: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Key/value pairs that represent deploymentoutput.""" - providers: Optional[List[Provider]] = None + providers: Optional[ + List[Provider | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of resource providers needed for the deployment.""" - dependencies: Optional[List[Dependency]] = None + dependencies: Optional[ + List[Dependency | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of deployment dependencies.""" - template: Optional[Dict[str, Any]] = None + template: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The template content. Use only one of Template or TemplateLink.""" - template_link: Optional[TemplateLink] = field( + template_link: Optional[TemplateLink | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "templateLink"}, ) - parameters: Optional[Dict[str, Any]] = None + parameters: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Deployment parameters. Use only one of Parameters or ParametersLink.""" - parameters_link: Optional[ParametersLink] = field( + parameters_link: Optional[ParametersLink | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parametersLink"}, ) - mode: Optional[str] = None + mode: str """The deployment mode.""" - debug_setting: Optional[DebugSetting] = field( + debug_setting: Optional[DebugSetting | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "debugSetting"}, ) @@ -711,14 +918,15 @@ class Plan: Definition: Plan """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The plan ID.""" - publisher: Optional[str] = None + publisher: Optional[str] = dataclass_field(default=None, kw_only=True) """The publisher ID.""" - product: Optional[str] = None + product: Optional[str] = dataclass_field(default=None, kw_only=True) """The offer ID.""" - promotion_code: Optional[str] = field( + promotion_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "promotionCode"}, ) """The promotion code.""" @@ -730,17 +938,17 @@ class Sku: Definition: Sku """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The sku name.""" - tier: Optional[str] = None + tier: Optional[str] = dataclass_field(default=None, kw_only=True) """The sku tier.""" - size: Optional[str] = None + size: Optional[str] = dataclass_field(default=None, kw_only=True) """The sku size.""" - family: Optional[str] = None + family: Optional[str] = dataclass_field(default=None, kw_only=True) """The sku family.""" - model: Optional[str] = None + model: Optional[str] = dataclass_field(default=None, kw_only=True) """The sku model.""" - capacity: Optional[int] = None + capacity: Optional[int] = dataclass_field(default=None, kw_only=True) """The sku capacity.""" @@ -750,17 +958,23 @@ class Identity: Definition: Identity """ - principal_id: Optional[str] = field( + principal_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "principalId"}, ) """The principal id of resource identity.""" - tenant_id: Optional[str] = field( + tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tenantId"}, ) """The tenant id of resource.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The identity type.""" @@ -770,8 +984,9 @@ class ResourceGroupProperties: Definition: ResourceGroupProperties """ - provisioning_state: Optional[str] = field( + provisioning_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "provisioningState"}, ) """The provisioning state.""" @@ -783,12 +998,12 @@ class ExportTemplateRequest: Definition: ExportTemplateRequest """ - resources: Optional[List[str]] = None + resources: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ The ids of the resources. The only supported string currently is '*' (all resources). Future api updates will support exporting specific resources. """ - options: Optional[str] = None + options: Optional[str] = dataclass_field(default=None, kw_only=True) """ The export template options. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or @@ -802,9 +1017,13 @@ class TagCount: Definition: TagCount """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type of count.""" - value: Optional[int] = None + value: Optional[int] = dataclass_field(default=None, kw_only=True) """Value of count.""" @@ -814,15 +1033,17 @@ class TargetResource: Definition: TargetResource """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the resource.""" - resource_name: Optional[str] = field( + resource_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceName"}, ) """The name of the resource.""" - resource_type: Optional[str] = field( + resource_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceType"}, ) """The type of the resource.""" @@ -834,7 +1055,7 @@ class HttpMessage: Definition: HttpMessage """ - content: Optional[Dict[str, Any]] = None + content: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """HTTP message content.""" @@ -844,34 +1065,44 @@ class DeploymentOperationProperties: Definition: DeploymentOperationProperties """ - provisioning_state: Optional[str] = field( + provisioning_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "provisioningState"}, ) """The state of the provisioning.""" - timestamp: Optional[str] = None + timestamp: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time of the operation.""" - service_request_id: Optional[str] = field( + service_request_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serviceRequestId"}, ) """Deployment operation service request id.""" - status_code: Optional[str] = field( + status_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusCode"}, ) """Operation status code.""" - status_message: Optional[Dict[str, Any]] = field( + status_message: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusMessage"}, ) """Operation status message.""" - target_resource: Optional[TargetResource] = field( + target_resource: Optional[TargetResource | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetResource"}, ) - request: Optional[HttpMessage] = None - response: Optional[HttpMessage] = None + request: Optional[HttpMessage | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + response: Optional[ + HttpMessage | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -880,7 +1111,7 @@ class ObjectWithoutType: Definition: ObjectWithoutType """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -898,7 +1129,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -915,8 +1146,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -937,7 +1168,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -953,15 +1184,49 @@ def connector_name(self) -> str: return "arm" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -978,7 +1243,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -991,7 +1260,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def subscriptions_list_locations_async( + def list_subscriptions_list_locations( self, subscription_id: str, *, @@ -999,11 +1268,31 @@ async def subscriptions_list_locations_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists the subscription locations Lists the locations available for the subscription. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Subscriptions_ListLocations`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1013,29 +1302,50 @@ async def subscriptions_list_locations_async( query_params.append("x-ms-api-version=" + quote("2016-06-01", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def subscriptions_get_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def subscriptions_get( self, subscription_id: str, *, @@ -1048,6 +1358,23 @@ async def subscriptions_get_async( Read a subscription Reads the details for a particular subscription. + + Swagger operation ID: `Subscriptions_Get`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1058,7 +1385,7 @@ async def subscriptions_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1072,6 +1399,7 @@ async def subscriptions_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1079,32 +1407,54 @@ async def subscriptions_get_async( return json.loads(response.text) - async def subscriptions_list_async( + def list_subscriptions( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List subscriptions Gets a list of all the subscriptions to which the principal has access. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Subscriptions_List`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/subscriptions" query_params = [] query_params.append("x-ms-api-version=" + quote("2016-06-01", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1117,29 +1467,38 @@ async def subscriptions_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def deployments_get_async( + return AsyncItemPaged(get_next, extract_data) + + async def deployments_get( self, subscription_id: str, resource_group_name: str, deployment_name: str, - wait: Optional[bool] = None, *, + wait: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1149,6 +1508,27 @@ async def deployments_get_async( Read a template deployment Reads a template deployment within a resource group. + + Swagger operation ID: `Deployments_Get`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + deployment_name: The name of the resource group template + deployment. + wait: If the action should wait until deployment is completed. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1171,7 +1551,7 @@ async def deployments_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1185,6 +1565,7 @@ async def deployments_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1192,14 +1573,14 @@ async def deployments_get_async( return json.loads(response.text) - async def deployments_create_or_update_async( + async def deployments_create_or_update( self, - input: Deployment, + input: Deployment | Mapping[str, Any], subscription_id: str, resource_group_name: str, deployment_name: str, - wait: Optional[bool] = None, *, + wait: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1210,6 +1591,28 @@ async def deployments_create_or_update_async( Create or update a named resource group template deployment. A template and parameters are expected for the request to succeed. + + Swagger operation ID: `Deployments_CreateOrUpdate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + deployment_name: The name of the deployment. + wait: If the action should wait until deployment is completed. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1232,7 +1635,7 @@ async def deployments_create_or_update_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1246,6 +1649,7 @@ async def deployments_create_or_update_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1253,7 +1657,7 @@ async def deployments_create_or_update_async( return json.loads(response.text) - async def deployments_delete_async( + async def deployments_delete( self, subscription_id: str, resource_group_name: str, @@ -1269,6 +1673,26 @@ async def deployments_delete_async( Deletes a resource group template deployment. The resources will not be deleted; only the metadata about the template deployment. + + Swagger operation ID: `Deployments_Delete`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + deployment_name: The name of the resource group template + deployment. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1286,7 +1710,7 @@ async def deployments_delete_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1294,15 +1718,19 @@ async def deployments_delete_async( response_hook=response_hook, ) + if response.status == 404: + return None + if not (200 <= response.status < 300): raise ConnectorException( "DELETE", request_url, response.status, response.text, + response=response, ) - async def deployments_cancel_async( + async def deployments_cancel( self, subscription_id: str, resource_group_name: str, @@ -1318,6 +1746,26 @@ async def deployments_cancel_async( Cancel a currently running template deployment. All pending template operations will be suspended. + + Swagger operation ID: `Deployments_Cancel`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + deployment_name: The name of the resource group template + deployment. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1336,7 +1784,7 @@ async def deployments_cancel_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1350,11 +1798,12 @@ async def deployments_cancel_async( request_url, response.status, response.text, + response=response, ) - async def deployments_validate_async( + async def deployments_validate( self, - input: Deployment, + input: Deployment | Mapping[str, Any], subscription_id: str, resource_group_name: str, deployment_name: str, @@ -1370,6 +1819,28 @@ async def deployments_validate_async( Validates a deployment template. This operation does not have side effects and can be used to test a template deployment for syntax or logical errors. + + Swagger operation ID: `Deployments_Validate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + deployment_name: The name of the resource group template + deployment. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1388,7 +1859,7 @@ async def deployments_validate_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1402,6 +1873,7 @@ async def deployments_validate_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1409,7 +1881,7 @@ async def deployments_validate_async( return json.loads(response.text) - async def deployments_export_template_async( + async def deployments_export_template( self, subscription_id: str, resource_group_name: str, @@ -1424,6 +1896,26 @@ async def deployments_export_template_async( Export deployment template Exports a template from a past resource group deployment. + + Swagger operation ID: `Deployments_ExportTemplate`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + deployment_name: The name of the resource group template + deployment. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1442,7 +1934,7 @@ async def deployments_export_template_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1456,6 +1948,7 @@ async def deployments_export_template_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1463,26 +1956,47 @@ async def deployments_export_template_async( return json.loads(response.text) - async def deployments_list_async( + def list_deployments( self, subscription_id: str, resource_group_name: str, + *, filter: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List template deployments Lists all the resource group template deployments. This operation is useful to know what has been provisioned thus far. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Deployments_List`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + filter: The filter to apply on the operation. + top: Query parameters. If nothing is passed returns all values. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1508,11 +2022,18 @@ async def deployments_list_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1525,23 +2046,32 @@ async def deployments_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def deployment_operations_get_async( + return AsyncItemPaged(get_next, extract_data) + + async def deployment_operations_get( self, subscription_id: str, resource_group_name: str, @@ -1558,6 +2088,27 @@ async def deployment_operations_get_async( Reads a particular resource group template deployment operation. This is useful for troubleshooting failed template deployments. + + Swagger operation ID: `DeploymentOperations_Get`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + deployment_name: The name of the resource group template + deployment. + operation_id: Operation Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1575,7 +2126,7 @@ async def deployment_operations_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1589,6 +2140,7 @@ async def deployment_operations_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1596,26 +2148,48 @@ async def deployment_operations_get_async( return json.loads(response.text) - async def deployment_operations_list_async( + def list_deployment_operations( self, subscription_id: str, resource_group_name: str, deployment_name: str, - top: Optional[int] = None, *, + top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists template deployment operations Lists all the template deployment operations. This is useful for troubleshooting failed template deployments. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `DeploymentOperations_List`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + deployment_name: The name of the resource group template + deployment. + top: Query parameters. If nothing is passed returns all values. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1636,11 +2210,18 @@ async def deployment_operations_list_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1653,23 +2234,32 @@ async def deployment_operations_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def providers_unregister_async( + return AsyncItemPaged(get_next, extract_data) + + async def providers_unregister( self, subscription_id: str, resource_provider_namespace: str, @@ -1685,6 +2275,24 @@ async def providers_unregister_async( Unregisters provider from a subscription. This operation will fail if there are any resources from that resource provider in the subscription. + + Swagger operation ID: `Providers_Unregister`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_provider_namespace: Namespace of the resource provider. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1699,7 +2307,7 @@ async def providers_unregister_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1713,6 +2321,7 @@ async def providers_unregister_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1720,7 +2329,7 @@ async def providers_unregister_async( return json.loads(response.text) - async def providers_register_async( + async def providers_register( self, subscription_id: str, resource_provider_namespace: str, @@ -1735,6 +2344,24 @@ async def providers_register_async( Registers a resource provider to be used with a subscription. This will provision permissions for the service into your subscription. + + Swagger operation ID: `Providers_Register`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_provider_namespace: Namespace of the resource provider. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1749,7 +2376,7 @@ async def providers_register_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1763,6 +2390,7 @@ async def providers_register_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1770,24 +2398,44 @@ async def providers_register_async( return json.loads(response.text) - async def providers_list_async( + def list_providers( self, subscription_id: str, + *, top: Optional[int] = None, expand: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List resource providers Lists the resource providers available for the subscription. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Providers_List`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + top: Query parameters. If nothing is passed returns all values. + expand: The $expand query parameter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1807,11 +2455,18 @@ async def providers_list_async( query_params.append(f"$expand={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1824,28 +2479,37 @@ async def providers_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def providers_get_async( + return AsyncItemPaged(get_next, extract_data) + + async def providers_get( self, subscription_id: str, resource_provider_namespace: str, - expand: Optional[str] = None, *, + expand: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1855,6 +2519,25 @@ async def providers_get_async( Read resource provider Reads a particular resource provider within the subscription. + + Swagger operation ID: `Providers_Get`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_provider_namespace: Namespace of the resource provider. + expand: The $expand query parameter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1873,7 +2556,7 @@ async def providers_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1887,6 +2570,7 @@ async def providers_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1894,26 +2578,48 @@ async def providers_get_async( return json.loads(response.text) - async def resource_groups_list_resources_async( + def list_resource_groups_list_resources( self, subscription_id: str, resource_group_name: str, + *, filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List resources by resource group Lists all the resources under a resource group. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ResourceGroups_ListResources`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + filter: The filter to apply on the operation. + expand: The $expand query parameter. + top: Query parameters. If nothing is passed returns all values. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1942,11 +2648,18 @@ async def resource_groups_list_resources_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1959,23 +2672,32 @@ async def resource_groups_list_resources_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def resource_groups_get_async( + return AsyncItemPaged(get_next, extract_data) + + async def resource_groups_get( self, subscription_id: str, resource_group_name: str, @@ -1989,6 +2711,24 @@ async def resource_groups_get_async( Read a resource group Reads a particular resource group within the subscription. + + Swagger operation ID: `ResourceGroups_Get`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2002,7 +2742,7 @@ async def resource_groups_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2016,6 +2756,7 @@ async def resource_groups_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2023,9 +2764,9 @@ async def resource_groups_get_async( return json.loads(response.text) - async def resource_groups_create_or_update_async( + async def resource_groups_create_or_update( self, - input: ResourceGroup, + input: ResourceGroup | Mapping[str, Any], subscription_id: str, resource_group_name: str, *, @@ -2039,6 +2780,27 @@ async def resource_groups_create_or_update_async( Creates or updates a resource group. The response code can be used to distinguish between a create (201) or update (200). + + Swagger operation ID: `ResourceGroups_CreateOrUpdate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: The name of the resource group to be created + or updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2052,7 +2814,7 @@ async def resource_groups_create_or_update_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2066,6 +2828,7 @@ async def resource_groups_create_or_update_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2073,7 +2836,7 @@ async def resource_groups_create_or_update_async( return json.loads(response.text) - async def resource_groups_delete_async( + async def resource_groups_delete( self, subscription_id: str, resource_group_name: str, @@ -2087,6 +2850,24 @@ async def resource_groups_delete_async( Delete a resource group Delete a particular resource group within the subscription. + + Swagger operation ID: `ResourceGroups_Delete`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2100,7 +2881,7 @@ async def resource_groups_delete_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2114,11 +2895,12 @@ async def resource_groups_delete_async( request_url, response.status, response.text, + response=response, ) - async def resource_groups_patch_async( + async def resource_groups_patch( self, - input: ResourceGroup, + input: ResourceGroup | Mapping[str, Any], subscription_id: str, resource_group_name: str, *, @@ -2132,6 +2914,26 @@ async def resource_groups_patch_async( Updates an existing resource group. If the resource does not exist, this request will fail. + + Swagger operation ID: `ResourceGroups_Patch`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2145,7 +2947,7 @@ async def resource_groups_patch_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -2159,6 +2961,7 @@ async def resource_groups_patch_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2166,9 +2969,9 @@ async def resource_groups_patch_async( return json.loads(response.text) - async def resource_groups_export_template_async( + async def resource_groups_export_template( self, - input: ExportTemplateRequest, + input: ExportTemplateRequest | Mapping[str, Any], subscription_id: str, resource_group_name: str, *, @@ -2183,6 +2986,26 @@ async def resource_groups_export_template_async( Exports a deployment template from an existing resource group. This can only be successful if the underlying resources have a schema defined by Microsoft. + + Swagger operation ID: `ResourceGroups_ExportTemplate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2197,7 +3020,7 @@ async def resource_groups_export_template_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2211,6 +3034,7 @@ async def resource_groups_export_template_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2218,25 +3042,45 @@ async def resource_groups_export_template_async( return json.loads(response.text) - async def resource_groups_list_async( + def list_resource_groups( self, subscription_id: str, + *, filter: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List resource groups Lists all the resource groups within the subscription. The results are paginated at 1,000+ records. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ResourceGroups_List`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + filter: The filter to apply on the operation. + top: Query parameters. If nothing is passed returns all values. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2258,11 +3102,18 @@ async def resource_groups_list_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2275,42 +3126,72 @@ async def resource_groups_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def resources_list_async( + def list_resources( self, subscription_id: str, + *, filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List resources by subscription Reads all of the resources under a particular subscription. The results are paginated at 1,000+ records. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Resources_List`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + filter: The filter to apply on the operation. + expand: The $expand query parameter. + top: Query parameters. If nothing is passed returns all values. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2335,11 +3216,18 @@ async def resources_list_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2352,23 +3240,32 @@ async def resources_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def resources_get_by_id_async( + return AsyncItemPaged(get_next, extract_data) + + async def resources_get_by_id( self, subscription_id: str, resource_group_name: str, @@ -2385,6 +3282,28 @@ async def resources_get_by_id_async( Read a resource Reads a resource object. + + Swagger operation ID: `Resources_GetById`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + resource_provider_namespace: Namespace of the resource provider. + short_resource_id: The short Id of the resource, including the + resource name and resource type. For example, sites/mySite. + x_ms_api_version: Api Version to be used. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2404,7 +3323,7 @@ async def resources_get_by_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2418,6 +3337,7 @@ async def resources_get_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2425,9 +3345,9 @@ async def resources_get_by_id_async( return json.loads(response.text) - async def resources_create_or_update_by_id_async( + async def resources_create_or_update_by_id( self, - input: GenericResource, + input: GenericResource | Mapping[str, Any], subscription_id: str, resource_group_name: str, resource_provider_namespace: str, @@ -2444,6 +3364,30 @@ async def resources_create_or_update_by_id_async( Creates or updates a resource. The response code can be used to distinguish between a create (201) or update (200). + + Swagger operation ID: `Resources_CreateOrUpdateById`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + resource_provider_namespace: Namespace of the resource provider. + short_resource_id: The short Id of the resource, including the + resource name and resource type. For example, sites/mySite. + x_ms_api_version: Api Version to be used. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2463,7 +3407,7 @@ async def resources_create_or_update_by_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2477,6 +3421,7 @@ async def resources_create_or_update_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2484,7 +3429,7 @@ async def resources_create_or_update_by_id_async( return json.loads(response.text) - async def resources_delete_by_id_async( + async def resources_delete_by_id( self, subscription_id: str, resource_group_name: str, @@ -2501,6 +3446,28 @@ async def resources_delete_by_id_async( Delete a resource Deletes a resource. + + Swagger operation ID: `Resources_DeleteById`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + resource_provider_namespace: Namespace of the resource provider. + short_resource_id: The short Id of the resource, including the + resource name and resource type. For example, sites/mySite. + x_ms_api_version: Api Version to be used. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2520,7 +3487,7 @@ async def resources_delete_by_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2534,11 +3501,12 @@ async def resources_delete_by_id_async( request_url, response.status, response.text, + response=response, ) - async def resources_invoke_async( + async def resources_invoke( self, - input: ResourcesInvokeInput, + input: ResourcesInvokeInput | Mapping[str, Any], subscription_id: str, resource_group_name: str, resource_provider_namespace: str, @@ -2555,6 +3523,31 @@ async def resources_invoke_async( Invoke resource operation Invokes an operation on an Azure resource. + + Swagger operation ID: `Resources_Invoke`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + resource_provider_namespace: Namespace of the resource provider. + short_resource_id: The short Id of the resource, including the + resource name and resource type. For example, sites/mySite. + action_name: Name of the resource action to invoke. + x_ms_api_version: Api Version to be used. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2575,7 +3568,7 @@ async def resources_invoke_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2589,6 +3582,7 @@ async def resources_invoke_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2596,7 +3590,7 @@ async def resources_invoke_async( return json.loads(response.text) - async def provider_resources_get_by_id_async( + async def provider_resources_get_by_id( self, subscription_id: str, resource_provider_namespace: str, @@ -2612,6 +3606,27 @@ async def provider_resources_get_by_id_async( Read a resource in provider Reads a resource object. + + Swagger operation ID: `Provider_Resources_GetById`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_provider_namespace: Namespace of the resource provider. + short_resource_id: The short Id of the resource, including the + resource name and resource type. For example, sites/mySite. + x_ms_api_version: Api Version to be used. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2629,7 +3644,7 @@ async def provider_resources_get_by_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2643,6 +3658,7 @@ async def provider_resources_get_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2650,9 +3666,9 @@ async def provider_resources_get_by_id_async( return json.loads(response.text) - async def provider_resources_invoke_async( + async def provider_resources_invoke( self, - input: ProviderResourcesInvokeInput, + input: ProviderResourcesInvokeInput | Mapping[str, Any], subscription_id: str, resource_provider_namespace: str, short_resource_id: str, @@ -2667,6 +3683,29 @@ async def provider_resources_invoke_async( Invoke resource operation in provider Invokes an operation on an Azure resource. + + Swagger operation ID: `Provider_Resources_Invoke`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_provider_namespace: Namespace of the resource provider. + short_resource_id: The short Id of the resource, including the + resource name and resource type. For example, sites/mySite. + x_ms_api_version: Api Version to be used. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2684,7 +3723,7 @@ async def provider_resources_invoke_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2698,6 +3737,7 @@ async def provider_resources_invoke_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2705,7 +3745,7 @@ async def provider_resources_invoke_async( return json.loads(response.text) - async def tags_create_or_update_value_async( + async def tags_create_or_update_value( self, subscription_id: str, tag_name: str, @@ -2720,6 +3760,25 @@ async def tags_create_or_update_value_async( Create or update a subscription resource tag value Create or update a subscription resource tag value. + + Swagger operation ID: `Tags_CreateOrUpdateValue`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + tag_name: The name of the tag. + tag_value: The value of the tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2735,7 +3794,7 @@ async def tags_create_or_update_value_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2749,6 +3808,7 @@ async def tags_create_or_update_value_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2756,7 +3816,7 @@ async def tags_create_or_update_value_async( return json.loads(response.text) - async def tags_delete_value_async( + async def tags_delete_value( self, subscription_id: str, tag_name: str, @@ -2771,6 +3831,25 @@ async def tags_delete_value_async( Delete a subscription resource tag value Delete a subscription resource tag value. + + Swagger operation ID: `Tags_DeleteValue`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + tag_name: The name of the tag. + tag_value: The value of the tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2786,7 +3865,7 @@ async def tags_delete_value_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2800,9 +3879,10 @@ async def tags_delete_value_async( request_url, response.status, response.text, + response=response, ) - async def tags_create_or_update_async( + async def tags_create_or_update( self, subscription_id: str, tag_name: str, @@ -2816,6 +3896,24 @@ async def tags_create_or_update_async( Create or update a subscription resource tag name Create or update a subscription resource tag name. + + Swagger operation ID: `Tags_CreateOrUpdate`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + tag_name: The name of the tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2829,7 +3927,7 @@ async def tags_create_or_update_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2843,6 +3941,7 @@ async def tags_create_or_update_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2850,7 +3949,7 @@ async def tags_create_or_update_async( return json.loads(response.text) - async def tags_delete_async( + async def tags_delete( self, subscription_id: str, tag_name: str, @@ -2864,6 +3963,24 @@ async def tags_delete_async( Delete a subscription resource tag name Delete a subscription resource tag name. + + Swagger operation ID: `Tags_Delete`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + tag_name: The name of the tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2877,7 +3994,7 @@ async def tags_delete_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2891,9 +4008,10 @@ async def tags_delete_async( request_url, response.status, response.text, + response=response, ) - async def tags_list_async( + def list_tags( self, subscription_id: str, *, @@ -2901,14 +4019,32 @@ async def tags_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List subscription resource tags Lists all the subscription resource tags. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Tags_List`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2918,11 +4054,18 @@ async def tags_list_async( query_params.append("x-ms-api-version=" + quote("2016-06-01", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2935,18 +4078,27 @@ async def tags_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/azuread.py b/src/azure/connectors/azuread.py index 1b3c5aa0..bc134331 100644 --- a/src/azure/connectors/azuread.py +++ b/src/azure/connectors/azuread.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,28 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "AzureadClient", + "AssignManagerRequest", + "CheckMemberGroupsRequest", + "CreateGroupInput", + "CreateGroupResponse", + "CreateOffice365GroupInput", + "CreateSecurityGroupInput", + "CreateUserRequest", + "GetGroupMembersResponse", + "GetGroupRequest", + "GetGroupResponse", + "GetMemberGroupsRequest", + "GetMemberGroupsResponse", + "GetMemberGroupsResponseV2", + "GetUserResponse", + "UpdateUserRequest", +] + # Type Definitions @@ -29,32 +50,23 @@ class CreateOffice365GroupInput: Create Office 365 group """ - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """Display name of the new group.""" - description: Optional[str] = None + description: str """Description of the new group.""" - mail_nickname: Optional[str] = field( - default=None, + mail_nickname: str = dataclass_field( metadata={"wire_name": "mailNickname"}, ) """The mail alias of the new group.""" - group_types: Optional[List[str]] = field( - default=None, + group_types: List[str] = dataclass_field( metadata={"wire_name": "groupTypes"}, ) """For Office 365, group type is 'Unified'.""" - security_enabled: Optional[bool] = field( - default=None, + security_enabled: bool = dataclass_field( metadata={"wire_name": "securityEnabled"}, ) """True if the new group is a security group.""" - mail_enabled: Optional[bool] = field( - default=None, - metadata={"wire_name": "mailEnabled"}, - ) + mail_enabled: bool = dataclass_field(metadata={"wire_name": "mailEnabled"}) """True if the new group is a mailing group.""" @@ -64,80 +76,93 @@ class CreateGroupResponse: Response for Create Office 365 group """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """@odata.context""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - deleted_date_time: Optional[str] = field( + deleted_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "deletedDateTime"}, ) """deletedDateTime""" - classification: Optional[str] = None + classification: Optional[str] = dataclass_field(default=None, kw_only=True) """classification""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """createdDateTime""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """description""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """displayName""" - group_types: Optional[List[str]] = field( + group_types: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "groupTypes"}, ) """groupTypes""" - mail: Optional[str] = None + mail: Optional[str] = dataclass_field(default=None, kw_only=True) """mail""" - mail_enabled: Optional[bool] = field( + mail_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mailEnabled"}, ) """mailEnabled""" - mail_nickname: Optional[str] = field( + mail_nickname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mailNickname"}, ) """mailNickname""" - on_premises_last_sync_date_time: Optional[str] = field( + on_premises_last_sync_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesLastSyncDateTime"}, ) """onPremisesLastSyncDateTime""" - on_premises_security_identifier: Optional[str] = field( + on_premises_security_identifier: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesSecurityIdentifier"}, ) """onPremisesSecurityIdentifier""" - on_premises_sync_enabled: Optional[bool] = field( + on_premises_sync_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesSyncEnabled"}, ) """onPremisesSyncEnabled""" - proxy_addresses: Optional[List[str]] = field( + proxy_addresses: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "proxyAddresses"}, ) """proxyAddresses""" - renewed_date_time: Optional[str] = field( + renewed_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "renewedDateTime"}, ) """renewedDateTime""" - security_enabled: Optional[bool] = field( + security_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "securityEnabled"}, ) """securityEnabled""" - visibility: Optional[str] = None + visibility: Optional[str] = dataclass_field(default=None, kw_only=True) """visibility""" @@ -147,27 +172,19 @@ class CreateSecurityGroupInput: Create security group """ - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """Display name of the new group.""" - description: Optional[str] = None + description: str """Description of the new group.""" - mail_nickname: Optional[str] = field( - default=None, + mail_nickname: str = dataclass_field( metadata={"wire_name": "mailNickname"}, ) """The mail alias of the new group.""" - security_enabled: Optional[bool] = field( - default=None, + security_enabled: bool = dataclass_field( metadata={"wire_name": "securityEnabled"}, ) """True if the new group is a security group.""" - mail_enabled: Optional[bool] = field( - default=None, - metadata={"wire_name": "mailEnabled"}, - ) + mail_enabled: bool = dataclass_field(metadata={"wire_name": "mailEnabled"}) """True if the new group is a mailing group.""" @@ -177,51 +194,58 @@ class GetGroupResponse: Response for Get group """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique identifier for the group.""" - deleted_date_time: Optional[str] = field( + deleted_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "deletedDateTime"}, ) """Date-time the group was deleted.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """Date-time the group was created.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """An optional description for the group.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The display name for the group.""" - mail: Optional[str] = None + mail: Optional[str] = dataclass_field(default=None, kw_only=True) """The SMTP address for the group.""" - mail_enabled: Optional[bool] = field( + mail_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mailEnabled"}, ) """True if the group is mail-enabled.""" - on_premises_last_sync_date_time: Optional[str] = field( + on_premises_last_sync_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesLastSyncDateTime"}, ) """ A date-time indicating the last time at which the group was synced with the on-premises directory. """ - on_premises_sync_enabled: Optional[bool] = field( + on_premises_sync_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesSyncEnabled"}, ) """True if this group is synced from an on-premises directory.""" - security_enabled: Optional[bool] = field( + security_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "securityEnabled"}, ) """True if the group is a security group.""" - visibility: Optional[str] = None + visibility: Optional[str] = dataclass_field(default=None, kw_only=True) """Visibility of the group (public or private).""" @@ -231,51 +255,59 @@ class GetUserResponse: Response for Get user """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """A unique identifier for the user.""" - business_phones: Optional[List[str]] = field( + business_phones: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "businessPhones"}, ) - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The name displayed in the address book for the user.""" - given_name: Optional[str] = field( + given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "givenName"}, ) """The given name (first name) of the user.""" - job_title: Optional[str] = field( + job_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobTitle"}, ) """The user's job title.""" - mail: Optional[str] = None + mail: Optional[str] = dataclass_field(default=None, kw_only=True) """The SMTP address for the user.""" - mobile_phone: Optional[str] = field( + mobile_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mobilePhone"}, ) """The primary cellular telephone number for the user.""" - office_location: Optional[str] = field( + office_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "officeLocation"}, ) """The office location in the user's place of business.""" - preferred_language: Optional[str] = field( + preferred_language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredLanguage"}, ) """ The preferred language for the user. Should follow ISO 639-1 Code; for example 'en-US'. """ - surname: Optional[str] = None + surname: Optional[str] = dataclass_field(default=None, kw_only=True) """The user's surname (family name or last name).""" - user_principal_name: Optional[str] = field( + user_principal_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userPrincipalName"}, ) """The user principal name (UPN) of the user.""" @@ -287,12 +319,18 @@ class GetGroupMembersResponse: Response for Get group members """ - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """Link to get next page of results""" - value: Optional[List[GetUserResponse]] = None + value: Optional[ + List[GetUserResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Array of users that are members of the group.""" @@ -302,34 +340,25 @@ class CreateGroupInput: Create group """ - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """Display name of the new group.""" - description: Optional[str] = None + description: str """Description of the new group.""" - mail_nickname: Optional[str] = field( - default=None, + mail_nickname: str = dataclass_field( metadata={"wire_name": "mailNickname"}, ) """The mail alias of the new group.""" - group_types: Optional[List[str]] = field( - default=None, + group_types: List[str] = dataclass_field( metadata={"wire_name": "groupTypes"}, ) """ Choose 'Unified' for an O365 group. Choose 'None' for a security group. """ - security_enabled: Optional[bool] = field( - default=None, + security_enabled: bool = dataclass_field( metadata={"wire_name": "securityEnabled"}, ) """True if the new group is a security group.""" - mail_enabled: Optional[bool] = field( - default=None, - metadata={"wire_name": "mailEnabled"}, - ) + mail_enabled: bool = dataclass_field(metadata={"wire_name": "mailEnabled"}) """True if the new group is a mailing group.""" @@ -339,7 +368,7 @@ class GetMemberGroupsResponseV2: Response for Check group membership (V2) """ - value: Optional[GetMemberGroupsResponse] = None + value: Optional[GetMemberGroupsResponse] = dataclass_field(default=None, kw_only=True) @dataclass @@ -348,10 +377,7 @@ class GetGroupRequest: Definition: GetGroup_Request """ - id: Optional[str] = field( - default=None, - metadata={"wire_name": "@odata.id"}, - ) + id: str = dataclass_field(metadata={"wire_name": "@odata.id"}) """ Unique identifier of a user (Ex. '5e6cf5c7-b511-4842-6aae-3f6b8ae5e95b'). """ @@ -363,10 +389,7 @@ class AssignManagerRequest: Definition: AssignManager_Request """ - id: Optional[str] = field( - default=None, - metadata={"wire_name": "@odata.id"}, - ) + id: str = dataclass_field(metadata={"wire_name": "@odata.id"}) """ Unique identifier of a manager (Ex. '5f6cf5c7-a561-4842-9aae-3e6d8ce5e95b'). @@ -379,76 +402,89 @@ class UpdateUserRequest: Definition: UpdateUser_Request """ - user_principal_name: Optional[str] = field( + user_principal_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userPrincipalName"}, ) """The user principal name (UPN) of the user.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The name displayed in the address book for the user.""" - mail_nickname: Optional[str] = field( + mail_nickname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mailNickname"}, ) """The mail alias for the user.""" - given_name: Optional[str] = field( + given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "givenName"}, ) """The given name (first name) of the user.""" - surname: Optional[str] = None + surname: Optional[str] = dataclass_field(default=None, kw_only=True) """The user's surname (family name or last name).""" - account_enabled: Optional[bool] = field( + account_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "accountEnabled"}, ) """True if the new account should be enabled.""" - job_title: Optional[str] = field( + job_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobTitle"}, ) """The user's job title.""" - department: Optional[str] = None + department: Optional[str] = dataclass_field(default=None, kw_only=True) """The name for the department in which the user works.""" - mobile_phone: Optional[str] = field( + mobile_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mobilePhone"}, ) """ The mobile phone number for the user in any format such as '1 (234) 567-8910'. """ - office_location: Optional[str] = field( + office_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "officeLocation"}, ) """The office location in the user's place of business.""" - preferred_language: Optional[str] = field( + preferred_language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredLanguage"}, ) """ The preferred language for the user. Should follow ISO 639-1 Code; for example 'en-US'. """ - business_phones: Optional[List[str]] = field( + business_phones: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "businessPhones"}, ) - other_mails: Optional[List[str]] = field( + other_mails: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "otherMails"}, ) - custom_properties: Optional[Dict[str, str]] = field( + custom_properties: Optional[Dict[str, str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """Free form property name and value for this user.""" - on_premises_extension_attributes: Optional[Dict[str, Any]] = field( + on_premises_extension_attributes: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesExtensionAttributes"}, ) @@ -459,8 +495,7 @@ class GetMemberGroupsRequest: Definition: GetMemberGroups_Request """ - security_enabled_only: Optional[bool] = field( - default=None, + security_enabled_only: bool = dataclass_field( metadata={"wire_name": "securityEnabledOnly"}, ) """Determines if only security enabled groups should be fetched.""" @@ -475,64 +510,63 @@ class CreateUserRequest: Definition: CreateUser_Request """ - account_enabled: Optional[bool] = field( - default=None, + account_enabled: bool = dataclass_field( metadata={"wire_name": "accountEnabled"}, ) """True if the new account should be enabled when it is created.""" - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """The name displayed in the address book for the user.""" - mail_nickname: Optional[str] = field( - default=None, + mail_nickname: str = dataclass_field( metadata={"wire_name": "mailNickname"}, ) """The mail alias for the user.""" - password_profile: Optional[Dict[str, Any]] = field( - default=None, + password_profile: Dict[str, Any] = dataclass_field( metadata={"wire_name": "passwordProfile"}, ) """passwordProfile""" - user_principal_name: Optional[str] = field( - default=None, + user_principal_name: str = dataclass_field( metadata={"wire_name": "userPrincipalName"}, ) """The user principal name (UPN) of the user.""" - given_name: Optional[str] = field( + given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "givenName"}, ) """The user's given name (first name).""" - surname: Optional[str] = None + surname: Optional[str] = dataclass_field(default=None, kw_only=True) """The user's surname (family name or last name).""" - business_phones: Optional[List[str]] = field( + business_phones: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "businessPhones"}, ) - department: Optional[str] = None + department: Optional[str] = dataclass_field(default=None, kw_only=True) """The name for the department in which the user works.""" - job_title: Optional[str] = field( + job_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobTitle"}, ) """The user's job title.""" - mobile_phone: Optional[str] = field( + mobile_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mobilePhone"}, ) """ The mobile phone number for the user in any format such as '1 (234) 567-8910'. """ - office_location: Optional[str] = field( + office_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "officeLocation"}, ) """The office location in the user's place of business.""" - preferred_language: Optional[str] = field( + preferred_language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredLanguage"}, ) """ @@ -547,10 +581,7 @@ class CheckMemberGroupsRequest: Definition: CheckMemberGroups_Request """ - group_ids: Optional[List[str]] = field( - default=None, - metadata={"wire_name": "groupIds"}, - ) + group_ids: List[str] = dataclass_field(metadata={"wire_name": "groupIds"}) # Client Class @@ -564,7 +595,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -581,8 +612,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -603,7 +634,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -619,15 +650,49 @@ def connector_name(self) -> str: return "azuread" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -644,7 +709,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -657,9 +726,9 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def create_office365_group_async( + async def create_office365_group( self, - input: CreateOffice365GroupInput, + input: CreateOffice365GroupInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -670,10 +739,26 @@ async def create_office365_group_async( Create Office 365 group Create an Office 365 group in your Microsoft Entra ID tenant. + + Swagger operation ID: `CreateOffice365Group`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/groups/office365" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -687,6 +772,7 @@ async def create_office365_group_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -694,9 +780,9 @@ async def create_office365_group_async( return json.loads(response.text) - async def create_security_group_async( + async def create_security_group( self, - input: CreateSecurityGroupInput, + input: CreateSecurityGroupInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -707,12 +793,28 @@ async def create_security_group_async( Create security group Create a security group in your Microsoft Entra ID tenant. + + Swagger operation ID: `CreateSecurityGroup`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1.0/groups/securityGroup" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -726,6 +828,7 @@ async def create_security_group_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -733,7 +836,7 @@ async def create_security_group_async( return json.loads(response.text) - async def get_group_async( + async def get_group( self, id: str, *, @@ -746,13 +849,29 @@ async def get_group_async( Get group Get details for a group. + + Swagger operation ID: `GetGroup`. + + Args: + id: Unique identifier of a group (Ex. + '40639f36-46a6-73a6-91e2-9584b7913429'). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/groups/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -766,6 +885,7 @@ async def get_group_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -773,7 +893,7 @@ async def get_group_async( return json.loads(response.text) - async def get_user_async( + async def get_user( self, id: str, *, @@ -786,13 +906,29 @@ async def get_user_async( Get user Get details for a user. + + Swagger operation ID: `GetUser`. + + Args: + id: Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' + or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b'). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/users/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -806,6 +942,7 @@ async def get_user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -813,9 +950,9 @@ async def get_user_async( return json.loads(response.text) - async def update_user_async( + async def update_user( self, - input: UpdateUserRequest, + input: UpdateUserRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -827,13 +964,31 @@ async def update_user_async( Update user Update the info for a user. + + Swagger operation ID: `UpdateUser`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' + or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b'). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/users/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -847,9 +1002,10 @@ async def update_user_async( request_url, response.status, response.text, + response=response, ) - async def refresh_tokens_async( + async def refresh_tokens( self, id: str, *, @@ -862,13 +1018,29 @@ async def refresh_tokens_async( Refresh tokens Invalidate all refresh tokens for a user + + Swagger operation ID: `RefreshTokens`. + + Args: + id: Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' + or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b'). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/users/{quote(str(id), safe='')}/revokeSignInSessions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -882,11 +1054,12 @@ async def refresh_tokens_async( request_url, response.status, response.text, + response=response, ) - async def create_user_async( + async def create_user( self, - input: CreateUserRequest, + input: CreateUserRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -897,10 +1070,26 @@ async def create_user_async( Create user Create a new user in your Microsoft Entra ID tenant. + + Swagger operation ID: `CreateUser`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/users" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -914,6 +1103,7 @@ async def create_user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -921,16 +1111,16 @@ async def create_user_async( return json.loads(response.text) - async def get_group_members_async( + def list_group_members( self, id: str, - top: Optional[int] = None, *, + top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get group members @@ -939,8 +1129,27 @@ async def get_group_members_async( values, please turn on the Settings->Pagination feature and provide a Threshold limit. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetGroupMembers`. + + Args: + id: Unique identifier of a group (Ex. + '40639f36-46a6-73a6-91e2-9584b7913429'). + top: Limit on the number of results to return (from 1 to 999, + default is 100). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -954,11 +1163,18 @@ async def get_group_members_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -971,23 +1187,32 @@ async def get_group_members_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def remove_member_from_group_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def remove_member_from_group( self, group_id: str, member_id: str, @@ -1001,6 +1226,22 @@ async def remove_member_from_group_async( Remove Member From Group Remove Member From Group + + Swagger operation ID: `RemoveMemberFromGroup`. + + Args: + group_id: The Id of the group. + member_id: The Id of the member. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1012,7 +1253,7 @@ async def remove_member_from_group_async( f"/$ref" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1026,11 +1267,12 @@ async def remove_member_from_group_async( request_url, response.status, response.text, + response=response, ) - async def add_user_to_group_async( + async def add_user_to_group( self, - input: GetGroupRequest, + input: GetGroupRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -1042,13 +1284,31 @@ async def add_user_to_group_async( Add user to group Add a user to a group in this Microsoft Entra ID tenant. + + Swagger operation ID: `AddUserToGroup`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Unique identifier of a group (Ex. + '40639f36-46a6-73a6-91e2-9584b7913429'). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/groups/{quote(str(id), safe='')}/members/$ref" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1062,11 +1322,12 @@ async def add_user_to_group_async( request_url, response.status, response.text, + response=response, ) - async def assign_manager_async( + async def assign_manager( self, - input: AssignManagerRequest, + input: AssignManagerRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -1078,13 +1339,31 @@ async def assign_manager_async( Assign manager Assign a manager for a user. + + Swagger operation ID: `AssignManager`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' + or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b'). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/users/{quote(str(id), safe='')}/manager/$ref" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1098,11 +1377,12 @@ async def assign_manager_async( request_url, response.status, response.text, + response=response, ) - async def create_group_async( + async def create_group( self, - input: CreateGroupInput, + input: CreateGroupInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1113,10 +1393,26 @@ async def create_group_async( Create group Create a group in your Microsoft Entra ID tenant. + + Swagger operation ID: `CreateGroup`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/groups" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1130,6 +1426,7 @@ async def create_group_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1137,9 +1434,9 @@ async def create_group_async( return json.loads(response.text) - async def check_member_groups_async( + async def check_member_groups( self, - input: CheckMemberGroupsRequest, + input: CheckMemberGroupsRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -1152,13 +1449,31 @@ async def check_member_groups_async( If the user is a member of the given group, the result will contain the given id. Otherwise the result will be empty. + + Swagger operation ID: `CheckMemberGroupsV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' + or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b'). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/v1.0/users/{quote(str(id), safe='')}/checkMemberGroups" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1172,6 +1487,7 @@ async def check_member_groups_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1179,43 +1495,85 @@ async def check_member_groups_async( return json.loads(response.text) - async def get_member_groups_async( + def list_member_groups( self, - input: GetMemberGroupsRequest, + input: GetMemberGroupsRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get groups of a user Get the groups a user is a member of. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMemberGroupsV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Unique identifier of a user (Ex. 'user@tennant.onmicrosoft.com' + or '5f6ce5c7-b521-4842-9bbe-3f6d5aa5e35b'). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/v1.0/users/{quote(str(id), safe='')}/getMemberGroups" ) + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/azureautomation.py b/src/azure/connectors/azureautomation.py index 85a58449..46ddda03 100644 --- a/src/azure/connectors/azureautomation.py +++ b/src/azure/connectors/azureautomation.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,21 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "AzureautomationClient", + "AutomationAccountResponse", + "CreateJobInput", + "CreateJobResponse", + "ResourceGroup", + "ResourceGroupListResult", + "RunbookListResults", + "Subscription", + "SubscriptionListResult", +] + # Type Definitions @@ -29,9 +43,9 @@ class CreateJobResponse: Response for Get status of job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Resource ID of the Job""" - properties: Optional[Dict[str, Any]] = None + properties: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """properties""" @@ -41,7 +55,7 @@ class CreateJobInput: Create job """ - properties: Optional[Dict[str, Any]] = None + properties: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -50,10 +64,16 @@ class SubscriptionListResult: Response for List subscriptions """ - value: Optional[List[Subscription]] = None + value: Optional[ + List[Subscription | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The subscriptions.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -65,10 +85,16 @@ class ResourceGroupListResult: Response for List resource groups """ - value: Optional[List[ResourceGroup]] = None + value: Optional[ + List[ResourceGroup | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of resource groups.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -80,7 +106,7 @@ class AutomationAccountResponse: Response for List Automation accounts """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -90,7 +116,7 @@ class RunbookListResults: Response for List runbooks """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -99,30 +125,34 @@ class Subscription: Definition: Subscription """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000. """ - subscription_id: Optional[str] = field( + subscription_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subscriptionId"}, ) """The subscription Id.""" - tenant_id: Optional[str] = field( + tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tenantId"}, ) """The tenant Id.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The subscription display name.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The subscription state.""" - authorization_source: Optional[str] = field( + authorization_source: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "authorizationSource"}, ) """ @@ -138,14 +168,15 @@ class ResourceGroup: Definition: ResourceGroup """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY). """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The Name of the resource group.""" - managed_by: Optional[str] = field( + managed_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managedBy"}, ) """Id of the resource that manages this resource group.""" @@ -162,7 +193,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -179,8 +210,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -201,7 +232,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -217,15 +248,49 @@ def connector_name(self) -> str: return "azureautomation" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -242,7 +307,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -255,7 +324,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def get_job_output_async( + async def get_job_output( self, subscription_id: str, resource_group_name: str, @@ -271,6 +340,26 @@ async def get_job_output_async( Get job output Get outputs of an Azure Automation job. + + Swagger operation ID: `GetJobOutput`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: The name of the Azure Resource Group. + automation_account: The name of the Azure Automation Account. + job_id: GUID for the ID of the run. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -291,7 +380,7 @@ async def get_job_output_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -305,11 +394,12 @@ async def get_job_output_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_status_of_job_async( + async def get_status_of_job( self, subscription_id: str, resource_group_name: str, @@ -325,6 +415,26 @@ async def get_status_of_job_async( Get status of job Get Status of a Job + + Swagger operation ID: `GetStatusOfJob`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: The name of the Azure Resource Group. + automation_account: The name of the Azure Automation Account. + job_id: GUID for the ID of the run. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -344,7 +454,7 @@ async def get_status_of_job_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -358,6 +468,7 @@ async def get_status_of_job_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -365,15 +476,15 @@ async def get_status_of_job_async( return json.loads(response.text) - async def create_job_async( + async def create_job( self, - input: CreateJobInput, + input: CreateJobInput | Mapping[str, Any], subscription_id: str, resource_group_name: str, automation_account: str, + *, runbook_name: Optional[str] = None, wait: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -383,6 +494,29 @@ async def create_job_async( Create job Create Job to run on hybrid worker + + Swagger operation ID: `CreateJob`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: The name of the Azure Resource Group. + automation_account: The name of the Azure Automation Account. + runbook_name: Name of the runbook to run. + wait: Wait for the job to finish before completing the action. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -411,7 +545,7 @@ async def create_job_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -425,6 +559,7 @@ async def create_job_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -432,32 +567,54 @@ async def create_job_async( return json.loads(response.text) - async def subscriptions_list_async( + def list_subscriptions( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List subscriptions Gets a list of all the subscriptions to which the principal has access. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Subscriptions_List`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/subscriptions" query_params = [] query_params.append("x-ms-api-version=" + quote("2015-11-01", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -470,23 +627,32 @@ async def subscriptions_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def resource_groups_list_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_resource_groups( self, subscription_id: str, *, @@ -494,15 +660,33 @@ async def resource_groups_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List resource groups Lists all the resource groups within the subscription. Paginates at 1,000 records. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ResourceGroups_List`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -514,11 +698,18 @@ async def resource_groups_list_async( query_params.append("x-ms-api-version=" + quote("2015-10-31", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -531,23 +722,32 @@ async def resource_groups_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def automation_accounts_list_async( + def list_automation_accounts( self, subscription_id: str, resource_group_name: str, @@ -556,11 +756,32 @@ async def automation_accounts_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Automation accounts Lists Azure Automation accounts in a resource group. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `AutomationAccounts_List`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: The name of the Azure Resource Group. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -576,29 +797,50 @@ async def automation_accounts_list_async( query_params.append("x-ms-api-version=" + quote("2015-10-31", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def runbooks_list_async( + def list_runbooks( self, subscription_id: str, resource_group_name: str, @@ -608,11 +850,33 @@ async def runbooks_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List runbooks Lists Azure Automation runbooks in an automation account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Runbooks_List`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: The name of the Azure Resource Group. + automation_account: The name of the Azure Automation Account. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -630,29 +894,50 @@ async def runbooks_list_async( query_params.append("x-ms-api-version=" + quote("2015-10-31", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_runbook_async( + def list_runbook( self, subscription_id: str, resource_group_name: str, @@ -663,11 +948,34 @@ async def get_runbook_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get runbook Get information on an Azure Automation runbook. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetRunbook`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: The name of the Azure Resource Group. + automation_account: The name of the Azure Automation Account. + runbook_name: The name of the Azure Automation runbook. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -686,24 +994,45 @@ async def get_runbook_async( query_params.append("x-ms-api-version=" + quote("2015-10-31", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/azureblob.py b/src/azure/connectors/azureblob.py index 24aaf847..d0eb19df 100644 --- a/src/azure/connectors/azureblob.py +++ b/src/azure/connectors/azureblob.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,28 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "AzureblobClient", + "BlobDataSetsMetadata", + "BlobMetadata", + "BlobMetadataPage", + "BlobMetadataResponse", + "DataSetsMetadata", + "DataWithSensitivityLabelInfo", + "ListOfBlobsWithSensitivityLabels", + "ObjectEntity", + "SensitivityLabelMetadata", + "SharedAccessSignature", + "SharedAccessSignatureBlobPolicy", + "StorageAccount", + "StorageAccountList", + "TabularDataSetsMetadata", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,41 +50,66 @@ class BlobMetadata: Response for Copy blob """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" @@ -75,8 +121,9 @@ class SharedAccessSignature: Response for Create SAS URI by path """ - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebUrl"}, ) """A URL to an object with access token.""" @@ -88,8 +135,9 @@ class SharedAccessSignatureBlobPolicy: Response for Get available access policies """ - group_policy_identifier: Optional[str] = field( + group_policy_identifier: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GroupPolicyIdentifier"}, ) """ @@ -97,37 +145,42 @@ class SharedAccessSignatureBlobPolicy: (e.g. Start time and End time) have precedence over input parameters mentioned in actions. """ - permissions: Optional[str] = field( + permissions: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Permissions"}, ) """The permissions specified on the SAS (Values separated by comma).""" - start_time: Optional[str] = field( + start_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartTime"}, ) """ The date and time at which the SAS becomes valid (example: '2017-11-01T15:30:00+00:00'). Default = now(). """ - expiry_time: Optional[str] = field( + expiry_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpiryTime"}, ) """ The date and time after which the SAS is no longer valid (example: '2017-12-01T15:30:00+00:00'). Default = now() + 24h. """ - access_protocol: Optional[str] = field( + access_protocol: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccessProtocol"}, ) """ The allowed protocols (https only, or http and https). Null if you don't want to restrict protocol. """ - ip_address_or_range: Optional[str] = field( + ip_address_or_range: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IpAddressOrRange"}, ) """ @@ -142,46 +195,74 @@ class DataWithSensitivityLabelInfo: Response for Get Blob Metadata """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" - sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field( + sensitivity_label_info: Optional[ + List[SensitivityLabelMetadata | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SensitivityLabelInfo"}, ) """Sensitivity label metadata info list""" @@ -193,10 +274,16 @@ class ListOfBlobsWithSensitivityLabels: Response for Lists blobs """ - value: Optional[List[DataWithSensitivityLabelInfo]] = None + value: Optional[ + List[DataWithSensitivityLabelInfo | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Blobs""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to retrieve the next page.""" @@ -208,15 +295,22 @@ class BlobMetadataPage: Response for Lists blobs in the root folder """ - value: Optional[List[BlobMetadata]] = None + value: Optional[ + List[BlobMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Blob metadata collection.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """An Url which can be used to retrieve the next page.""" - next_page_marker: Optional[str] = field( + next_page_marker: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextPageMarker"}, ) """A marker which can be used to retrieve the next page.""" @@ -228,7 +322,12 @@ class StorageAccountList: Response for Get storage accounts """ - value: Optional[List[StorageAccount]] = None + value: Optional[ + List[StorageAccount | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of storage account names""" @@ -238,7 +337,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -251,41 +350,66 @@ class BlobMetadataResponse: Definition: BlobMetadataResponse """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" @@ -297,41 +421,47 @@ class SensitivityLabelMetadata: Definition: SensitivityLabelMetadata """ - sensitivity_label_id: Optional[str] = field( + sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelId"}, ) """SensitivityLabel Id.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel name.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """SensitivityLabel displayName info""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel details on tooltip.""" - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """SensitivityLabel priority.""" - color: Optional[str] = None + color: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel color.""" - is_encrypted: Optional[bool] = field( + is_encrypted: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEncrypted"}, ) """ is SensitivityLabel Encrypted.""" - is_enabled: Optional[bool] = field( + is_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEnabled"}, ) """Whether SensitivityLabel is Enabled.""" - is_parent: Optional[bool] = field( + is_parent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isParent"}, ) """Whether SensitivityLabel is Parent.""" - parent_sensitivity_label_id: Optional[str] = field( + parent_sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentSensitivityLabelId"}, ) """Parent SensitivityLabel Id.""" @@ -343,10 +473,15 @@ class StorageAccount: Definition: StorageAccount """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the storage account.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the storage account.""" @@ -358,8 +493,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -368,25 +513,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -398,15 +547,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -423,7 +574,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -440,8 +591,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -462,7 +613,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -478,15 +629,49 @@ def connector_name(self) -> str: return "azureblob" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -503,7 +688,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -516,13 +705,13 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def copy_file_async( + async def copy_file( self, dataset: str, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -538,6 +727,26 @@ async def copy_file_async( action. If source and destination are present in same storage account, please use relative path. Otherwise, maximum size of a source for copy blob operation is 50 MB. + + Swagger operation ID: `CopyFile_V2`. + + Args: + dataset: Azure Storage account name or blob endpoint. + source: Specify the url to source blob. + destination: Specify the destination blob path, including the + target blob name. + overwrite: Should the destination blob be overwritten + (true/false)?. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -564,7 +773,7 @@ async def copy_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -578,6 +787,7 @@ async def copy_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -585,7 +795,7 @@ async def copy_file_async( return json.loads(response.text) - async def create_block_blob_async( + async def create_block_blob( self, input: bytes, storage_account_name: str, @@ -601,6 +811,24 @@ async def create_block_blob_async( Create block blob This operation uploads a block blob to Azure Blob Storage. + + Swagger operation ID: `CreateBlockBlob_V2`. + + Args: + input: The binary request body. + storage_account_name: The storage account name. + folder_path: Specify folder path to upload. + name: Specify name of the blob to create. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -622,7 +850,7 @@ async def create_block_blob_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -639,9 +867,10 @@ async def create_block_blob_async( request_url, response.status, response.text, + response=response, ) - async def create_file_async( + async def create_file( self, input: bytes, dataset: str, @@ -657,6 +886,24 @@ async def create_file_async( Create blob This operation uploads a blob to Azure Blob Storage. + + Swagger operation ID: `CreateFile_V2`. + + Args: + input: The binary request body. + dataset: Azure Storage account name or blob endpoint. + folder_path: Specify folder path to upload. + name: Specify name of the blob to create. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -678,7 +925,7 @@ async def create_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -695,6 +942,7 @@ async def create_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -702,9 +950,9 @@ async def create_file_async( return json.loads(response.text) - async def create_share_link_by_path_async( + async def create_share_link_by_path( self, - input: SharedAccessSignatureBlobPolicy, + input: SharedAccessSignatureBlobPolicy | Mapping[str, Any], storage_account_name: str, path: str, *, @@ -717,6 +965,24 @@ async def create_share_link_by_path_async( Create SAS URI by path This operation creates a SAS link for a blob using the path. + + Swagger operation ID: `CreateShareLinkByPath_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + storage_account_name: Azure Storage account name or blob endpoint. + path: The unique path of the blob. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -733,7 +999,7 @@ async def create_share_link_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -747,6 +1013,7 @@ async def create_share_link_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -754,7 +1021,7 @@ async def create_share_link_by_path_async( return json.loads(response.text) - async def delete_file_async( + async def delete_file( self, dataset: str, id: str, @@ -768,6 +1035,22 @@ async def delete_file_async( Delete blob This operation deletes a blob. + + Swagger operation ID: `DeleteFile_V2`. + + Args: + dataset: Azure Storage account name or blob endpoint. + id: Specify the blob to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -778,7 +1061,7 @@ async def delete_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -792,15 +1075,16 @@ async def delete_file_async( request_url, response.status, response.text, + response=response, ) - async def extract_folder_async( + async def extract_folder( self, dataset: str, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -810,6 +1094,25 @@ async def extract_folder_async( Extract archive to folder This operation extracts an archive blob into a folder (example: .zip). + + Swagger operation ID: `ExtractFolder_V3`. + + Args: + dataset: Azure Storage account name or blob endpoint. + source: Specify the path to the archive blob. + destination: Specify the path in Azure Blob Storage to extract the + archive contents. + overwrite: Should destination blob be overwritten (true/false)?. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -836,7 +1139,7 @@ async def extract_folder_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -850,6 +1153,7 @@ async def extract_folder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -857,7 +1161,7 @@ async def extract_folder_async( return json.loads(response.text) - async def get_access_policies_async( + def list_access_policies( self, storage_account_name: str, path: str, @@ -866,11 +1170,30 @@ async def get_access_policies_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get available access policies This operation gets available shared access policies for a blob. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAccessPolicies_V2`. + + Args: + storage_account_name: Azure Storage account name or blob endpoint. + path: The unique path of the blob. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -886,36 +1209,57 @@ async def get_access_policies_async( query_params.append(f"path={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_file_content_async( + async def get_file_content( self, dataset: str, id: str, + *, infer_content_type: Optional[bool] = None, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -925,6 +1269,26 @@ async def get_file_content_async( Get blob content This operation retrieves blob contents using id. + + Swagger operation ID: `GetFileContent_V2`. + + Args: + dataset: Azure Storage account name or blob endpoint. + id: Specify the blob. + infer_content_type: Infer content-type based on extension. + extract_sensitivity_label: Specify whether to extract MIP labels. + purview_account_name: Default collection will be queried unless + specified. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -954,7 +1318,7 @@ async def get_file_content_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -968,18 +1332,19 @@ async def get_file_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_file_content_by_path_async( + async def get_file_content_by_path( self, dataset: str, path: str, + *, infer_content_type: Optional[bool] = None, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -989,6 +1354,26 @@ async def get_file_content_by_path_async( Get blob content using path This operation retrieves blob contents using path. + + Swagger operation ID: `GetFileContentByPath_V2`. + + Args: + dataset: Azure Storage account name or blob endpoint. + path: Specify unique path to the blob. + infer_content_type: Infer content-type based on extension. + extract_sensitivity_label: Specify whether to extract MIP labels. + purview_account_name: Default collection will be queried unless + specified. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1021,7 +1406,7 @@ async def get_file_content_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1035,17 +1420,18 @@ async def get_file_content_by_path_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_file_metadata_async( + async def get_file_metadata( self, dataset: str, id: str, + *, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1055,6 +1441,25 @@ async def get_file_metadata_async( Get Blob Metadata This operation retrieves blob metadata using blob id. + + Swagger operation ID: `GetFileMetadata_V2`. + + Args: + dataset: Azure Storage account name or blob endpoint. + id: Specify the blob. + extract_sensitivity_label: Specify whether to extract MIP labels. + purview_account_name: Default collection will be queried unless + specified. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1078,7 +1483,7 @@ async def get_file_metadata_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1092,6 +1497,7 @@ async def get_file_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1099,13 +1505,13 @@ async def get_file_metadata_async( return json.loads(response.text) - async def get_file_metadata_by_path_async( + async def get_file_metadata_by_path( self, dataset: str, path: str, + *, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1115,6 +1521,25 @@ async def get_file_metadata_by_path_async( Get Blob Metadata using path This operation retrieves blob metadata using path. + + Swagger operation ID: `GetFileMetadataByPath_V2`. + + Args: + dataset: Azure Storage account name or blob endpoint. + path: Specify unique path to the blob. + extract_sensitivity_label: Specify whether to extract MIP labels. + purview_account_name: Default collection will be queried unless + specified. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1142,7 +1567,7 @@ async def get_file_metadata_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1156,6 +1581,7 @@ async def get_file_metadata_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1163,27 +1589,47 @@ async def get_file_metadata_by_path_async( return json.loads(response.text) - async def list_folder_async( + def list_folder( self, dataset: str, id: str, - next_page_marker: Optional[str] = None, + *, use_flat_listing: Optional[bool] = None, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists blobs This operation lists blobs in a container. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListFolder_V4`. + + Args: + dataset: Azure Storage account name or blob endpoint. + id: Specify the folder. + use_flat_listing: Whether or not to list blobs in flat listing\". + extract_sensitivity_label: Specify whether to extract MIP labels. + purview_account_name: Default collection will be queried unless + specified. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1194,11 +1640,6 @@ async def list_folder_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) query_params = [] - if next_page_marker is not None: - value = str(next_page_marker) - if isinstance(next_page_marker, bool): - value = value.lower() - query_params.append(f"nextPageMarker={quote(value, safe='')}") if use_flat_listing is not None: value = str(use_flat_listing) if isinstance(use_flat_listing, bool): @@ -1216,11 +1657,18 @@ async def list_folder_async( query_params.append(f"purviewAccountName={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1233,39 +1681,63 @@ async def list_folder_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def list_root_folder_async( + def list_root_folder( self, dataset: str, - next_page_marker: Optional[str] = None, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists blobs in the root folder This operation lists blobs in the Azure Blob Storage root folder. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListRootFolder_V4`. + + Args: + dataset: Azure Storage account name or blob endpoint. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1276,18 +1748,20 @@ async def list_root_folder_async( ) query_params = [] query_params.append("useFlatListing=" + quote("false", safe='')) - if next_page_marker is not None: - value = str(next_page_marker) - if isinstance(next_page_marker, bool): - value = value.lower() - query_params.append(f"nextPageMarker={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1300,23 +1774,32 @@ async def list_root_folder_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def set_blob_tier_by_path_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def set_blob_tier_by_path( self, storage_account_name: str, path: str, @@ -1332,6 +1815,23 @@ async def set_blob_tier_by_path_async( This operation sets a tier for a block blob on a standard storage account using the path. + + Swagger operation ID: `SetBlobTierByPath_V2`. + + Args: + storage_account_name: Azure Storage account name or blob endpoint. + path: The unique path of the blob. + new_tier: The new tier for the blob. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1352,7 +1852,7 @@ async def set_blob_tier_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1366,9 +1866,10 @@ async def set_blob_tier_by_path_async( request_url, response.status, response.text, + response=response, ) - async def update_file_async( + async def update_file( self, input: bytes, dataset: str, @@ -1383,6 +1884,23 @@ async def update_file_async( Update blob This operation updates a blob in Azure Blob Storage. + + Swagger operation ID: `UpdateFile_V2`. + + Args: + input: The binary request body. + dataset: Azure Storage account name or blob endpoint. + id: Specify the blob to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1393,7 +1911,7 @@ async def update_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, @@ -1410,6 +1928,7 @@ async def update_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1417,41 +1936,79 @@ async def update_file_async( return json.loads(response.text) - async def get_data_sets_async( + def list_data_sets( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get storage accounts This operation list the user's Azure Storage Account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDataSets`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/codeless/GetDataSets" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/azuredatafactory.py b/src/azure/connectors/azuredatafactory.py index 593f7b6e..9fe791dc 100644 --- a/src/azure/connectors/azuredatafactory.py +++ b/src/azure/connectors/azuredatafactory.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,28 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "AzuredatafactoryClient", + "Activity", + "ActivityFull", + "CreatePipelineRunResponse", + "DataFactory", + "DataFactoryListResult", + "ParameterValueSpecification", + "Pipeline", + "PipelineListResult", + "PipelineRun", + "ResourceGroup", + "ResourceGroupListResult", + "ResourceGroupProperties", + "Subscription", + "SubscriptionListResult", + "SubscriptionPolicies", +] + # Type Definitions @@ -29,8 +50,9 @@ class CreatePipelineRunResponse: Response for Create a pipeline run """ - run_id: Optional[str] = field( + run_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "runId"}, ) """runId""" @@ -42,53 +64,60 @@ class PipelineRun: Response for Get a pipeline run """ - run_id: Optional[str] = field( + run_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "runId"}, ) """Identifier of a run""" - pipeline_name: Optional[str] = field( + pipeline_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pipelineName"}, ) """The pipeline name""" - parameters: Optional[Dict[str, Any]] = None + parameters: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ The full of partial list of parameter name, value pair used in the pipeline run. """ - invoked_by: Optional[Dict[str, Any]] = field( + invoked_by: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "invokedBy"}, ) """Entity that started the pipeline.""" - run_start: Optional[str] = field( + run_start: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "runStart"}, ) """The start time of a pipeline run in ISO8601 format.""" - run_end: Optional[str] = field( + run_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "runEnd"}, ) """The end time of a pipeline run in ISO8601 format.""" - duration_in_ms: Optional[int] = field( + duration_in_ms: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "durationInMs"}, ) """The duration of a pipeline run in milliseconds.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status of the pipeline run.""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """The message from a pipeline run.""" - last_updated: Optional[str] = field( + last_updated: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastUpdated"}, ) """ The last updated timestamp for the pipeline run event in ISO8601 format. """ - annotations: Optional[List[str]] = None + annotations: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """The annotations for the pipeline run.""" @@ -98,10 +127,16 @@ class SubscriptionListResult: Response for List subscriptions """ - value: Optional[List[Subscription]] = None + value: Optional[ + List[Subscription | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The subscriptions.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -113,10 +148,16 @@ class ResourceGroupListResult: Response for List resource groups """ - value: Optional[List[ResourceGroup]] = None + value: Optional[ + List[ResourceGroup | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of resource groups.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -128,10 +169,16 @@ class DataFactoryListResult: Response for List Factories """ - value: Optional[List[DataFactory]] = None + value: Optional[ + List[DataFactory | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of Data Factories.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -143,10 +190,16 @@ class PipelineListResult: Response for List pipelines """ - value: Optional[List[Pipeline]] = None + value: Optional[ + List[Pipeline | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of Data Factories.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -158,19 +211,23 @@ class DataFactory: Definition: DataFactory """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The resource name.""" - tags: Optional[Dict[str, Any]] = None + tags: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The resource tags.""" - properties: Optional[Dict[str, Any]] = None + properties: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Data Factory additional properties.""" - identity: Optional[Dict[str, Any]] = None + identity: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Managed service identity of the factory.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The resource identitfier.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The resource type.""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """The resource location""" @@ -180,13 +237,13 @@ class Pipeline: Definition: Pipeline """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The resource identifier.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The resource name of the pipeline.""" - properties: Optional[Dict[str, Any]] = None + properties: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The pipeline properties.""" - etag: Optional[str] = None + etag: Optional[str] = dataclass_field(default=None, kw_only=True) """Etag identifies change in the resource.""" @@ -196,7 +253,7 @@ class Activity: Definition: Activity """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -209,20 +266,25 @@ class ActivityFull: Definition: Activity-Full """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """type""" - inputs: Optional[List[Dict[str, Any]]] = None + inputs: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """inputs""" - outputs: Optional[List[Dict[str, Any]]] = None + outputs: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """outputs""" - type_properties: Optional[Dict[str, Any]] = field( + type_properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "typeProperties"}, ) """typeProperties""" - policy: Optional[Dict[str, Any]] = None + policy: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """policy""" @@ -232,7 +294,7 @@ class ParameterValueSpecification: Definition: ParameterValueSpecification """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -245,34 +307,39 @@ class Subscription: Definition: Subscription """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000. """ - subscription_id: Optional[str] = field( + subscription_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subscriptionId"}, ) """The subscription Id.""" - tenant_id: Optional[str] = field( + tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tenantId"}, ) """The tenant Id.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The subscription display name.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The subscription state.""" - subscription_policies: Optional[SubscriptionPolicies] = field( + subscription_policies: Optional[SubscriptionPolicies | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subscriptionPolicies"}, ) - authorization_source: Optional[str] = field( + authorization_source: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "authorizationSource"}, ) """ @@ -288,8 +355,9 @@ class SubscriptionPolicies: Definition: SubscriptionPolicies """ - location_placement_id: Optional[str] = field( + location_placement_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "locationPlacementId"}, ) """ @@ -297,13 +365,15 @@ class SubscriptionPolicies: visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions. """ - quota_id: Optional[str] = field( + quota_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "quotaId"}, ) """The subscription quota Id.""" - spending_limit: Optional[str] = field( + spending_limit: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spendingLimit"}, ) """The subscription spending limit.""" @@ -315,26 +385,32 @@ class ResourceGroup: Definition: ResourceGroup """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY). """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The Name of the resource group.""" - location: Optional[str] = None + location: str """ The location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc. """ - managed_by: Optional[str] = field( + managed_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managedBy"}, ) """Id of the resource that manages this resource group.""" - tags: Optional[Dict[str, str]] = None + tags: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True) """The tags attached to the resource group.""" - properties: Optional[ResourceGroupProperties] = None + properties: Optional[ + ResourceGroupProperties | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -343,8 +419,9 @@ class ResourceGroupProperties: Definition: ResourceGroupProperties """ - provisioning_state: Optional[str] = field( + provisioning_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "provisioningState"}, ) """The provisioning state.""" @@ -361,7 +438,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -378,8 +455,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -400,7 +477,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -416,15 +493,49 @@ def connector_name(self) -> str: return "azuredatafactory" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -441,7 +552,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -454,15 +569,15 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def create_pipeline_run_async( + async def create_pipeline_run( self, - input: ParameterValueSpecification, + input: ParameterValueSpecification | Mapping[str, Any], subscription_id: str, resource_group_name: str, data_factory_name: str, pipeline_name: str, - reference_pipeline_run_id: Optional[str] = None, *, + reference_pipeline_run_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -472,6 +587,31 @@ async def create_pipeline_run_async( Create a pipeline run This operation creates a new pipeline run in your factory + + Swagger operation ID: `CreatePipelineRun`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + data_factory_name: The name of the Data Factory. + pipeline_name: The name of the Data Factory pipeline. + reference_pipeline_run_id: The pipeline run identifier. If run ID + is specified the parameters of the specified run will be used + to create a new run. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -497,7 +637,7 @@ async def create_pipeline_run_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -511,6 +651,7 @@ async def create_pipeline_run_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -518,7 +659,7 @@ async def create_pipeline_run_async( return json.loads(response.text) - async def cancel_pipeline_run_async( + async def cancel_pipeline_run( self, subscription_id: str, resource_group_name: str, @@ -534,6 +675,26 @@ async def cancel_pipeline_run_async( Cancel a pipeline run This operation cancels a pipeline run by its run ID. + + Swagger operation ID: `CancelPipelineRun`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + data_factory_name: The name of the Data Factory. + pipeline_run_name: The id of the Data Factory pipeline run. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -553,7 +714,7 @@ async def cancel_pipeline_run_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -567,9 +728,10 @@ async def cancel_pipeline_run_async( request_url, response.status, response.text, + response=response, ) - async def get_pipeline_run_async( + async def get_pipeline_run( self, subscription_id: str, resource_group_name: str, @@ -585,6 +747,26 @@ async def get_pipeline_run_async( Get a pipeline run Get a particular pipeline run execution + + Swagger operation ID: `GetPipelineRun`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + data_factory_name: The name of the Data Factory. + pipeline_run_name: The id of the Data Factory pipeline run. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -604,7 +786,7 @@ async def get_pipeline_run_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -618,6 +800,7 @@ async def get_pipeline_run_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -625,32 +808,54 @@ async def get_pipeline_run_async( return json.loads(response.text) - async def list_subscriptions_async( + def list_subscriptions( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List subscriptions Gets a list of all the subscriptions to which the principal has access. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListSubscriptions`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/subscriptions" query_params = [] query_params.append("x-ms-api-version=" + quote("2017-09-01-preview", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -663,41 +868,70 @@ async def list_subscriptions_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def list_resource_groups_async( + def list_resource_groups( self, subscription_id: str, + *, filter: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List resource groups Lists all the resource groups within the subscription. The results are paginated at 1,000+ records. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListResourceGroups`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + filter: The filter to apply on the operation. + top: Query parameters. If nothing is passed returns all values. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -719,11 +953,18 @@ async def list_resource_groups_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -736,23 +977,32 @@ async def list_resource_groups_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def list_data_factories_async( + return AsyncItemPaged(get_next, extract_data) + + def list_data_factories( self, subscription_id: str, resource_group_name: str, @@ -761,14 +1011,33 @@ async def list_data_factories_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Factories Get the list of Data Factories - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListDataFactories`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -784,11 +1053,18 @@ async def list_data_factories_async( query_params.append("x-ms-api-version=" + quote("2017-09-01-preview", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -801,23 +1077,32 @@ async def list_data_factories_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def list_pipelines_async( + def list_pipelines( self, subscription_id: str, resource_group_name: str, @@ -827,14 +1112,34 @@ async def list_pipelines_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List pipelines List the list of pipelines from a particular factory - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListPipelines`. + + Args: + subscription_id: The unique identifier for the Microsoft Azure + subscription. The subscription ID forms part of the ID for + every Azure resource. + resource_group_name: Resource group name. + data_factory_name: The name of the Data Factory. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -852,11 +1157,18 @@ async def list_pipelines_async( query_params.append("x-ms-api-version=" + quote("2017-09-01-preview", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -869,18 +1181,27 @@ async def list_pipelines_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/azuredigitaltwins.py b/src/azure/connectors/azuredigitaltwins.py index fe54ea05..f24934f1 100644 --- a/src/azure/connectors/azuredigitaltwins.py +++ b/src/azure/connectors/azuredigitaltwins.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,32 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "AzuredigitaltwinsClient", + "AddModelsInput", + "AddRelationshipInput", + "AddTwinInput", + "GetComponentResult", + "GetModelByIdResponse", + "IncomingRelationship", + "ListIncomingRelationshipsResponse", + "ListModelsResponse", + "ListRelationshipsResponse", + "QueryResult", + "QueryTwinsInput", + "SendComponentTelemetryInput", + "SendTelemetryInput", + "TwinRelationship", + "TwinResult", + "UpdateComponentInput", + "UpdateModelInput", + "UpdateRelationshipInput", + "UpdateTwinInput", +] + # Type Definitions @@ -32,15 +57,17 @@ class ListModelsResponse: Response for List Models """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Array values.""" - continuation_token: Optional[str] = field( + continuation_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "continuationToken"}, ) """Continuation Token the next page of Twin Relationship.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of Models.""" @@ -52,19 +79,20 @@ class GetModelByIdResponse: Response for Get Model By Id """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the model as specified in the model definition.""" - upload_time: Optional[str] = field( + upload_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "uploadTime"}, ) """The time the model was uploaded to the service.""" - decommissioned: Optional[bool] = None + decommissioned: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins. """ - model: Optional[Dict[str, Any]] = None + model: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Model reference.""" @@ -74,7 +102,7 @@ class UpdateModelInput: Update Model's Property """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Request for the API.""" @@ -84,7 +112,7 @@ class TwinResult: Response for Get Twin by Id """ - result: Optional[str] = None + result: Optional[str] = dataclass_field(default=None, kw_only=True) """Results From the Twin.""" @@ -94,7 +122,7 @@ class AddTwinInput: Add Twin """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Request for the API.""" @@ -104,7 +132,7 @@ class UpdateTwinInput: Update Twin """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Request for the API.""" @@ -114,7 +142,7 @@ class GetComponentResult: Response for Get Component """ - result: Optional[str] = None + result: Optional[str] = dataclass_field(default=None, kw_only=True) """Results From the Twin.""" @@ -124,7 +152,7 @@ class UpdateComponentInput: Update Component """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Request for the API.""" @@ -134,30 +162,39 @@ class TwinRelationship: Response for Get Relationship by Id """ - source_id: Optional[str] = field( + source_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "$sourceId"}, ) """Source Id.""" - relationship_id: Optional[str] = field( + relationship_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "$relationshipId"}, ) """Relationship Id.""" - target_id: Optional[str] = field( + target_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "$targetId"}, ) """Target Id.""" - relationship_name: Optional[str] = field( + relationship_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "$relationshipName"}, ) """Relationship Name.""" - etag: Optional[str] = field(default=None, metadata={"wire_name": "$etag"}) + etag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "$etag"}, + ) """E Tag Link.""" - additional_properties: Optional[str] = field( + additional_properties: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "additionalProperties"}, ) """Property Values.""" @@ -169,7 +206,7 @@ class AddRelationshipInput: Add Relationship """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Request for the API.""" @@ -179,7 +216,7 @@ class UpdateRelationshipInput: Update Relationship """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Request for the API.""" @@ -189,15 +226,17 @@ class ListIncomingRelationshipsResponse: Response for List Incoming Relationships """ - value: Optional[List[IncomingRelationship]] = None + value: List[IncomingRelationship | Mapping[str, Any]] """The collection of Incoming relationships.""" - continuation_token: Optional[str] = field( + continuation_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "continuationToken"}, ) """Continuation Token the next page of Twin Relationship.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of Incoming Relationship.""" @@ -209,7 +248,7 @@ class SendTelemetryInput: Send Telemetry """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Send Telemetry Inputs.""" @@ -219,7 +258,7 @@ class SendComponentTelemetryInput: Send Component Telemetry """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Send Component Telemetry Inputs.""" @@ -229,15 +268,17 @@ class ListRelationshipsResponse: Response for List Relationships """ - value: Optional[List[TwinRelationship]] = None + value: List[TwinRelationship | Mapping[str, Any]] """The collection of twin relationships.""" - continuation_token: Optional[str] = field( + continuation_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "continuationToken"}, ) """Continuation Token the next page of Twin Relationship.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of Twin Relationship.""" @@ -249,10 +290,11 @@ class QueryTwinsInput: Query API """ - query: Optional[str] = None + query: Optional[str] = dataclass_field(default=None, kw_only=True) """Query the Twins.""" - continuation_token: Optional[str] = field( + continuation_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "continuationToken"}, ) """Link to get next set of items.""" @@ -264,10 +306,11 @@ class QueryResult: Response for Query API """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Results From the Twin.""" - continuation_token: Optional[str] = field( + continuation_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "continuationToken"}, ) """Link to get next set of items.""" @@ -279,23 +322,27 @@ class IncomingRelationship: Definition: IncomingRelationship """ - source_id: Optional[str] = field( + source_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "$sourceId"}, ) """Source Id.""" - relationship_id: Optional[str] = field( + relationship_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "$relationshipId"}, ) """Relationship Id.""" - relationship_name: Optional[str] = field( + relationship_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "$relationshipName"}, ) """Relationship Name.""" - relationship_link: Optional[str] = field( + relationship_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "$relationshipLink"}, ) """Relationship Link.""" @@ -312,7 +359,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -329,8 +376,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -351,7 +398,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -367,15 +414,49 @@ def connector_name(self) -> str: return "azuredigitaltwins" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -392,7 +473,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -405,7 +490,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def add_models_async( + async def add_models( self, input: AddModelsInput, *, @@ -419,6 +504,21 @@ async def add_models_async( Uploads one or more models. When any error occurs, no models are uploaded. + + Swagger operation ID: `AddModels`. + + Args: + input: The request body. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/models" query_params = [] @@ -426,7 +526,7 @@ async def add_models_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -440,6 +540,7 @@ async def add_models_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -447,24 +548,42 @@ async def add_models_async( return json.loads(response.text) - async def list_models_async( + def list_models( self, + *, dependencies_for: Optional[str] = None, include_model_definition: Optional[str] = None, - continuation_token: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Models Retrieves model metadata and, optionally, model definitions. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListModels`. + + Args: + dependencies_for: The set of the models which will have their + dependencies retrieved. If omitted, all models are retrieved. + include_model_definition: When true the model definition will be + returned as part of the result. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/models" query_params = [] @@ -479,18 +598,20 @@ async def list_models_async( if isinstance(include_model_definition, bool): value = value.lower() query_params.append(f"includeModelDefinition={quote(value, safe='')}") - if continuation_token is not None: - value = str(continuation_token) - if isinstance(continuation_token, bool): - value = value.lower() - query_params.append(f"continuationToken={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -503,23 +624,32 @@ async def list_models_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def delete_model_async( + async def delete_model( self, modelid: str, *, @@ -533,6 +663,22 @@ async def delete_model_async( Deletes a model. A model can only be deleted if no other models reference it. + + Swagger operation ID: `DeleteModel`. + + Args: + modelid: The id of the Model. The id is unique within the service + and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -543,7 +689,7 @@ async def delete_model_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -557,13 +703,14 @@ async def delete_model_async( request_url, response.status, response.text, + response=response, ) - async def get_model_by_id_async( + async def get_model_by_id( self, modelid: str, - include_model_definition: Optional[str] = None, *, + include_model_definition: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -573,6 +720,24 @@ async def get_model_by_id_async( Get Model By Id Retrieves model metadata and, optionally, the model definition. + + Swagger operation ID: `GetModelById`. + + Args: + modelid: The id of the Model. The id is unique within the service + and case sensitive. + include_model_definition: When true the model definition will be + returned as part of the result. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -588,7 +753,7 @@ async def get_model_by_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -602,6 +767,7 @@ async def get_model_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -609,9 +775,9 @@ async def get_model_by_id_async( return json.loads(response.text) - async def update_model_async( + async def update_model( self, - input: UpdateModelInput, + input: UpdateModelInput | Mapping[str, Any], modelid: str, *, timeout: Optional[float] = None, @@ -623,6 +789,24 @@ async def update_model_async( Update Model's Property Updates the metadata for a model. + + Swagger operation ID: `UpdateModel`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + modelid: The id of the Model. The id is unique within the service + and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -633,7 +817,7 @@ async def update_model_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -647,9 +831,10 @@ async def update_model_async( request_url, response.status, response.text, + response=response, ) - async def get_twin_by_id_async( + async def get_twin_by_id( self, twinid: str, *, @@ -662,6 +847,22 @@ async def get_twin_by_id_async( Get Twin by Id Retrieves a digital twin and its data. + + Swagger operation ID: `GetTwinById`. + + Args: + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -672,7 +873,7 @@ async def get_twin_by_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -686,6 +887,7 @@ async def get_twin_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -693,7 +895,7 @@ async def get_twin_by_id_async( return json.loads(response.text) - async def delete_twin_async( + async def delete_twin( self, twinid: str, *, @@ -707,6 +909,22 @@ async def delete_twin_async( Deletes a digital twin. All relationships referencing the digital twin must already be deleted. + + Swagger operation ID: `DeleteTwin`. + + Args: + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -717,7 +935,7 @@ async def delete_twin_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -731,11 +949,12 @@ async def delete_twin_async( request_url, response.status, response.text, + response=response, ) - async def add_twin_async( + async def add_twin( self, - input: AddTwinInput, + input: AddTwinInput | Mapping[str, Any], twinid: str, *, timeout: Optional[float] = None, @@ -747,6 +966,24 @@ async def add_twin_async( Add Twin Adds or replaces a digital twin. + + Swagger operation ID: `AddTwin`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -757,7 +994,7 @@ async def add_twin_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -771,6 +1008,7 @@ async def add_twin_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -778,9 +1016,9 @@ async def add_twin_async( return json.loads(response.text) - async def update_twin_async( + async def update_twin( self, - input: UpdateTwinInput, + input: UpdateTwinInput | Mapping[str, Any], twinid: str, *, timeout: Optional[float] = None, @@ -792,6 +1030,24 @@ async def update_twin_async( Update Twin Updates properties on a twin. + + Swagger operation ID: `UpdateTwin`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -802,7 +1058,7 @@ async def update_twin_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -816,9 +1072,10 @@ async def update_twin_async( request_url, response.status, response.text, + response=response, ) - async def get_component_async( + async def get_component( self, twinid: str, component_path: str, @@ -832,6 +1089,23 @@ async def get_component_async( Get Component Retrieves a component from a digital twin. + + Swagger operation ID: `GetComponent`. + + Args: + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + component_path: The name of the DTDL component. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -845,7 +1119,7 @@ async def get_component_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -859,6 +1133,7 @@ async def get_component_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -866,9 +1141,9 @@ async def get_component_async( return json.loads(response.text) - async def update_component_async( + async def update_component( self, - input: UpdateComponentInput, + input: UpdateComponentInput | Mapping[str, Any], twinid: str, component_path: str, *, @@ -881,6 +1156,25 @@ async def update_component_async( Update Component Updates integer properties on a component of a twin. + + Swagger operation ID: `UpdateComponent`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + component_path: The name of the DTDL component. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -894,7 +1188,7 @@ async def update_component_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -908,9 +1202,10 @@ async def update_component_async( request_url, response.status, response.text, + response=response, ) - async def get_relationship_by_id_async( + async def get_relationship_by_id( self, twinid: str, relationship_id: str, @@ -924,6 +1219,24 @@ async def get_relationship_by_id_async( Get Relationship by Id Retrieves a relationship between two digital twins. + + Swagger operation ID: `GetRelationshipById`. + + Args: + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + relationship_id: The id of the relationship. The id is unique + within the digital twin and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -937,7 +1250,7 @@ async def get_relationship_by_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -951,6 +1264,7 @@ async def get_relationship_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -958,7 +1272,7 @@ async def get_relationship_by_id_async( return json.loads(response.text) - async def delete_relationship_async( + async def delete_relationship( self, twinid: str, relationship_id: str, @@ -972,6 +1286,24 @@ async def delete_relationship_async( Delete Relationship Deletes a relationship between two digital twins. + + Swagger operation ID: `DeleteRelationship`. + + Args: + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + relationship_id: The id of the relationship. The id is unique + within the digital twin and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -985,7 +1317,7 @@ async def delete_relationship_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -999,11 +1331,12 @@ async def delete_relationship_async( request_url, response.status, response.text, + response=response, ) - async def add_relationship_async( + async def add_relationship( self, - input: AddRelationshipInput, + input: AddRelationshipInput | Mapping[str, Any], twinid: str, relationship_id: str, *, @@ -1016,6 +1349,26 @@ async def add_relationship_async( Add Relationship Adds a relationship between two digital twins. + + Swagger operation ID: `AddRelationship`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + relationship_id: The id of the relationship. The id is unique + within the digital twin and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1029,7 +1382,7 @@ async def add_relationship_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1043,6 +1396,7 @@ async def add_relationship_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1050,9 +1404,9 @@ async def add_relationship_async( return json.loads(response.text) - async def update_relationship_async( + async def update_relationship( self, - input: UpdateRelationshipInput, + input: UpdateRelationshipInput | Mapping[str, Any], twinid: str, relationship_id: str, *, @@ -1065,6 +1419,26 @@ async def update_relationship_async( Update Relationship Updates integer properties on a relationship between two digital twins. + + Swagger operation ID: `UpdateRelationship`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + relationship_id: The id of the relationship. The id is unique + within the digital twin and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1078,7 +1452,7 @@ async def update_relationship_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1092,25 +1466,42 @@ async def update_relationship_async( request_url, response.status, response.text, + response=response, ) - async def list_incoming_relationships_async( + def list_incoming_relationships( self, twinid: str, - continuation_token: Optional[str] = None, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Incoming Relationships Retrieves all incoming relationships for a digital twin. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListIncomingRelationships`. + + Args: + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1120,18 +1511,20 @@ async def list_incoming_relationships_async( ) query_params = [] query_params.append("api-version=" + quote("2020-10-31", safe='')) - if continuation_token is not None: - value = str(continuation_token) - if isinstance(continuation_token, bool): - value = value.lower() - query_params.append(f"continuationToken={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1144,25 +1537,34 @@ async def list_incoming_relationships_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def send_telemetry_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def send_telemetry( self, - input: SendTelemetryInput, + input: SendTelemetryInput | Mapping[str, Any], twinid: str, *, timeout: Optional[float] = None, @@ -1174,6 +1576,24 @@ async def send_telemetry_async( Send Telemetry Sends telemetry on behalf of a digital twin. + + Swagger operation ID: `SendTelemetry`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1184,7 +1604,7 @@ async def send_telemetry_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1198,11 +1618,12 @@ async def send_telemetry_async( request_url, response.status, response.text, + response=response, ) - async def send_component_telemetry_async( + async def send_component_telemetry( self, - input: SendComponentTelemetryInput, + input: SendComponentTelemetryInput | Mapping[str, Any], twinid: str, component_path: str, *, @@ -1215,6 +1636,25 @@ async def send_component_telemetry_async( Send Component Telemetry Sends telemetry on behalf of a component in a digital twin. + + Swagger operation ID: `SendComponentTelemetry`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + component_path: The name of the DTDL component. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1229,7 +1669,7 @@ async def send_component_telemetry_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1243,25 +1683,42 @@ async def send_component_telemetry_async( request_url, response.status, response.text, + response=response, ) - async def list_relationships_async( + def list_relationships( self, twinid: str, - continuation_token: Optional[str] = None, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Relationships Retrieves all outgoing relationships from a digital twin. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListRelationships`. + + Args: + twinid: The id of the digital twin. The id is unique within the + service and case sensitive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1269,18 +1726,20 @@ async def list_relationships_async( ) query_params = [] query_params.append("api-version=" + quote("2020-10-31", safe='')) - if continuation_token is not None: - value = str(continuation_token) - if isinstance(continuation_token, bool): - value = value.lower() - query_params.append(f"continuationToken={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1293,25 +1752,34 @@ async def list_relationships_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def query_twins_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def query_twins( self, - input: QueryTwinsInput, + input: QueryTwinsInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1323,6 +1791,22 @@ async def query_twins_async( Executes a query that allows traversing relationships and filtering by property values. + + Swagger operation ID: `QueryTwins`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/query" query_params = [] @@ -1330,7 +1814,7 @@ async def query_twins_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1344,6 +1828,7 @@ async def query_twins_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/azureeventgrid.py b/src/azure/connectors/azureeventgrid.py index 9d42dec1..1ab5c300 100644 --- a/src/azure/connectors/azureeventgrid.py +++ b/src/azure/connectors/azureeventgrid.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,21 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "AzureeventgridClient", + "EventRequest", + "EventSchema", + "EventTypesResponse", + "ResourceNameResponse", + "Subscription", + "SubscriptionListResult", + "TopicTypesResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +43,12 @@ class SubscriptionListResult: Response for List subscriptions """ - value: Optional[List[Subscription]] = None + value: Optional[ + List[Subscription | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The subscriptions available to the user.""" @@ -39,7 +58,7 @@ class TopicTypesResponse: Response for TopicTypes_List """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -48,7 +67,7 @@ class EventRequest: Definition: EventRequest """ - properties: Optional[Dict[str, Any]] = None + properties: Dict[str, Any] EventSchema = List[Dict[str, Any]] @@ -60,7 +79,7 @@ class EventTypesResponse: Definition: EventTypesResponse """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -69,7 +88,7 @@ class ResourceNameResponse: Definition: ResourceNameResponse """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -78,18 +97,20 @@ class Subscription: Definition: Subscription """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000. """ - subscription_id: Optional[str] = field( + subscription_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subscriptionId"}, ) """The subscription Id.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The subscription display name.""" @@ -106,7 +127,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -123,8 +144,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -145,7 +166,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -160,56 +181,188 @@ def __init__( def connector_name(self) -> str: return "azureeventgrid" - async def subscriptions_list_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_subscriptions( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List subscriptions Gets a list of all the subscriptions to which the principal has access. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Subscriptions_List`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/subscriptions" query_params = [] query_params.append("x-ms-api-version=" + quote("2015-11-01", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - if not response.text: - return None + return None, items() - return json.loads(response.text) + return AsyncItemPaged(get_next, extract_data) - async def topic_types_list_async( + def list_topic_types( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ TopicTypes_List + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `TopicTypes_List`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -219,27 +372,48 @@ async def topic_types_list_async( query_params.append("x-ms-api-version=" + quote("2017-09-15-preview", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - if not response.text: - return None + return None, items() - return json.loads(response.text) + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/azureiotcentral.py b/src/azure/connectors/azureiotcentral.py index 3d5916a8..32700db6 100644 --- a/src/azure/connectors/azureiotcentral.py +++ b/src/azure/connectors/azureiotcentral.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,93 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "AzureiotcentralClient", + "Action", + "ActionGroupsAction", + "Application", + "ApplicationCollection", + "CloudPropertyJobData", + "CommandJobData", + "DateJobSchedule", + "Device", + "DeviceCloudProperties", + "DeviceCollection", + "DeviceCommand", + "DeviceCommandV1", + "DeviceComponentCommand", + "DeviceComponentTelemetry", + "DeviceGroup", + "DeviceGroupCollection", + "DeviceGroupDeviceCollection", + "DeviceModuleCommand", + "DeviceModuleComponentCommand", + "DeviceModuleComponentTelemetry", + "DeviceModuleTelemetry", + "DeviceProperties", + "DeviceRelationship", + "DeviceRelationshipCollection", + "DeviceRelationshipStatic", + "DeviceTelemetry", + "DeviceTemplate", + "DeviceTemplateCollection", + "DeviceTemplateCollectionV1", + "DeviceTemplateMigrationJobData", + "DeviceTemplateV1", + "DeviceV1", + "DeviceV2", + "DynamicValues", + "EmailAction", + "EmailUser", + "Job", + "JobBatch", + "JobCancellationThreshold", + "JobCollection", + "JobDeviceStatus", + "JobDeviceStatusCollection", + "JobSchedule", + "JobScheduleEnd", + "JobStatic", + "LogicAppsAction", + "ModuleProperties", + "OccurrencesJobSchedule", + "Organization", + "OrganizationCollection", + "OrganizationStatic", + "PowerAutomateAction", + "PropertyJobData", + "Role", + "RoleAssignment", + "RoleCollection", + "Rule", + "RuleCollection", + "ScheduledJob", + "ScheduledJobCollection", + "ScheduledJobJobCollection", + "ScheduledJobPatch", + "ScheduledJobStatic", + "SchemaDeviceCloudPropertiesResponse", + "SchemaDeviceCommandResponse", + "SchemaDevicePropertiesResponse", + "SchemaDeviceTelemetryResponse", + "SchemaJobResponse", + "SchemaScheduledJobResponse", + "SchemaUserResponse", + "ServicePrincipalUser", + "User", + "UserCollection", + "UserPatch", + "UserStatic", + "WebhookAction", + "WebhookActionBody", + "WebhookActionDevice", + "WorkflowTrigger", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,10 +115,11 @@ class DeviceGroupCollection: Response for List device groups """ - value: Optional[List[DeviceGroup]] = None + value: List[DeviceGroup | Mapping[str, Any]] """The collection of device groups.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of device groups.""" @@ -44,20 +131,17 @@ class DeviceGroup: Response for Get a device group """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the device group.""" - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """Display name of the device group.""" - filter: Optional[str] = None + filter: str """Query defining which devices should be in this group.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Short summary of device group.""" - etag: Optional[str] = None + etag: Optional[str] = dataclass_field(default=None, kw_only=True) """ETag used to prevent conflict in device group updates.""" - organizations: Optional[List[str]] = None + organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ List of organizations of the device group, only one organization is supported today, multiple organizations will be supported soon. @@ -70,10 +154,11 @@ class DeviceGroupDeviceCollection: Response for Get devices by device group ID """ - value: Optional[List[DeviceV1]] = None + value: List[DeviceV1 | Mapping[str, Any]] """The collection of devices belonging to the device group.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of devices in the group.""" @@ -85,7 +170,7 @@ class DeviceCloudProperties: Response for Get device cloud properties (deprecated) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -98,30 +183,33 @@ class DeviceCommand: Response for Execute a device command (deprecated) """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The request ID of the device command execution.""" - request: Optional[Any] = None + request: Optional[Any] = dataclass_field(default=None, kw_only=True) """The payload for the device command.""" - response: Optional[Any] = None + response: Optional[Any] = dataclass_field(default=None, kw_only=True) """The payload of the device command response.""" - connection_timeout: Optional[int] = field( + connection_timeout: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "connectionTimeout"}, ) """ Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. """ - response_timeout: Optional[int] = field( + response_timeout: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseTimeout"}, ) """ Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. """ - response_code: Optional[int] = field( + response_code: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseCode"}, ) """The status code of the device command response.""" @@ -133,10 +221,11 @@ class DeviceRelationshipCollection: Response for List relationships """ - value: Optional[List[DeviceRelationshipStatic]] = None + value: List[DeviceRelationshipStatic | Mapping[str, Any]] """The collection of device relationships.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of device relationships.""" @@ -148,11 +237,11 @@ class DeviceRelationshipStatic: Response for Get device relationship """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the device relationship.""" - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """The device ID of the source (parent) device.""" - target: Optional[str] = None + target: Optional[str] = dataclass_field(default=None, kw_only=True) """The device ID of the source (child) device.""" @@ -162,10 +251,11 @@ class JobCollection: Response for List jobs """ - value: Optional[List[JobStatic]] = None + value: List[JobStatic | Mapping[str, Any]] """The collection of jobs.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of jobs.""" @@ -177,36 +267,37 @@ class JobStatic: Response for Get a job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the job.""" - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """Display name of the job.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Detailed description of the job.""" - group: Optional[str] = None + group: str """The ID of the device group on which to execute the job.""" - batch: Optional[JobBatch] = None + batch: Optional[JobBatch | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) """The batching configuration for the job.""" - cancellation_threshold: Optional[JobCancellationThreshold] = field( + cancellation_threshold: Optional[ + JobCancellationThreshold | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "cancellationThreshold"}, ) """The cancellation threshold for the job.""" - data: Optional[List[Dict[str, Any]]] = None + data: List[Dict[str, Any]] """ Data related to the operation being performed by this job. All entries must be of the same type. """ - organizations: Optional[List[str]] = None + organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. """ - scheduled_job_id: Optional[str] = field( + scheduled_job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "scheduledJobId"}, ) """Id of the scheduled job definition that created this job.""" @@ -218,31 +309,32 @@ class Job: Response for Create a job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the job.""" - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """Display name of the job.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Detailed description of the job.""" - group: Optional[str] = None + group: str """The ID of the device group on which to execute the job.""" - batch: Optional[JobBatch] = None + batch: Optional[JobBatch | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) """The batching configuration for the job.""" - cancellation_threshold: Optional[JobCancellationThreshold] = field( + cancellation_threshold: Optional[ + JobCancellationThreshold | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "cancellationThreshold"}, ) """The cancellation threshold for the job.""" - organizations: Optional[List[str]] = None + organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. """ - scheduled_job_id: Optional[str] = field( + scheduled_job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "scheduledJobId"}, ) """Id of the scheduled job definition that created this job.""" @@ -254,10 +346,11 @@ class JobDeviceStatusCollection: Response for Get device statuses """ - value: Optional[List[JobDeviceStatus]] = None + value: List[JobDeviceStatus | Mapping[str, Any]] """The collection of job device statuses.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of job device statuses.""" @@ -269,10 +362,11 @@ class OrganizationCollection: Response for List organizations """ - value: Optional[List[Organization]] = None + value: List[Organization | Mapping[str, Any]] """The collection of organizations.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of organizations.""" @@ -284,14 +378,15 @@ class Organization: Response for Get an organization """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the organization.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the organization.""" - parent: Optional[str] = None + parent: Optional[str] = dataclass_field(default=None, kw_only=True) """Display name of the parent organization.""" @@ -301,10 +396,11 @@ class ScheduledJobCollection: Response for List scheduled jobs """ - value: Optional[List[ScheduledJob]] = None + value: List[ScheduledJob | Mapping[str, Any]] """The collection of scheduled jobs.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of scheduled jobs.""" @@ -316,36 +412,36 @@ class ScheduledJob: Response for Get a scheduled job """ - etag: Optional[str] = None + etag: Optional[str] = dataclass_field(default=None, kw_only=True) """ETag used to prevent conflict in scheduled job updates.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the scheduled job.""" - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """Display name of the scheduled job.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Detailed description of the scheduled job.""" - group: Optional[str] = None + group: str """The ID of the device group on which to execute the job.""" - batch: Optional[JobBatch] = None + batch: Optional[JobBatch | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) """The batching configuration for the scheduled job.""" - cancellation_threshold: Optional[JobCancellationThreshold] = field( + cancellation_threshold: Optional[ + JobCancellationThreshold | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "cancellationThreshold"}, ) """The cancellation threshold for the scheduled job.""" - organizations: Optional[List[str]] = None + organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. """ - schedule: Optional[Dict[str, Any]] = None + schedule: Dict[str, Any] """The schedule at which to execute the job.""" - enabled: Optional[bool] = None + enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the scheduled job is enabled.""" - completed: Optional[bool] = None + completed: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the scheduled job has completed.""" @@ -355,41 +451,41 @@ class ScheduledJobStatic: Response for Update a scheduled job """ - etag: Optional[str] = None + etag: Optional[str] = dataclass_field(default=None, kw_only=True) """ETag used to prevent conflict in scheduled job updates.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the scheduled job.""" - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """Display name of the scheduled job.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Detailed description of the scheduled job.""" - group: Optional[str] = None + group: str """The ID of the device group on which to execute the job.""" - batch: Optional[JobBatch] = None + batch: Optional[JobBatch | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) """The batching configuration for the scheduled job.""" - cancellation_threshold: Optional[JobCancellationThreshold] = field( + cancellation_threshold: Optional[ + JobCancellationThreshold | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "cancellationThreshold"}, ) """The cancellation threshold for the scheduled job.""" - data: Optional[List[Dict[str, Any]]] = None + data: List[Dict[str, Any]] """ Data related to the operation being performed by this job. All entries must be of the same type. """ - organizations: Optional[List[str]] = None + organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. """ - schedule: Optional[Dict[str, Any]] = None + schedule: Dict[str, Any] """The schedule at which to execute the job.""" - enabled: Optional[bool] = None + enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the scheduled job is enabled.""" - completed: Optional[bool] = None + completed: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the scheduled job has completed.""" @@ -399,10 +495,11 @@ class ScheduledJobJobCollection: Response for Get jobs by scheduled job ID """ - value: Optional[List[JobStatic]] = None + value: List[JobStatic | Mapping[str, Any]] """The collection of jobs.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of jobs.""" @@ -414,11 +511,11 @@ class WorkflowTrigger: Response for When a rule is fired """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the workflow trigger.""" - rule: Optional[str] = None + rule: str """Unique ID of the rule that is tied to the workflow trigger.""" - url: Optional[str] = None + url: str """Callback URL of the workflow Trigger.""" @@ -428,22 +525,23 @@ class DeviceV1: Response for Get a device by ID """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the device.""" - etag: Optional[str] = None + etag: Optional[str] = dataclass_field(default=None, kw_only=True) """ETag used to prevent conflict in device updates.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the device.""" - template: Optional[str] = None + template: Optional[str] = dataclass_field(default=None, kw_only=True) """The device template definition for the device.""" - simulated: Optional[bool] = None + simulated: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the device is simulated.""" - enabled: Optional[bool] = None + enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the device connection to IoT Central has been enabled.""" - provisioned: Optional[bool] = None + provisioned: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether resources have been allocated for the device.""" @@ -453,30 +551,33 @@ class DeviceCommandV1: Response for Get device command response """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The request ID of the device command execution.""" - request: Optional[Any] = None + request: Optional[Any] = dataclass_field(default=None, kw_only=True) """The payload for the device command.""" - response: Optional[Any] = None + response: Optional[Any] = dataclass_field(default=None, kw_only=True) """The payload of the device command response.""" - connection_timeout: Optional[int] = field( + connection_timeout: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "connectionTimeout"}, ) """ Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. """ - response_timeout: Optional[int] = field( + response_timeout: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseTimeout"}, ) """ Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. """ - response_code: Optional[int] = field( + response_code: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseCode"}, ) """The status code of the device command response.""" @@ -488,30 +589,33 @@ class DeviceComponentCommand: Response for Get component command response """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The request ID of the device command execution.""" - request: Optional[Any] = None + request: Optional[Any] = dataclass_field(default=None, kw_only=True) """The payload for the device command.""" - response: Optional[Any] = None + response: Optional[Any] = dataclass_field(default=None, kw_only=True) """The payload of the device command response.""" - connection_timeout: Optional[int] = field( + connection_timeout: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "connectionTimeout"}, ) """ Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. """ - response_timeout: Optional[int] = field( + response_timeout: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseTimeout"}, ) """ Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. """ - response_code: Optional[int] = field( + response_code: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseCode"}, ) """The status code of the device command response.""" @@ -523,9 +627,9 @@ class DeviceComponentTelemetry: Response for Get component telemetry value """ - value: Optional[Any] = None + value: Optional[Any] = dataclass_field(default=None, kw_only=True) """The last known value of this device telemetry.""" - timestamp: Optional[str] = None + timestamp: Optional[str] = dataclass_field(default=None, kw_only=True) """ String-formatted date representing the time when the telemetry value was sent. @@ -538,30 +642,33 @@ class DeviceModuleCommand: Response for Get module command response """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The request ID of the device command execution.""" - request: Optional[Any] = None + request: Optional[Any] = dataclass_field(default=None, kw_only=True) """The payload for the device command.""" - response: Optional[Any] = None + response: Optional[Any] = dataclass_field(default=None, kw_only=True) """The payload of the device command response.""" - connection_timeout: Optional[int] = field( + connection_timeout: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "connectionTimeout"}, ) """ Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. """ - response_timeout: Optional[int] = field( + response_timeout: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseTimeout"}, ) """ Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. """ - response_code: Optional[int] = field( + response_code: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseCode"}, ) """The status code of the device command response.""" @@ -573,30 +680,33 @@ class DeviceModuleComponentCommand: Response for Get module component command response """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The request ID of the device command execution.""" - request: Optional[Any] = None + request: Optional[Any] = dataclass_field(default=None, kw_only=True) """The payload for the device command.""" - response: Optional[Any] = None + response: Optional[Any] = dataclass_field(default=None, kw_only=True) """The payload of the device command response.""" - connection_timeout: Optional[int] = field( + connection_timeout: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "connectionTimeout"}, ) """ Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. """ - response_timeout: Optional[int] = field( + response_timeout: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseTimeout"}, ) """ Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. """ - response_code: Optional[int] = field( + response_code: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseCode"}, ) """The status code of the device command response.""" @@ -608,9 +718,9 @@ class DeviceModuleComponentTelemetry: Response for Get module component telemetry value """ - value: Optional[Any] = None + value: Optional[Any] = dataclass_field(default=None, kw_only=True) """The last known value of this device telemetry.""" - timestamp: Optional[str] = None + timestamp: Optional[str] = dataclass_field(default=None, kw_only=True) """ String-formatted date representing the time when the telemetry value was sent. @@ -623,7 +733,7 @@ class ModuleProperties: Response for Get module properties """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -636,9 +746,9 @@ class DeviceModuleTelemetry: Response for Get module telemetry value """ - value: Optional[Any] = None + value: Optional[Any] = dataclass_field(default=None, kw_only=True) """The last known value of this device telemetry.""" - timestamp: Optional[str] = None + timestamp: Optional[str] = dataclass_field(default=None, kw_only=True) """ String-formatted date representing the time when the telemetry value was sent. @@ -651,7 +761,7 @@ class DeviceProperties: Response for Get device properties """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -664,9 +774,9 @@ class DeviceTelemetry: Response for Get device telemetry value """ - value: Optional[Any] = None + value: Optional[Any] = dataclass_field(default=None, kw_only=True) """The last known value of this device telemetry.""" - timestamp: Optional[str] = None + timestamp: Optional[str] = dataclass_field(default=None, kw_only=True) """ String-formatted date representing the time when the telemetry value was sent. @@ -679,10 +789,11 @@ class DeviceCollection: Response for List devices """ - value: Optional[List[DeviceV1]] = None + value: List[DeviceV1 | Mapping[str, Any]] """The collection of devices.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of devices.""" @@ -694,27 +805,28 @@ class DeviceV2: Response for Create or update a device """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the device.""" - etag: Optional[str] = None + etag: Optional[str] = dataclass_field(default=None, kw_only=True) """ETag used to prevent conflict in device updates.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the device.""" - template: Optional[str] = None + template: Optional[str] = dataclass_field(default=None, kw_only=True) """The device template definition for the device.""" - simulated: Optional[bool] = None + simulated: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the device is simulated.""" - enabled: Optional[bool] = None + enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the device connection to IoT Central has been enabled.""" - organizations: Optional[List[str]] = None + organizations: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ List of organizations of the device, only one organization is supported today, multiple organizations will be supported soon. """ - provisioned: Optional[bool] = None + provisioned: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether resources have been allocated for the device.""" @@ -724,24 +836,27 @@ class DeviceTemplateV1: Response for Get a device template by ID """ - id: Optional[str] = field(default=None, metadata={"wire_name": "@id"}) - """Unique ID of the device template.""" - etag: Optional[str] = None - """ETag used to prevent conflict in device template updates.""" - type_: Optional[List[str]] = field( + id: Optional[str] = dataclass_field( default=None, - metadata={"wire_name": "@type"}, + kw_only=True, + metadata={"wire_name": "@id"}, ) + """Unique ID of the device template.""" + etag: Optional[str] = dataclass_field(default=None, kw_only=True) + """ETag used to prevent conflict in device template updates.""" + type_: List[str] = dataclass_field(metadata={"wire_name": "@type"}) """The JSON-LD types of this device template.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the device template.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Detailed description of the device template.""" - capability_model: Optional[Any] = field( + capability_model: Optional[Any] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "capabilityModel"}, ) """The capability model utilized by this device template.""" @@ -753,10 +868,11 @@ class DeviceTemplateCollectionV1: Response for List device templates """ - value: Optional[List[DeviceTemplateV1]] = None + value: List[DeviceTemplateV1 | Mapping[str, Any]] """The collection of device templates.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of device templates.""" @@ -768,10 +884,11 @@ class Role: Response for Get role """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the role.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the role.""" @@ -783,7 +900,7 @@ class RoleCollection: Response for List roles """ - value: Optional[List[Role]] = None + value: List[Role | Mapping[str, Any]] """The collection of roles.""" @@ -793,7 +910,7 @@ class User: Response for Create user """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -806,11 +923,15 @@ class UserStatic: Response for Get user """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the user.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type of the user.""" - roles: Optional[List[RoleAssignment]] = None + roles: List[RoleAssignment | Mapping[str, Any]] """ List of role assignments that specify the permissions to access the application. @@ -823,7 +944,7 @@ class UserCollection: Response for List users """ - value: Optional[List[UserStatic]] = None + value: List[UserStatic | Mapping[str, Any]] """The collection of users.""" @@ -833,7 +954,7 @@ class UserPatch: Response for Update user """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -846,10 +967,11 @@ class ApplicationCollection: Response for Get the list of applications accessible to the signed-in user """ - value: Optional[List[Application]] = None + value: List[Application | Mapping[str, Any]] """The collection of applications.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of applications.""" @@ -861,10 +983,11 @@ class DeviceTemplateCollection: Response for List device templates """ - value: Optional[List[DeviceTemplate]] = None + value: List[DeviceTemplate | Mapping[str, Any]] """The collection of device templates.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of device templates.""" @@ -879,7 +1002,7 @@ class SchemaDeviceCloudPropertiesResponse: Response for Schema_DeviceCloudProperties """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -892,7 +1015,7 @@ class SchemaDeviceCommandResponse: Response for Schema_DeviceCommand """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -905,7 +1028,7 @@ class SchemaDevicePropertiesResponse: Response for Schema_DeviceProperties """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -918,7 +1041,7 @@ class SchemaDeviceTelemetryResponse: Response for Schema_DeviceTelemetry """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -931,7 +1054,7 @@ class SchemaJobResponse: Response for Schema_Job """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -944,7 +1067,7 @@ class SchemaScheduledJobResponse: Response for Schema_ScheduledJob """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -957,7 +1080,7 @@ class SchemaUserResponse: Response for Schema_User """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -970,16 +1093,17 @@ class Action: Definition: Action """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the action.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the action.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Type of the action.""" - rules: Optional[List[str]] = None + rules: List[str] """Unique IDs of the rules that are tied to the action.""" @@ -989,16 +1113,17 @@ class EmailAction: Definition: EmailAction """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the email action.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the email action.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Type of the email action.""" - rules: Optional[List[str]] = None + rules: List[str] """Unique IDs of the rules that are tied to the email action.""" @@ -1008,18 +1133,19 @@ class WebhookAction: Definition: WebhookAction """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the webhook action.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the webhook action.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Type of the webhook action.""" - rules: Optional[List[str]] = None + rules: List[str] """Unique IDs of the rules that are tied to the webhook action.""" - url: Optional[str] = None + url: str """Callback URL of the webhook.""" @@ -1029,16 +1155,17 @@ class PowerAutomateAction: Definition: PowerAutomateAction """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the Power Automate action.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the Power Automate action.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Type of the Power Automate action.""" - rules: Optional[List[str]] = None + rules: List[str] """Unique IDs of the rules that are tied to the Power Automate action.""" @@ -1048,16 +1175,17 @@ class LogicAppsAction: Definition: LogicAppsAction """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the Logic Apps action.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the Logic Apps action.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Type of the Logic Apps action.""" - rules: Optional[List[str]] = None + rules: List[str] """Unique IDs of the rules that are tied to the Logic Apps action.""" @@ -1067,16 +1195,17 @@ class ActionGroupsAction: Definition: ActionGroupsAction """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the Action Groups action.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the Action Groups action.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Type of the Action Groups action.""" - rules: Optional[List[str]] = None + rules: List[str] """Unique IDs of the rules that are tied to the Action Groups action.""" @@ -1086,16 +1215,17 @@ class Application: Definition: Application """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the application.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the application.""" - subdomain: Optional[str] = None + subdomain: str """The URL subdomain of the application.""" - host: Optional[str] = None + host: str """The URL host of the application.""" @@ -1105,25 +1235,27 @@ class Device: Definition: Device """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the device.""" - etag: Optional[str] = None + etag: Optional[str] = dataclass_field(default=None, kw_only=True) """ETag used to prevent conflict in device updates.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the device.""" - instance_of: Optional[str] = field( + instance_of: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "instanceOf"}, ) """The device template definition for the device.""" - simulated: Optional[bool] = None + simulated: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the device is simulated.""" - approved: Optional[bool] = None + approved: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the device has been approved to connect to IoT Central.""" - provisioned: Optional[bool] = None + provisioned: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether resources have been allocated for the device.""" @@ -1133,9 +1265,9 @@ class DeviceRelationship: Definition: DeviceRelationship """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the device relationship.""" - target: Optional[str] = None + target: str """The device ID of the source (child) device.""" @@ -1145,18 +1277,19 @@ class DeviceTemplate: Definition: DeviceTemplate """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the device template.""" - etag: Optional[str] = None + etag: Optional[str] = dataclass_field(default=None, kw_only=True) """ETag used to prevent conflict in device template updates.""" - types: Optional[List[str]] = None + types: List[str] """The types of device to which this template applies.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the device template.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Detailed description of the device template.""" @@ -1166,7 +1299,7 @@ class PropertyJobData: Definition: PropertyJobData """ - data: Optional[List[Dict[str, Any]]] = None + data: List[Dict[str, Any]] """ Data related to the operation being performed by this job. All entries must be of the same type. @@ -1179,7 +1312,7 @@ class CommandJobData: Definition: CommandJobData """ - data: Optional[List[Dict[str, Any]]] = None + data: List[Dict[str, Any]] """ Data related to the operation being performed by this job. All entries must be of the same type. @@ -1192,7 +1325,7 @@ class CloudPropertyJobData: Definition: CloudPropertyJobData """ - data: Optional[List[Dict[str, Any]]] = None + data: List[Dict[str, Any]] """The collection of job data.""" @@ -1202,7 +1335,7 @@ class DeviceTemplateMigrationJobData: Definition: DeviceTemplateMigrationJobData """ - data: Optional[List[Dict[str, Any]]] = None + data: List[Dict[str, Any]] """The collection of job data.""" @@ -1212,9 +1345,9 @@ class JobDeviceStatus: Definition: JobDeviceStatus """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID of the device whose job status is being provided.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Indicates whether the job is starting, running, etc. for the given device. """ @@ -1226,12 +1359,12 @@ class JobBatch: Definition: JobBatch """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """ Whether batching is done on a specified number of devices or a percentage of the total devices. """ - value: Optional[float] = None + value: float """The number or percentage of devices on which batching is done.""" @@ -1241,17 +1374,17 @@ class JobCancellationThreshold: Definition: JobCancellationThreshold """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """ Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. """ - value: Optional[float] = None + value: float """ The number or percentage of devices on which the cancellation threshold is applied. """ - batch: Optional[bool] = None + batch: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether the cancellation threshold applies per-batch or to the overall job. """ @@ -1266,10 +1399,11 @@ class Rule: Definition: Rule """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the rule.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the rule.""" @@ -1281,10 +1415,11 @@ class RuleCollection: Definition: RuleCollection """ - value: Optional[List[Rule]] = None + value: List[Rule | Mapping[str, Any]] """The collection of rules.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """URL to get the next page of rules.""" @@ -1296,7 +1431,7 @@ class JobSchedule: Definition: JobSchedule """ - schedule: Optional[Dict[str, Any]] = None + schedule: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The schedule at which to execute the job.""" @@ -1306,7 +1441,7 @@ class DateJobSchedule: Definition: DateJobSchedule """ - schedule: Optional[Dict[str, Any]] = None + schedule: Dict[str, Any] """The schedule at which to execute the job.""" @@ -1316,7 +1451,7 @@ class OccurrencesJobSchedule: Definition: OccurrencesJobSchedule """ - schedule: Optional[Dict[str, Any]] = None + schedule: Dict[str, Any] """The schedule at which to execute the job.""" @@ -1326,11 +1461,15 @@ class JobScheduleEnd: Definition: JobScheduleEnd """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type of the job schedule end.""" - date: Optional[str] = None + date: Optional[str] = dataclass_field(default=None, kw_only=True) """The date when to end the scheduled job (YYYY-MM-DDTHH:MM:SSZ).""" - occurrences: Optional[int] = None + occurrences: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of occurrences after which to end the scheduled job.""" @@ -1340,15 +1479,15 @@ class ScheduledJobPatch: Definition: ScheduledJobPatch """ - etag: Optional[str] = None + etag: Optional[str] = dataclass_field(default=None, kw_only=True) """ETag used to prevent conflict in scheduled job updates.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the scheduled job.""" - schedule: Optional[Dict[str, Any]] = None + schedule: Dict[str, Any] """The schedule at which to execute the job.""" - enabled: Optional[bool] = None + enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the scheduled job is enabled.""" - completed: Optional[bool] = None + completed: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the scheduled job has completed.""" @@ -1358,16 +1497,16 @@ class EmailUser: Definition: EmailUser """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the user.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Type of the user.""" - roles: Optional[List[RoleAssignment]] = None + roles: List[RoleAssignment | Mapping[str, Any]] """ List of role assignments that specify the permissions to access the application. """ - email: Optional[str] = None + email: str """Email address of the user.""" @@ -1377,24 +1516,18 @@ class ServicePrincipalUser: Definition: ServicePrincipalUser """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the user.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Type of the user.""" - roles: Optional[List[RoleAssignment]] = None + roles: List[RoleAssignment | Mapping[str, Any]] """ List of role assignments that specify the permissions to access the application. """ - tenant_id: Optional[str] = field( - default=None, - metadata={"wire_name": "tenantId"}, - ) + tenant_id: str = dataclass_field(metadata={"wire_name": "tenantId"}) """The Microsoft Entra ID tenant ID of the service principal.""" - object_id: Optional[str] = field( - default=None, - metadata={"wire_name": "objectId"}, - ) + object_id: str = dataclass_field(metadata={"wire_name": "objectId"}) """The Microsoft Entra ID object ID of the service principal.""" @@ -1404,7 +1537,7 @@ class RoleAssignment: Definition: RoleAssignment """ - role: Optional[str] = None + role: str """ID of the role for this role assignment.""" @@ -1414,34 +1547,37 @@ class WebhookActionDevice: Definition: WebhookActionDevice """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the device.""" - etag: Optional[str] = None + etag: Optional[str] = dataclass_field(default=None, kw_only=True) """ETag used to prevent conflict in device updates.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the device.""" - instance_of: Optional[str] = field( + instance_of: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "instanceOf"}, ) """The device template definition for the device.""" - simulated: Optional[bool] = None + simulated: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the device is simulated.""" - approved: Optional[bool] = None + approved: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the device has been approved to connect to IoT Central.""" - provisioned: Optional[bool] = None + provisioned: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether resources have been allocated for the device.""" - cloud_properties: Optional[Dict[str, Any]] = field( + cloud_properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "cloudProperties"}, ) """Cloud properties that triggered the webhook.""" - properties: Optional[Dict[str, Any]] = None + properties: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Device properties that triggered the webhook.""" - telemetry: Optional[Dict[str, Any]] = None + telemetry: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Device telemetry that triggered the webhook.""" @@ -1451,15 +1587,15 @@ class WebhookActionBody: Definition: WebhookActionBody """ - action: Optional[Action] = None + action: Action | Mapping[str, Any] """Action that triggered the webhook.""" - application: Optional[Application] = None + application: Application | Mapping[str, Any] """Application that triggered the webhook.""" - device: Optional[WebhookActionDevice] = None + device: WebhookActionDevice | Mapping[str, Any] """Device that triggered the webhook.""" - rule: Optional[Rule] = None + rule: Rule | Mapping[str, Any] """Rule that triggered the webhook.""" - timestamp: Optional[str] = None + timestamp: str """Timestamp at which the webhook was triggered.""" @@ -1474,7 +1610,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1491,8 +1627,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1513,7 +1649,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1529,15 +1665,49 @@ def connector_name(self) -> str: return "azureiotcentral" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -1554,7 +1724,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -1567,7 +1741,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def device_groups_list_async( + def list_device_groups( self, application: str, *, @@ -1575,14 +1749,30 @@ async def device_groups_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List device groups Get the list of device groups in an application. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `DeviceGroups_List`. + + Args: + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/api/ga_2022_07_31/deviceGroups" @@ -1594,11 +1784,18 @@ async def device_groups_list_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1611,23 +1808,32 @@ async def device_groups_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def device_groups_get_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def device_groups_get( self, device_group_id: str, application: str, @@ -1641,6 +1847,22 @@ async def device_groups_get_async( Get a device group Get details about an existing device group by ID. + + Swagger operation ID: `DeviceGroups_Get`. + + Args: + device_group_id: Unique ID of the device group. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1657,7 +1879,7 @@ async def device_groups_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1671,6 +1893,7 @@ async def device_groups_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1678,9 +1901,9 @@ async def device_groups_get_async( return json.loads(response.text) - async def device_groups_set_async( + async def device_groups_set( self, - input: DeviceGroup, + input: DeviceGroup | Mapping[str, Any], device_group_id: str, application: str, *, @@ -1693,6 +1916,24 @@ async def device_groups_set_async( Create a device group Create or update a device group. + + Swagger operation ID: `DeviceGroups_Set`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + device_group_id: Unique ID of the device group. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1709,7 +1950,7 @@ async def device_groups_set_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1723,6 +1964,7 @@ async def device_groups_set_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1730,7 +1972,7 @@ async def device_groups_set_async( return json.loads(response.text) - async def device_groups_remove_async( + async def device_groups_remove( self, device_group_id: str, application: str, @@ -1744,6 +1986,22 @@ async def device_groups_remove_async( Delete device group Delete an existing device group by ID + + Swagger operation ID: `DeviceGroups_Remove`. + + Args: + device_group_id: Unique ID of the device group. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1760,7 +2018,7 @@ async def device_groups_remove_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1774,9 +2032,10 @@ async def device_groups_remove_async( request_url, response.status, response.text, + response=response, ) - async def device_groups_get_devices_async( + def list_device_groups_get_devices( self, device_group_id: str, application: str, @@ -1785,14 +2044,31 @@ async def device_groups_get_devices_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get devices by device group ID Get the list of devices in a device group in an application. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `DeviceGroups_GetDevices`. + + Args: + device_group_id: Unique ID of the device group. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1809,11 +2085,18 @@ async def device_groups_get_devices_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1826,28 +2109,37 @@ async def device_groups_get_devices_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def devices_get_cloud_properties_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def devices_get_cloud_properties( self, device_id: str, application: str, - instance_of: Optional[str] = None, *, + instance_of: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1857,6 +2149,23 @@ async def devices_get_cloud_properties_async( Get device cloud properties (deprecated) Get all cloud property values of a device by device ID (deprecated). + + Swagger operation ID: `Devices_GetCloudProperties`. + + Args: + device_id: Unique ID of the device. + application: Unique ID of the application. + instance_of: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1879,7 +2188,7 @@ async def devices_get_cloud_properties_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1893,6 +2202,7 @@ async def devices_get_cloud_properties_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1900,13 +2210,13 @@ async def devices_get_cloud_properties_async( return json.loads(response.text) - async def devices_update_cloud_properties_async( + async def devices_update_cloud_properties( self, - input: DeviceCloudProperties, + input: DeviceCloudProperties | Mapping[str, Any], device_id: str, application: str, - instance_of: Optional[str] = None, *, + instance_of: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1916,6 +2226,25 @@ async def devices_update_cloud_properties_async( Update device cloud properties (deprecated) Update all cloud property values of a device by device ID (deprecated). + + Swagger operation ID: `Devices_UpdateCloudProperties`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + device_id: Unique ID of the device. + application: Unique ID of the application. + instance_of: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1938,7 +2267,7 @@ async def devices_update_cloud_properties_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1952,6 +2281,7 @@ async def devices_update_cloud_properties_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1959,15 +2289,15 @@ async def devices_update_cloud_properties_async( return json.loads(response.text) - async def devices_execute_component_command_async( + async def devices_execute_component_command( self, - input: DeviceCommand, + input: DeviceCommand | Mapping[str, Any], device_id: str, component_name: str, command_name: str, application: str, - instance_of: Optional[str] = None, *, + instance_of: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1977,6 +2307,27 @@ async def devices_execute_component_command_async( Execute a device command (deprecated) Execute a command on a device (deprecated). + + Swagger operation ID: `Devices_ExecuteComponentCommand`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + device_id: Unique ID of the device. + component_name: Name of the device component. + command_name: Name of this device command. + application: Unique ID of the application. + instance_of: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2002,7 +2353,7 @@ async def devices_execute_component_command_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2016,6 +2367,7 @@ async def devices_execute_component_command_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2023,7 +2375,7 @@ async def devices_execute_component_command_async( return json.loads(response.text) - async def device_relationships_list_async( + def list_device_relationships( self, device_id: str, application: str, @@ -2032,14 +2384,31 @@ async def device_relationships_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List relationships List all relationships based on device ID. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `DeviceRelationships_List`. + + Args: + device_id: Unique ID of the device. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2056,11 +2425,18 @@ async def device_relationships_list_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2073,23 +2449,32 @@ async def device_relationships_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def device_relationships_get_async( + async def device_relationships_get( self, device_id: str, relationship_id: str, @@ -2105,6 +2490,23 @@ async def device_relationships_get_async( Get details about an existing device relationship by device ID and by relationship ID. + + Swagger operation ID: `DeviceRelationships_Get`. + + Args: + device_id: Unique ID of the device. + relationship_id: Unique ID of the device relationship. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2123,7 +2525,7 @@ async def device_relationships_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2137,6 +2539,7 @@ async def device_relationships_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2144,9 +2547,9 @@ async def device_relationships_get_async( return json.loads(response.text) - async def device_relationships_set_async( + async def device_relationships_set( self, - input: DeviceRelationship, + input: DeviceRelationship | Mapping[str, Any], relationship_id: str, device_id: str, application: str, @@ -2161,6 +2564,25 @@ async def device_relationships_set_async( Create a new device relationship between the given device and a new device given a device ID and a relationship ID. + + Swagger operation ID: `DeviceRelationships_Set`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + relationship_id: Unique ID of the device relationship. + device_id: Unique ID of the device. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2179,7 +2601,7 @@ async def device_relationships_set_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2193,6 +2615,7 @@ async def device_relationships_set_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2200,9 +2623,9 @@ async def device_relationships_set_async( return json.loads(response.text) - async def device_relationships_update_async( + async def device_relationships_update( self, - input: DeviceRelationship, + input: DeviceRelationship | Mapping[str, Any], device_id: str, relationship_id: str, application: str, @@ -2217,6 +2640,25 @@ async def device_relationships_update_async( Update an existing device relationship between the given device and a new device given a device ID and a relationship ID. + + Swagger operation ID: `DeviceRelationships_Update`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + device_id: Unique ID of the device. + relationship_id: Unique ID of the device relationship. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2235,7 +2677,7 @@ async def device_relationships_update_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -2249,6 +2691,7 @@ async def device_relationships_update_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2256,7 +2699,7 @@ async def device_relationships_update_async( return json.loads(response.text) - async def device_relationships_remove_async( + async def device_relationships_remove( self, device_id: str, relationship_id: str, @@ -2272,6 +2715,23 @@ async def device_relationships_remove_async( Delete an existing device relationship by device ID and relationship ID. + + Swagger operation ID: `DeviceRelationships_Remove`. + + Args: + device_id: Unique ID of the device. + relationship_id: Unique ID of the device relationship. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2290,7 +2750,7 @@ async def device_relationships_remove_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2304,9 +2764,10 @@ async def device_relationships_remove_async( request_url, response.status, response.text, + response=response, ) - async def jobs_list_async( + def list_jobs( self, application: str, *, @@ -2314,14 +2775,30 @@ async def jobs_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List jobs Get the list of jobs in an application. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Jobs_List`. + + Args: + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/ga_2022_07_31/jobs" query_params = [] @@ -2331,11 +2808,18 @@ async def jobs_list_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2348,23 +2832,32 @@ async def jobs_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def jobs_get_async( + return AsyncItemPaged(get_next, extract_data) + + async def jobs_get( self, job_id: str, application: str, @@ -2378,6 +2871,22 @@ async def jobs_get_async( Get a job Get details about an existing job by ID. + + Swagger operation ID: `Jobs_Get`. + + Args: + job_id: Unique ID of the job. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2391,7 +2900,7 @@ async def jobs_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2405,6 +2914,7 @@ async def jobs_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2412,13 +2922,13 @@ async def jobs_get_async( return json.loads(response.text) - async def jobs_set_async( + async def jobs_set( self, - input: Job, + input: Job | Mapping[str, Any], job_id: str, application: str, - job_type: Optional[str] = None, *, + job_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2428,6 +2938,25 @@ async def jobs_set_async( Create a job Create and execute a new job via its job definition. + + Swagger operation ID: `Jobs_Set`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + job_id: Unique ID of the job. + application: Unique ID of the application. + job_type: Type of the job. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2446,7 +2975,7 @@ async def jobs_set_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2460,6 +2989,7 @@ async def jobs_set_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2467,7 +2997,7 @@ async def jobs_set_async( return json.loads(response.text) - async def jobs_get_devices_async( + def list_jobs_get_devices( self, job_id: str, application: str, @@ -2476,14 +3006,31 @@ async def jobs_get_devices_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get device statuses Get the list of individual device statuses by job ID. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Jobs_GetDevices`. + + Args: + job_id: Unique ID of the job. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2496,11 +3043,18 @@ async def jobs_get_devices_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2513,23 +3067,32 @@ async def jobs_get_devices_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def jobs_stop_async( + async def jobs_stop( self, job_id: str, application: str, @@ -2543,6 +3106,22 @@ async def jobs_stop_async( Stop a running job Stop execution of a job that is currently running. + + Swagger operation ID: `Jobs_Stop`. + + Args: + job_id: Unique ID of the job. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2556,7 +3135,7 @@ async def jobs_stop_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2570,9 +3149,10 @@ async def jobs_stop_async( request_url, response.status, response.text, + response=response, ) - async def jobs_resume_async( + async def jobs_resume( self, job_id: str, application: str, @@ -2586,6 +3166,22 @@ async def jobs_resume_async( Resume a stopped job Resume execution of an existing stopped job. + + Swagger operation ID: `Jobs_Resume`. + + Args: + job_id: Unique ID of the job. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2599,7 +3195,7 @@ async def jobs_resume_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2613,9 +3209,10 @@ async def jobs_resume_async( request_url, response.status, response.text, + response=response, ) - async def jobs_rerun_async( + async def jobs_rerun( self, job_id: str, rerun_id: str, @@ -2630,6 +3227,23 @@ async def jobs_rerun_async( Resume a job on failed devices Execute a rerun of an existing job on all failed devices. + + Swagger operation ID: `Jobs_Rerun`. + + Args: + job_id: Unique ID of the job. + rerun_id: Unique ID of the rerun. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2648,7 +3262,7 @@ async def jobs_rerun_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2662,6 +3276,7 @@ async def jobs_rerun_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2669,7 +3284,7 @@ async def jobs_rerun_async( return json.loads(response.text) - async def organizations_list_async( + def list_organizations( self, application: str, *, @@ -2677,14 +3292,30 @@ async def organizations_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List organizations Get the list of organizations in an application. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Organizations_List`. + + Args: + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/api/ga_2022_07_31/organizations" @@ -2696,11 +3327,18 @@ async def organizations_list_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2713,23 +3351,32 @@ async def organizations_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def organizations_get_async( + async def organizations_get( self, organization_id: str, application: str, @@ -2743,6 +3390,22 @@ async def organizations_get_async( Get an organization Get details about an existing organization by ID. + + Swagger operation ID: `Organizations_Get`. + + Args: + organization_id: Unique ID of the organization. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2759,7 +3422,7 @@ async def organizations_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2773,6 +3436,7 @@ async def organizations_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2780,9 +3444,9 @@ async def organizations_get_async( return json.loads(response.text) - async def organizations_set_async( + async def organizations_set( self, - input: Organization, + input: Organization | Mapping[str, Any], organization_id: str, application: str, *, @@ -2795,6 +3459,24 @@ async def organizations_set_async( Create an organization Create a new organization. + + Swagger operation ID: `Organizations_Set`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + organization_id: Unique ID of the organization. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2811,7 +3493,7 @@ async def organizations_set_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2825,6 +3507,7 @@ async def organizations_set_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2832,7 +3515,7 @@ async def organizations_set_async( return json.loads(response.text) - async def organizations_remove_async( + async def organizations_remove( self, organization_id: str, application: str, @@ -2846,6 +3529,22 @@ async def organizations_remove_async( Delete organization Delete an existing organization by ID + + Swagger operation ID: `Organizations_Remove`. + + Args: + organization_id: Unique ID of the organization. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2862,7 +3561,7 @@ async def organizations_remove_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2876,9 +3575,10 @@ async def organizations_remove_async( request_url, response.status, response.text, + response=response, ) - async def scheduled_jobs_list_async( + def list_scheduled_jobs( self, application: str, *, @@ -2886,14 +3586,30 @@ async def scheduled_jobs_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List scheduled jobs Get the list of scheduled jobs in an application. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ScheduledJobs_List`. + + Args: + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/api/ga_2022_07_31/scheduledJobs" @@ -2905,11 +3621,18 @@ async def scheduled_jobs_list_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2922,23 +3645,32 @@ async def scheduled_jobs_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def scheduled_jobs_get_async( + async def scheduled_jobs_get( self, scheduled_job_id: str, application: str, @@ -2952,6 +3684,22 @@ async def scheduled_jobs_get_async( Get a scheduled job Get details about an existing scheduled job by ID. + + Swagger operation ID: `ScheduledJobs_Get`. + + Args: + scheduled_job_id: Unique ID of the scheduled job. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2968,7 +3716,7 @@ async def scheduled_jobs_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2982,6 +3730,7 @@ async def scheduled_jobs_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2989,14 +3738,14 @@ async def scheduled_jobs_get_async( return json.loads(response.text) - async def scheduled_jobs_set_async( + async def scheduled_jobs_set( self, - input: ScheduledJob, + input: ScheduledJob | Mapping[str, Any], scheduled_job_id: str, application: str, + *, job_type: Optional[str] = None, scheduled_job_end_type: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3006,6 +3755,27 @@ async def scheduled_jobs_set_async( Create a scheduled job Create and execute a new scheduled job via its job definition. + + Swagger operation ID: `ScheduledJobs_Set`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + scheduled_job_id: Unique ID of the scheduled job. + application: Unique ID of the application. + job_type: Type of the job. + scheduled_job_end_type: How the scheduled job should end (not + applied to device template migrations). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3032,7 +3802,7 @@ async def scheduled_jobs_set_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -3046,6 +3816,7 @@ async def scheduled_jobs_set_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3053,13 +3824,13 @@ async def scheduled_jobs_set_async( return json.loads(response.text) - async def scheduled_jobs_update_async( + async def scheduled_jobs_update( self, - input: ScheduledJobPatch, + input: ScheduledJobPatch | Mapping[str, Any], scheduled_job_id: str, application: str, - scheduled_job_end_type: Optional[str] = None, *, + scheduled_job_end_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3069,6 +3840,26 @@ async def scheduled_jobs_update_async( Update a scheduled job Update an existing scheduled job by ID. + + Swagger operation ID: `ScheduledJobs_Update`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + scheduled_job_id: Unique ID of the scheduled job. + application: Unique ID of the application. + scheduled_job_end_type: How the scheduled job should end (not + applied to device template migrations). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3090,7 +3881,7 @@ async def scheduled_jobs_update_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -3104,6 +3895,7 @@ async def scheduled_jobs_update_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3111,7 +3903,7 @@ async def scheduled_jobs_update_async( return json.loads(response.text) - async def scheduled_jobs_remove_async( + async def scheduled_jobs_remove( self, scheduled_job_id: str, application: str, @@ -3125,6 +3917,22 @@ async def scheduled_jobs_remove_async( Delete a scheduled job Delete an existing scheduled job by ID. + + Swagger operation ID: `ScheduledJobs_Remove`. + + Args: + scheduled_job_id: Unique ID of the scheduled job. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3141,7 +3949,7 @@ async def scheduled_jobs_remove_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -3155,9 +3963,10 @@ async def scheduled_jobs_remove_async( request_url, response.status, response.text, + response=response, ) - async def scheduled_jobs_list_jobs_async( + def list_scheduled_jobs_list_jobs( self, scheduled_job_id: str, application: str, @@ -3166,14 +3975,31 @@ async def scheduled_jobs_list_jobs_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get jobs by scheduled job ID Get the list of jobs for a scheduled job definition. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ScheduledJobs_ListJobs`. + + Args: + scheduled_job_id: Unique ID of the scheduled job. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3190,11 +4016,18 @@ async def scheduled_jobs_list_jobs_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -3207,23 +4040,32 @@ async def scheduled_jobs_list_jobs_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def devices_get_async( + return AsyncItemPaged(get_next, extract_data) + + async def devices_get( self, device_id: str, application: str, @@ -3237,6 +4079,22 @@ async def devices_get_async( Get a device by ID Get details about an existing device by device ID. + + Swagger operation ID: `Devices_Get_V1`. + + Args: + device_id: Unique ID of the device. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3250,7 +4108,7 @@ async def devices_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3264,6 +4122,7 @@ async def devices_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3271,13 +4130,13 @@ async def devices_get_async( return json.loads(response.text) - async def devices_get_command_response_async( + async def devices_get_command_response( self, device_id: str, command_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3287,6 +4146,24 @@ async def devices_get_command_response_async( Get device command response Get the last response for a device command. + + Swagger operation ID: `Devices_GetCommandResponse_V1`. + + Args: + device_id: Unique ID of the device. + command_name: Name of this device command. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3310,7 +4187,7 @@ async def devices_get_command_response_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3324,6 +4201,7 @@ async def devices_get_command_response_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3331,14 +4209,14 @@ async def devices_get_command_response_async( return json.loads(response.text) - async def devices_get_component_command_response_async( + async def devices_get_component_command_response( self, device_id: str, component_name: str, command_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3348,6 +4226,25 @@ async def devices_get_component_command_response_async( Get component command response Get the last response for a device component command. + + Swagger operation ID: `Devices_GetComponentCommandResponse_V1`. + + Args: + device_id: Unique ID of the device. + component_name: Name of the device component. + command_name: Name of this device command. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3373,7 +4270,7 @@ async def devices_get_component_command_response_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3387,6 +4284,7 @@ async def devices_get_component_command_response_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3394,14 +4292,14 @@ async def devices_get_component_command_response_async( return json.loads(response.text) - async def devices_get_component_telemetry_value_async( + async def devices_get_component_telemetry_value( self, device_id: str, component_name: str, telemetry_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3411,6 +4309,25 @@ async def devices_get_component_telemetry_value_async( Get component telemetry value Get the last telemetry value from a component. + + Swagger operation ID: `Devices_GetComponentTelemetryValue_V1`. + + Args: + device_id: Unique ID of the device. + component_name: Name of the device component. + telemetry_name: Name of this device telemetry. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3436,7 +4353,7 @@ async def devices_get_component_telemetry_value_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3450,6 +4367,7 @@ async def devices_get_component_telemetry_value_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3457,14 +4375,14 @@ async def devices_get_component_telemetry_value_async( return json.loads(response.text) - async def devices_get_module_command_response_async( + async def devices_get_module_command_response( self, device_id: str, module: str, command_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3474,6 +4392,25 @@ async def devices_get_module_command_response_async( Get module command response Get the last response for a device module command + + Swagger operation ID: `Devices_GetModuleCommandResponse_V1`. + + Args: + device_id: Unique ID of the device. + module: Name of the device module. + command_name: Name of this device command. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3499,7 +4436,7 @@ async def devices_get_module_command_response_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3513,6 +4450,7 @@ async def devices_get_module_command_response_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3520,15 +4458,15 @@ async def devices_get_module_command_response_async( return json.loads(response.text) - async def devices_get_module_component_command_response_async( + async def devices_get_module_component_command_response( self, device_id: str, module: str, component_name: str, command_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3538,6 +4476,26 @@ async def devices_get_module_component_command_response_async( Get module component command response Get the last response for a module component command. + + Swagger operation ID: `Devices_GetModuleComponentCommandResponse_V1`. + + Args: + device_id: Unique ID of the device. + module: Name of the device module. + component_name: Name of the device component. + command_name: Name of this device command. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3565,7 +4523,7 @@ async def devices_get_module_component_command_response_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3579,6 +4537,7 @@ async def devices_get_module_component_command_response_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3586,15 +4545,15 @@ async def devices_get_module_component_command_response_async( return json.loads(response.text) - async def devices_get_module_component_telemetry_value_async( + async def devices_get_module_component_telemetry_value( self, device_id: str, module: str, component_name: str, telemetry_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3604,6 +4563,26 @@ async def devices_get_module_component_telemetry_value_async( Get module component telemetry value Get the last telemetry value from a module component. + + Swagger operation ID: `Devices_GetModuleComponentTelemetryValue_V1`. + + Args: + device_id: Unique ID of the device. + module: Name of the device module. + component_name: Name of the device component. + telemetry_name: Name of this device telemetry. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3631,7 +4610,7 @@ async def devices_get_module_component_telemetry_value_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3645,6 +4624,7 @@ async def devices_get_module_component_telemetry_value_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3652,13 +4632,13 @@ async def devices_get_module_component_telemetry_value_async( return json.loads(response.text) - async def devices_get_module_properties_async( + async def devices_get_module_properties( self, device_id: str, module: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3668,10 +4648,28 @@ async def devices_get_module_properties_async( Get module properties Get all property values of a module. - """ - request_url = ( - f"{self._connection_runtime_url}" - f"/api" + + Swagger operation ID: `Devices_GetModuleProperties_V1`. + + Args: + device_id: Unique ID of the device. + module: Name of the device module. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. + """ + request_url = ( + f"{self._connection_runtime_url}" + f"/api" f"/v1" f"/devices" f"/{quote(str(device_id), safe='')}" @@ -3692,7 +4690,7 @@ async def devices_get_module_properties_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3706,6 +4704,7 @@ async def devices_get_module_properties_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3713,14 +4712,14 @@ async def devices_get_module_properties_async( return json.loads(response.text) - async def devices_get_module_telemetry_value_async( + async def devices_get_module_telemetry_value( self, device_id: str, module: str, telemetry_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3730,6 +4729,25 @@ async def devices_get_module_telemetry_value_async( Get module telemetry value Get the last telemetry value from a module. + + Swagger operation ID: `Devices_GetModuleTelemetryValue_V1`. + + Args: + device_id: Unique ID of the device. + module: Name of the device module. + telemetry_name: Name of this device telemetry. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3755,7 +4773,7 @@ async def devices_get_module_telemetry_value_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3769,6 +4787,7 @@ async def devices_get_module_telemetry_value_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3776,12 +4795,12 @@ async def devices_get_module_telemetry_value_async( return json.loads(response.text) - async def devices_get_properties_async( + async def devices_get_properties( self, device_id: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3791,6 +4810,23 @@ async def devices_get_properties_async( Get device properties Get all property values of a device by device ID. + + Swagger operation ID: `Devices_GetProperties_V1`. + + Args: + device_id: Unique ID of the device. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3809,7 +4845,7 @@ async def devices_get_properties_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3823,6 +4859,7 @@ async def devices_get_properties_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3830,13 +4867,13 @@ async def devices_get_properties_async( return json.loads(response.text) - async def devices_get_telemetry_value_async( + async def devices_get_telemetry_value( self, device_id: str, telemetry_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3846,6 +4883,24 @@ async def devices_get_telemetry_value_async( Get device telemetry value Get the last telemetry value from a device. + + Swagger operation ID: `Devices_GetTelemetryValue_V1`. + + Args: + device_id: Unique ID of the device. + telemetry_name: Name of this device telemetry. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3869,7 +4924,7 @@ async def devices_get_telemetry_value_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3883,6 +4938,7 @@ async def devices_get_telemetry_value_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3890,7 +4946,7 @@ async def devices_get_telemetry_value_async( return json.loads(response.text) - async def devices_list_async( + def list_devices( self, application: str, *, @@ -3898,14 +4954,30 @@ async def devices_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List devices Get the list of devices in an application. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Devices_List_V1`. + + Args: + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v1/devices" query_params = [] @@ -3915,11 +4987,18 @@ async def devices_list_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -3932,23 +5011,32 @@ async def devices_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def devices_remove_async( + return AsyncItemPaged(get_next, extract_data) + + async def devices_remove( self, device_id: str, application: str, @@ -3962,6 +5050,22 @@ async def devices_remove_async( Delete a device Delete an existing device by device ID. + + Swagger operation ID: `Devices_Remove_V1`. + + Args: + device_id: Unique ID of the device. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3975,7 +5079,7 @@ async def devices_remove_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -3989,16 +5093,17 @@ async def devices_remove_async( request_url, response.status, response.text, + response=response, ) - async def devices_run_command_async( + async def devices_run_command( self, - input: DeviceCommandV1, + input: DeviceCommandV1 | Mapping[str, Any], device_id: str, command_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4008,6 +5113,26 @@ async def devices_run_command_async( Run a device command Run a command on a device. + + Swagger operation ID: `Devices_RunCommand_V1`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + device_id: Unique ID of the device. + command_name: Name of this device command. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4031,7 +5156,7 @@ async def devices_run_command_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4045,6 +5170,7 @@ async def devices_run_command_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4052,15 +5178,15 @@ async def devices_run_command_async( return json.loads(response.text) - async def devices_run_component_command_async( + async def devices_run_component_command( self, - input: DeviceComponentCommand, + input: DeviceComponentCommand | Mapping[str, Any], device_id: str, component_name: str, command_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4070,6 +5196,27 @@ async def devices_run_component_command_async( Run a component command Run a command on a component. + + Swagger operation ID: `Devices_RunComponentCommand_V1`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + device_id: Unique ID of the device. + component_name: Name of the device component. + command_name: Name of this device command. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4095,7 +5242,7 @@ async def devices_run_component_command_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4109,6 +5256,7 @@ async def devices_run_component_command_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4116,15 +5264,15 @@ async def devices_run_component_command_async( return json.loads(response.text) - async def devices_run_module_command_async( + async def devices_run_module_command( self, - input: DeviceModuleCommand, + input: DeviceModuleCommand | Mapping[str, Any], device_id: str, module: str, command_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4134,6 +5282,27 @@ async def devices_run_module_command_async( Run a module command Run a command on a module. + + Swagger operation ID: `Devices_RunModuleCommand_V1`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + device_id: Unique ID of the device. + module: Name of the device module. + command_name: Name of this device command. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4159,7 +5328,7 @@ async def devices_run_module_command_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4173,6 +5342,7 @@ async def devices_run_module_command_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4180,16 +5350,16 @@ async def devices_run_module_command_async( return json.loads(response.text) - async def devices_run_module_component_command_async( + async def devices_run_module_component_command( self, - input: DeviceModuleComponentCommand, + input: DeviceModuleComponentCommand | Mapping[str, Any], device_id: str, module: str, component_name: str, command_name: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4199,6 +5369,28 @@ async def devices_run_module_component_command_async( Run a module component command Run a command on a module component. + + Swagger operation ID: `Devices_RunModuleComponentCommand_V1`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + device_id: Unique ID of the device. + module: Name of the device module. + component_name: Name of the device component. + command_name: Name of this device command. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4226,7 +5418,7 @@ async def devices_run_module_component_command_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4240,6 +5432,7 @@ async def devices_run_module_component_command_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4247,9 +5440,9 @@ async def devices_run_module_component_command_async( return json.loads(response.text) - async def devices_set_async( + async def devices_set( self, - input: DeviceV2, + input: DeviceV2 | Mapping[str, Any], device_id: str, application: str, *, @@ -4262,6 +5455,24 @@ async def devices_set_async( Create or update a device Create a new device or update an existing one by device ID. + + Swagger operation ID: `Devices_Set_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + device_id: Unique ID of the device. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4275,7 +5486,7 @@ async def devices_set_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -4289,6 +5500,7 @@ async def devices_set_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4296,14 +5508,14 @@ async def devices_set_async( return json.loads(response.text) - async def devices_update_module_properties_async( + async def devices_update_module_properties( self, - input: ModuleProperties, + input: ModuleProperties | Mapping[str, Any], device_id: str, module: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4313,6 +5525,26 @@ async def devices_update_module_properties_async( Update module properties Update all property values of a module. + + Swagger operation ID: `Devices_UpdateModuleProperties_V1`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + device_id: Unique ID of the device. + module: Name of the device module. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4337,7 +5569,7 @@ async def devices_update_module_properties_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -4351,6 +5583,7 @@ async def devices_update_module_properties_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4358,13 +5591,13 @@ async def devices_update_module_properties_async( return json.loads(response.text) - async def devices_update_properties_async( + async def devices_update_properties( self, - input: DeviceProperties, + input: DeviceProperties | Mapping[str, Any], device_id: str, application: str, - template: Optional[str] = None, *, + template: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4374,6 +5607,25 @@ async def devices_update_properties_async( Update device properties Update all property values of a device by device ID. + + Swagger operation ID: `Devices_UpdateProperties_V1`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + device_id: Unique ID of the device. + application: Unique ID of the application. + template: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4392,7 +5644,7 @@ async def devices_update_properties_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -4406,6 +5658,7 @@ async def devices_update_properties_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4413,7 +5666,7 @@ async def devices_update_properties_async( return json.loads(response.text) - async def device_templates_get_async( + async def device_templates_get( self, template_id: str, application: str, @@ -4427,6 +5680,22 @@ async def device_templates_get_async( Get a device template by ID Get details about an existing device template by ID. + + Swagger operation ID: `DeviceTemplates_Get_V1`. + + Args: + template_id: Unique ID of the template. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4440,7 +5709,7 @@ async def device_templates_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4454,6 +5723,7 @@ async def device_templates_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4461,7 +5731,7 @@ async def device_templates_get_async( return json.loads(response.text) - async def device_templates_list_async( + def list_device_templates( self, application: str, *, @@ -4469,14 +5739,30 @@ async def device_templates_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List device templates Get the list of device templates in an application. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `DeviceTemplates_List_V1`. + + Args: + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v1/deviceTemplates" query_params = [] @@ -4486,11 +5772,18 @@ async def device_templates_list_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -4503,23 +5796,32 @@ async def device_templates_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def device_templates_remove_async( + return AsyncItemPaged(get_next, extract_data) + + async def device_templates_remove( self, template_id: str, application: str, @@ -4533,6 +5835,22 @@ async def device_templates_remove_async( Delete a device template Delete an existing device template by ID. + + Swagger operation ID: `DeviceTemplates_Remove_V1`. + + Args: + template_id: Unique ID of the template. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4546,7 +5864,7 @@ async def device_templates_remove_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -4560,9 +5878,10 @@ async def device_templates_remove_async( request_url, response.status, response.text, + response=response, ) - async def roles_get_async( + async def roles_get( self, role_id: str, application: str, @@ -4576,6 +5895,22 @@ async def roles_get_async( Get role Get a role by ID. + + Swagger operation ID: `Roles_Get_V1`. + + Args: + role_id: Unique ID for the role. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4589,7 +5924,7 @@ async def roles_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4603,6 +5938,7 @@ async def roles_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4610,7 +5946,7 @@ async def roles_get_async( return json.loads(response.text) - async def roles_list_async( + def list_roles( self, application: str, *, @@ -4618,11 +5954,29 @@ async def roles_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List roles Get the list of roles in an application. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Roles_List_V1`. + + Args: + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v1/roles" query_params = [] @@ -4632,35 +5986,56 @@ async def roles_list_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def users_create_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def users_create( self, - input: User, + input: User | Mapping[str, Any], user_id: str, application: str, - user_type: Optional[str] = None, *, + user_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4670,6 +6045,25 @@ async def users_create_async( Create user Create a user in the application + + Swagger operation ID: `Users_Create_V1`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + user_id: Unique ID of the user. + application: Unique ID of the application. + user_type: Type of the user. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4688,7 +6082,7 @@ async def users_create_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -4702,6 +6096,7 @@ async def users_create_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4709,7 +6104,7 @@ async def users_create_async( return json.loads(response.text) - async def users_get_async( + async def users_get( self, user_id: str, application: str, @@ -4723,6 +6118,22 @@ async def users_get_async( Get user Get a user by ID + + Swagger operation ID: `Users_Get_V1`. + + Args: + user_id: Unique ID of the user. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4736,7 +6147,7 @@ async def users_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4750,6 +6161,7 @@ async def users_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4757,7 +6169,7 @@ async def users_get_async( return json.loads(response.text) - async def users_list_async( + def list_users( self, application: str, *, @@ -4765,11 +6177,29 @@ async def users_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List users Get the list of users in an application + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Users_List_V1`. + + Args: + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v1/users" query_params = [] @@ -4779,29 +6209,50 @@ async def users_list_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def users_remove_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def users_remove( self, user_id: str, application: str, @@ -4815,6 +6266,22 @@ async def users_remove_async( Delete user Delete a user + + Swagger operation ID: `Users_Remove_V1`. + + Args: + user_id: Unique ID of the user. + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4828,7 +6295,7 @@ async def users_remove_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -4842,15 +6309,16 @@ async def users_remove_async( request_url, response.status, response.text, + response=response, ) - async def users_update_async( + async def users_update( self, - input: UserPatch, + input: UserPatch | Mapping[str, Any], user_id: str, application: str, - user_type: Optional[str] = None, *, + user_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4860,6 +6328,25 @@ async def users_update_async( Update user Update a user in the application via patch + + Swagger operation ID: `Users_Update_V1`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + user_id: Unique ID of the user. + application: Unique ID of the application. + user_type: Type of the user. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4878,7 +6365,7 @@ async def users_update_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -4892,6 +6379,7 @@ async def users_update_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4899,28 +6387,50 @@ async def users_update_async( return json.loads(response.text) - async def applications_list_async( + def list_applications( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get the list of applications accessible to the signed-in user - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Applications_List`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/api/preview/applications" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -4933,23 +6443,32 @@ async def applications_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def device_templates_list_2_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_device_templates_2( self, application: str, *, @@ -4957,14 +6476,30 @@ async def device_templates_list_2_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List device templates Get the list of device templates in an application. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `DeviceTemplates_List`. + + Args: + application: Unique ID of the application. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/api/preview/deviceTemplates" @@ -4976,11 +6511,18 @@ async def device_templates_list_2_async( query_params.append(f"application={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -4993,35 +6535,64 @@ async def device_templates_list_2_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def workflow_get_components_async( + def list_workflow_get_components( self, application: str, template: str, - module: Optional[str] = None, *, + module: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Workflow_GetComponents + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Workflow_GetComponents`. + + Args: + application: Unique ID of the application. + template: template. + module: module. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5043,43 +6614,86 @@ async def workflow_get_components_async( query_params.append(f"module={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def workflow_get_capabilities_async( + return AsyncItemPaged(get_next, extract_data) + + def list_workflow_get_capabilities( self, application: str, template: str, + *, component: Optional[str] = None, module: Optional[str] = None, type_: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Workflow_GetCapabilities + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Workflow_GetCapabilities`. + + Args: + application: Unique ID of the application. + template: template. + component: component. + module: module. + type_: type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5111,43 +6725,86 @@ async def workflow_get_capabilities_async( query_params.append(f"type={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def workflow_get_capabilities_v1_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_workflow_get_capabilities_v1( self, application: str, template: str, + *, component: Optional[str] = None, module: Optional[str] = None, type_: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Workflow_GetCapabilities_V1 + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Workflow_GetCapabilities_V1`. + + Args: + application: Unique ID of the application. + template: template. + component: component. + module: module. + type_: type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5179,41 +6836,82 @@ async def workflow_get_capabilities_v1_async( query_params.append(f"type={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def workflow_get_components_v1_async( + def list_workflow_get_components_v1( self, application: str, template: str, - module: Optional[str] = None, *, + module: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Workflow_GetComponents_V1 + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Workflow_GetComponents_V1`. + + Args: + application: Unique ID of the application. + template: template. + module: module. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5235,29 +6933,50 @@ async def workflow_get_components_v1_async( query_params.append(f"module={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def workflow_get_modules_async( + return AsyncItemPaged(get_next, extract_data) + + def list_workflow_get_modules( self, application: str, template: str, @@ -5266,9 +6985,28 @@ async def workflow_get_modules_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Workflow_GetModules + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Workflow_GetModules_V1`. + + Args: + application: Unique ID of the application. + template: template. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/api/v1/_internal/workflow/modules" @@ -5284,33 +7022,54 @@ async def workflow_get_modules_async( query_params.append(f"template={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def schema_device_cloud_properties_async( + async def schema_device_cloud_properties( self, application: str, - instance_of: Optional[str] = None, *, + instance_of: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5318,6 +7077,22 @@ async def schema_device_cloud_properties_async( ) -> dict[str, Any] | None: """ Schema_DeviceCloudProperties + + Swagger operation ID: `Schema_DeviceCloudProperties`. + + Args: + application: Unique ID of the application. + instance_of: The device template definition for the device. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5336,7 +7111,7 @@ async def schema_device_cloud_properties_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5350,6 +7125,7 @@ async def schema_device_cloud_properties_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5357,13 +7133,13 @@ async def schema_device_cloud_properties_async( return json.loads(response.text) - async def schema_device_command_async( + async def schema_device_command( self, application: str, + *, instance_of: Optional[str] = None, component: Optional[str] = None, capability: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5371,6 +7147,24 @@ async def schema_device_command_async( ) -> dict[str, Any] | None: """ Schema_DeviceCommand + + Swagger operation ID: `Schema_DeviceCommand`. + + Args: + application: Unique ID of the application. + instance_of: The device template definition for the device. + component: component. + capability: capability. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5399,7 +7193,7 @@ async def schema_device_command_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5413,6 +7207,7 @@ async def schema_device_command_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5420,14 +7215,14 @@ async def schema_device_command_async( return json.loads(response.text) - async def schema_device_command_v1_async( + async def schema_device_command_v1( self, application: str, + *, template: Optional[str] = None, module: Optional[str] = None, component: Optional[str] = None, capability: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5435,6 +7230,25 @@ async def schema_device_command_v1_async( ) -> dict[str, Any] | None: """ Schema_DeviceCommand_V1 + + Swagger operation ID: `Schema_DeviceCommand_V1`. + + Args: + application: Unique ID of the application. + template: The device template definition for the device. + module: module. + component: component. + capability: capability. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5468,7 +7282,7 @@ async def schema_device_command_v1_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5482,6 +7296,7 @@ async def schema_device_command_v1_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5489,12 +7304,12 @@ async def schema_device_command_v1_async( return json.loads(response.text) - async def schema_device_properties_async( + async def schema_device_properties( self, application: str, + *, template: Optional[str] = None, module: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5502,6 +7317,23 @@ async def schema_device_properties_async( ) -> dict[str, Any] | None: """ Schema_DeviceProperties + + Swagger operation ID: `Schema_DeviceProperties_V1`. + + Args: + application: Unique ID of the application. + template: The device template definition for the device. + module: module. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5525,7 +7357,7 @@ async def schema_device_properties_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5539,6 +7371,7 @@ async def schema_device_properties_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5546,14 +7379,14 @@ async def schema_device_properties_async( return json.loads(response.text) - async def schema_device_telemetry_async( + async def schema_device_telemetry( self, application: str, + *, template: Optional[str] = None, module: Optional[str] = None, component: Optional[str] = None, capability: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5561,6 +7394,25 @@ async def schema_device_telemetry_async( ) -> dict[str, Any] | None: """ Schema_DeviceTelemetry + + Swagger operation ID: `Schema_DeviceTelemetry_V1`. + + Args: + application: Unique ID of the application. + template: The device template definition for the device. + module: module. + component: component. + capability: capability. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5594,7 +7446,7 @@ async def schema_device_telemetry_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5608,6 +7460,7 @@ async def schema_device_telemetry_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5615,11 +7468,11 @@ async def schema_device_telemetry_async( return json.loads(response.text) - async def schema_job_async( + async def schema_job( self, application: str, - job_type: Optional[str] = None, *, + job_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5627,6 +7480,22 @@ async def schema_job_async( ) -> dict[str, Any] | None: """ Schema_Job + + Swagger operation ID: `Schema_Job`. + + Args: + application: Unique ID of the application. + job_type: job_type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5645,7 +7514,7 @@ async def schema_job_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5659,6 +7528,7 @@ async def schema_job_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5666,13 +7536,13 @@ async def schema_job_async( return json.loads(response.text) - async def schema_scheduled_job_async( + async def schema_scheduled_job( self, application: str, + *, scheduled_job_end_type: Optional[str] = None, job_type: Optional[str] = None, patch: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5680,6 +7550,24 @@ async def schema_scheduled_job_async( ) -> dict[str, Any] | None: """ Schema_ScheduledJob + + Swagger operation ID: `Schema_ScheduledJob`. + + Args: + application: Unique ID of the application. + scheduled_job_end_type: scheduled_job_end_type. + job_type: job_type. + patch: patch. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5708,7 +7596,7 @@ async def schema_scheduled_job_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5722,6 +7610,7 @@ async def schema_scheduled_job_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5729,12 +7618,12 @@ async def schema_scheduled_job_async( return json.loads(response.text) - async def schema_user_async( + async def schema_user( self, application: str, + *, user_type: Optional[str] = None, patch: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5742,6 +7631,23 @@ async def schema_user_async( ) -> dict[str, Any] | None: """ Schema_User + + Swagger operation ID: `Schema_User_V1`. + + Args: + application: Unique ID of the application. + user_type: user_type. + patch: patch. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5765,7 +7671,7 @@ async def schema_user_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5779,6 +7685,7 @@ async def schema_user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5786,11 +7693,11 @@ async def schema_user_async( return json.loads(response.text) - async def schema_webhook_action_body_async( + async def schema_webhook_action_body( self, application: str, - rule: Optional[str] = None, *, + rule: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5798,6 +7705,22 @@ async def schema_webhook_action_body_async( ) -> None: """ Schema_WebhookActionBody + + Swagger operation ID: `Schema_WebhookActionBody`. + + Args: + application: Unique ID of the application. + rule: rule. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5816,7 +7739,7 @@ async def schema_webhook_action_body_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5830,6 +7753,7 @@ async def schema_webhook_action_body_async( request_url, response.status, response.text, + response=response, ) diff --git a/src/azure/connectors/azuremonitorlogs.py b/src/azure/connectors/azuremonitorlogs.py index 7da1740b..0850f42a 100644 --- a/src/azure/connectors/azuremonitorlogs.py +++ b/src/azure/connectors/azuremonitorlogs.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,30 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "AzuremonitorlogsClient", + "ObjectEntity", + "PartialQueryError", + "QueryDataInput", + "QuerySchemaInput", + "ResourceGroup", + "ResourceGroupListResult", + "ResourceItem", + "ResourceItemListResult", + "Row", + "Subscription", + "SubscriptionListResult", + "Table", + "TimeRangeItem", + "TimeRangeListResult", + "TimeRangeTypesListResult", + "VisualizeQueryInput", + "VisualizeResults", +] + # Type Definitions @@ -29,11 +52,11 @@ class QueryDataInput: Run query and list results """ - query: Optional[str] = None + query: str """Specify the query you would like to run. """ - timerangetype: Optional[str] = None + timerangetype: str """Select Time Range type. """ - timerange: Optional[Dict[str, Any]] = None + timerange: Dict[str, Any] """Time Range""" @@ -43,8 +66,18 @@ class Table: Response for Run query and list results """ - value: Optional[List[Row]] = None - error: Optional[PartialQueryError] = None + value: Optional[ + List[Row | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + error: Optional[ + PartialQueryError | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -53,11 +86,11 @@ class VisualizeQueryInput: Run query and visualize results """ - query: Optional[str] = None + query: str """Specify the query you would like to run. """ - timerangetype: Optional[str] = None + timerangetype: str """Select Time Range type. """ - timerange: Optional[Dict[str, Any]] = None + timerange: Dict[str, Any] """Time Range""" @@ -67,16 +100,23 @@ class VisualizeResults: Response for Run query and visualize results """ - body: Optional[str] = None - attachment_content: Optional[str] = field( + body: Optional[str] = dataclass_field(default=None, kw_only=True) + attachment_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "attachmentContent"}, ) - attachment_name: Optional[str] = field( + attachment_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "attachmentName"}, ) - error: Optional[PartialQueryError] = None + error: Optional[ + PartialQueryError | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -85,10 +125,16 @@ class SubscriptionListResult: Response for List subscriptions """ - value: Optional[List[Subscription]] = None + value: Optional[ + List[Subscription | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The subscriptions .""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results. """ @@ -100,10 +146,16 @@ class ResourceGroupListResult: Response for List resource groups """ - value: Optional[List[ResourceGroup]] = None + value: Optional[ + List[ResourceGroup | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of resource groups. """ - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results. """ @@ -115,10 +167,16 @@ class ResourceItemListResult: Response for List resources """ - value: Optional[List[ResourceItem]] = None + value: Optional[ + List[ResourceItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of resource items. """ - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results. """ @@ -133,7 +191,7 @@ class ObjectEntity: Response for Get query schema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -146,7 +204,7 @@ class Row: Definition: Row """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -159,7 +217,7 @@ class PartialQueryError: Definition: PartialQueryError """ - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -168,18 +226,20 @@ class Subscription: Definition: Subscription """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000. """ - subscription_id: Optional[str] = field( + subscription_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subscriptionId"}, ) """The subscription Id. """ - authorization_source: Optional[str] = field( + authorization_source: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "authorizationSource"}, ) """ @@ -195,11 +255,11 @@ class ResourceGroup: Definition: ResourceGroup """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY). """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The Name of the resource group. """ @@ -209,9 +269,9 @@ class ResourceItem: Definition: ResourceItem """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the resource. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The Name of the resource .""" @@ -221,10 +281,16 @@ class TimeRangeTypesListResult: Definition: TimeRangeTypesListResult """ - value: Optional[List[TimeRangeItem]] = None + value: Optional[ + List[TimeRangeItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of time range types (Relative\\Absolute\\SetInQuery). """ - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results. """ @@ -236,10 +302,16 @@ class TimeRangeListResult: Definition: TimeRangeListResult """ - value: Optional[List[TimeRangeItem]] = None + value: Optional[ + List[TimeRangeItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of time range. """ - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results. """ @@ -251,9 +323,9 @@ class TimeRangeItem: Definition: TimeRangeItem """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The ID of the item. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The Name of the item. """ @@ -268,7 +340,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -285,8 +357,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -307,7 +379,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -323,15 +395,49 @@ def connector_name(self) -> str: return "azuremonitorlogs" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -348,7 +454,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -361,9 +471,9 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def query_data_async( + async def query_data( self, - input: QueryDataInput, + input: QueryDataInput | Mapping[str, Any], subscriptions: str, resourcegroups: str, resourcetype: str, @@ -379,6 +489,26 @@ async def query_data_async( Returns each row as its own object. Use this action when you want to work with each row separately in the rest of the workflow. + + Swagger operation ID: `QueryDataV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscriptions: Select subscription. + resourcegroups: Select resource group. + resourcetype: Select Resource Type. + resourcename: Select Resource. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/queryDataV2" query_params = [] @@ -401,7 +531,7 @@ async def query_data_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -415,6 +545,7 @@ async def query_data_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -422,9 +553,9 @@ async def query_data_async( return json.loads(response.text) - async def visualize_query_async( + async def visualize_query( self, - input: VisualizeQueryInput, + input: VisualizeQueryInput | Mapping[str, Any], subscriptions: str, resourcegroups: str, resourcetype: str, @@ -442,6 +573,27 @@ async def visualize_query_async( Returns all rows in the result set as a single formatted object. Use this action when you want to use the result set together in the rest of the workflow. + + Swagger operation ID: `VisualizeQueryV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + subscriptions: Select subscription. + resourcegroups: Select resource group. + resourcetype: Select Resource Type. + resourcename: Select Resource. + vis_type: Specify the resulting chart type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/visualizeQueryV2" query_params = [] @@ -468,7 +620,7 @@ async def visualize_query_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -482,6 +634,7 @@ async def visualize_query_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -489,28 +642,50 @@ async def visualize_query_async( return json.loads(response.text) - async def list_subscriptions_async( + def list_subscriptions( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List subscriptions Gets a list of all the subscriptions to which the principal has access. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListSubscriptions`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/listSubscriptions" + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -523,23 +698,32 @@ async def list_subscriptions_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def list_resource_groups_async( + return AsyncItemPaged(get_next, extract_data) + + def list_resource_groups( self, subscriptions: str, *, @@ -547,14 +731,30 @@ async def list_resource_groups_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List resource groups Lists all the resource groups within the subscription. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListResourceGroups`. + + Args: + subscriptions: Select subscription. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/listResourceGroups" query_params = [] @@ -564,11 +764,18 @@ async def list_resource_groups_async( query_params.append(f"subscriptions={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -581,23 +788,32 @@ async def list_resource_groups_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def list_resources_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_resources( self, subscriptions: str, resourcegroups: str, @@ -607,14 +823,32 @@ async def list_resources_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List resources Lists all the resource groups within the resource group. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListResources`. + + Args: + subscriptions: Select subscription. + resourcegroups: Select resource group. + resourcetype: Select Resource Type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/listResources" query_params = [] @@ -632,11 +866,18 @@ async def list_resources_async( query_params.append(f"resourcetype={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -649,23 +890,32 @@ async def list_resources_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def query_schema_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def query_schema( self, input: QuerySchemaInput, subscriptions: str, @@ -682,6 +932,25 @@ async def query_schema_async( Get query schema Gets the schema for a specific query. + + Swagger operation ID: `QuerySchemaV2`. + + Args: + input: The request body. + subscriptions: Select subscription. + resourcegroups: Select resource group. + resourcetype: Select Resource Type. + resourcename: Select Resource. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/querySchemaV2" query_params = [] @@ -704,7 +973,7 @@ async def query_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -718,6 +987,7 @@ async def query_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -725,7 +995,7 @@ async def query_schema_async( return json.loads(response.text) - async def get_time_range_selection_control_async( + async def get_time_range_selection_control( self, timerangetype: str, *, @@ -738,6 +1008,21 @@ async def get_time_range_selection_control_async( Returns the control schema according to to the given time range type Returns the Relative\\Absolute\\Set in query time range control. + + Swagger operation ID: `getTimeRangeSelectionControl`. + + Args: + timerangetype: The Time Range type that the control represents. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/getTimeRangeSelectionControl" @@ -750,7 +1035,7 @@ async def get_time_range_selection_control_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -764,6 +1049,7 @@ async def get_time_range_selection_control_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/azurequeues.py b/src/azure/connectors/azurequeues.py index 3ac187e3..30c2bb9c 100644 --- a/src/azure/connectors/azurequeues.py +++ b/src/azure/connectors/azurequeues.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,23 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "AzurequeuesClient", + "MessagePost", + "Messages", + "PutMessageInput", + "QueueArray", + "QueueInfo", + "QueueMessage", + "QueueMessagesList", + "StorageAccount", + "StorageAccountList", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,13 +45,14 @@ class Messages: Response for Get messages """ - queue_messages_list: Optional[QueueMessagesList] = field( + queue_messages_list: Optional[QueueMessagesList | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "QueueMessagesList"}, ) -QueueArray = List["QueueInfo"] +QueueArray = List["QueueInfo | Mapping[str, Any]"] PutMessageInput = str @@ -47,7 +64,12 @@ class StorageAccountList: Response for Get storage accounts """ - value: Optional[List[StorageAccount]] = None + value: Optional[ + List[StorageAccount | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of storage account names""" @@ -57,10 +79,15 @@ class StorageAccount: Definition: StorageAccount """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name or queue endpoint of the storage account.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the storage account.""" @@ -72,7 +99,11 @@ class QueueInfo: Definition: Queue """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the queue.""" @@ -82,10 +113,7 @@ class MessagePost: Definition: MessagePost """ - message: Optional[str] = field( - default=None, - metadata={"wire_name": "Message"}, - ) + message: str = dataclass_field(metadata={"wire_name": "Message"}) """The message to put in the queue.""" @@ -95,38 +123,45 @@ class QueueMessage: Definition: QueueMessage """ - message_id: Optional[str] = field( + message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageId"}, ) """The unique identifier of the message.""" - insertion_time: Optional[str] = field( + insertion_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InsertionTime"}, ) """The time the message was inserted into the queue.""" - expiration_time: Optional[str] = field( + expiration_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpirationTime"}, ) """The time the message will expire from the queue.""" - pop_receipt: Optional[str] = field( + pop_receipt: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PopReceipt"}, ) """Used to delete the message after popping it off the queue.""" - next_visible_time: Optional[str] = field( + next_visible_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeNextVisible"}, ) """The time the message will be visible to other consumers.""" - message_text: Optional[str] = field( + message_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageText"}, ) """The text of the message.""" - dequeue_count: Optional[str] = field( + dequeue_count: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DequeueCount"}, ) """The number of times the message has been dequeued.""" @@ -138,8 +173,9 @@ class QueueMessagesList: Definition: QueueMessagesList """ - queue_message: Optional[List[QueueMessage]] = field( + queue_message: Optional[List[QueueMessage | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "QueueMessage"}, ) @@ -155,7 +191,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -172,8 +208,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -194,7 +230,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -209,7 +245,84 @@ def __init__( def connector_name(self) -> str: return "azurequeues" - async def delete_message_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def delete_message( self, storage_account_name: str, queue_name: str, @@ -225,6 +338,25 @@ async def delete_message_async( Delete message Delete a specific message from the queue. + + Swagger operation ID: `DeleteMessage_V2`. + + Args: + storage_account_name: Azure Storage account name or queue endpoint. + queue_name: The queue to delete a message from. + message_id: The ID of the message to delete. + popreceipt: A valid pop receipt value returned from an earlier call + to the Get Messages. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -244,7 +376,7 @@ async def delete_message_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -258,15 +390,16 @@ async def delete_message_async( request_url, response.status, response.text, + response=response, ) - async def get_messages_async( + async def get_messages( self, storage_account_name: str, queue_name: str, + *, numofmessages: Optional[str] = None, visibilitytimeout: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -277,6 +410,26 @@ async def get_messages_async( Get a specific set of messages from the queue. The messages will be hidden but remain on the queue until the delete action is used. + + Swagger operation ID: `GetMessages_V2`. + + Args: + storage_account_name: Azure Storage account name or queue endpoint. + queue_name: The queue to get Messages from. + numofmessages: The number of messages to grab from the queue + (default 1). + visibilitytimeout: The time in seconds that messages will be + invisible to other consumers (default 30). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -301,7 +454,7 @@ async def get_messages_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -315,6 +468,7 @@ async def get_messages_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -322,7 +476,7 @@ async def get_messages_async( return json.loads(response.text) - async def list_queues_async( + def list_queues( self, storage_account_name: str, *, @@ -330,11 +484,29 @@ async def list_queues_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List queues List all the queues for your storage account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListQueues_V2`. + + Args: + storage_account_name: Azure Storage account name or queue endpoint. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -344,29 +516,50 @@ async def list_queues_async( f"/queues" f"/list" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def put_message_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def put_message( self, input: PutMessageInput, storage_account_name: str, @@ -381,6 +574,23 @@ async def put_message_async( Put a message on a queue Adds a message to the given queue. + + Swagger operation ID: `PutMessage_V2`. + + Args: + input: The request body. + storage_account_name: Azure Storage account name or queue endpoint. + queue_name: The queue to put a message to. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -392,7 +602,7 @@ async def put_message_async( f"/messages" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -406,9 +616,10 @@ async def put_message_async( request_url, response.status, response.text, + response=response, ) - async def put_queue_async( + async def put_queue( self, storage_account_name: str, queue_name: str, @@ -422,6 +633,22 @@ async def put_queue_async( Create a new queue Adds a queue to your account. + + Swagger operation ID: `PutQueue_V2`. + + Args: + storage_account_name: Azure Storage account name or queue endpoint. + queue_name: The name of the queue to create. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -439,7 +666,7 @@ async def put_queue_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -453,6 +680,7 @@ async def put_queue_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -460,41 +688,79 @@ async def put_queue_async( return json.loads(response.text) - async def get_storage_accounts_async( + def list_storage_accounts( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get storage accounts This operation list the user's Azure Storage Account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetStorageAccounts`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/GetStorageAccounts" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/azuretables.py b/src/azure/connectors/azuretables.py index f3cd1d61..8ca41478 100644 --- a/src/azure/connectors/azuretables.py +++ b/src/azure/connectors/azuretables.py @@ -5,11 +5,13 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core import MatchConditions +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +20,27 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "AzuretablesClient", + "CreateEntityInput", + "CreateTableInput", + "EntityItem", + "GetEntitiesResponse", + "GetEntityResponse", + "GetTableResponse", + "GetTablesResponse", + "InsertEntityResponse", + "InsertMergeEntityInput", + "InsertReplaceEntityInput", + "MergeEntityInput", + "ReplaceEntityInput", + "StorageAccount", + "StorageAccountList", +] + # Type Definitions @@ -29,7 +50,7 @@ class CreateEntityInput: Insert Entity """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -42,23 +63,27 @@ class InsertEntityResponse: Response for Insert Entity """ - odata_metadata: Optional[str] = field( + odata_metadata: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "odata.metadata"}, ) """Entity Metadata location""" - partition_key: Optional[str] = field( + partition_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PartitionKey"}, ) """Partition Key""" - row_key: Optional[str] = field( + row_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RowKey"}, ) """Row Key""" - additional_properties: Optional[str] = field( + additional_properties: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "additionalProperties"}, ) """Dynamic entity columns returned by the service.""" @@ -73,13 +98,15 @@ class GetTableResponse: Response for Create table """ - odata_id: Optional[str] = field( + odata_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "odata.id"}, ) """URL to the Table data""" - table_name: Optional[str] = field( + table_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableName"}, ) """Table Name""" @@ -91,15 +118,22 @@ class GetEntitiesResponse: Response for Get entities """ - odata_metadata: Optional[str] = field( + odata_metadata: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "odata.metadata"}, ) """Table Metadata location""" - value: Optional[List[EntityItem]] = None + value: Optional[ + List[EntityItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Entities""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to retrieve the next page.""" @@ -111,23 +145,27 @@ class GetEntityResponse: Response for Get entity """ - odata_metadata: Optional[str] = field( + odata_metadata: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "odata.metadata"}, ) """Table Metadata location""" - partition_key: Optional[str] = field( + partition_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PartitionKey"}, ) """Partition Key""" - row_key: Optional[str] = field( + row_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RowKey"}, ) """Row Key""" - additional_properties: Optional[str] = field( + additional_properties: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "additionalProperties"}, ) """Dynamic entity columns returned by the service.""" @@ -139,12 +177,13 @@ class GetTablesResponse: Response for List tables """ - odata_metadata: Optional[str] = field( + odata_metadata: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "odata.metadata"}, ) """URL to the account metadata""" - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of tables""" @@ -154,7 +193,7 @@ class InsertMergeEntityInput: Insert or Merge Entity """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -167,7 +206,7 @@ class InsertReplaceEntityInput: Insert or Replace Entity """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -180,7 +219,7 @@ class MergeEntityInput: Merge Entity """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -193,7 +232,7 @@ class ReplaceEntityInput: Replace Entity """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -206,7 +245,12 @@ class StorageAccountList: Response for Get storage accounts """ - value: Optional[List[StorageAccount]] = None + value: Optional[ + List[StorageAccount | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of storage account names""" @@ -216,10 +260,15 @@ class StorageAccount: Definition: StorageAccount """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the storage account.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the storage account.""" @@ -231,18 +280,21 @@ class EntityItem: Definition: Item """ - partition_key: Optional[str] = field( + partition_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PartitionKey"}, ) """Partition Key""" - row_key: Optional[str] = field( + row_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RowKey"}, ) """Row Key""" - additional_properties: Optional[str] = field( + additional_properties: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "additionalProperties"}, ) """Dynamic entity columns returned by the service.""" @@ -259,7 +311,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -276,8 +328,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -298,7 +350,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -313,16 +365,92 @@ def __init__( def connector_name(self) -> str: return "azuretables" + @staticmethod + def _prepare_match_headers( + headers: Optional[Mapping[str, str]], + etag: Optional[str], + match_condition: Optional[MatchConditions], + *, + default_etag: Optional[str], + if_match_required: bool, + ) -> Optional[Mapping[str, str]]: + request_headers = dict(headers) if headers is not None else {} + existing_if_match = next( + (name for name in request_headers if name.lower() == "if-match"), + None, + ) + if etag is None and match_condition is None: + if existing_if_match is not None: + return request_headers + if default_etag is not None: + request_headers["If-Match"] = default_etag + elif if_match_required: + request_headers["If-Match"] = "*" + return request_headers or None + + if existing_if_match is not None: + del request_headers[existing_if_match] + if match_condition is None: + assert etag is not None + request_headers["If-Match"] = etag + elif match_condition == MatchConditions.IfNotModified: + if etag is None: + raise ValueError( + "etag is required for MatchConditions.IfNotModified." + ) + request_headers["If-Match"] = etag + elif match_condition == MatchConditions.Unconditionally: + request_headers["If-Match"] = "*" + else: + raise ValueError( + "If-Match operations support only IfNotModified or Unconditionally." + ) + return request_headers or None + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -339,7 +467,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -352,9 +484,9 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def create_entity_async( + async def create_entity( self, - input: CreateEntityInput, + input: CreateEntityInput | Mapping[str, Any], storage_account_name: str, table_name: str, *, @@ -367,6 +499,24 @@ async def create_entity_async( Insert Entity Operation to add an entity to a table. + + Swagger operation ID: `CreateEntity_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + storage_account_name: Azure Storage account name or table endpoint. + table_name: Specify the table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -378,7 +528,7 @@ async def create_entity_async( f"/entities" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -392,6 +542,7 @@ async def create_entity_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -399,7 +550,7 @@ async def create_entity_async( return json.loads(response.text) - async def create_table_async( + async def create_table( self, input: CreateTableInput, storage_account_name: str, @@ -413,6 +564,22 @@ async def create_table_async( Create table This operation adds a table to the storage account. + + Swagger operation ID: `CreateTable_V2`. + + Args: + input: The request body. + storage_account_name: Azure Storage account name or table endpoint. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -422,7 +589,7 @@ async def create_table_async( f"/tables" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -436,6 +603,7 @@ async def create_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -443,13 +611,15 @@ async def create_table_async( return json.loads(response.text) - async def delete_entity_async( + async def delete_entity( self, storage_account_name: str, table_name: str, partition_key: str, row_key: str, *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -459,7 +629,35 @@ async def delete_entity_async( Delete Entity Operation to delete an entity. + + Swagger operation ID: `DeleteEntity_V2`. + + Args: + storage_account_name: Azure Storage account name or table endpoint. + table_name: Specify the table. + partition_key: The partition id containing this entity. + row_key: The row id containing this entity. + etag: The entity tag for the conditional request. + match_condition: The Azure Core match condition. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ + headers = self._prepare_match_headers( + headers, + etag, + match_condition, + default_etag=None, + if_match_required=False, + ) + request_url = ( f"{self._connection_runtime_url}" f"/v2" @@ -475,7 +673,7 @@ async def delete_entity_async( f"')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -489,9 +687,10 @@ async def delete_entity_async( request_url, response.status, response.text, + response=response, ) - async def delete_table_async( + async def delete_table( self, storage_account_name: str, table_name: str, @@ -505,6 +704,22 @@ async def delete_table_async( Delete a table Delete a table. + + Swagger operation ID: `DeleteTable_V2`. + + Args: + storage_account_name: Azure Storage account name or table endpoint. + table_name: Specify the table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -515,7 +730,7 @@ async def delete_table_async( f"/{quote(str(table_name), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -529,27 +744,50 @@ async def delete_table_async( request_url, response.status, response.text, + response=response, ) - async def get_entities_async( + def list_entities( self, storage_account_name: str, table_name: str, + *, filter: Optional[str] = None, select: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get entities This operation queries the entities in a table. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetEntities_V2`. + + Args: + storage_account_name: Azure Storage account name or table endpoint. + table_name: Specify the table. + filter: OData filter query for which entities to return. Example: + Column eq 'Value' and Column2 ne 2. Invalid OData queries, such + as not wrapping string values in quotes will return 501. + select: OData select query for the columns to be returned. Example: + Column, PartitionKey. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -573,11 +811,18 @@ async def get_entities_async( query_params.append(f"$select={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -590,30 +835,39 @@ async def get_entities_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_entity_async( + async def get_entity( self, storage_account_name: str, table_name: str, partition_key: str, row_key: str, - select: Optional[str] = None, *, + select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -624,6 +878,26 @@ async def get_entity_async( This operation gets the entity in a table based on the partition and row key. + + Swagger operation ID: `GetEntity_V2`. + + Args: + storage_account_name: Azure Storage account name or table endpoint. + table_name: Specify the table. + partition_key: The partition id containing this entity. + row_key: The row id containing this entity. + select: OData select query for the columns to be returned. Example: + Column, PartitionKey. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -647,7 +921,7 @@ async def get_entity_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -661,6 +935,7 @@ async def get_entity_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -668,7 +943,7 @@ async def get_entity_async( return json.loads(response.text) - async def get_table_async( + async def get_table( self, storage_account_name: str, table_name: str, @@ -682,6 +957,22 @@ async def get_table_async( Get a table This operation gets the metadata of a table. + + Swagger operation ID: `GetTable_V2`. + + Args: + storage_account_name: Azure Storage account name or table endpoint. + table_name: Specify the table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -692,7 +983,7 @@ async def get_table_async( f"/{quote(str(table_name), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -706,6 +997,7 @@ async def get_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -713,7 +1005,7 @@ async def get_table_async( return json.loads(response.text) - async def get_tables_async( + def list_tables( self, storage_account_name: str, *, @@ -721,11 +1013,29 @@ async def get_tables_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List tables List all the tables for your storage account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTables_V2`. + + Args: + storage_account_name: Azure Storage account name or table endpoint. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -734,31 +1044,52 @@ async def get_tables_async( f"/{quote(quote(str(storage_account_name), safe=''), safe='')}" f"/tables" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def insert_merge_entity_async( + return AsyncItemPaged(get_next, extract_data) + + async def insert_merge_entity( self, - input: InsertMergeEntityInput, + input: InsertMergeEntityInput | Mapping[str, Any], storage_account_name: str, table_name: str, partition_key: str, @@ -774,6 +1105,26 @@ async def insert_merge_entity_async( Operation to merge data with an entity in a table, creating a new entity if needed. + + Swagger operation ID: `InsertMergeEntity_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + storage_account_name: Azure Storage account name or table endpoint. + table_name: Specify the table. + partition_key: The partition id containing this entity. + row_key: The row id containing this entity. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -789,7 +1140,7 @@ async def insert_merge_entity_async( f"')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -803,11 +1154,12 @@ async def insert_merge_entity_async( request_url, response.status, response.text, + response=response, ) - async def insert_replace_entity_async( + async def insert_replace_entity( self, - input: InsertReplaceEntityInput, + input: InsertReplaceEntityInput | Mapping[str, Any], storage_account_name: str, table_name: str, partition_key: str, @@ -823,6 +1175,26 @@ async def insert_replace_entity_async( Operation to replace an entity in a table, creating a new entity if needed. + + Swagger operation ID: `InsertReplaceEntity_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + storage_account_name: Azure Storage account name or table endpoint. + table_name: Specify the table. + partition_key: The partition id containing this entity. + row_key: The row id containing this entity. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -838,7 +1210,7 @@ async def insert_replace_entity_async( f"')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -852,16 +1224,19 @@ async def insert_replace_entity_async( request_url, response.status, response.text, + response=response, ) - async def merge_entity_async( + async def merge_entity( self, - input: MergeEntityInput, + input: MergeEntityInput | Mapping[str, Any], storage_account_name: str, table_name: str, partition_key: str, row_key: str, *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -871,7 +1246,37 @@ async def merge_entity_async( Merge Entity Operation to merge data with an entity in a table. + + Swagger operation ID: `MergeEntity_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + storage_account_name: Azure Storage account name or table endpoint. + table_name: Specify the table. + partition_key: The partition id containing this entity. + row_key: The row id containing this entity. + etag: The entity tag for the conditional request. + match_condition: The Azure Core match condition. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ + headers = self._prepare_match_headers( + headers, + etag, + match_condition, + default_etag=None, + if_match_required=True, + ) + request_url = ( f"{self._connection_runtime_url}" f"/v2" @@ -887,7 +1292,7 @@ async def merge_entity_async( f"')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -901,16 +1306,19 @@ async def merge_entity_async( request_url, response.status, response.text, + response=response, ) - async def replace_entity_async( + async def replace_entity( self, - input: ReplaceEntityInput, + input: ReplaceEntityInput | Mapping[str, Any], storage_account_name: str, table_name: str, partition_key: str, row_key: str, *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -920,7 +1328,37 @@ async def replace_entity_async( Replace Entity Operation to replace an entity in a table. + + Swagger operation ID: `ReplaceEntity_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + storage_account_name: Azure Storage account name or table endpoint. + table_name: Specify the table. + partition_key: The partition id containing this entity. + row_key: The row id containing this entity. + etag: The entity tag for the conditional request. + match_condition: The Azure Core match condition. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ + headers = self._prepare_match_headers( + headers, + etag, + match_condition, + default_etag="*", + if_match_required=True, + ) + request_url = ( f"{self._connection_runtime_url}" f"/v2" @@ -936,7 +1374,7 @@ async def replace_entity_async( f"')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -950,40 +1388,79 @@ async def replace_entity_async( request_url, response.status, response.text, + response=response, ) - async def get_storage_accounts_async( + def list_storage_accounts( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get storage accounts This operation list the user's Azure Storage Account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetStorageAccounts`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/GetStorageAccounts" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/azurevm.py b/src/azure/connectors/azurevm.py index 17085a0e..09fcbae3 100644 --- a/src/azure/connectors/azurevm.py +++ b/src/azure/connectors/azurevm.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,26 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "AzurevmClient", + "ResourceGroup", + "ResourceGroupListResult", + "Subscription", + "SubscriptionListResult", + "VirtualMachine", + "VirtualMachineInScaleSet", + "VirtualMachineInScaleSetListResult", + "VirtualMachineInScaleSetProperties", + "VirtualMachineListResult", + "VirtualMachineProperties", + "VirtualMachineScaleSet", + "VirtualMachineScaleSetListResult", + "VirtualMachineScaleSetProperties", +] + # Type Definitions @@ -29,16 +48,22 @@ class VirtualMachineInScaleSet: Response for Get virtual machine in a VM scale set """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the virtual machine.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The Name of the virtual machine.""" - instance_id: Optional[str] = field( + instance_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "instanceId"}, ) """The instance Id of the virtual machine.""" - properties: Optional[VirtualMachineInScaleSetProperties] = None + properties: Optional[ + VirtualMachineInScaleSetProperties | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -47,11 +72,16 @@ class VirtualMachine: Response for Get virtual machine """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the virtual machine.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The Name of the virtual machine.""" - properties: Optional[VirtualMachineProperties] = None + properties: Optional[ + VirtualMachineProperties | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -60,10 +90,16 @@ class SubscriptionListResult: Response for List subscriptions """ - value: Optional[List[Subscription]] = None + value: Optional[ + List[Subscription | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The subscriptions.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -75,10 +111,16 @@ class ResourceGroupListResult: Response for List resource groups """ - value: Optional[List[ResourceGroup]] = None + value: Optional[ + List[ResourceGroup | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of resource groups.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -90,10 +132,16 @@ class VirtualMachineScaleSetListResult: Response for List virtual machine scale sets """ - value: Optional[List[VirtualMachineScaleSet]] = None + value: Optional[ + List[VirtualMachineScaleSet | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of virtual machine scale sets.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -105,10 +153,16 @@ class VirtualMachineInScaleSetListResult: Response for List virtual machines in a VM scale set """ - value: Optional[List[VirtualMachineInScaleSet]] = None + value: Optional[ + List[VirtualMachineInScaleSet | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of virtual machines in a VM scale set.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -120,10 +174,16 @@ class VirtualMachineListResult: Response for List virtual machines """ - value: Optional[List[VirtualMachine]] = None + value: Optional[ + List[VirtualMachine | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of virtual machines.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to get the next set of results.""" @@ -135,27 +195,31 @@ class Subscription: Definition: Subscription """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The fully qualified Id.""" - subscription_id: Optional[str] = field( + subscription_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subscriptionId"}, ) """The subscription Id.""" - tenant_id: Optional[str] = field( + tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tenantId"}, ) """The tenant Id.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The subscription display name.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The subscription state.""" - authorization_source: Optional[str] = field( + authorization_source: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "authorizationSource"}, ) """ @@ -171,12 +235,13 @@ class ResourceGroup: Definition: ResourceGroup """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the resource group.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The Name of the resource group.""" - managed_by: Optional[str] = field( + managed_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managedBy"}, ) """Id of the resource that manages this resource group.""" @@ -188,11 +253,16 @@ class VirtualMachineScaleSet: Definition: VirtualMachineScaleSet """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the virtual machine scale set.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The Name of the virtual machine scale set.""" - properties: Optional[VirtualMachineScaleSetProperties] = None + properties: Optional[ + VirtualMachineScaleSetProperties | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -201,8 +271,9 @@ class VirtualMachineScaleSetProperties: Definition: VirtualMachineScaleSetProperties """ - provisioning_state: Optional[str] = field( + provisioning_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "provisioningState"}, ) """The state of the virtual machine scale set.""" @@ -214,8 +285,9 @@ class VirtualMachineInScaleSetProperties: Definition: VirtualMachineInScaleSetProperties """ - provisioning_state: Optional[str] = field( + provisioning_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "provisioningState"}, ) """The state of the virtual machine.""" @@ -227,8 +299,9 @@ class VirtualMachineProperties: Definition: VirtualMachineProperties """ - provisioning_state: Optional[str] = field( + provisioning_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "provisioningState"}, ) """The state of the virtual machine.""" @@ -245,7 +318,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -262,8 +335,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -284,7 +357,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -300,15 +373,49 @@ def connector_name(self) -> str: return "azurevm" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -325,7 +432,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -338,7 +449,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def virtual_machine_in_scale_set_get_async( + async def virtual_machine_in_scale_set_get( self, subscription_id: str, resource_group_name: str, @@ -354,6 +465,26 @@ async def virtual_machine_in_scale_set_get_async( Get virtual machine in a VM scale set Gets a virtual machine in a VM scale set. + + Swagger operation ID: `VirtualMachineInScaleSet_Get`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_scale_set_name: The name of the virtual machine + scale set. + virtual_machine_in_scale_set_instance_id: The name of the virtual + machine in a VM scale set. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -373,7 +504,7 @@ async def virtual_machine_in_scale_set_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -387,6 +518,7 @@ async def virtual_machine_in_scale_set_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -394,7 +526,7 @@ async def virtual_machine_in_scale_set_get_async( return json.loads(response.text) - async def virtual_machine_in_scale_set_deallocate_async( + async def virtual_machine_in_scale_set_deallocate( self, subscription_id: str, resource_group_name: str, @@ -413,6 +545,26 @@ async def virtual_machine_in_scale_set_deallocate_async( the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated. + + Swagger operation ID: `VirtualMachineInScaleSet_Deallocate`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_scale_set_name: The name of the virtual machine + scale set. + virtual_machine_in_scale_set_instance_id: The name of the virtual + machine in a VM scale set. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -433,7 +585,7 @@ async def virtual_machine_in_scale_set_deallocate_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -447,9 +599,10 @@ async def virtual_machine_in_scale_set_deallocate_async( request_url, response.status, response.text, + response=response, ) - async def virtual_machine_in_scale_set_power_off_async( + async def virtual_machine_in_scale_set_power_off( self, subscription_id: str, resource_group_name: str, @@ -467,6 +620,26 @@ async def virtual_machine_in_scale_set_power_off_async( Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. + + Swagger operation ID: `VirtualMachineInScaleSet_PowerOff`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_scale_set_name: The name of the virtual machine + scale set. + virtual_machine_in_scale_set_instance_id: The name of the virtual + machine in a VM scale set. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -487,7 +660,7 @@ async def virtual_machine_in_scale_set_power_off_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -501,9 +674,10 @@ async def virtual_machine_in_scale_set_power_off_async( request_url, response.status, response.text, + response=response, ) - async def virtual_machine_in_scale_set_redeploy_async( + async def virtual_machine_in_scale_set_redeploy( self, subscription_id: str, resource_group_name: str, @@ -520,6 +694,26 @@ async def virtual_machine_in_scale_set_redeploy_async( Shuts down the virtual machine in the VM scale set, moves it to a new node, and powers it back on. + + Swagger operation ID: `VirtualMachineInScaleSet_Redeploy`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_scale_set_name: The name of the virtual machine + scale set. + virtual_machine_in_scale_set_instance_id: The name of the virtual + machine in a VM scale set. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -540,7 +734,7 @@ async def virtual_machine_in_scale_set_redeploy_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -554,9 +748,10 @@ async def virtual_machine_in_scale_set_redeploy_async( request_url, response.status, response.text, + response=response, ) - async def virtual_machine_in_scale_set_reimage_async( + async def virtual_machine_in_scale_set_reimage( self, subscription_id: str, resource_group_name: str, @@ -573,6 +768,26 @@ async def virtual_machine_in_scale_set_reimage_async( Reimages (upgrade the operating system) a specific virtual machine in a VM scale set. + + Swagger operation ID: `VirtualMachineInScaleSet_Reimage`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_scale_set_name: The name of the virtual machine + scale set. + virtual_machine_in_scale_set_instance_id: The name of the virtual + machine in a VM scale set. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -593,7 +808,7 @@ async def virtual_machine_in_scale_set_reimage_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -607,9 +822,10 @@ async def virtual_machine_in_scale_set_reimage_async( request_url, response.status, response.text, + response=response, ) - async def virtual_machine_in_scale_set_restart_async( + async def virtual_machine_in_scale_set_restart( self, subscription_id: str, resource_group_name: str, @@ -625,6 +841,26 @@ async def virtual_machine_in_scale_set_restart_async( Restart virtual machine in a VM scale set Restarts a virtual machine in a VM scale set. + + Swagger operation ID: `VirtualMachineInScaleSet_Restart`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_scale_set_name: The name of the virtual machine + scale set. + virtual_machine_in_scale_set_instance_id: The name of the virtual + machine in a VM scale set. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -645,7 +881,7 @@ async def virtual_machine_in_scale_set_restart_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -659,9 +895,10 @@ async def virtual_machine_in_scale_set_restart_async( request_url, response.status, response.text, + response=response, ) - async def virtual_machine_in_scale_set_start_async( + async def virtual_machine_in_scale_set_start( self, subscription_id: str, resource_group_name: str, @@ -677,6 +914,26 @@ async def virtual_machine_in_scale_set_start_async( Start virtual machine in a VM scale set Starts a virtual machine in a VM scale set. + + Swagger operation ID: `VirtualMachineInScaleSet_Start`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_scale_set_name: The name of the virtual machine + scale set. + virtual_machine_in_scale_set_instance_id: The name of the virtual + machine in a VM scale set. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -697,7 +954,7 @@ async def virtual_machine_in_scale_set_start_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -711,9 +968,10 @@ async def virtual_machine_in_scale_set_start_async( request_url, response.status, response.text, + response=response, ) - async def virtual_machine_get_async( + async def virtual_machine_get( self, subscription_id: str, resource_group_name: str, @@ -728,6 +986,23 @@ async def virtual_machine_get_async( Get virtual machine Gets a virtual machine. + + Swagger operation ID: `VirtualMachine_Get`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_name: The name of the virtual machine. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -745,7 +1020,7 @@ async def virtual_machine_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -759,6 +1034,7 @@ async def virtual_machine_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -766,7 +1042,7 @@ async def virtual_machine_get_async( return json.loads(response.text) - async def virtual_machine_start_async( + async def virtual_machine_start( self, subscription_id: str, resource_group_name: str, @@ -781,6 +1057,23 @@ async def virtual_machine_start_async( Start virtual machine Starts a virtual machine. + + Swagger operation ID: `VirtualMachine_Start`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_name: The name of the virtual machine. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -799,7 +1092,7 @@ async def virtual_machine_start_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -813,9 +1106,10 @@ async def virtual_machine_start_async( request_url, response.status, response.text, + response=response, ) - async def virtual_machine_deallocate_async( + async def virtual_machine_deallocate( self, subscription_id: str, resource_group_name: str, @@ -832,6 +1126,23 @@ async def virtual_machine_deallocate_async( Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses. + + Swagger operation ID: `VirtualMachine_Deallocate`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_name: The name of the virtual machine. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -850,7 +1161,7 @@ async def virtual_machine_deallocate_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -864,9 +1175,10 @@ async def virtual_machine_deallocate_async( request_url, response.status, response.text, + response=response, ) - async def virtual_machine_poweroff_async( + async def virtual_machine_poweroff( self, subscription_id: str, resource_group_name: str, @@ -883,6 +1195,23 @@ async def virtual_machine_poweroff_async( Power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine. + + Swagger operation ID: `VirtualMachine_Poweroff`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_name: The name of the virtual machine. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -901,7 +1230,7 @@ async def virtual_machine_poweroff_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -915,9 +1244,10 @@ async def virtual_machine_poweroff_async( request_url, response.status, response.text, + response=response, ) - async def virtual_machine_reapply_async( + async def virtual_machine_reapply( self, subscription_id: str, resource_group_name: str, @@ -932,6 +1262,23 @@ async def virtual_machine_reapply_async( Reapply virtual machine Reapply a virtual machine's state. + + Swagger operation ID: `VirtualMachine_Reapply`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_name: The name of the virtual machine. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -950,7 +1297,7 @@ async def virtual_machine_reapply_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -964,9 +1311,10 @@ async def virtual_machine_reapply_async( request_url, response.status, response.text, + response=response, ) - async def virtual_machine_redeploy_async( + async def virtual_machine_redeploy( self, subscription_id: str, resource_group_name: str, @@ -982,6 +1330,23 @@ async def virtual_machine_redeploy_async( Shuts down the virtual machine, moves it to a new node, and powers it back on. + + Swagger operation ID: `VirtualMachine_Redeploy`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_name: The name of the virtual machine. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1000,7 +1365,7 @@ async def virtual_machine_redeploy_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1014,9 +1379,10 @@ async def virtual_machine_redeploy_async( request_url, response.status, response.text, + response=response, ) - async def virtual_machine_restart_async( + async def virtual_machine_restart( self, subscription_id: str, resource_group_name: str, @@ -1031,6 +1397,23 @@ async def virtual_machine_restart_async( Restart virtual machine Restarts a virtual machine. + + Swagger operation ID: `VirtualMachine_Restart`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_name: The name of the virtual machine. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1049,7 +1432,7 @@ async def virtual_machine_restart_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1063,34 +1446,57 @@ async def virtual_machine_restart_async( request_url, response.status, response.text, + response=response, ) - async def subscriptions_list_async( + def list_subscriptions( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List subscriptions Gets a list of all the subscriptions to which the principal has access. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `Subscriptions_List`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/subscriptions" query_params = [] query_params.append("x-ms-api-version=" + quote("2020-01-01", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1103,23 +1509,32 @@ async def subscriptions_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def resource_groups_list_async( + def list_resource_groups( self, subscription_id: str, *, @@ -1127,14 +1542,30 @@ async def resource_groups_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List resource groups Lists all the resource groups within the subscription. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ResourceGroups_List`. + + Args: + subscription_id: Microsoft Azure subscription. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1146,11 +1577,18 @@ async def resource_groups_list_async( query_params.append("x-ms-api-version=" + quote("2020-01-01", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1163,23 +1601,32 @@ async def resource_groups_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def virtual_machine_scale_sets_list_async( + def list_virtual_machine_scale_sets( self, subscription_id: str, resource_group_name: str, @@ -1188,14 +1635,31 @@ async def virtual_machine_scale_sets_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List virtual machine scale sets Lists all the virtual machine scale sets within the resource group. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `VirtualMachineScaleSets_List`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1211,11 +1675,18 @@ async def virtual_machine_scale_sets_list_async( query_params.append("x-ms-api-version=" + quote("2019-12-01", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1228,23 +1699,32 @@ async def virtual_machine_scale_sets_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def virtual_machines_in_scale_set_list_async( + return AsyncItemPaged(get_next, extract_data) + + def list_virtual_machines_in_scale_set( self, subscription_id: str, resource_group_name: str, @@ -1254,14 +1734,33 @@ async def virtual_machines_in_scale_set_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List virtual machines in a VM scale set Lists all the virtual machines in a VM scale set. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `VirtualMachinesInScaleSet_List`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + virtual_machine_scale_set_name: The name of the virtual machine + scale set. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1279,11 +1778,18 @@ async def virtual_machines_in_scale_set_list_async( query_params.append("x-ms-api-version=" + quote("2019-12-01", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1296,23 +1802,32 @@ async def virtual_machines_in_scale_set_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def virtual_machines_list_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_virtual_machines( self, subscription_id: str, resource_group_name: str, @@ -1321,14 +1836,31 @@ async def virtual_machines_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List virtual machines Lists all the virtual machines within the resource group. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `VirtualMachines_List`. + + Args: + subscription_id: Microsoft Azure subscription. + resource_group_name: The name of the resource group. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1344,11 +1876,18 @@ async def virtual_machines_list_async( query_params.append("x-ms-api-version=" + quote("2019-12-01", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1361,18 +1900,27 @@ async def virtual_machines_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/box.py b/src/azure/connectors/box.py index 8e46e347..8ae98657 100644 --- a/src/azure/connectors/box.py +++ b/src/azure/connectors/box.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,21 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "BoxClient", + "BlobDataSetsMetadata", + "BlobMetadata", + "BlobMetadataPage", + "BlobMetadataResponse", + "DataSetsMetadata", + "ObjectEntity", + "TabularDataSetsMetadata", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,46 +43,72 @@ class BlobMetadata: Response for Get file metadata using id """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" - last_modified_by: Optional[str] = field( + last_modified_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModifiedBy"}, ) """The user who last modified the file or folder.""" @@ -80,8 +120,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -90,25 +140,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -120,15 +174,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -140,7 +196,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -153,41 +209,66 @@ class BlobMetadataResponse: Definition: BlobMetadataResponse """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" @@ -199,7 +280,12 @@ class BlobMetadataPage: Definition: BlobMetadataPage """ - value: Optional[List[BlobMetadata]] = None + value: Optional[ + List[BlobMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Blob metadata collection.""" @@ -214,7 +300,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -231,8 +317,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -253,7 +339,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -268,7 +354,84 @@ def __init__( def connector_name(self) -> str: return "box" - async def get_file_metadata_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def get_file_metadata( self, id: str, *, @@ -281,6 +444,21 @@ async def get_file_metadata_async( Get file metadata using id Retrieves the file metadata from Box using file id. + + Swagger operation ID: `GetFileMetadata`. + + Args: + id: The unique identifier of the file in Box. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -290,7 +468,7 @@ async def get_file_metadata_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -304,6 +482,7 @@ async def get_file_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -311,7 +490,7 @@ async def get_file_metadata_async( return json.loads(response.text) - async def update_file_async( + async def update_file( self, input: bytes, id: str, @@ -325,6 +504,22 @@ async def update_file_async( Update file Updates an existing file in Box. + + Swagger operation ID: `UpdateFile`. + + Args: + input: The binary request body. + id: The unique identifier of the file to update in Box. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -334,7 +529,7 @@ async def update_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, @@ -351,6 +546,7 @@ async def update_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -358,7 +554,7 @@ async def update_file_async( return json.loads(response.text) - async def delete_file_async( + async def delete_file( self, id: str, *, @@ -371,6 +567,21 @@ async def delete_file_async( Delete file Deletes an existing file from Box. + + Swagger operation ID: `DeleteFile`. + + Args: + id: The unique identifier of the file to delete from Box. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -380,7 +591,7 @@ async def delete_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -394,9 +605,10 @@ async def delete_file_async( request_url, response.status, response.text, + response=response, ) - async def get_file_metadata_by_path_async( + async def get_file_metadata_by_path( self, path: str, *, @@ -409,6 +621,21 @@ async def get_file_metadata_by_path_async( Get file metadata using path Retrieves the file metadata from Box using path. + + Swagger operation ID: `GetFileMetadataByPath`. + + Args: + path: The unique path to the file in Box. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/GetFileByPath" @@ -422,7 +649,7 @@ async def get_file_metadata_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -436,6 +663,7 @@ async def get_file_metadata_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -443,11 +671,11 @@ async def get_file_metadata_by_path_async( return json.loads(response.text) - async def get_file_content_by_path_async( + async def get_file_content_by_path( self, path: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -457,6 +685,23 @@ async def get_file_content_by_path_async( Get file content using path Retrieves the file contents from Box using path. + + Swagger operation ID: `GetFileContentByPath`. + + Args: + path: The unique path to the file in Box. + infer_content_type: A boolean value (true, false) to infer + content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -476,7 +721,7 @@ async def get_file_content_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -490,15 +735,16 @@ async def get_file_content_by_path_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_file_content_async( + async def get_file_content( self, id: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -508,6 +754,23 @@ async def get_file_content_async( Get file content using id Retrieves the file content from Box using id. + + Swagger operation ID: `GetFileContent`. + + Args: + id: The unique identifier of the file in Box. + infer_content_type: A boolean value (true, false) to infer + content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -526,7 +789,7 @@ async def get_file_content_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -540,11 +803,12 @@ async def get_file_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def create_file_async( + async def create_file( self, input: bytes, folder_path: str, @@ -559,6 +823,23 @@ async def create_file_async( Create file Uploads a file to Box. + + Swagger operation ID: `CreateFile`. + + Args: + input: The binary request body. + folder_path: The folder path to upload the file to Box. + name: The name of the file to create in Box. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/datasets/default/files" query_params = [] @@ -574,7 +855,7 @@ async def create_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -591,6 +872,7 @@ async def create_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -598,12 +880,12 @@ async def create_file_async( return json.loads(response.text) - async def copy_file_async( + async def copy_file( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -613,6 +895,24 @@ async def copy_file_async( Copy file Copy a file to a file path in Box. + + Swagger operation ID: `CopyFile`. + + Args: + source: The url to source file. + destination: The destination file path in Box, including target + filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/copyFile" @@ -635,7 +935,7 @@ async def copy_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -649,6 +949,7 @@ async def copy_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -656,7 +957,7 @@ async def copy_file_async( return json.loads(response.text) - async def list_folder_async( + def list_folder( self, id: str, *, @@ -664,11 +965,29 @@ async def list_folder_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files and folders in folder Lists the files and folders in a Box folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListFolder`. + + Args: + id: The unique identifier of the folder in Box. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -677,72 +996,131 @@ async def list_folder_async( f"/folders" f"/{quote(quote(str(id), safe=''), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_root_folder_async( + def list_root_folder( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files and folders in root folder Lists the files and folders in the Box root folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRootFolder`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/folders" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def extract_folder_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def extract_folder( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -752,6 +1130,23 @@ async def extract_folder_async( Extract archive to folder Extracts an archive file into a folder in Box (example: .zip). + + Swagger operation ID: `ExtractFolderV2`. + + Args: + source: The path to the archive file. + destination: The path in Box to extract the archive contents. + overwrite: Overwrites the destination files if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/extractFolderV2" @@ -774,7 +1169,7 @@ async def extract_folder_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -788,6 +1183,7 @@ async def extract_folder_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/campfire.py b/src/azure/connectors/campfire.py index fb4e417c..c7c909a3 100644 --- a/src/azure/connectors/campfire.py +++ b/src/azure/connectors/campfire.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,25 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "CampfireClient", + "Account", + "AccountsResponse", + "CreateMessageResponse", + "CreateUploadResponse", + "Message", + "MessagesResponse", + "Room", + "RoomsResponse", + "Upload", + "UploadResponse", + "UserResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +47,7 @@ class CreateMessageResponse: Response for Create a message """ - message: Optional[Dict[str, Any]] = None + message: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """A Campfire message""" @@ -39,7 +57,7 @@ class RoomsResponse: Response for When a room is created """ - rooms: Optional[List[Dict[str, Any]]] = None + rooms: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Collection of Rooms""" @@ -49,7 +67,7 @@ class MessagesResponse: Response for When a new message is received """ - messages: Optional[List[Dict[str, Any]]] = None + messages: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Collection Of messages""" @@ -59,7 +77,7 @@ class UploadResponse: Response for When a file is uploaded """ - uploads: Optional[List[Dict[str, Any]]] = None + uploads: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Collection of Uploads""" @@ -69,7 +87,7 @@ class UserResponse: Response for Get user by ID """ - user: Optional[Dict[str, Any]] = None + user: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -78,7 +96,7 @@ class AccountsResponse: Response for List accounts """ - accounts: Optional[List[Dict[str, Any]]] = None + accounts: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Collection Of Accounts""" @@ -88,13 +106,13 @@ class Account: Definition: Account """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the account""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the account""" - app_href: Optional[str] = None + app_href: Optional[str] = dataclass_field(default=None, kw_only=True) """Link to the account""" - account_url: Optional[str] = None + account_url: Optional[str] = dataclass_field(default=None, kw_only=True) """Account Url""" @@ -104,13 +122,13 @@ class Room: Definition: Room """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Room name.""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Room Id.""" - locked: Optional[bool] = None + locked: Optional[bool] = dataclass_field(default=None, kw_only=True) """Boolean value, True if a room is locked.""" - topic: Optional[str] = None + topic: Optional[str] = dataclass_field(default=None, kw_only=True) """Room topic or description.""" @@ -120,11 +138,11 @@ class Message: Definition: Message """ - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """Message Body.""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Message Id.""" - starred: Optional[bool] = None + starred: Optional[bool] = dataclass_field(default=None, kw_only=True) """Boolean value, True if a message is starred.""" @@ -134,17 +152,17 @@ class Upload: Definition: Upload """ - full_url: Optional[str] = None + full_url: Optional[str] = dataclass_field(default=None, kw_only=True) """File Url.""" - room_id: Optional[int] = None + room_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Room Id.""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """File Id.""" - content_type: Optional[str] = None + content_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Format of the uploaded file.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name.""" - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of upload.""" @@ -154,7 +172,7 @@ class CreateUploadResponse: Definition: CreateUploadResponse """ - upload: Optional[Upload] = None + upload: Optional[Upload | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) # Client Class @@ -168,7 +186,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -185,8 +203,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -207,7 +225,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -222,7 +240,84 @@ def __init__( def connector_name(self) -> str: return "campfire" - async def create_message_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def create_message( self, room_id: str, account: str, @@ -237,6 +332,23 @@ async def create_message_async( Create a message Sends a message to the given room. + + Swagger operation ID: `CreateMessage`. + + Args: + room_id: A room associated with the account. + account: Account in Campfire. + message: Message text to be created. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -254,7 +366,7 @@ async def create_message_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -268,6 +380,7 @@ async def create_message_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -275,7 +388,7 @@ async def create_message_async( return json.loads(response.text) - async def get_user_async( + async def get_user( self, user_id: int, account: str, @@ -289,6 +402,22 @@ async def get_user_async( Get user by ID Retrieves information about a user by given ID + + Swagger operation ID: `GetUser`. + + Args: + user_id: User ID. + account: Account in Campfire. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -302,7 +431,7 @@ async def get_user_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -316,6 +445,7 @@ async def get_user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -323,19 +453,37 @@ async def get_user_async( return json.loads(response.text) - async def list_accounts_async( + def list_accounts( self, - parent_operation: Optional[str] = None, *, + parent_operation: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List accounts Retrieves the list of accounts this user has access too + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListAccounts`. + + Args: + parent_operation: parentOperation. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/authorization.json" query_params = [] @@ -346,29 +494,50 @@ async def list_accounts_async( query_params.append(f"parentOperation={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("accounts", []): + yield item + + return None, items() - async def list_rooms_async( + return AsyncItemPaged(get_next, extract_data) + + def list_rooms( self, account: str, *, @@ -376,11 +545,29 @@ async def list_rooms_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Rooms Retrieves the list of rooms in an account + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRooms`. + + Args: + account: Account in Campfire. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/rooms.json" query_params = [] @@ -390,27 +577,48 @@ async def list_rooms_async( query_params.append(f"account={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("rooms", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/clicksendsms.py b/src/azure/connectors/clicksendsms.py index 491f0d14..b10b3d0b 100644 --- a/src/azure/connectors/clicksendsms.py +++ b/src/azure/connectors/clicksendsms.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Any, Mapping from urllib.parse import quote import json @@ -20,6 +20,35 @@ ConnectorResponseHook, ) +__all__ = [ + "ClicksendsmsClient", + "CreateListContactInput", + "CreateListContactResponse", + "CreateListInput", + "CreateListResponse", + "DeleteListContactResponse", + "DeleteListResponse", + "GetContactListsResponse", + "SearchContactListResponse", + "SendFaxInput", + "SendFaxResponse", + "SendLetterInput", + "SendLetterResponse", + "SendMmsInput", + "SendMmsResponse", + "SendPostcardInput", + "SendPostcardResponse", + "SendVoiceInput", + "SendVoiceResponse", + "SmsInboundAutomationInput", + "SmsSendInput", + "SmsSendResponse", + "UploadMediaInput", + "UploadMediaResponse", + "ViewListContactsResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +58,7 @@ class SmsSendInput: Send SMS """ - messages: Optional[List[Dict[str, Any]]] = None + messages: List[Dict[str, Any]] """Message""" @@ -39,13 +68,13 @@ class SmsSendResponse: Response for Send SMS """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Msg""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -55,7 +84,7 @@ class CreateListInput: Create New Contact List """ - list_name: Optional[str] = None + list_name: str """Your contact list name""" @@ -65,13 +94,13 @@ class CreateListResponse: Response for Create New Contact List """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -81,13 +110,13 @@ class GetContactListsResponse: Response for Get Contact Lists """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -97,7 +126,7 @@ class SendVoiceInput: Send Voice Message """ - messages: Optional[List[Dict[str, Any]]] = None + messages: List[Dict[str, Any]] """Message""" @@ -107,13 +136,13 @@ class SendVoiceResponse: Response for Send Voice Message """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -123,11 +152,11 @@ class DeleteListResponse: Response for Delete List """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" @@ -137,52 +166,58 @@ class CreateListContactInput: Create New Contact """ - first_name: Optional[str] = None + first_name: str """Contact's first name.""" - last_name: Optional[str] = None + last_name: str """Contact's last name.""" - phone_number: Optional[str] = None + phone_number: str """The contact phone in local or international format e.g. +61411111111.""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """Contact's email address.""" - fax_number: Optional[str] = None + fax_number: Optional[str] = dataclass_field(default=None, kw_only=True) """Contact's fax number.""" - organization_name: Optional[str] = None + organization_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Contact's organization name.""" - address_country: Optional[str] = None + address_country: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's country.""" - address_state: Optional[str] = None + address_state: Optional[str] = dataclass_field(default=None, kw_only=True) """State""" - address_city: Optional[str] = None + address_city: Optional[str] = dataclass_field(default=None, kw_only=True) """Address City""" - custom1: Optional[str] = field( + custom1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "custom_1"}, ) """Custom 1""" - custom3: Optional[str] = field( + custom3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "custom_3"}, ) """Custom 3""" - address_postal_code: Optional[str] = None - custom2: Optional[str] = field( + address_postal_code: Optional[str] = dataclass_field(default=None, kw_only=True) + custom2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "custom_2"}, ) """Custom 2""" - custom4: Optional[str] = field( + custom4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "custom_4"}, ) """Custom 4""" - address_line1: Optional[str] = field( + address_line1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "address_line_1"}, ) """Address Line 1""" - address_line2: Optional[str] = field( + address_line2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "address_line_2"}, ) """Address Line 2""" @@ -194,13 +229,13 @@ class CreateListContactResponse: Response for Create New Contact """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -210,13 +245,13 @@ class ViewListContactsResponse: Response for Get Contacts in a List """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -226,11 +261,11 @@ class DeleteListContactResponse: Response for Delete a Contact """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" @@ -240,9 +275,9 @@ class SendMmsInput: Send MMS """ - messages: Optional[List[Dict[str, Any]]] = None + messages: List[Dict[str, Any]] """Message""" - media_file: Optional[str] = None + media_file: str """ Supports maximum file size of 250kB, Gif can only be supported if it below 100 kB file size @@ -255,13 +290,13 @@ class SendMmsResponse: Response for Send MMS """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -271,9 +306,9 @@ class SendFaxInput: Send Fax """ - messages: Optional[List[Dict[str, Any]]] = None + messages: List[Dict[str, Any]] """Message""" - file_url: Optional[str] = None + file_url: str """ Maximum file size is 4 MB. All pages should be in portrait. Chat with ClickSend Support for complete specifications @@ -286,13 +321,13 @@ class SendFaxResponse: Response for Send Fax """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -302,7 +337,7 @@ class UploadMediaInput: Convert Media File Format """ - content: Optional[str] = None + content: str """File Content (base64)""" @@ -312,13 +347,13 @@ class UploadMediaResponse: Response for Convert Media File Format """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -328,13 +363,13 @@ class SearchContactListResponse: Response for Search Contact Lists """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -344,27 +379,27 @@ class SendLetterInput: Send Letter """ - file_url: Optional[str] = None + file_url: str """ Maximum file size is 10 MB. All pages should be in portrait. Chat with ClickSend Support for complete specifications. """ - template_used: Optional[int] = None + template_used: Optional[int] = dataclass_field(default=None, kw_only=True) """ Whether using letter template. Flag value must be 1 for yes or 0 for no. """ - colour: Optional[int] = None + colour: int """Choose to use colour or B&W printing. (Black & White = 0, Colour = 1)""" - duplex: Optional[int] = None + duplex: int """ Choose to use Duplex = 1 (double-sided) or Simplex = 0(single sided) printing. """ - priority_post: Optional[int] = None + priority_post: Optional[int] = dataclass_field(default=None, kw_only=True) """Whether letter is priority, Flag value must be 1 for yes or 0 for no.""" - recipients: Optional[List[Dict[str, Any]]] = None + recipients: List[Dict[str, Any]] """Recipient""" - source: Optional[str] = None + source: str """Source""" @@ -374,13 +409,13 @@ class SendLetterResponse: Response for Send Letter """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -390,9 +425,9 @@ class SendPostcardInput: Send Postcard """ - recipients: Optional[List[Dict[str, Any]]] = None + recipients: List[Dict[str, Any]] """item""" - file_urls: Optional[List[str]] = None + file_urls: List[str] """PDF File URL""" @@ -402,13 +437,13 @@ class SendPostcardResponse: Response for Send Postcard """ - http_code: Optional[int] = None + http_code: Optional[int] = dataclass_field(default=None, kw_only=True) """Http Code""" - response_code: Optional[str] = None + response_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Code""" - response_msg: Optional[str] = None + response_msg: Optional[str] = dataclass_field(default=None, kw_only=True) """Response Message""" - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -418,28 +453,28 @@ class SmsInboundAutomationInput: SMS Inbound Automation """ - message_search_type: Optional[int] = None + message_search_type: int """ Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain. """ - message_search_term: Optional[str] = None + message_search_term: str """word or phrase in the SMS""" - action_address: Optional[str] = None + action_address: str """Action address""" - dedicated_number: Optional[str] = None + dedicated_number: str """Decicated Number. Can be '*' to apply to all numbers.""" - rule_name: Optional[str] = None + rule_name: str """Rule Name""" - webhook_type: Optional[str] = None + webhook_type: str """Webhook Type""" - action: Optional[str] = None + action: str """ Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE). """ - enabled: Optional[int] = None + enabled: int """enabled""" @@ -454,7 +489,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -471,8 +506,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -493,7 +528,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -508,9 +543,9 @@ def __init__( def connector_name(self) -> str: return "clicksendsms" - async def sms_send_async( + async def sms_send( self, - input: SmsSendInput, + input: SmsSendInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -521,10 +556,26 @@ async def sms_send_async( Send SMS Each 160 characters = 1 SMS. Can send up to 1,224 standard characters. + + Swagger operation ID: `sms_send`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/sms/send" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -538,6 +589,7 @@ async def sms_send_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -545,9 +597,9 @@ async def sms_send_async( return json.loads(response.text) - async def create_list_async( + async def create_list( self, - input: CreateListInput, + input: CreateListInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -558,10 +610,26 @@ async def create_list_async( Create New Contact List Create New Contact List + + Swagger operation ID: `create_list`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/lists" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -575,6 +643,7 @@ async def create_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -582,11 +651,11 @@ async def create_list_async( return json.loads(response.text) - async def get_contact_lists_async( + async def get_contact_lists( self, + *, page: Optional[int] = None, limit: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -596,6 +665,22 @@ async def get_contact_lists_async( Get Contact Lists Get all contact lists unless specified in the advance options + + Swagger operation ID: `get_contact_lists`. + + Args: + page: Page number. + limit: Number of records per page. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/lists" query_params = [] @@ -612,7 +697,7 @@ async def get_contact_lists_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -626,6 +711,7 @@ async def get_contact_lists_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -633,9 +719,9 @@ async def get_contact_lists_async( return json.loads(response.text) - async def send_voice_async( + async def send_voice( self, - input: SendVoiceInput, + input: SendVoiceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -647,10 +733,26 @@ async def send_voice_async( Each 300 characters = 1 voice message. Can send up to 1,200 standard characters + + Swagger operation ID: `send_voice`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/voice/send" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -664,6 +766,7 @@ async def send_voice_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -671,7 +774,7 @@ async def send_voice_async( return json.loads(response.text) - async def delete_list_async( + async def delete_list( self, list_id: int, *, @@ -684,13 +787,29 @@ async def delete_list_async( Delete List Delete a specific contact list + + Swagger operation ID: `delete_list`. + + Args: + list_id: You may use the Search Contact List action OR Get Contact + List action to get the List ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/lists/{quote(str(list_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -704,6 +823,7 @@ async def delete_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -711,9 +831,9 @@ async def delete_list_async( return json.loads(response.text) - async def create_list_contact_async( + async def create_list_contact( self, - input: CreateListContactInput, + input: CreateListContactInput | Mapping[str, Any], list_id: int, *, timeout: Optional[float] = None, @@ -725,13 +845,31 @@ async def create_list_contact_async( Create New Contact Create New Contact + + Swagger operation ID: `create_list_contact`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + list_id: You may use the Search Contact List action OR Get Contact + List action to get the List ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/lists/{quote(str(list_id), safe='')}/contacts" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -745,6 +883,7 @@ async def create_list_contact_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -752,7 +891,7 @@ async def create_list_contact_async( return json.loads(response.text) - async def view_list_contacts_async( + async def view_list_contacts( self, list_id: int, *, @@ -765,13 +904,29 @@ async def view_list_contacts_async( Get Contacts in a List Get all Contacts in a List + + Swagger operation ID: `view_list_contacts`. + + Args: + list_id: You may use the Search Contact List action OR Get Contact + List action to get the List ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/lists/{quote(str(list_id), safe='')}/contacts" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -785,6 +940,7 @@ async def view_list_contacts_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -792,7 +948,7 @@ async def view_list_contacts_async( return json.loads(response.text) - async def delete_list_contact_async( + async def delete_list_contact( self, list_id: int, contact_id: int, @@ -806,6 +962,23 @@ async def delete_list_contact_async( Delete a Contact Delete a Contact + + Swagger operation ID: `delete_list_contact`. + + Args: + list_id: You may use the Search Contact List action OR Get Contact + List action to get the List ID. + contact_id: Contact ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -815,7 +988,7 @@ async def delete_list_contact_async( f"/{quote(str(contact_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -829,6 +1002,7 @@ async def delete_list_contact_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -836,9 +1010,9 @@ async def delete_list_contact_async( return json.loads(response.text) - async def send_mms_async( + async def send_mms( self, - input: SendMmsInput, + input: SendMmsInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -849,10 +1023,26 @@ async def send_mms_async( Send MMS Send MMS + + Swagger operation ID: `send_mms`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/mms/send" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -866,6 +1056,7 @@ async def send_mms_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -873,9 +1064,9 @@ async def send_mms_async( return json.loads(response.text) - async def send_fax_async( + async def send_fax( self, - input: SendFaxInput, + input: SendFaxInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -886,10 +1077,26 @@ async def send_fax_async( Send Fax Send Fax + + Swagger operation ID: `send_fax`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/fax/send" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -903,6 +1110,7 @@ async def send_fax_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -910,9 +1118,9 @@ async def send_fax_async( return json.loads(response.text) - async def upload_media_async( + async def upload_media( self, - input: UploadMediaInput, + input: UploadMediaInput | Mapping[str, Any], convert: str, *, timeout: Optional[float] = None, @@ -924,6 +1132,23 @@ async def upload_media_async( Convert Media File Format Convert Media File Format + + Swagger operation ID: `upload_media`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + convert: Select action the file is needed for. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/uploads" query_params = [] @@ -934,7 +1159,7 @@ async def upload_media_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -948,6 +1173,7 @@ async def upload_media_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -955,7 +1181,7 @@ async def upload_media_async( return json.loads(response.text) - async def search_contact_list_async( + async def search_contact_list( self, q: str, *, @@ -968,6 +1194,21 @@ async def search_contact_list_async( Search Contact Lists Get list of searched contact list + + Swagger operation ID: `search_contact_list`. + + Args: + q: Search for. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/search/contacts-lists" query_params = [] @@ -978,7 +1219,7 @@ async def search_contact_list_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -992,6 +1233,7 @@ async def search_contact_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -999,9 +1241,9 @@ async def search_contact_list_async( return json.loads(response.text) - async def send_letter_async( + async def send_letter( self, - input: SendLetterInput, + input: SendLetterInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1012,10 +1254,26 @@ async def send_letter_async( Send Letter Send Letter + + Swagger operation ID: `send_letter`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/post/letters/send" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1029,6 +1287,7 @@ async def send_letter_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1036,9 +1295,9 @@ async def send_letter_async( return json.loads(response.text) - async def send_postcard_async( + async def send_postcard( self, - input: SendPostcardInput, + input: SendPostcardInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1049,10 +1308,26 @@ async def send_postcard_async( Send Postcard Send one or more postcards + + Swagger operation ID: `send_postcard`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/post/postcards/send" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1066,6 +1341,7 @@ async def send_postcard_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/cloudconvert.py b/src/azure/connectors/cloudconvert.py index 3ec90222..2712d14e 100644 --- a/src/azure/connectors/cloudconvert.py +++ b/src/azure/connectors/cloudconvert.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, Any, Mapping from urllib.parse import quote import json @@ -20,6 +20,19 @@ ConnectorResponseHook, ) +__all__ = [ + "CloudconvertClient", + "CaptureWebsiteInput", + "ConvertFileInput", + "GetCaptureWebsiteOptionsResponse", + "GetConvertOptionsResponse", + "GetMergeInputsResponse", + "GetMergeOptionsResponse", + "GetOptimizeOptionsResponse", + "MergeFilesInput", + "OptimizeFileInput", +] + # Type Definitions @@ -29,7 +42,7 @@ class ConvertFileInput: Convert File """ - tasks: Optional[Dict[str, Any]] = None + tasks: Dict[str, Any] """tasks""" @@ -39,7 +52,7 @@ class OptimizeFileInput: Compress File """ - tasks: Optional[Dict[str, Any]] = None + tasks: Dict[str, Any] """tasks""" @@ -49,7 +62,7 @@ class CaptureWebsiteInput: Create Website Screenshot """ - tasks: Optional[Dict[str, Any]] = None + tasks: Dict[str, Any] """tasks""" @@ -59,10 +72,10 @@ class MergeFilesInput: Merge Files """ - number_of_inputs: Optional[int] = None + number_of_inputs: int """Number of input files to merge.""" - additional_inputs: Optional[Dict[str, Any]] = None - tasks: Optional[Dict[str, Any]] = None + additional_inputs: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + tasks: Dict[str, Any] """tasks""" @@ -72,7 +85,7 @@ class GetConvertOptionsResponse: Response for Get Convert Options """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -81,7 +94,7 @@ class GetOptimizeOptionsResponse: Response for Get Optimize Options """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -90,7 +103,7 @@ class GetCaptureWebsiteOptionsResponse: Response for Get Capture Website Options """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -99,7 +112,7 @@ class GetMergeInputsResponse: Response for Get Merge Inputs """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -108,7 +121,7 @@ class GetMergeOptionsResponse: Response for Get Merge Options """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) # Client Class @@ -122,7 +135,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -139,8 +152,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -161,7 +174,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -176,9 +189,9 @@ def __init__( def connector_name(self) -> str: return "cloudconvert" - async def convert_file_async( + async def convert_file( self, - input: ConvertFileInput, + input: ConvertFileInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -189,10 +202,26 @@ async def convert_file_async( Convert File Convert a file to another format + + Swagger operation ID: `ConvertFile`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/flow/jobs/convertfile" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -206,13 +235,14 @@ async def convert_file_async( request_url, response.status, response.text, + response=response, ) return response.content - async def optimize_file_async( + async def optimize_file( self, - input: OptimizeFileInput, + input: OptimizeFileInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -223,10 +253,26 @@ async def optimize_file_async( Compress File Compress a PDF, PNG or JPG file + + Swagger operation ID: `OptimizeFile`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/flow/jobs/optimize" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -240,13 +286,14 @@ async def optimize_file_async( request_url, response.status, response.text, + response=response, ) return response.content - async def capture_website_async( + async def capture_website( self, - input: CaptureWebsiteInput, + input: CaptureWebsiteInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -257,12 +304,28 @@ async def capture_website_async( Create Website Screenshot Create a website screenshot as PDF, PNG or JPG + + Swagger operation ID: `CaptureWebsite`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/jobs/capture-website" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -276,13 +339,14 @@ async def capture_website_async( request_url, response.status, response.text, + response=response, ) return response.content - async def merge_files_async( + async def merge_files( self, - input: MergeFilesInput, + input: MergeFilesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -293,10 +357,26 @@ async def merge_files_async( Merge Files Merge multiple files in one PDF + + Swagger operation ID: `MergeFiles`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/flow/jobs/merge" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -310,15 +390,16 @@ async def merge_files_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_convert_options_async( + async def get_convert_options( self, + *, input_format: Optional[str] = None, output_format: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -326,6 +407,22 @@ async def get_convert_options_async( ) -> dict[str, Any] | None: """ Get Convert Options + + Swagger operation ID: `GetConvertOptions`. + + Args: + input_format: input_format. + output_format: output_format. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/flow/options/convert" query_params = [] @@ -342,7 +439,7 @@ async def get_convert_options_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -356,6 +453,7 @@ async def get_convert_options_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -363,10 +461,10 @@ async def get_convert_options_async( return json.loads(response.text) - async def get_optimize_options_async( + async def get_optimize_options( self, - input_format: Optional[str] = None, *, + input_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -374,6 +472,21 @@ async def get_optimize_options_async( ) -> dict[str, Any] | None: """ Get Optimize Options + + Swagger operation ID: `GetOptimizeOptions`. + + Args: + input_format: input_format. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/flow/options/optimize" query_params = [] @@ -385,7 +498,7 @@ async def get_optimize_options_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -399,6 +512,7 @@ async def get_optimize_options_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -406,10 +520,10 @@ async def get_optimize_options_async( return json.loads(response.text) - async def get_capture_website_options_async( + async def get_capture_website_options( self, - output_format: Optional[str] = None, *, + output_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -417,6 +531,21 @@ async def get_capture_website_options_async( ) -> dict[str, Any] | None: """ Get Capture Website Options + + Swagger operation ID: `GetCaptureWebsiteOptions`. + + Args: + output_format: output_format. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/options/capture-website" @@ -430,7 +559,7 @@ async def get_capture_website_options_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -444,6 +573,7 @@ async def get_capture_website_options_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -451,10 +581,10 @@ async def get_capture_website_options_async( return json.loads(response.text) - async def get_merge_inputs_async( + async def get_merge_inputs( self, - number_of_inputs: Optional[int] = None, *, + number_of_inputs: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -462,6 +592,21 @@ async def get_merge_inputs_async( ) -> dict[str, Any] | None: """ Get Merge Inputs + + Swagger operation ID: `GetMergeInputs`. + + Args: + number_of_inputs: number_of_inputs. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/flow/inputs/merge" query_params = [] @@ -473,7 +618,7 @@ async def get_merge_inputs_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -487,6 +632,7 @@ async def get_merge_inputs_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -494,10 +640,10 @@ async def get_merge_inputs_async( return json.loads(response.text) - async def get_merge_options_async( + async def get_merge_options( self, - output_format: Optional[str] = None, *, + output_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -505,6 +651,21 @@ async def get_merge_options_async( ) -> dict[str, Any] | None: """ Get Merge Options + + Swagger operation ID: `GetMergeOptions`. + + Args: + output_format: output_format. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/flow/options/merge" query_params = [] @@ -516,7 +677,7 @@ async def get_merge_options_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -530,6 +691,7 @@ async def get_merge_options_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/cloudmersiveconvert.py b/src/azure/connectors/cloudmersiveconvert.py index c2ea0943..056d46e5 100644 --- a/src/azure/connectors/cloudmersiveconvert.py +++ b/src/azure/connectors/cloudmersiveconvert.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Any, Mapping import json @@ -19,6 +19,203 @@ ConnectorResponseHook, ) +__all__ = [ + "CloudmersiveconvertClient", + "AddPdfAnnotationRequest", + "AlternateFileFormatCandidate", + "AutodetectDocumentValidationResult", + "AutodetectGetInfoResult", + "AutodetectToPngResult", + "Base64DecodeRequest", + "Base64DecodeResponse", + "Base64DetectRequest", + "Base64DetectResponse", + "Base64EncodeRequest", + "Base64EncodeResponse", + "ChangeLineEndingResponse", + "ClearXlsxCellRequest", + "ClearXlsxCellResponse", + "ConvertDataJsonToXmlInput", + "ConvertWebHtmlToPngResponse", + "ConvertedPngPage", + "CreateBlankDocxRequest", + "CreateBlankDocxResponse", + "CreateBlankSpreadsheetRequest", + "CreateBlankSpreadsheetResponse", + "CreateSpreadsheetFromDataRequest", + "CreateSpreadsheetFromDataResponse", + "CreateZipArchiveRequest", + "DeleteDocxTableRowRangeRequest", + "DeleteDocxTableRowRangeResponse", + "DeleteDocxTableRowRequest", + "DeleteDocxTableRowResponse", + "DetectLineEndingsResponse", + "DocumentValidationError", + "DocumentValidationResult", + "DocxBody", + "DocxCellStyle", + "DocxComment", + "DocxFooter", + "DocxHeader", + "DocxImage", + "DocxInsertCommentOnParagraphRequest", + "DocxInsertImageRequest", + "DocxInsertImageResponse", + "DocxPage", + "DocxParagraph", + "DocxRemoveObjectRequest", + "DocxRemoveObjectResponse", + "DocxRun", + "DocxSection", + "DocxSetFooterAddPageNumberRequest", + "DocxSetFooterRequest", + "DocxSetFooterResponse", + "DocxSetHeaderRequest", + "DocxSetHeaderResponse", + "DocxStyle", + "DocxTable", + "DocxTableCell", + "DocxTableRow", + "DocxTemplateApplicationRequest", + "DocxTemplateOperation", + "DocxText", + "DocxTopLevelComment", + "EditDocumentXlsxDeleteWorksheetResponse", + "ExifValue", + "FindRegexMatch", + "FindStringMatch", + "FindStringRegexRequest", + "FindStringRegexResponse", + "FindStringSimpleRequest", + "FindStringSimpleResponse", + "FinishEditingRequest", + "GetDocxBodyRequest", + "GetDocxBodyResponse", + "GetDocxCommentsHierarchicalResponse", + "GetDocxCommentsResponse", + "GetDocxGetCommentsHierarchicalRequest", + "GetDocxGetCommentsRequest", + "GetDocxHeadersAndFootersRequest", + "GetDocxHeadersAndFootersResponse", + "GetDocxImagesRequest", + "GetDocxImagesResponse", + "GetDocxPagesRequest", + "GetDocxPagesResponse", + "GetDocxSectionsRequest", + "GetDocxSectionsResponse", + "GetDocxStylesRequest", + "GetDocxStylesResponse", + "GetDocxTableByIndexRequest", + "GetDocxTableByIndexResponse", + "GetDocxTableRowRequest", + "GetDocxTableRowResponse", + "GetDocxTablesRequest", + "GetDocxTablesResponse", + "GetImageInfoResult", + "GetPdfAnnotationsResult", + "GetXlsxCellByIdentifierRequest", + "GetXlsxCellByIdentifierResponse", + "GetXlsxCellRequest", + "GetXlsxCellResponse", + "GetXlsxColumnsRequest", + "GetXlsxColumnsResponse", + "GetXlsxImagesRequest", + "GetXlsxImagesResponse", + "GetXlsxRowsAndCellsRequest", + "GetXlsxRowsAndCellsResponse", + "GetXlsxStylesRequest", + "GetXlsxStylesResponse", + "GetXlsxWorksheetsRequest", + "GetXlsxWorksheetsResponse", + "HtmlMdResult", + "HtmlTemplateApplicationRequest", + "HtmlTemplateApplicationResponse", + "HtmlTemplateOperation", + "HtmlToOfficeRequest", + "HtmlToPdfRequest", + "HtmlToPngRequest", + "HtmlToTextRequest", + "HtmlToTextResponse", + "InsertDocxCommentOnParagraphResponse", + "InsertDocxInsertParagraphRequest", + "InsertDocxInsertParagraphResponse", + "InsertDocxTableRowRequest", + "InsertDocxTableRowResponse", + "InsertDocxTablesRequest", + "InsertDocxTablesResponse", + "InsertXlsxWorksheetRequest", + "InsertXlsxWorksheetResponse", + "MultipageImageFormatConversionResult", + "PageConversionResult", + "PdfAnnotation", + "PdfDocument", + "PdfFormField", + "PdfFormFields", + "PdfMetadata", + "PdfPageText", + "PdfTextByPageResult", + "PdfToPngResult", + "PresentationResult", + "RemoveDocxHeadersAndFootersRequest", + "RemoveDocxHeadersAndFootersResponse", + "RemoveDocxPagesRequest", + "RemoveHtmlFromTextRequest", + "RemoveHtmlFromTextResponse", + "RemovePptxSlidesRequest", + "RemoveWhitespaceFromTextRequest", + "RemoveWhitespaceFromTextResponse", + "RemoveXlsxWorksheetRequest", + "ReplaceStringRegexRequest", + "ReplaceStringRegexResponse", + "ReplaceStringRequest", + "ReplaceStringSimpleRequest", + "ReplaceStringSimpleResponse", + "ScreenshotRequest", + "SetFormFieldValue", + "SetPdfFormFieldsRequest", + "SetPdfMetadataRequest", + "SetXlsxCellByIdentifierRequest", + "SetXlsxCellByIdentifierResponse", + "SetXlsxCellRequest", + "SetXlsxCellResponse", + "SplitDocumentResult", + "SplitDocxDocumentResult", + "SplitPdfResult", + "SplitPptxPresentationResult", + "SplitTextDocumentByLinesResult", + "SplitTextDocumentByStringResult", + "SplitXlsxWorksheetResult", + "TextConversionResult", + "TextDocumentElement", + "TextDocumentLine", + "TextEncodingDetectResponse", + "UpdateDocxTableCellRequest", + "UpdateDocxTableCellResponse", + "UpdateDocxTableRowRequest", + "UpdateDocxTableRowResponse", + "UrlToTextRequest", + "UrlToTextResponse", + "ViewerResponse", + "WorksheetResult", + "XlsxImage", + "XlsxSpreadsheetCell", + "XlsxSpreadsheetColumn", + "XlsxSpreadsheetRow", + "XlsxWorksheet", + "XmlAddAttributeWithXPathResult", + "XmlAddChildWithXPathResult", + "XmlFilterWithXPathResult", + "XmlQueryWithXQueryMultiResult", + "XmlQueryWithXQueryResult", + "XmlRemoveAllChildrenWithXPathResult", + "XmlRemoveWithXPathResult", + "XmlReplaceWithXPathResult", + "XmlSetValueWithXPathResult", + "ZipDirectory", + "ZipExtractResponse", + "ZipFile", +] + # Type Definitions @@ -28,16 +225,18 @@ class CreateBlankDocxResponse: Response for Create a blank Word DOCX document """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -49,16 +248,18 @@ class DeleteDocxTableRowResponse: Response for Deletes a table row in an existing table in a Word DOCX document """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -70,16 +271,18 @@ class DeleteDocxTableRowRangeResponse: Response for Deletes a range of multiple table rows in an existing table in a Word """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -91,13 +294,15 @@ class GetDocxBodyResponse: Response for Get body from a Word DOCX document """ - body: Optional[DocxBody] = field( + body: Optional[DocxBody | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Body"}, ) """Body in the DOCX document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -109,18 +314,21 @@ class GetDocxCommentsHierarchicalResponse: Response for Get comments from a Word DOCX document hierarchically """ - comments: Optional[List[DocxTopLevelComment]] = field( + comments: Optional[List[DocxTopLevelComment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Comments in the document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - top_level_comment_count: Optional[int] = field( + top_level_comment_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TopLevelCommentCount"}, ) """The number of comments in the document""" @@ -132,16 +340,19 @@ class GetDocxHeadersAndFootersResponse: Response for Get content of a footer from a Word DOCX document """ - footers: Optional[List[DocxFooter]] = field( + footers: Optional[List[DocxFooter | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Footers"}, ) - headers: Optional[List[DocxHeader]] = field( + headers: Optional[List[DocxHeader | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Headers"}, ) - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -153,13 +364,15 @@ class GetDocxImagesResponse: Response for Get images from a Word DOCX document """ - images: Optional[List[DocxImage]] = field( + images: Optional[List[DocxImage | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Images"}, ) """Images in the DOCX document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -171,18 +384,21 @@ class GetDocxPagesResponse: Response for Get pages and content from a Word DOCX document """ - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PageCount"}, ) """Count of pages""" - pages: Optional[List[DocxPage]] = field( + pages: Optional[List[DocxPage | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Pages"}, ) """Pages in the document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -194,13 +410,15 @@ class GetDocxSectionsResponse: Response for Get sections from a Word DOCX document """ - sections: Optional[List[DocxSection]] = field( + sections: Optional[List[DocxSection | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sections"}, ) """Sections in the DOCX document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -212,13 +430,15 @@ class GetDocxStylesResponse: Response for Get styles from a Word DOCX document """ - styles: Optional[List[DocxStyle]] = field( + styles: Optional[List[DocxStyle | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Styles"}, ) """Styles in the DOCX document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -230,13 +450,15 @@ class GetDocxTableRowResponse: Response for Gets the contents of an existing table row in an existing table in a W """ - row_result: Optional[DocxTableRow] = field( + row_result: Optional[DocxTableRow | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RowResult"}, ) """Contents of the table row that was requested""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -248,13 +470,15 @@ class GetDocxTableByIndexResponse: Response for Get a specific table by index in a Word DOCX document """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - table: Optional[DocxTable] = field( + table: Optional[DocxTable | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Table"}, ) """Requested Table in the DOCX file""" @@ -266,13 +490,15 @@ class GetDocxTablesResponse: Response for Get all tables in Word DOCX document """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - tables: Optional[List[DocxTable]] = field( + tables: Optional[List[DocxTable | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Tables"}, ) """Tables in the DOCX file""" @@ -284,16 +510,18 @@ class InsertDocxCommentOnParagraphResponse: Response for Insert a new comment into a Word DOCX document attached to a paragraph """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -305,16 +533,18 @@ class DocxInsertImageResponse: Response for Insert image into a Word DOCX document """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -326,16 +556,18 @@ class InsertDocxInsertParagraphResponse: Response for Insert a new paragraph into a Word DOCX document """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -347,16 +579,18 @@ class InsertDocxTablesResponse: Response for Insert a new table into a Word DOCX document """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -368,16 +602,18 @@ class InsertDocxTableRowResponse: Response for Insert a new row into an existing table in a Word DOCX document """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -389,8 +625,9 @@ class RemoveDocxHeadersAndFootersResponse: Response for Remove headers and footers from Word DOCX document """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ @@ -399,8 +636,9 @@ class RemoveDocxHeadersAndFootersResponse: in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -412,16 +650,18 @@ class DocxRemoveObjectResponse: Response for Delete any object in a Word DOCX document """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -433,16 +673,18 @@ class DocxSetFooterResponse: Response for Set the footer in a Word DOCX document """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -454,16 +696,18 @@ class DocxSetHeaderResponse: Response for Set the header in a Word DOCX document """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -475,16 +719,18 @@ class UpdateDocxTableCellResponse: Response for Update, set contents of a table cell in an existing table in a Word DO """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -496,16 +742,18 @@ class UpdateDocxTableRowResponse: Response for Update, set contents of a table row in an existing table in a Word DOCX document """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -517,16 +765,18 @@ class ClearXlsxCellResponse: Response for Clear cell contents in an Excel XLSX spreadsheet, worksheet by index """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -538,16 +788,18 @@ class CreateBlankSpreadsheetResponse: Response for Create a blank Excel XLSX spreadsheet """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -559,16 +811,18 @@ class CreateSpreadsheetFromDataResponse: Response for Create a new Excel XLSX spreadsheet from column and row data """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -580,7 +834,7 @@ class EditDocumentXlsxDeleteWorksheetResponse: Response for Delete, remove worksheet from an Excel XLSX spreadsheet document """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -593,13 +847,15 @@ class GetXlsxCellByIdentifierResponse: Response for Get cell from an Excel XLSX spreadsheet, worksheet by cell identifier """ - cell: Optional[XlsxSpreadsheetCell] = field( + cell: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Cell"}, ) """Requested Cell in the Excel XLSX document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -611,13 +867,15 @@ class GetXlsxCellResponse: Response for Get cell from an Excel XLSX spreadsheet, worksheet by index """ - cell: Optional[XlsxSpreadsheetCell] = field( + cell: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Cell"}, ) """Requested Cell in the Excel XLSX document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -629,13 +887,15 @@ class GetXlsxColumnsResponse: Response for Get rows and cells from a Excel XLSX spreadsheet, worksheet """ - columns: Optional[List[XlsxSpreadsheetColumn]] = field( + columns: Optional[List[XlsxSpreadsheetColumn | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Columns"}, ) """Spreadsheet Columns in the XLSX document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -647,13 +907,15 @@ class GetXlsxImagesResponse: Response for Get images from a Excel XLSX spreadsheet, worksheet """ - images: Optional[List[XlsxImage]] = field( + images: Optional[List[XlsxImage | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Images"}, ) """Spreadsheet Images in the XLSX document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -665,13 +927,15 @@ class GetXlsxRowsAndCellsResponse: Response for Get rows and cells from a Excel XLSX spreadsheet, worksheet """ - rows: Optional[List[XlsxSpreadsheetRow]] = field( + rows: Optional[List[XlsxSpreadsheetRow | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Rows"}, ) """Spreadsheet Rows in the Excel XLSX document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -683,13 +947,15 @@ class GetXlsxStylesResponse: Response for Get styles from a Excel XLSX spreadsheet, worksheet """ - cell_styles: Optional[List[DocxCellStyle]] = field( + cell_styles: Optional[List[DocxCellStyle | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellStyles"}, ) """Cell styles""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -701,13 +967,15 @@ class GetXlsxWorksheetsResponse: Response for Get worksheets from a Excel XLSX spreadsheet """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - worksheets: Optional[List[XlsxWorksheet]] = field( + worksheets: Optional[List[XlsxWorksheet | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Worksheets"}, ) """Worksheets in the Excel XLSX spreadsheet""" @@ -719,16 +987,18 @@ class InsertXlsxWorksheetResponse: Response for Insert a new worksheet into an Excel XLSX spreadsheet """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -740,16 +1010,18 @@ class SetXlsxCellByIdentifierResponse: Response for Set, update cell contents in an Excel XLSX spreadsheet, worksheet by c """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -761,16 +1033,18 @@ class SetXlsxCellResponse: Response for Set, update cell contents in an Excel XLSX spreadsheet, worksheet by index """ - edited_document_u_r_l: Optional[str] = field( + edited_document_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EditedDocumentURL"}, ) """ URL to the edited XLSX file; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the result document contents. """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -782,7 +1056,7 @@ class ConvertDataJsonToXmlInput: Convert JSON to XML conversion """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -795,13 +1069,15 @@ class HtmlTemplateApplicationResponse: Response for Apply HTML template """ - final_html: Optional[str] = field( + final_html: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FinalHtml"}, ) """Final HTML result of all operations on input""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -813,7 +1089,7 @@ class ConvertWebHtmlToPngResponse: Response for Convert HTML string to PNG screenshot """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -826,13 +1102,15 @@ class HtmlToTextResponse: Response for Convert HTML string to text (txt) """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - text_content_result: Optional[str] = field( + text_content_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContentResult"}, ) """Text content result from the HTML input""" @@ -844,13 +1122,15 @@ class UrlToTextResponse: Response for Convert website URL page to text (txt) """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - text_content_result: Optional[str] = field( + text_content_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContentResult"}, ) """Text content result from the URL website input""" @@ -862,13 +1142,15 @@ class AddPdfAnnotationRequest: Definition: AddPdfAnnotationRequest """ - annotations_to_add: Optional[List[PdfAnnotation]] = field( + annotations_to_add: Optional[List[PdfAnnotation | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AnnotationsToAdd"}, ) """Annotations to add to the PDF file""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Input file contents bytes for the file to modify""" @@ -880,18 +1162,21 @@ class AlternateFileFormatCandidate: Definition: AlternateFileFormatCandidate """ - detected_file_extension: Optional[str] = field( + detected_file_extension: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DetectedFileExtension"}, ) """Detected file extension of the file format, with a leading period""" - detected_mime_type: Optional[str] = field( + detected_mime_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DetectedMimeType"}, ) """MIME type of this file extension""" - probability: Optional[float] = field( + probability: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Probability"}, ) """ @@ -906,27 +1191,34 @@ class AutodetectDocumentValidationResult: Definition: AutodetectDocumentValidationResult """ - document_is_valid: Optional[bool] = field( + document_is_valid: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DocumentIsValid"}, ) """True if the document is valid and has no errors, false otherwise""" - error_count: Optional[int] = field( + error_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ErrorCount"}, ) """Number of validation errors found in the document""" - errors_and_warnings: Optional[List[DocumentValidationError]] = field( + errors_and_warnings: Optional[ + List[DocumentValidationError | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ErrorsAndWarnings"}, ) """Details of errors and warnings found""" - file_format_extension: Optional[str] = field( + file_format_extension: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileFormatExtension"}, ) - warning_count: Optional[int] = field( + warning_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WarningCount"}, ) """Number of validation warnings found in the document""" @@ -938,39 +1230,47 @@ class AutodetectGetInfoResult: Definition: AutodetectGetInfoResult """ - alternate_file_type_candidates: Optional[List[AlternateFileFormatCandidate]] = field( + alternate_file_type_candidates: Optional[ + List[AlternateFileFormatCandidate | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AlternateFileTypeCandidates"}, ) """Alternate file type options and their probability""" - author: Optional[str] = field( + author: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Author"}, ) """ User name of the creator/author of the document, if available, null if not available """ - date_modified: Optional[str] = field( + date_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) """ The timestamp that the document was last modified, if available, null if not available """ - detected_file_extension: Optional[str] = field( + detected_file_extension: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DetectedFileExtension"}, ) """Detected file extension of the file format, with a leading period""" - detected_mime_type: Optional[str] = field( + detected_mime_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DetectedMimeType"}, ) """MIME type of this file extension""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PageCount"}, ) """ @@ -979,8 +1279,9 @@ class AutodetectGetInfoResult: Contains 0 when the page count cannot be determined, or if the concept of page count does not apply (e.g. for an image) """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -992,13 +1293,15 @@ class AutodetectToPngResult: Definition: AutodetectToPngResult """ - png_result_pages: Optional[List[ConvertedPngPage]] = field( + png_result_pages: Optional[List[ConvertedPngPage | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PngResultPages"}, ) """Array of converted pages""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -1010,8 +1313,9 @@ class Base64DecodeRequest: Definition: Base64DecodeRequest """ - base64_content_to_decode: Optional[str] = field( + base64_content_to_decode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Base64ContentToDecode"}, ) """Input content to decode from Base 64 into binary""" @@ -1023,13 +1327,15 @@ class Base64DecodeResponse: Definition: Base64DecodeResponse """ - content_result: Optional[str] = field( + content_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentResult"}, ) """Result of performing a base 64 decode operation, binary file content""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -1041,8 +1347,9 @@ class Base64DetectRequest: Definition: Base64DetectRequest """ - base64_content_to_detect: Optional[str] = field( + base64_content_to_detect: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Base64ContentToDetect"}, ) """Input content text to detect if it is base 64 encoded""" @@ -1054,13 +1361,15 @@ class Base64DetectResponse: Definition: Base64DetectResponse """ - is_base64_encoded: Optional[bool] = field( + is_base64_encoded: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsBase64Encoded"}, ) """True if the input string is base 64 encoded, false otherwise""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -1072,8 +1381,9 @@ class Base64EncodeRequest: Definition: Base64EncodeRequest """ - content_to_encode: Optional[str] = field( + content_to_encode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentToEncode"}, ) """Input content to encode into Base 64""" @@ -1085,16 +1395,18 @@ class Base64EncodeResponse: Definition: Base64EncodeResponse """ - base64_text_content_result: Optional[str] = field( + base64_text_content_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Base64TextContentResult"}, ) """ Result of performing a base 64 encoding operation, a text string representing the encoded original file content """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -1106,13 +1418,15 @@ class ChangeLineEndingResponse: Definition: ChangeLineEndingResponse """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - text_content_result: Optional[str] = field( + text_content_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContentResult"}, ) """Text content result""" @@ -1124,18 +1438,21 @@ class ClearXlsxCellRequest: Definition: ClearXlsxCellRequest """ - cell_index: Optional[int] = field( + cell_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellIndex"}, ) """0-based index of the cell, 0, 1, 2, ... in the row to clear""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -1144,13 +1461,15 @@ class ClearXlsxCellRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - row_index: Optional[int] = field( + row_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RowIndex"}, ) """0-based index of the row, 0, 1, 2, ... to clear""" - worksheet_to_update: Optional[XlsxWorksheet] = field( + worksheet_to_update: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetToUpdate"}, ) """ @@ -1165,12 +1484,17 @@ class ConvertedPngPage: Definition: ConvertedPngPage """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PageNumber"}, ) """Page number of the converted page, starting with 1""" - u_r_l: Optional[str] = field(default=None, metadata={"wire_name": "URL"}) + u_r_l: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "URL"}, + ) """ URL to the PNG file of this page; file is stored in an in-memory cache and will be deleted @@ -1183,8 +1507,9 @@ class CreateBlankDocxRequest: Definition: CreateBlankDocxRequest """ - initial_text: Optional[str] = field( + initial_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InitialText"}, ) """Optional; initial text to include in the document""" @@ -1196,8 +1521,9 @@ class CreateBlankSpreadsheetRequest: Definition: CreateBlankSpreadsheetRequest """ - worksheet_name: Optional[str] = field( + worksheet_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetName"}, ) """ @@ -1212,13 +1538,15 @@ class CreateSpreadsheetFromDataRequest: Definition: CreateSpreadsheetFromDataRequest """ - rows: Optional[List[XlsxSpreadsheetRow]] = field( + rows: Optional[List[XlsxSpreadsheetRow | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Rows"}, ) """Required; Rows and cells to populate the spreadsheet with""" - worksheet_name: Optional[str] = field( + worksheet_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetName"}, ) """ @@ -1233,16 +1561,18 @@ class CreateZipArchiveRequest: Definition: CreateZipArchiveRequest """ - directories_in_zip: Optional[List[ZipDirectory]] = field( + directories_in_zip: Optional[List[ZipDirectory | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DirectoriesInZip"}, ) """ Top-level directories in the root directory of the zip; directories can contain sub-directories and files """ - files_in_zip: Optional[List[ZipFile]] = field( + files_in_zip: Optional[List[ZipFile | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FilesInZip"}, ) """Top-level files in the root directory fo the zip file""" @@ -1254,13 +1584,15 @@ class DeleteDocxTableRowRangeRequest: Definition: DeleteDocxTableRowRangeRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -1269,21 +1601,24 @@ class DeleteDocxTableRowRangeRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - table_path: Optional[str] = field( + table_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TablePath"}, ) """Path to the table to delete the row from""" - table_row_row_index_end: Optional[int] = field( + table_row_row_index_end: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableRowRowIndexEnd"}, ) """ 0-based index of the row to stop deleting rows (e.g. 0, 1, 2, ...) in the table """ - table_row_row_index_start: Optional[int] = field( + table_row_row_index_start: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableRowRowIndexStart"}, ) """ @@ -1298,13 +1633,15 @@ class DeleteDocxTableRowRequest: Definition: DeleteDocxTableRowRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -1313,13 +1650,15 @@ class DeleteDocxTableRowRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - table_path: Optional[str] = field( + table_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TablePath"}, ) """Path to the table to delete the row from""" - table_row_row_index: Optional[int] = field( + table_row_row_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableRowRowIndex"}, ) """0-based index of the row to delete (e.g. 0, 1, 2, ...) in the table""" @@ -1331,21 +1670,24 @@ class DetectLineEndingsResponse: Definition: DetectLineEndingsResponse """ - input_length: Optional[int] = field( + input_length: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputLength"}, ) """Length of the input string in characters""" - primary_newline_terminator: Optional[str] = field( + primary_newline_terminator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PrimaryNewlineTerminator"}, ) """ Characters used to terminate a newline; can be carriage return, linefeed, or carriage return + linefeed """ - primary_newline_type: Optional[str] = field( + primary_newline_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PrimaryNewlineType"}, ) """ @@ -1353,8 +1695,9 @@ class DetectLineEndingsResponse: uses carriage return only); \"Unix\" (Unix and Linux OSes, and modern Mac OS); \"Windows\" (Windows operating systems) """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -1366,19 +1709,29 @@ class DocumentValidationError: Definition: DocumentValidationError """ - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Description of the error""" - is_error: Optional[bool] = field( + is_error: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsError"}, ) """True if this is an error, false otherwise""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """XPath to the error""" - uri: Optional[str] = field(default=None, metadata={"wire_name": "Uri"}) + uri: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Uri"}, + ) """URI of the part in question""" @@ -1388,23 +1741,29 @@ class DocumentValidationResult: Definition: DocumentValidationResult """ - document_is_valid: Optional[bool] = field( + document_is_valid: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DocumentIsValid"}, ) """True if the document is valid and has no errors, false otherwise""" - error_count: Optional[int] = field( + error_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ErrorCount"}, ) """Number of validation errors found in the document""" - errors_and_warnings: Optional[List[DocumentValidationError]] = field( + errors_and_warnings: Optional[ + List[DocumentValidationError | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ErrorsAndWarnings"}, ) """Details of errors and warnings found""" - warning_count: Optional[int] = field( + warning_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WarningCount"}, ) """Number of validation warnings found in the document""" @@ -1416,23 +1775,29 @@ class DocxBody: Definition: DocxBody """ - all_paragraphs: Optional[List[DocxParagraph]] = field( + all_paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllParagraphs"}, ) """ All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document """ - all_tables: Optional[List[DocxTable]] = field( + all_tables: Optional[List[DocxTable | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllTables"}, ) """ All tables anywhere in the document; these objects are not sequentially placed but are scatted across the document """ - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new tables""" @@ -1442,19 +1807,29 @@ class DocxCellStyle: Definition: DocxCellStyle """ - built_in_id: Optional[int] = field( + built_in_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BuiltInID"}, ) """Built=in ID of the cell style""" - format_id: Optional[int] = field( + format_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FormatID"}, ) """Format ID of the cell style""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Name of the style""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new rows""" @@ -1464,50 +1839,65 @@ class DocxComment: Definition: DocxComment """ - author: Optional[str] = field( + author: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Author"}, ) """Author name of the comment""" - author_initials: Optional[str] = field( + author_initials: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AuthorInitials"}, ) """Initials of the author of the comment""" - comment_date: Optional[str] = field( + comment_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CommentDate"}, ) """Date timestamp of the comment""" - comment_text: Optional[str] = field( + comment_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CommentText"}, ) """Text content of the comment""" - done: Optional[bool] = field(default=None, metadata={"wire_name": "Done"}) + done: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Done"}, + ) """True if this comment is marked as Done in Word, otherwise it is false""" - is_reply: Optional[bool] = field( + is_reply: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsReply"}, ) """True if this comment is a reply to another comment, false otherwise""" - is_top_level: Optional[bool] = field( + is_top_level: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsTopLevel"}, ) """ True if the comment is at the top level, false if this comment is a child reply of another comment """ - parent_comment_path: Optional[str] = field( + parent_comment_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ParentCommentPath"}, ) """ Path to the parent of this comment, if this comment is a reply, otherwise this value will be null """ - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """Path to the comment in the document""" @@ -1517,15 +1907,21 @@ class DocxFooter: Definition: DocxFooter """ - paragraphs: Optional[List[DocxParagraph]] = field( + paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Paragraphs"}, ) """Paragraphs in this footer""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new tables""" - sections_with_footer: Optional[List[DocxSection]] = field( + sections_with_footer: Optional[List[DocxSection | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SectionsWithFooter"}, ) """Sections that the footer is applied to""" @@ -1537,15 +1933,21 @@ class DocxHeader: Definition: DocxHeader """ - paragraphs: Optional[List[DocxParagraph]] = field( + paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Paragraphs"}, ) """Paragraphs in this header""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new tables""" - sections_with_header: Optional[List[DocxSection]] = field( + sections_with_header: Optional[List[DocxSection | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SectionsWithHeader"}, ) """Sections that the header is applied to""" @@ -1557,74 +1959,90 @@ class DocxImage: Definition: DocxImage """ - image_contents_u_r_l: Optional[str] = field( + image_contents_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageContentsURL"}, ) """ URL to the image contents; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the contents. """ - image_data_content_type: Optional[str] = field( + image_data_content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageDataContentType"}, ) """Read-only; image data MIME content-type""" - image_data_embed_id: Optional[str] = field( + image_data_embed_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageDataEmbedId"}, ) """Read-only; internal ID for the image contents""" - image_description: Optional[str] = field( + image_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageDescription"}, ) """The Description of the image""" - image_height: Optional[int] = field( + image_height: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageHeight"}, ) """ Height of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height """ - image_id: Optional[int] = field( + image_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageId"}, ) """The Id of the image""" - image_internal_file_name: Optional[str] = field( + image_internal_file_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageInternalFileName"}, ) """Read-only; internal file name/path for the image""" - image_name: Optional[str] = field( + image_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageName"}, ) """The Name of the image""" - image_width: Optional[int] = field( + image_width: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageWidth"}, ) """ Width of the image in EMUs (English Metric Units); set to 0 to default to page width and aspect-ratio based height """ - inline_with_text: Optional[bool] = field( + inline_with_text: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InlineWithText"}, ) """True if the image is inline with the text; false if it is floating""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new tables""" - x_offset: Optional[int] = field( + x_offset: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "XOffset"}, ) """X (horizontal) offset of the image""" - y_offset: Optional[int] = field( + y_offset: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "YOffset"}, ) """Y (vertical) offset of the image""" @@ -1636,18 +2054,21 @@ class DocxInsertCommentOnParagraphRequest: Definition: DocxInsertCommentOnParagraphRequest """ - comment_to_insert: Optional[DocxComment] = field( + comment_to_insert: Optional[DocxComment | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CommentToInsert"}, ) """Comment to insert""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -1656,8 +2077,9 @@ class DocxInsertCommentOnParagraphRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - paragraph_path: Optional[str] = field( + paragraph_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ParagraphPath"}, ) """ @@ -1673,26 +2095,30 @@ class DocxInsertImageRequest: Definition: DocxInsertImageRequest """ - height_in_e_m_us: Optional[int] = field( + height_in_e_m_us: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HeightInEMUs"}, ) """Optional: The height of the image in EMUs""" - image_to_add: Optional[DocxImage] = field( + image_to_add: Optional[DocxImage | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageToAdd"}, ) """ Optional: Image to add; if you supply in this object, do not supply InputImageFileBytes or InputImageFileUrl. """ - input_document_file_bytes: Optional[str] = field( + input_document_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputDocumentFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_document_file_url: Optional[str] = field( + input_document_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputDocumentFileUrl"}, ) """ @@ -1701,16 +2127,18 @@ class DocxInsertImageRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - input_image_file_bytes: Optional[str] = field( + input_image_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputImageFileBytes"}, ) """ Optional: Bytes of the input image file to operate on; if you supply this value do not supply InputImageFileUrl or ImageToAdd. """ - input_image_file_url: Optional[str] = field( + input_image_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputImageFileUrl"}, ) """ @@ -1720,8 +2148,9 @@ class DocxInsertImageRequest: pass in the secure URL result from that operation as the URL here (this URL is not public). """ - insert_path: Optional[str] = field( + insert_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InsertPath"}, ) """ @@ -1729,8 +2158,9 @@ class DocxInsertImageRequest: InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject """ - insert_placement: Optional[str] = field( + insert_placement: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InsertPlacement"}, ) """ @@ -1741,8 +2171,9 @@ class DocxInsertImageRequest: object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object) """ - width_in_e_m_us: Optional[int] = field( + width_in_e_m_us: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WidthInEMUs"}, ) """Optional: The width of the image in EMUs""" @@ -1754,13 +2185,15 @@ class DocxPage: Definition: DocxPage """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PageNumber"}, ) """Page number of this page, 1-based""" - paragraphs: Optional[List[DocxParagraph]] = field( + paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Paragraphs"}, ) """ @@ -1775,23 +2208,30 @@ class DocxParagraph: Definition: DocxParagraph """ - content_runs: Optional[List[DocxRun]] = field( + content_runs: Optional[List[DocxRun | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentRuns"}, ) """ The content runs in the paragraph - this is where text is stored; similar to a span in HTML """ - paragraph_index: Optional[int] = field( + paragraph_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ParagraphIndex"}, ) """The index of the paragraph; 0-based""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new tables""" - style_id: Optional[str] = field( + style_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StyleID"}, ) """ @@ -1805,13 +2245,15 @@ class DocxRemoveObjectRequest: Definition: DocxRemoveObjectRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -1820,8 +2262,9 @@ class DocxRemoveObjectRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - path_to_object_to_remove: Optional[str] = field( + path_to_object_to_remove: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PathToObjectToRemove"}, ) """ @@ -1836,39 +2279,53 @@ class DocxRun: Definition: DocxRun """ - bold: Optional[bool] = field(default=None, metadata={"wire_name": "Bold"}) + bold: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bold"}, + ) """True to make the text bold, false otherwise""" - font_family: Optional[str] = field( + font_family: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FontFamily"}, ) """Font Family name for the text, e.g. \"Arial\" or \"Times New Roman\"""" - font_size: Optional[str] = field( + font_size: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FontSize"}, ) """Font size in font points (e.g. \"24\")""" - italic: Optional[bool] = field( + italic: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Italic"}, ) """True to make the text italic, false otherwise""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new tables""" - run_index: Optional[int] = field( + run_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RunIndex"}, ) """Index of the run, 0-based""" - text_items: Optional[List[DocxText]] = field( + text_items: Optional[List[DocxText | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextItems"}, ) """ Text items inside the run; this is where the actual text content is stored """ - underline: Optional[str] = field( + underline: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Underline"}, ) """ @@ -1885,10 +2342,15 @@ class DocxSection: Definition: DocxSection """ - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new tables""" - starting_page_numbers: Optional[List[int]] = field( + starting_page_numbers: Optional[List[int]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartingPageNumbers"}, ) """Page numbers that the section starts at, typically just one""" @@ -1900,13 +2362,15 @@ class DocxSetFooterAddPageNumberRequest: Definition: DocxSetFooterAddPageNumberRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -1915,8 +2379,9 @@ class DocxSetFooterAddPageNumberRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - prepend_text: Optional[str] = field( + prepend_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PrependText"}, ) """ @@ -1931,18 +2396,21 @@ class DocxSetFooterRequest: Definition: DocxSetFooterRequest """ - footer_to_apply: Optional[DocxFooter] = field( + footer_to_apply: Optional[DocxFooter | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FooterToApply"}, ) """Footer to apply""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -1959,18 +2427,21 @@ class DocxSetHeaderRequest: Definition: DocxSetHeaderRequest """ - header_to_apply: Optional[DocxHeader] = field( + header_to_apply: Optional[DocxHeader | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HeaderToApply"}, ) """Header to apply""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -1987,32 +2458,45 @@ class DocxStyle: Definition: DocxStyle """ - bold: Optional[bool] = field(default=None, metadata={"wire_name": "Bold"}) + bold: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bold"}, + ) """Style applies bold formatting""" - font_family: Optional[str] = field( + font_family: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FontFamily"}, ) """Font family""" - font_size: Optional[str] = field( + font_size: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FontSize"}, ) """Font size""" - italic: Optional[bool] = field( + italic: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Italic"}, ) """Style applies italic formatting""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new tables""" - style_id: Optional[str] = field( + style_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StyleID"}, ) """ID of the style""" - underline: Optional[bool] = field( + underline: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Underline"}, ) """Style applies underline formatting""" @@ -2024,23 +2508,27 @@ class DocxTable: Definition: DocxTable """ - bottom_border_color: Optional[str] = field( + bottom_border_color: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BottomBorderColor"}, ) """HTML-style color hex value (do not include a #)""" - bottom_border_size: Optional[int] = field( + bottom_border_size: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BottomBorderSize"}, ) """Width of the border in points (1/72nd of an inch)""" - bottom_border_space: Optional[int] = field( + bottom_border_space: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BottomBorderSpace"}, ) """Spacing around the border in points (1/72nd of an inch)""" - bottom_border_type: Optional[str] = field( + bottom_border_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BottomBorderType"}, ) """ @@ -2051,23 +2539,27 @@ class DocxTable: ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave """ - cell_horizontal_border_color: Optional[str] = field( + cell_horizontal_border_color: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellHorizontalBorderColor"}, ) """HTML-style color hex value (do not include a #)""" - cell_horizontal_border_size: Optional[int] = field( + cell_horizontal_border_size: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellHorizontalBorderSize"}, ) """Width of the border in points (1/72nd of an inch)""" - cell_horizontal_border_space: Optional[int] = field( + cell_horizontal_border_space: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellHorizontalBorderSpace"}, ) """Spacing around the border in points (1/72nd of an inch)""" - cell_horizontal_border_type: Optional[str] = field( + cell_horizontal_border_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellHorizontalBorderType"}, ) """ @@ -2078,23 +2570,27 @@ class DocxTable: ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave """ - cell_vertical_border_color: Optional[str] = field( + cell_vertical_border_color: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellVerticalBorderColor"}, ) """HTML-style color hex value (do not include a #)""" - cell_vertical_border_size: Optional[int] = field( + cell_vertical_border_size: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellVerticalBorderSize"}, ) """Width of the border in points (1/72nd of an inch)""" - cell_vertical_border_space: Optional[int] = field( + cell_vertical_border_space: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellVerticalBorderSpace"}, ) """Spacing around the border in points (1/72nd of an inch)""" - cell_vertical_border_type: Optional[str] = field( + cell_vertical_border_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellVerticalBorderType"}, ) """ @@ -2105,23 +2601,27 @@ class DocxTable: ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave """ - end_border_color: Optional[str] = field( + end_border_color: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndBorderColor"}, ) """HTML-style color hex value (do not include a #)""" - end_border_size: Optional[int] = field( + end_border_size: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndBorderSize"}, ) """Width of the border in points (1/72nd of an inch)""" - end_border_space: Optional[int] = field( + end_border_space: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndBorderSpace"}, ) """Spacing around the border in points (1/72nd of an inch)""" - end_border_type: Optional[str] = field( + end_border_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndBorderType"}, ) """ @@ -2132,23 +2632,27 @@ class DocxTable: ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave """ - left_border_color: Optional[str] = field( + left_border_color: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LeftBorderColor"}, ) """HTML-style color hex value (do not include a #)""" - left_border_size: Optional[int] = field( + left_border_size: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LeftBorderSize"}, ) """Width of the border in points (1/72nd of an inch)""" - left_border_space: Optional[int] = field( + left_border_space: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LeftBorderSpace"}, ) """Spacing around the border in points (1/72nd of an inch)""" - left_border_type: Optional[str] = field( + left_border_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LeftBorderType"}, ) """ @@ -2159,27 +2663,35 @@ class DocxTable: ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave """ - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """ The Path of the location of this table object; leave blank for new tables """ - right_border_color: Optional[str] = field( + right_border_color: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RightBorderColor"}, ) """HTML-style color hex value (do not include a #)""" - right_border_size: Optional[int] = field( + right_border_size: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RightBorderSize"}, ) """Width of the border in points (1/72nd of an inch)""" - right_border_space: Optional[int] = field( + right_border_space: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RightBorderSpace"}, ) """Spacing around the border in points (1/72nd of an inch)""" - right_border_type: Optional[str] = field( + right_border_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RightBorderType"}, ) """ @@ -2190,23 +2702,27 @@ class DocxTable: ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave """ - start_border_color: Optional[str] = field( + start_border_color: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartBorderColor"}, ) """HTML-style color hex value (do not include a #)""" - start_border_size: Optional[int] = field( + start_border_size: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartBorderSize"}, ) """Width of the border in points (1/72nd of an inch)""" - start_border_space: Optional[int] = field( + start_border_space: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartBorderSpace"}, ) """Spacing around the border in points (1/72nd of an inch)""" - start_border_type: Optional[str] = field( + start_border_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartBorderType"}, ) """ @@ -2217,43 +2733,51 @@ class DocxTable: ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave """ - table_id: Optional[str] = field( + table_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableID"}, ) """The ID of the table; leave blank for new tables""" - table_indentation_mode: Optional[str] = field( + table_indentation_mode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableIndentationMode"}, ) """Table indentation type""" - table_indentation_width: Optional[int] = field( + table_indentation_width: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableIndentationWidth"}, ) """Table indentation width""" - table_rows: Optional[List[DocxTableRow]] = field( + table_rows: Optional[List[DocxTableRow | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableRows"}, ) """Rows in the table; this is where the contents is located""" - top_border_color: Optional[str] = field( + top_border_color: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TopBorderColor"}, ) """HTML-style color hex value (do not include a #)""" - top_border_size: Optional[int] = field( + top_border_size: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TopBorderSize"}, ) """Width of the border in points (1/72nd of an inch)""" - top_border_space: Optional[int] = field( + top_border_space: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TopBorderSpace"}, ) """Spacing around the border in points (1/72nd of an inch)""" - top_border_type: Optional[str] = field( + top_border_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TopBorderType"}, ) """ @@ -2264,10 +2788,15 @@ class DocxTable: ThinThickSmallGap, ThinThickThinLargeGap, ThinThickThinMediumGap, ThinThickThinSmallGap, ThreeDEmboss, ThreeDEngrave, Triple, Wave """ - width: Optional[str] = field(default=None, metadata={"wire_name": "Width"}) + width: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Width"}, + ) """The Width of the table, or 0 if not specified""" - width_type: Optional[str] = field( + width_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WidthType"}, ) """The Width configuration type of the table""" @@ -2279,45 +2808,56 @@ class DocxTableCell: Definition: DocxTableCell """ - cell_index: Optional[int] = field( + cell_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellIndex"}, ) """The index of the cell, 0-based""" - cell_shading_color: Optional[str] = field( + cell_shading_color: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellShadingColor"}, ) """Color of the cell shading""" - cell_shading_fill: Optional[str] = field( + cell_shading_fill: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellShadingFill"}, ) """Fill of the cell shading""" - cell_shading_pattern: Optional[str] = field( + cell_shading_pattern: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellShadingPattern"}, ) """Pattern of the cell shading""" - cell_width: Optional[str] = field( + cell_width: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellWidth"}, ) """Width of the cell""" - cell_width_mode: Optional[str] = field( + cell_width_mode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellWidthMode"}, ) """Width mode of the cell; can be auto (for automatic) or manual""" - paragraphs: Optional[List[DocxParagraph]] = field( + paragraphs: Optional[List[DocxParagraph | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Paragraphs"}, ) """ Paragraphs inside the cell; this is where the contents of the cell are stored """ - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new tables""" @@ -2327,18 +2867,24 @@ class DocxTableRow: Definition: DocxTableRow """ - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """ The Path of the location of this table row object; leave blank for new tables """ - row_cells: Optional[List[DocxTableCell]] = field( + row_cells: Optional[List[DocxTableCell | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RowCells"}, ) """Cells in the row; this is where the contents of the row is stored""" - row_index: Optional[int] = field( + row_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RowIndex"}, ) """Index of the row, 0-based""" @@ -2350,8 +2896,9 @@ class DocxTemplateApplicationRequest: Definition: DocxTemplateApplicationRequest """ - operations: Optional[List[DocxTemplateOperation]] = field( + operations: Optional[List[DocxTemplateOperation | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Operations"}, ) """Operations to apply to this template""" @@ -2363,21 +2910,24 @@ class DocxTemplateOperation: Definition: DocxTemplateOperation """ - action: Optional[int] = field( + action: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Action"}, ) """Operation action to take; possible values are \"Replace\"""" - match_against: Optional[str] = field( + match_against: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MatchAgainst"}, ) """ For Replace operations, the string to match against (to be replaced with ReplaceWith string) """ - replace_with: Optional[str] = field( + replace_with: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplaceWith"}, ) """ @@ -2391,15 +2941,21 @@ class DocxText: Definition: DocxText """ - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new tables""" - text_content: Optional[str] = field( + text_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContent"}, ) """Text string containing the text content of this text content item""" - text_index: Optional[int] = field( + text_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextIndex"}, ) """Index of the text content in the run; 0-based""" @@ -2411,32 +2967,45 @@ class DocxTopLevelComment: Definition: DocxTopLevelComment """ - author: Optional[str] = field( + author: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Author"}, ) """Author name of the comment""" - author_initials: Optional[str] = field( + author_initials: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AuthorInitials"}, ) """Initials of the author of the comment""" - comment_date: Optional[str] = field( + comment_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CommentDate"}, ) """Date timestamp of the comment""" - comment_text: Optional[str] = field( + comment_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CommentText"}, ) """Text content of the comment""" - done: Optional[bool] = field(default=None, metadata={"wire_name": "Done"}) + done: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Done"}, + ) """True if this comment is marked as Done in Word, otherwise it is false""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """Path to the comment in the document""" - reply_child_comments: Optional[List[DocxComment]] = field( + reply_child_comments: Optional[List[DocxComment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyChildComments"}, ) """Child comments, that are replies to this one""" @@ -2448,17 +3017,23 @@ class ExifValue: Definition: ExifValue """ - data_type: Optional[str] = field( + data_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DataType"}, ) """Date type of the EXIF value""" - data_value: Optional[str] = field( + data_value: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DataValue"}, ) """Value, formatted as a string of the EXIF value""" - tag: Optional[str] = field(default=None, metadata={"wire_name": "Tag"}) + tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Tag"}, + ) """Tag name for the EXIF value""" @@ -2468,30 +3043,35 @@ class FindRegexMatch: Definition: FindRegexMatch """ - character_offset_end: Optional[int] = field( + character_offset_end: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CharacterOffsetEnd"}, ) """0-based index of the end of the match""" - character_offset_start: Optional[int] = field( + character_offset_start: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CharacterOffsetStart"}, ) """0-based index of the start of the match""" - containing_line: Optional[str] = field( + containing_line: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContainingLine"}, ) """Text content of the line containing the match""" - match_groups: Optional[List[str]] = field( + match_groups: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MatchGroups"}, ) """ Regular expression regex match groups; these correspond to the match values """ - match_value: Optional[str] = field( + match_value: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MatchValue"}, ) """The match value""" @@ -2503,18 +3083,21 @@ class FindStringMatch: Definition: FindStringMatch """ - character_offset_end: Optional[int] = field( + character_offset_end: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CharacterOffsetEnd"}, ) """0-based index of the end of the match""" - character_offset_start: Optional[int] = field( + character_offset_start: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CharacterOffsetStart"}, ) """0-based index of the start of the match""" - containing_line: Optional[str] = field( + containing_line: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContainingLine"}, ) """Text content of the line containing the match""" @@ -2526,18 +3109,21 @@ class FindStringRegexRequest: Definition: FindStringRegexRequest """ - match_case: Optional[bool] = field( + match_case: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MatchCase"}, ) """Set to True to match case, False to ignore case""" - target_regex: Optional[str] = field( + target_regex: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TargetRegex"}, ) """Target input regular expression (regex) to find""" - text_content: Optional[str] = field( + text_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContent"}, ) """Input text content""" @@ -2549,18 +3135,21 @@ class FindStringRegexResponse: Definition: FindStringRegexResponse """ - match_count: Optional[int] = field( + match_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MatchCount"}, ) """The number of matches""" - matches: Optional[List[FindRegexMatch]] = field( + matches: Optional[List[FindRegexMatch | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Matches"}, ) """Regular expression matches""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -2572,13 +3161,15 @@ class FindStringSimpleRequest: Definition: FindStringSimpleRequest """ - target_string: Optional[str] = field( + target_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TargetString"}, ) """Target input string to find""" - text_content: Optional[str] = field( + text_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContent"}, ) """Input text content""" @@ -2590,18 +3181,21 @@ class FindStringSimpleResponse: Definition: FindStringSimpleResponse """ - match_count: Optional[int] = field( + match_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MatchCount"}, ) """The number of matches""" - matches: Optional[List[FindStringMatch]] = field( + matches: Optional[List[FindStringMatch | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Matches"}, ) """Found matches""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -2613,8 +3207,9 @@ class FinishEditingRequest: Definition: FinishEditingRequest """ - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """URL of a document being edited to get the contents of.""" @@ -2626,13 +3221,15 @@ class GetDocxBodyRequest: Definition: GetDocxBodyRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -2649,18 +3246,21 @@ class GetDocxCommentsResponse: Definition: GetDocxCommentsResponse """ - comment_count: Optional[int] = field( + comment_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CommentCount"}, ) """The number of comments in the document""" - comments: Optional[List[DocxComment]] = field( + comments: Optional[List[DocxComment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Comments in the document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -2672,13 +3272,15 @@ class GetDocxGetCommentsHierarchicalRequest: Definition: GetDocxGetCommentsHierarchicalRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -2695,13 +3297,15 @@ class GetDocxGetCommentsRequest: Definition: GetDocxGetCommentsRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -2718,13 +3322,15 @@ class GetDocxHeadersAndFootersRequest: Definition: GetDocxHeadersAndFootersRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -2741,13 +3347,15 @@ class GetDocxImagesRequest: Definition: GetDocxImagesRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -2764,13 +3372,15 @@ class GetDocxPagesRequest: Definition: GetDocxPagesRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -2787,13 +3397,15 @@ class GetDocxSectionsRequest: Definition: GetDocxSectionsRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -2810,13 +3422,15 @@ class GetDocxStylesRequest: Definition: GetDocxStylesRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -2833,13 +3447,15 @@ class GetDocxTableByIndexRequest: Definition: GetDocxTableByIndexRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -2848,8 +3464,9 @@ class GetDocxTableByIndexRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - table_index: Optional[int] = field( + table_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableIndex"}, ) """0-based index of the table to retrieve from the Word Document""" @@ -2861,13 +3478,15 @@ class GetDocxTableRowRequest: Definition: GetDocxTableRowRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -2876,13 +3495,15 @@ class GetDocxTableRowRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - table_path: Optional[str] = field( + table_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TablePath"}, ) """Path to the table to retrievew the row from""" - table_row_row_index: Optional[int] = field( + table_row_row_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableRowRowIndex"}, ) """0-based index of the row to retrieve (e.g. 0, 1, 2, ...) in the table""" @@ -2894,13 +3515,15 @@ class GetDocxTablesRequest: Definition: GetDocxTablesRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -2917,85 +3540,108 @@ class GetImageInfoResult: Definition: GetImageInfoResult """ - bit_depth: Optional[int] = field( + bit_depth: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BitDepth"}, ) """Bit depth of the image""" - color_count: Optional[int] = field( + color_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ColorCount"}, ) """Unique colors in the image""" - color_space: Optional[str] = field( + color_space: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ColorSpace"}, ) """Color space of the image""" - color_type: Optional[str] = field( + color_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ColorType"}, ) """Color type of the image""" - comment: Optional[str] = field( + comment: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comment"}, ) """Comment string in the image""" - compression_level: Optional[int] = field( + compression_level: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompressionLevel"}, ) """ Compression level value from 0 (lowest quality) to 100 (highest quality) """ - d_p_i: Optional[float] = field(default=None, metadata={"wire_name": "DPI"}) + d_p_i: Optional[float] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "DPI"}, + ) """DPI (pixels per unit, e.g. pixels per inch) of the image""" - d_p_i_unit: Optional[str] = field( + d_p_i_unit: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DPIUnit"}, ) """Units of the DPI measurement; can be either in Inches or Centimeters""" - exif_profile_name: Optional[str] = field( + exif_profile_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExifProfileName"}, ) """Name of the EXIF profile used""" - exif_values: Optional[List[ExifValue]] = field( + exif_values: Optional[List[ExifValue | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExifValues"}, ) """EXIF tags and values embedded in the image""" - has_transparency: Optional[bool] = field( + has_transparency: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HasTransparency"}, ) """True if the image contains transparency, otherwise false""" - height: Optional[int] = field( + height: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Height"}, ) """Height in pixels of the image""" - image_format: Optional[str] = field( + image_format: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageFormat"}, ) """Image format""" - image_hash_signature: Optional[str] = field( + image_hash_signature: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageHashSignature"}, ) """SHA256 hash signature of the image""" - mime_type: Optional[str] = field( + mime_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MimeType"}, ) """MIME type of the image format""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) - width: Optional[int] = field(default=None, metadata={"wire_name": "Width"}) + width: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Width"}, + ) """Width in pixels of the image""" @@ -3005,16 +3651,18 @@ class GetPdfAnnotationsResult: Definition: GetPdfAnnotationsResult """ - annotations: Optional[List[PdfAnnotation]] = field( + annotations: Optional[List[PdfAnnotation | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Annotations"}, ) """ Annotations in the PDF file, ordered by placement from start to finish in the document """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -3026,18 +3674,21 @@ class GetXlsxCellByIdentifierRequest: Definition: GetXlsxCellByIdentifierRequest """ - cell_identifier: Optional[str] = field( + cell_identifier: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellIdentifier"}, ) """Required; Excel cell identifier, e.g. A1, B22, C33, etc.""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3046,8 +3697,9 @@ class GetXlsxCellByIdentifierRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - worksheet_to_query: Optional[XlsxWorksheet] = field( + worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetToQuery"}, ) """ @@ -3062,18 +3714,21 @@ class GetXlsxCellRequest: Definition: GetXlsxCellRequest """ - cell_index: Optional[int] = field( + cell_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellIndex"}, ) """0-based index of the cell, 0, 1, 2, ... in the row to retrieve""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3082,13 +3737,15 @@ class GetXlsxCellRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - row_index: Optional[int] = field( + row_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RowIndex"}, ) """0-based index of the row, 0, 1, 2, ... to retrieve""" - worksheet_to_query: Optional[XlsxWorksheet] = field( + worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetToQuery"}, ) """ @@ -3103,13 +3760,15 @@ class GetXlsxColumnsRequest: Definition: GetXlsxColumnsRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3118,8 +3777,9 @@ class GetXlsxColumnsRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - worksheet_to_query: Optional[XlsxWorksheet] = field( + worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetToQuery"}, ) """ @@ -3134,13 +3794,15 @@ class GetXlsxImagesRequest: Definition: GetXlsxImagesRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3149,8 +3811,9 @@ class GetXlsxImagesRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - worksheet_to_query: Optional[XlsxWorksheet] = field( + worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetToQuery"}, ) """ @@ -3165,13 +3828,15 @@ class GetXlsxRowsAndCellsRequest: Definition: GetXlsxRowsAndCellsRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3180,8 +3845,9 @@ class GetXlsxRowsAndCellsRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - worksheet_to_query: Optional[XlsxWorksheet] = field( + worksheet_to_query: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetToQuery"}, ) """ @@ -3196,13 +3862,15 @@ class GetXlsxStylesRequest: Definition: GetXlsxStylesRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3219,13 +3887,15 @@ class GetXlsxWorksheetsRequest: Definition: GetXlsxWorksheetsRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3242,10 +3912,15 @@ class HtmlMdResult: Definition: HtmlMdResult """ - html: Optional[str] = field(default=None, metadata={"wire_name": "Html"}) + html: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Html"}, + ) """Resulting HTML from the conversion""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if operation was successful, false otherwise""" @@ -3257,18 +3932,21 @@ class HtmlTemplateApplicationRequest: Definition: HtmlTemplateApplicationRequest """ - html_template: Optional[str] = field( + html_template: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HtmlTemplate"}, ) """HTML template input as a string""" - html_template_url: Optional[str] = field( + html_template_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HtmlTemplateUrl"}, ) """URL to HTML template input""" - operations: Optional[List[HtmlTemplateOperation]] = field( + operations: Optional[List[HtmlTemplateOperation | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Operations"}, ) """Operations to apply to this template""" @@ -3280,21 +3958,24 @@ class HtmlTemplateOperation: Definition: HtmlTemplateOperation """ - action: Optional[int] = field( + action: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Action"}, ) """Operation action to take; possible values are \"Replace\"""" - match_agsint: Optional[str] = field( + match_agsint: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MatchAgsint"}, ) """ For Replace operations, the string to match against (to be replaced with ReplaceWith string) """ - replace_with: Optional[str] = field( + replace_with: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplaceWith"}, ) """ @@ -3308,7 +3989,11 @@ class HtmlToOfficeRequest: Definition: HtmlToOfficeRequest """ - html: Optional[str] = field(default=None, metadata={"wire_name": "Html"}) + html: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Html"}, + ) """HTML to render to Office format""" @@ -3318,8 +4003,9 @@ class HtmlToPdfRequest: Definition: HtmlToPdfRequest """ - extra_loading_wait: Optional[int] = field( + extra_loading_wait: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExtraLoadingWait"}, ) """ @@ -3327,7 +4013,11 @@ class HtmlToPdfRequest: finished loading before taking the screenshot. Can be helpful for highly asynchronous websites. """ - html: Optional[str] = field(default=None, metadata={"wire_name": "Html"}) + html: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Html"}, + ) """HTML to render to PDF""" @@ -3337,8 +4027,9 @@ class HtmlToPngRequest: Definition: HtmlToPngRequest """ - extra_loading_wait: Optional[int] = field( + extra_loading_wait: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExtraLoadingWait"}, ) """ @@ -3346,10 +4037,15 @@ class HtmlToPngRequest: finished loading before taking the screenshot. Can be helpful for highly asynchronous websites. """ - html: Optional[str] = field(default=None, metadata={"wire_name": "Html"}) + html: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Html"}, + ) """HTML to render to PNG (screenshot)""" - screenshot_height: Optional[int] = field( + screenshot_height: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ScreenshotHeight"}, ) """ @@ -3357,8 +4053,9 @@ class HtmlToPngRequest: 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot """ - screenshot_width: Optional[int] = field( + screenshot_width: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ScreenshotWidth"}, ) """ @@ -3374,7 +4071,11 @@ class HtmlToTextRequest: Definition: HtmlToTextRequest """ - html: Optional[str] = field(default=None, metadata={"wire_name": "Html"}) + html: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Html"}, + ) """HTML to extract the text from""" @@ -3384,13 +4085,15 @@ class InsertDocxInsertParagraphRequest: Definition: InsertDocxInsertParagraphRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3399,8 +4102,9 @@ class InsertDocxInsertParagraphRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - insert_path: Optional[str] = field( + insert_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InsertPath"}, ) """ @@ -3408,8 +4112,9 @@ class InsertDocxInsertParagraphRequest: InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject """ - insert_placement: Optional[str] = field( + insert_placement: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InsertPlacement"}, ) """ @@ -3420,8 +4125,9 @@ class InsertDocxInsertParagraphRequest: object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object) """ - paragraph_to_insert: Optional[DocxParagraph] = field( + paragraph_to_insert: Optional[DocxParagraph | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ParagraphToInsert"}, ) """Table you would like to insert""" @@ -3433,18 +4139,21 @@ class InsertDocxTableRowRequest: Definition: InsertDocxTableRowRequest """ - existing_table_path: Optional[str] = field( + existing_table_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExistingTablePath"}, ) """Required; the path to the existing table to modify""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3453,8 +4162,9 @@ class InsertDocxTableRowRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - insert_placement: Optional[str] = field( + insert_placement: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InsertPlacement"}, ) """ @@ -3464,8 +4174,9 @@ class InsertDocxTableRowRequest: first row in the table, 1 being the second row in the table, 2 being the third row in the table, etc. to insert this row after """ - row_to_insert: Optional[DocxTableRow] = field( + row_to_insert: Optional[DocxTableRow | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RowToInsert"}, ) """Table you would like to insert""" @@ -3477,13 +4188,15 @@ class InsertDocxTablesRequest: Definition: InsertDocxTablesRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3492,8 +4205,9 @@ class InsertDocxTablesRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - insert_path: Optional[str] = field( + insert_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InsertPath"}, ) """ @@ -3501,8 +4215,9 @@ class InsertDocxTablesRequest: InsertPath field using the Path value from an existing object. Used with InsertPlacement of BeforeExistingObject or AfterExistingObject """ - insert_placement: Optional[str] = field( + insert_placement: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InsertPlacement"}, ) """ @@ -3513,8 +4228,9 @@ class InsertDocxTablesRequest: object), AfterExistingObject (right after an existing object - fill in the InsertPath field using the Path value from an existing object) """ - table_to_insert: Optional[DocxTable] = field( + table_to_insert: Optional[DocxTable | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableToInsert"}, ) """Table you would like to insert""" @@ -3526,13 +4242,15 @@ class InsertXlsxWorksheetRequest: Definition: InsertXlsxWorksheetRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3541,8 +4259,9 @@ class InsertXlsxWorksheetRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - worksheet_to_insert: Optional[XlsxWorksheet] = field( + worksheet_to_insert: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetToInsert"}, ) """Workersheet to insert""" @@ -3554,18 +4273,21 @@ class MultipageImageFormatConversionResult: Definition: MultipageImageFormatConversionResult """ - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PageCount"}, ) """The number of pages in the converted output""" - pages: Optional[List[PageConversionResult]] = field( + pages: Optional[List[PageConversionResult | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Pages"}, ) """Converted page results""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" @@ -3577,13 +4299,15 @@ class PageConversionResult: Definition: PageConversionResult """ - file_bytes: Optional[str] = field( + file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileBytes"}, ) """File bytes (contents) of the image in converted file format""" - filename: Optional[str] = field( + filename: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Filename"}, ) """File name of the image in the converted file format""" @@ -3595,63 +4319,78 @@ class PdfAnnotation: Definition: PdfAnnotation """ - annotation_index: Optional[int] = field( + annotation_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AnnotationIndex"}, ) """The 0-based index of the annotation in the document""" - annotation_type: Optional[str] = field( + annotation_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AnnotationType"}, ) """Type of the annotation; possible values are Text""" - creation_date: Optional[str] = field( + creation_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreationDate"}, ) """Date that the annotation was created""" - height: Optional[float] = field( + height: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Height"}, ) """Height of the annotation""" - left_x: Optional[float] = field( + left_x: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LeftX"}, ) """Left X coordinate for the location of the annotation""" - modified_date: Optional[str] = field( + modified_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ModifiedDate"}, ) """Date that the annotation was last modified""" - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PageNumber"}, ) """The 1-based index of the page containing the annotation""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Subject of the annotation""" - text_contents: Optional[str] = field( + text_contents: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContents"}, ) """Text contents of the annotation""" - title: Optional[str] = field(default=None, metadata={"wire_name": "Title"}) + title: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Title"}, + ) """ Title of the annotation; this is often the author of the annotation in Acrobat-created PDF files """ - top_y: Optional[float] = field( + top_y: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TopY"}, ) """Top Y coordination of the location of the annotation""" - width: Optional[float] = field( + width: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Width"}, ) """Width of the annotation""" @@ -3663,8 +4402,9 @@ class PdfDocument: Definition: PdfDocument """ - document_contents: Optional[str] = field( + document_contents: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DocumentContents"}, ) """ @@ -3672,12 +4412,17 @@ class PdfDocument: document; otherwise will be set to null and the document contents will be available via the URL parameter """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PageNumber"}, ) """Page number of the converted page, starting with 1 for the first page""" - u_r_l: Optional[str] = field(default=None, metadata={"wire_name": "URL"}) + u_r_l: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "URL"}, + ) """ URL to the PDF file of this worksheet; file is stored in an in-memory cache and will be deleted @@ -3690,21 +4435,24 @@ class PdfFormField: Definition: PdfFormField """ - field_combo_box_selected_index: Optional[int] = field( + field_combo_box_selected_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FieldComboBoxSelectedIndex"}, ) """ Applies to ComboBox field types only; specifies the selected index of the combo box selection if available """ - field_name: Optional[str] = field( + field_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FieldName"}, ) """Name of the form field""" - field_type: Optional[str] = field( + field_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FieldType"}, ) """ @@ -3712,8 +4460,9 @@ class PdfFormField: string), Checkbox (FieldValue can be \"true\" or \"false\"), ComboBox (FieldComboBoxSelectedIndex will also be populated), Other """ - field_value: Optional[str] = field( + field_value: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FieldValue"}, ) """Value of the form field""" @@ -3725,13 +4474,15 @@ class PdfFormFields: Definition: PdfFormFields """ - form_fields: Optional[List[PdfFormField]] = field( + form_fields: Optional[List[PdfFormField | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FormFields"}, ) """Fields and field values found in the form""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -3743,56 +4494,68 @@ class PdfMetadata: Definition: PdfMetadata """ - author: Optional[str] = field( + author: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Author"}, ) """ User name of the creator/author of the document, if available, null if not available """ - creator: Optional[str] = field( + creator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Creator"}, ) """Creator of the document""" - date_created: Optional[str] = field( + date_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateCreated"}, ) """ The timestamp that the document was created, if available, null if not available """ - date_modified: Optional[str] = field( + date_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) """ The timestamp that the document was last modified, if available, null if not available """ - keywords: Optional[str] = field( + keywords: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Keywords"}, ) """Keywords of the document""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PageCount"}, ) """The number of pages in the document""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Subject of the document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" - title: Optional[str] = field(default=None, metadata={"wire_name": "Title"}) + title: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Title"}, + ) """Title of the document""" @@ -3802,13 +4565,15 @@ class PdfPageText: Definition: PdfPageText """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PageNumber"}, ) """Page number of the page (1-based)""" - page_text: Optional[str] = field( + page_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PageText"}, ) """Text of the page""" @@ -3820,13 +4585,15 @@ class PdfTextByPageResult: Definition: PdfTextByPageResult """ - pages: Optional[List[PdfPageText]] = field( + pages: Optional[List[PdfPageText | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Pages"}, ) """Pages in the PDF""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -3838,13 +4605,15 @@ class PdfToPngResult: Definition: PdfToPngResult """ - png_result_pages: Optional[List[ConvertedPngPage]] = field( + png_result_pages: Optional[List[ConvertedPngPage | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PngResultPages"}, ) """Array of converted pages""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -3856,20 +4625,26 @@ class PresentationResult: Definition: PresentationResult """ - presentation_contents: Optional[str] = field( + presentation_contents: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PresentationContents"}, ) """Contents of the presentation in bytes""" - slide_number: Optional[int] = field( + slide_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SlideNumber"}, ) """ Worksheet number of the converted page, starting with 1 for the left-most worksheet """ - u_r_l: Optional[str] = field(default=None, metadata={"wire_name": "URL"}) + u_r_l: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "URL"}, + ) """ URL to the PPTX file of this slide; file is stored in an in-memory cache and will be deleted @@ -3882,13 +4657,15 @@ class RemoveDocxHeadersAndFootersRequest: Definition: RemoveDocxHeadersAndFootersRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3897,16 +4674,18 @@ class RemoveDocxHeadersAndFootersRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - remove_footers: Optional[bool] = field( + remove_footers: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RemoveFooters"}, ) """ True if you would like to remove all footers from the input document, false otherwise """ - remove_headers: Optional[bool] = field( + remove_headers: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RemoveHeaders"}, ) """ @@ -3921,18 +4700,21 @@ class RemoveDocxPagesRequest: Definition: RemoveDocxPagesRequest """ - end_delete_page_number: Optional[int] = field( + end_delete_page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndDeletePageNumber"}, ) """Page number (1-based) to stop deleting pages; inclusive""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -3941,8 +4723,9 @@ class RemoveDocxPagesRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - start_delete_page_number: Optional[int] = field( + start_delete_page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDeletePageNumber"}, ) """Page number (1-based) to start deleting pages; inclusive""" @@ -3954,8 +4737,9 @@ class RemoveHtmlFromTextRequest: Definition: RemoveHtmlFromTextRequest """ - text_containing_html: Optional[str] = field( + text_containing_html: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContainingHtml"}, ) """Input text string to remove the HTML from""" @@ -3967,13 +4751,15 @@ class RemoveHtmlFromTextResponse: Definition: RemoveHtmlFromTextResponse """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - text_content_result: Optional[str] = field( + text_content_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContentResult"}, ) """Result of performing a remove HTML from string operation""" @@ -3985,18 +4771,21 @@ class RemovePptxSlidesRequest: Definition: RemovePptxSlidesRequest """ - end_delete_slide_number: Optional[int] = field( + end_delete_slide_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndDeleteSlideNumber"}, ) """Slide number (1-based) to stop deleting slides; inclusive""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -4005,8 +4794,9 @@ class RemovePptxSlidesRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - start_delete_slide_number: Optional[int] = field( + start_delete_slide_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDeleteSlideNumber"}, ) """Slide number (1-based) to start deleting slides; inclusive""" @@ -4018,8 +4808,9 @@ class RemoveWhitespaceFromTextRequest: Definition: RemoveWhitespaceFromTextRequest """ - text_containing_whitespace: Optional[str] = field( + text_containing_whitespace: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContainingWhitespace"}, ) """Input text string to remove the whitespace from""" @@ -4031,13 +4822,15 @@ class RemoveWhitespaceFromTextResponse: Definition: RemoveWhitespaceFromTextResponse """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - text_content_result: Optional[str] = field( + text_content_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContentResult"}, ) """Result of performing a remove whitespace from string operation""" @@ -4049,13 +4842,15 @@ class RemoveXlsxWorksheetRequest: Definition: RemoveXlsxWorksheetRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -4064,8 +4859,9 @@ class RemoveXlsxWorksheetRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - worksheet_to_remove: Optional[XlsxWorksheet] = field( + worksheet_to_remove: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetToRemove"}, ) """ @@ -4081,24 +4877,27 @@ class ReplaceStringRegexRequest: Definition: ReplaceStringRegexRequest """ - regular_expression_string: Optional[str] = field( + regular_expression_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RegularExpressionString"}, ) """ Target input regular expression (regex) string to match and be replaced; supports all regular expression values """ - replace_with_string: Optional[str] = field( + replace_with_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplaceWithString"}, ) """ Replacement for target string; supports referencing indexed regex matched values from RegularExpressionString, such as $1, $2, and so on """ - text_content: Optional[str] = field( + text_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContent"}, ) """Input text content""" @@ -4110,13 +4909,15 @@ class ReplaceStringRegexResponse: Definition: ReplaceStringRegexResponse """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - text_content_result: Optional[str] = field( + text_content_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContentResult"}, ) """Result of performing a base 64 decode operation, binary file content""" @@ -4128,13 +4929,15 @@ class ReplaceStringRequest: Definition: ReplaceStringRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -4143,18 +4946,21 @@ class ReplaceStringRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - match_case: Optional[bool] = field( + match_case: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MatchCase"}, ) """True if the case should be matched, false for case insensitive match""" - match_string: Optional[str] = field( + match_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MatchString"}, ) """String to search for and match against, to be replaced""" - replace_string: Optional[str] = field( + replace_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplaceString"}, ) """String to replace the matched values with""" @@ -4166,18 +4972,21 @@ class ReplaceStringSimpleRequest: Definition: ReplaceStringSimpleRequest """ - replace_with_string: Optional[str] = field( + replace_with_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplaceWithString"}, ) """Replacement for target string""" - target_string: Optional[str] = field( + target_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TargetString"}, ) """Target input string to match and be replaced""" - text_content: Optional[str] = field( + text_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContent"}, ) """Input text content""" @@ -4189,13 +4998,15 @@ class ReplaceStringSimpleResponse: Definition: ReplaceStringSimpleResponse """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - text_content_result: Optional[str] = field( + text_content_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextContentResult"}, ) """Result of performing a replace string operation""" @@ -4207,8 +5018,9 @@ class ScreenshotRequest: Definition: ScreenshotRequest """ - extra_loading_wait: Optional[int] = field( + extra_loading_wait: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExtraLoadingWait"}, ) """ @@ -4217,8 +5029,9 @@ class ScreenshotRequest: asynchronous websites. Provide a value of 0 for the default of 5000 milliseconds (5 seconds) """ - screenshot_height: Optional[int] = field( + screenshot_height: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ScreenshotHeight"}, ) """ @@ -4226,15 +5039,20 @@ class ScreenshotRequest: 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot """ - screenshot_width: Optional[int] = field( + screenshot_width: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ScreenshotWidth"}, ) """ Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024 """ - url: Optional[str] = field(default=None, metadata={"wire_name": "Url"}) + url: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Url"}, + ) """ URL address of the website to screenshot. HTTP and HTTPS are both supported, as are custom ports. @@ -4247,29 +5065,33 @@ class SetFormFieldValue: Definition: SetFormFieldValue """ - checkbox_value: Optional[bool] = field( + checkbox_value: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckboxValue"}, ) """For fields of type Checkbox, the value to put into the field""" - combo_box_selected_index: Optional[int] = field( + combo_box_selected_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ComboBoxSelectedIndex"}, ) """ For fields of type ComboBox; specifies the selected index of the combo box selection """ - field_name: Optional[str] = field( + field_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FieldName"}, ) """ Name of the field to set; you can call /convert/edit/pdf/form/get-fields to enumerate field names in a form """ - text_value: Optional[str] = field( + text_value: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextValue"}, ) """For fields of type Text, the text value to put into the field""" @@ -4281,13 +5103,15 @@ class SetPdfFormFieldsRequest: Definition: SetPdfFormFieldsRequest """ - field_values: Optional[List[SetFormFieldValue]] = field( + field_values: Optional[List[SetFormFieldValue | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FieldValues"}, ) """Field values to set""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Contents of the input file to set the fields on""" @@ -4299,13 +5123,15 @@ class SetPdfMetadataRequest: Definition: SetPdfMetadataRequest """ - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Input file contents bytes for the file to modify""" - metadata_to_set: Optional[PdfMetadata] = field( + metadata_to_set: Optional[PdfMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MetadataToSet"}, ) """PDF metadata to set on the file""" @@ -4317,25 +5143,29 @@ class SetXlsxCellByIdentifierRequest: Definition: SetXlsxCellByIdentifierRequest """ - cell_identifier: Optional[str] = field( + cell_identifier: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellIdentifier"}, ) """ The Excel cell identifier (e.g. A1, B2, C33, etc.) of the cell to update """ - cell_value: Optional[XlsxSpreadsheetCell] = field( + cell_value: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellValue"}, ) """New Cell value to update/overwrite into the Excel XLSX spreadsheet""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -4344,8 +5174,9 @@ class SetXlsxCellByIdentifierRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - worksheet_to_update: Optional[XlsxWorksheet] = field( + worksheet_to_update: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetToUpdate"}, ) """ @@ -4360,23 +5191,27 @@ class SetXlsxCellRequest: Definition: SetXlsxCellRequest """ - cell_index: Optional[int] = field( + cell_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellIndex"}, ) """0-based index of the cell, 0, 1, 2, ... in the row to set""" - cell_value: Optional[XlsxSpreadsheetCell] = field( + cell_value: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellValue"}, ) """New Cell value to update/overwrite into the Excel XLSX spreadsheet""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -4385,13 +5220,15 @@ class SetXlsxCellRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - row_index: Optional[int] = field( + row_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RowIndex"}, ) """0-based index of the row, 0, 1, 2, ... to set""" - worksheet_to_update: Optional[XlsxWorksheet] = field( + worksheet_to_update: Optional[XlsxWorksheet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetToUpdate"}, ) """ @@ -4406,17 +5243,23 @@ class SplitDocumentResult: Definition: SplitDocumentResult """ - document_contents: Optional[str] = field( + document_contents: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DocumentContents"}, ) """Contents of the document in bytes""" - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PageNumber"}, ) """Page number of the converted page, starting with 1 for the first page""" - u_r_l: Optional[str] = field(default=None, metadata={"wire_name": "URL"}) + u_r_l: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "URL"}, + ) """ URL to the DOCX file of this slide; file is stored in an in-memory cache and will be deleted @@ -4429,12 +5272,16 @@ class SplitDocxDocumentResult: Definition: SplitDocxDocumentResult """ - result_documents: Optional[List[SplitDocumentResult]] = field( + result_documents: Optional[ + List[SplitDocumentResult | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultDocuments"}, ) - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -4446,13 +5293,15 @@ class SplitPdfResult: Definition: SplitPdfResult """ - documents: Optional[List[PdfDocument]] = field( + documents: Optional[List[PdfDocument | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Documents"}, ) """PDF documents as output""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -4464,12 +5313,16 @@ class SplitPptxPresentationResult: Definition: SplitPptxPresentationResult """ - result_presentations: Optional[List[PresentationResult]] = field( + result_presentations: Optional[ + List[PresentationResult | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultPresentations"}, ) - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -4481,17 +5334,20 @@ class SplitTextDocumentByLinesResult: Definition: SplitTextDocumentByLinesResult """ - line_count: Optional[int] = field( + line_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LineCount"}, ) """The count of lines in the text file""" - result_lines: Optional[List[TextDocumentLine]] = field( + result_lines: Optional[List[TextDocumentLine | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultLines"}, ) - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -4503,17 +5359,22 @@ class SplitTextDocumentByStringResult: Definition: SplitTextDocumentByStringResult """ - element_count: Optional[int] = field( + element_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ElementCount"}, ) """The count of elements in the text file""" - result_elements: Optional[List[TextDocumentElement]] = field( + result_elements: Optional[ + List[TextDocumentElement | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultElements"}, ) - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -4525,12 +5386,14 @@ class SplitXlsxWorksheetResult: Definition: SplitXlsxWorksheetResult """ - result_worksheets: Optional[List[WorksheetResult]] = field( + result_worksheets: Optional[List[WorksheetResult | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultWorksheets"}, ) - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -4542,13 +5405,15 @@ class TextConversionResult: Definition: TextConversionResult """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" - text_result: Optional[str] = field( + text_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextResult"}, ) """ @@ -4563,13 +5428,15 @@ class TextDocumentElement: Definition: TextDocumentElement """ - element_contents: Optional[str] = field( + element_contents: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ElementContents"}, ) """The text contents of a single element of a text file""" - element_number: Optional[int] = field( + element_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ElementNumber"}, ) """The 1-based line index of the element""" @@ -4581,13 +5448,15 @@ class TextDocumentLine: Definition: TextDocumentLine """ - line_contents: Optional[str] = field( + line_contents: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LineContents"}, ) """The text contents of a single line of a text file""" - line_number: Optional[int] = field( + line_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LineNumber"}, ) """The 1-based line index of the line""" @@ -4599,13 +5468,15 @@ class TextEncodingDetectResponse: Definition: TextEncodingDetectResponse """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if successful, false otherwise""" - text_encoding: Optional[str] = field( + text_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextEncoding"}, ) """ @@ -4620,23 +5491,27 @@ class UpdateDocxTableCellRequest: Definition: UpdateDocxTableCellRequest """ - cell_to_update: Optional[DocxTableCell] = field( + cell_to_update: Optional[DocxTableCell | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellToUpdate"}, ) """Table cell contents you would like to update the cell with""" - existing_table_path: Optional[str] = field( + existing_table_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExistingTablePath"}, ) """Required; the path to the existing table to modify""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -4645,13 +5520,15 @@ class UpdateDocxTableCellRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - table_cell_index: Optional[int] = field( + table_cell_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableCellIndex"}, ) """0-based index of the Table Cell (within the row) to update""" - table_row_index: Optional[int] = field( + table_row_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableRowIndex"}, ) """0-based index of the Table Row to update""" @@ -4663,18 +5540,21 @@ class UpdateDocxTableRowRequest: Definition: UpdateDocxTableRowRequest """ - existing_table_path: Optional[str] = field( + existing_table_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExistingTablePath"}, ) """Required; the path to the existing table to modify""" - input_file_bytes: Optional[str] = field( + input_file_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileBytes"}, ) """Optional: Bytes of the input file to operate on""" - input_file_url: Optional[str] = field( + input_file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InputFileUrl"}, ) """ @@ -4683,13 +5563,15 @@ class UpdateDocxTableRowRequest: the secure URL result from that operation as the URL here (this URL is not public). """ - row_to_update: Optional[DocxTableRow] = field( + row_to_update: Optional[DocxTableRow | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RowToUpdate"}, ) """Table row contents you would like to update the row with""" - table_row_index: Optional[int] = field( + table_row_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableRowIndex"}, ) """0-based index of the Table Row to update""" @@ -4701,7 +5583,11 @@ class UrlToTextRequest: Definition: UrlToTextRequest """ - url: Optional[str] = field(default=None, metadata={"wire_name": "Url"}) + url: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Url"}, + ) """URL of the website to extract the text from""" @@ -4711,12 +5597,14 @@ class ViewerResponse: Definition: ViewerResponse """ - html_embed: Optional[str] = field( + html_embed: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HtmlEmbed"}, ) - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) @@ -4727,23 +5615,30 @@ class WorksheetResult: Definition: WorksheetResult """ - u_r_l: Optional[str] = field(default=None, metadata={"wire_name": "URL"}) + u_r_l: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "URL"}, + ) """ URL to the XLSX file of this worksheet; file is stored in an in-memory cache and will be deleted """ - worksheet_contents: Optional[str] = field( + worksheet_contents: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetContents"}, ) """Contents of the worksheet in bytes""" - worksheet_name: Optional[str] = field( + worksheet_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetName"}, ) """The name of the worksheet""" - worksheet_number: Optional[int] = field( + worksheet_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetNumber"}, ) """ @@ -4758,30 +5653,38 @@ class XlsxImage: Definition: XlsxImage """ - image_contents_u_r_l: Optional[str] = field( + image_contents_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageContentsURL"}, ) """ URL to the image contents; file is stored in an in-memory cache and will be deleted. Call Finish-Editing to get the contents. """ - image_data_content_type: Optional[str] = field( + image_data_content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageDataContentType"}, ) """Read-only; image data MIME content-type""" - image_data_embed_id: Optional[str] = field( + image_data_embed_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageDataEmbedId"}, ) """Read-only; internal ID for the image contents""" - image_internal_file_name: Optional[str] = field( + image_internal_file_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageInternalFileName"}, ) """Read-only; internal file name/path for the image""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new rows""" @@ -4791,24 +5694,32 @@ class XlsxSpreadsheetCell: Definition: XlsxSpreadsheetCell """ - cell_identifier: Optional[str] = field( + cell_identifier: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CellIdentifier"}, ) """Cell reference of the cell, e.g. A1, Z22, etc.""" - formula: Optional[str] = field( + formula: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Formula"}, ) - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new rows""" - style_index: Optional[int] = field( + style_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StyleIndex"}, ) """Identifier for the style to apply to this style""" - text_value: Optional[str] = field( + text_value: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TextValue"}, ) """Text value of the cell""" @@ -4820,12 +5731,17 @@ class XlsxSpreadsheetColumn: Definition: XlsxSpreadsheetColumn """ - heading_cell: Optional[XlsxSpreadsheetCell] = field( + heading_cell: Optional[XlsxSpreadsheetCell | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HeadingCell"}, ) """Heading cell for this column""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new rows""" @@ -4835,12 +5751,17 @@ class XlsxSpreadsheetRow: Definition: XlsxSpreadsheetRow """ - cells: Optional[List[XlsxSpreadsheetCell]] = field( + cells: Optional[List[XlsxSpreadsheetCell | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Cells"}, ) """Spreadsheet Cells in the spreadsheet row""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The Path of the location of this object; leave blank for new rows""" @@ -4850,12 +5771,17 @@ class XlsxWorksheet: Definition: XlsxWorksheet """ - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """ The Path of the location of this object; leave blank for new worksheets """ - worksheet_name: Optional[str] = field( + worksheet_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorksheetName"}, ) """User-facing name of the worksheet tab""" @@ -4867,18 +5793,21 @@ class XmlAddAttributeWithXPathResult: Definition: XmlAddAttributeWithXPathResult """ - nodes_edited_count: Optional[int] = field( + nodes_edited_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NodesEditedCount"}, ) """Count of the matching results""" - resulting_xml_document: Optional[str] = field( + resulting_xml_document: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultingXmlDocument"}, ) """Resulting, modified XML document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -4890,18 +5819,21 @@ class XmlAddChildWithXPathResult: Definition: XmlAddChildWithXPathResult """ - nodes_edited_count: Optional[int] = field( + nodes_edited_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NodesEditedCount"}, ) """Count of the matching results""" - resulting_xml_document: Optional[str] = field( + resulting_xml_document: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultingXmlDocument"}, ) """Resulting, modified XML document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -4913,18 +5845,21 @@ class XmlFilterWithXPathResult: Definition: XmlFilterWithXPathResult """ - result_count: Optional[int] = field( + result_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultCount"}, ) """Count of the matching results""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" - xml_nodes: Optional[List[str]] = field( + xml_nodes: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "XmlNodes"}, ) """Matching selected XML nodes as strings""" @@ -4936,18 +5871,21 @@ class XmlQueryWithXQueryMultiResult: Definition: XmlQueryWithXQueryMultiResult """ - error_message: Optional[str] = field( + error_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ErrorMessage"}, ) """If an error occurs, additional details on the error""" - resulting_xml: Optional[str] = field( + resulting_xml: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultingXml"}, ) """Resulting XML result output""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -4959,18 +5897,21 @@ class XmlQueryWithXQueryResult: Definition: XmlQueryWithXQueryResult """ - error_message: Optional[str] = field( + error_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ErrorMessage"}, ) """If an error occurs, additional details on the error""" - resulting_xml: Optional[str] = field( + resulting_xml: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultingXml"}, ) """Resulting XML result output""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -4982,18 +5923,21 @@ class XmlRemoveAllChildrenWithXPathResult: Definition: XmlRemoveAllChildrenWithXPathResult """ - nodes_edited_count: Optional[int] = field( + nodes_edited_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NodesEditedCount"}, ) """Count of the matching results""" - resulting_xml_document: Optional[str] = field( + resulting_xml_document: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultingXmlDocument"}, ) """Resulting, modified XML document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -5005,25 +5949,29 @@ class XmlRemoveWithXPathResult: Definition: XmlRemoveWithXPathResult """ - nodes_removed_count: Optional[int] = field( + nodes_removed_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NodesRemovedCount"}, ) """Count of the matching results""" - resulting_xml_document: Optional[str] = field( + resulting_xml_document: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultingXmlDocument"}, ) """ Resulting, modified XML document with matching nodes removed as a string """ - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" - xml_nodes_removed: Optional[List[str]] = field( + xml_nodes_removed: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "XmlNodesRemoved"}, ) """Matching selected XML nodes as strings""" @@ -5035,18 +5983,21 @@ class XmlReplaceWithXPathResult: Definition: XmlReplaceWithXPathResult """ - nodes_edited_count: Optional[int] = field( + nodes_edited_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NodesEditedCount"}, ) """Count of the matching results""" - resulting_xml_document: Optional[str] = field( + resulting_xml_document: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultingXmlDocument"}, ) """Resulting, modified XML document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -5058,18 +6009,21 @@ class XmlSetValueWithXPathResult: Definition: XmlSetValueWithXPathResult """ - nodes_edited_count: Optional[int] = field( + nodes_edited_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NodesEditedCount"}, ) """Count of the matching results""" - resulting_xml_document: Optional[str] = field( + resulting_xml_document: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultingXmlDocument"}, ) """Resulting, modified XML document""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -5081,18 +6035,23 @@ class ZipDirectory: Definition: ZipDirectory """ - directories_in_directory: Optional[List[ZipDirectory]] = field( + directories_in_directory: Optional[ + List[ZipDirectory | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DirectoriesInDirectory"}, ) """Child directories contained directly in this directory""" - directory_name: Optional[str] = field( + directory_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DirectoryName"}, ) """Name of this directory""" - files_in_directory: Optional[List[ZipFile]] = field( + files_in_directory: Optional[List[ZipFile | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FilesInDirectory"}, ) """Child files contained directly in this directory""" @@ -5104,21 +6063,24 @@ class ZipExtractResponse: Definition: ZipExtractResponse """ - directories_in_zip: Optional[List[ZipDirectory]] = field( + directories_in_zip: Optional[List[ZipDirectory | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DirectoriesInZip"}, ) """ Top-level directories in the root directory of the zip; directories can contain sub-directories and files """ - files_in_zip: Optional[List[ZipFile]] = field( + files_in_zip: Optional[List[ZipFile | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FilesInZip"}, ) """Top-level files in the root directory fo the zip file""" - successful: Optional[bool] = field( + successful: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Successful"}, ) """True if the operation was successful, false otherwise""" @@ -5130,13 +6092,15 @@ class ZipFile: Definition: ZipFile """ - file_contents: Optional[str] = field( + file_contents: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileContents"}, ) """Contents of this file""" - file_name: Optional[str] = field( + file_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileName"}, ) """Name of this file""" @@ -5153,7 +6117,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -5170,8 +6134,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -5192,7 +6156,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -5207,9 +6171,9 @@ def __init__( def connector_name(self) -> str: return "cloudmersiveconvert" - async def edit_document_docx_create_blank_document_async( + async def edit_document_docx_create_blank_document( self, - input: CreateBlankDocxRequest, + input: CreateBlankDocxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5222,12 +6186,28 @@ async def edit_document_docx_create_blank_document_async( Returns a blank Word DOCX Document format file. The file is blank, with no contents. Use additional editing commands such as Insert Paragraph or Insert Table or Insert Image to populate the document. + + Swagger operation ID: `EditDocument_DocxCreateBlankDocument`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/create/blank" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5241,6 +6221,7 @@ async def edit_document_docx_create_blank_document_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5248,9 +6229,9 @@ async def edit_document_docx_create_blank_document_async( return json.loads(response.text) - async def edit_document_docx_delete_pages_async( + async def edit_document_docx_delete_pages( self, - input: RemoveDocxPagesRequest, + input: RemoveDocxPagesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5262,12 +6243,28 @@ async def edit_document_docx_delete_pages_async( Returns the edited Word Document in the Word Document (DOCX) format file with the specified pages removed + + Swagger operation ID: `EditDocument_DocxDeletePages`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/delete-pages" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5281,13 +6278,14 @@ async def edit_document_docx_delete_pages_async( request_url, response.status, response.text, + response=response, ) return response.content - async def edit_document_docx_delete_table_row_async( + async def edit_document_docx_delete_table_row( self, - input: DeleteDocxTableRowRequest, + input: DeleteDocxTableRowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5299,13 +6297,29 @@ async def edit_document_docx_delete_table_row_async( Deletes an existing table row in a Word DOCX Document and returns the result. + + Swagger operation ID: `EditDocument_DocxDeleteTableRow`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/delete-table-row" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5319,6 +6333,7 @@ async def edit_document_docx_delete_table_row_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5326,9 +6341,9 @@ async def edit_document_docx_delete_table_row_async( return json.loads(response.text) - async def edit_document_docx_delete_table_row_range_async( + async def edit_document_docx_delete_table_row_range( self, - input: DeleteDocxTableRowRangeRequest, + input: DeleteDocxTableRowRangeRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5340,13 +6355,29 @@ async def edit_document_docx_delete_table_row_range_async( Deletes a range of 1 or more existing table rows in a Word DOCX Document and returns the result. + + Swagger operation ID: `EditDocument_DocxDeleteTableRowRange`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/delete-table-row/range" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5360,6 +6391,7 @@ async def edit_document_docx_delete_table_row_range_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5367,9 +6399,9 @@ async def edit_document_docx_delete_table_row_range_async( return json.loads(response.text) - async def edit_document_docx_body_async( + async def edit_document_docx_body( self, - input: GetDocxBodyRequest, + input: GetDocxBodyRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5381,12 +6413,28 @@ async def edit_document_docx_body_async( Returns the body defined in the Word Document (DOCX) format file; this is the main content part of a DOCX document + + Swagger operation ID: `EditDocument_DocxBody`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/get-body" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5400,6 +6448,7 @@ async def edit_document_docx_body_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5407,9 +6456,9 @@ async def edit_document_docx_body_async( return json.loads(response.text) - async def edit_document_docx_get_comments_hierarchical_async( + async def edit_document_docx_get_comments_hierarchical( self, - input: GetDocxGetCommentsHierarchicalRequest, + input: GetDocxGetCommentsHierarchicalRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5422,13 +6471,29 @@ async def edit_document_docx_get_comments_hierarchical_async( Returns the comments and review annotations stored in the Word Document (DOCX) format file hierarchically, where reply comments are nested as children under top-level comments in the results returned. + + Swagger operation ID: `EditDocument_DocxGetCommentsHierarchical`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/get-comments/hierarchical" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5442,6 +6507,7 @@ async def edit_document_docx_get_comments_hierarchical_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5449,9 +6515,9 @@ async def edit_document_docx_get_comments_hierarchical_async( return json.loads(response.text) - async def edit_document_docx_get_headers_and_footers_async( + async def edit_document_docx_get_headers_and_footers( self, - input: GetDocxHeadersAndFootersRequest, + input: GetDocxHeadersAndFootersRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5462,13 +6528,29 @@ async def edit_document_docx_get_headers_and_footers_async( Get content of a footer from a Word DOCX document Returns the footer content from a Word Document (DOCX) format file + + Swagger operation ID: `EditDocument_DocxGetHeadersAndFooters`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/get-headers-and-footers" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5482,6 +6564,7 @@ async def edit_document_docx_get_headers_and_footers_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5489,9 +6572,9 @@ async def edit_document_docx_get_headers_and_footers_async( return json.loads(response.text) - async def edit_document_docx_get_images_async( + async def edit_document_docx_get_images( self, - input: GetDocxImagesRequest, + input: GetDocxImagesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5502,12 +6585,28 @@ async def edit_document_docx_get_images_async( Get images from a Word DOCX document Returns the images defined in the Word Document (DOCX) format file + + Swagger operation ID: `EditDocument_DocxGetImages`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/get-images" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5521,6 +6620,7 @@ async def edit_document_docx_get_images_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5528,9 +6628,9 @@ async def edit_document_docx_get_images_async( return json.loads(response.text) - async def edit_document_docx_pages_async( + async def edit_document_docx_pages( self, - input: GetDocxPagesRequest, + input: GetDocxPagesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5542,12 +6642,28 @@ async def edit_document_docx_pages_async( Returns the pages and contents of each page defined in the Word Document (DOCX) format file + + Swagger operation ID: `EditDocument_DocxPages`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/get-pages" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5561,6 +6677,7 @@ async def edit_document_docx_pages_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5568,9 +6685,9 @@ async def edit_document_docx_pages_async( return json.loads(response.text) - async def edit_document_docx_get_sections_async( + async def edit_document_docx_get_sections( self, - input: GetDocxSectionsRequest, + input: GetDocxSectionsRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5581,12 +6698,28 @@ async def edit_document_docx_get_sections_async( Get sections from a Word DOCX document Returns the sections defined in the Word Document (DOCX) format file + + Swagger operation ID: `EditDocument_DocxGetSections`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/get-sections" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5600,6 +6733,7 @@ async def edit_document_docx_get_sections_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5607,9 +6741,9 @@ async def edit_document_docx_get_sections_async( return json.loads(response.text) - async def edit_document_docx_get_styles_async( + async def edit_document_docx_get_styles( self, - input: GetDocxStylesRequest, + input: GetDocxStylesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5620,12 +6754,28 @@ async def edit_document_docx_get_styles_async( Get styles from a Word DOCX document Returns the styles defined in the Word Document (DOCX) format file + + Swagger operation ID: `EditDocument_DocxGetStyles`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/get-styles" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5639,6 +6789,7 @@ async def edit_document_docx_get_styles_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5646,9 +6797,9 @@ async def edit_document_docx_get_styles_async( return json.loads(response.text) - async def edit_document_docx_get_table_row_async( + async def edit_document_docx_get_table_row( self, - input: GetDocxTableRowRequest, + input: GetDocxTableRowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5660,12 +6811,28 @@ async def edit_document_docx_get_table_row_async( Gets the contents of an existing table row in a Word DOCX Document and returns the result. + + Swagger operation ID: `EditDocument_DocxGetTableRow`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/get-table-row" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5679,6 +6846,7 @@ async def edit_document_docx_get_table_row_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5686,9 +6854,9 @@ async def edit_document_docx_get_table_row_async( return json.loads(response.text) - async def edit_document_docx_get_table_by_index_async( + async def edit_document_docx_get_table_by_index( self, - input: GetDocxTableByIndexRequest, + input: GetDocxTableByIndexRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5700,13 +6868,29 @@ async def edit_document_docx_get_table_by_index_async( Returns the specific table object by its 0-based index in an Office Word Document (DOCX) + + Swagger operation ID: `EditDocument_DocxGetTableByIndex`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/get-table/by-index" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5720,6 +6904,7 @@ async def edit_document_docx_get_table_by_index_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5727,9 +6912,9 @@ async def edit_document_docx_get_table_by_index_async( return json.loads(response.text) - async def edit_document_docx_get_tables_async( + async def edit_document_docx_get_tables( self, - input: GetDocxTablesRequest, + input: GetDocxTablesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5740,12 +6925,28 @@ async def edit_document_docx_get_tables_async( Get all tables in Word DOCX document Returns all the table objects in an Office Word Document (docx) + + Swagger operation ID: `EditDocument_DocxGetTables`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/get-tables" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5759,6 +6960,7 @@ async def edit_document_docx_get_tables_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5766,9 +6968,9 @@ async def edit_document_docx_get_tables_async( return json.loads(response.text) - async def edit_document_docx_insert_comment_on_paragraph_async( + async def edit_document_docx_insert_comment_on_paragraph( self, - input: DocxInsertCommentOnParagraphRequest, + input: DocxInsertCommentOnParagraphRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5781,13 +6983,29 @@ async def edit_document_docx_insert_comment_on_paragraph_async( Adds a new comment into a Word DOCX document attached to a paragraph and returns the result. Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxInsertCommentOnParagraph`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/insert-comment/on/paragraph" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5801,6 +7019,7 @@ async def edit_document_docx_insert_comment_on_paragraph_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5808,9 +7027,9 @@ async def edit_document_docx_insert_comment_on_paragraph_async( return json.loads(response.text) - async def edit_document_docx_insert_image_async( + async def edit_document_docx_insert_image( self, - input: DocxInsertImageRequest, + input: DocxInsertImageRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5822,12 +7041,28 @@ async def edit_document_docx_insert_image_async( Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxInsertImage`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/insert-image" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5841,6 +7076,7 @@ async def edit_document_docx_insert_image_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5848,9 +7084,9 @@ async def edit_document_docx_insert_image_async( return json.loads(response.text) - async def edit_document_docx_insert_paragraph_async( + async def edit_document_docx_insert_paragraph( self, - input: InsertDocxInsertParagraphRequest, + input: InsertDocxInsertParagraphRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5864,13 +7100,29 @@ async def edit_document_docx_insert_paragraph_async( at the beginning/end of a document, or before/after an existing object using its Path (location within the document). Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxInsertParagraph`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/insert-paragraph" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5884,6 +7136,7 @@ async def edit_document_docx_insert_paragraph_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5891,9 +7144,9 @@ async def edit_document_docx_insert_paragraph_async( return json.loads(response.text) - async def edit_document_docx_insert_table_async( + async def edit_document_docx_insert_table( self, - input: InsertDocxTablesRequest, + input: InsertDocxTablesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5905,12 +7158,28 @@ async def edit_document_docx_insert_table_async( Adds a new table into a DOCX and returns the result. Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxInsertTable`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/insert-table" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5924,6 +7193,7 @@ async def edit_document_docx_insert_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5931,9 +7201,9 @@ async def edit_document_docx_insert_table_async( return json.loads(response.text) - async def edit_document_docx_insert_table_row_async( + async def edit_document_docx_insert_table_row( self, - input: InsertDocxTableRowRequest, + input: InsertDocxTableRowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5945,13 +7215,29 @@ async def edit_document_docx_insert_table_row_async( Adds a new table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxInsertTableRow`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/insert-table-row" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5965,6 +7251,7 @@ async def edit_document_docx_insert_table_row_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5972,9 +7259,9 @@ async def edit_document_docx_insert_table_row_async( return json.loads(response.text) - async def edit_document_docx_remove_headers_and_footers_async( + async def edit_document_docx_remove_headers_and_footers( self, - input: RemoveDocxHeadersAndFootersRequest, + input: RemoveDocxHeadersAndFootersRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5986,13 +7273,29 @@ async def edit_document_docx_remove_headers_and_footers_async( Remove all headers, or footers, or both from a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxRemoveHeadersAndFooters`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/remove-headers-and-footers" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6006,6 +7309,7 @@ async def edit_document_docx_remove_headers_and_footers_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6013,9 +7317,9 @@ async def edit_document_docx_remove_headers_and_footers_async( return json.loads(response.text) - async def edit_document_docx_remove_object_async( + async def edit_document_docx_remove_object( self, - input: DocxRemoveObjectRequest, + input: DocxRemoveObjectRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6030,12 +7334,28 @@ async def edit_document_docx_remove_object_async( delete. You can call other functions such as Get-Tables, Get-Images, Get-Body, etc. to get the paths of the objects in the document. Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxRemoveObject`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/remove-object" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6049,6 +7369,7 @@ async def edit_document_docx_remove_object_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6056,9 +7377,9 @@ async def edit_document_docx_remove_object_async( return json.loads(response.text) - async def edit_document_docx_replace_async( + async def edit_document_docx_replace( self, - input: ReplaceStringRequest, + input: ReplaceStringRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6069,12 +7390,28 @@ async def edit_document_docx_replace_async( Replace string in Word DOCX document Replace all instances of a string in an Office Word Document (docx) + + Swagger operation ID: `EditDocument_DocxReplace`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/replace-all" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6088,13 +7425,14 @@ async def edit_document_docx_replace_async( request_url, response.status, response.text, + response=response, ) return response.content - async def edit_document_docx_set_footer_async( + async def edit_document_docx_set_footer( self, - input: DocxSetFooterRequest, + input: DocxSetFooterRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6106,12 +7444,28 @@ async def edit_document_docx_set_footer_async( Set the footer in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxSetFooter`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/set-footer" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6125,6 +7479,7 @@ async def edit_document_docx_set_footer_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6132,9 +7487,9 @@ async def edit_document_docx_set_footer_async( return json.loads(response.text) - async def edit_document_docx_set_footer_add_page_number_async( + async def edit_document_docx_set_footer_add_page_number( self, - input: DocxSetFooterAddPageNumberRequest, + input: DocxSetFooterAddPageNumberRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6146,13 +7501,29 @@ async def edit_document_docx_set_footer_add_page_number_async( Set the footer in a Word Document (DOCX) to contain a page number. Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxSetFooterAddPageNumber`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/set-footer/add-page-number" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6166,6 +7537,7 @@ async def edit_document_docx_set_footer_add_page_number_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6173,9 +7545,9 @@ async def edit_document_docx_set_footer_add_page_number_async( return json.loads(response.text) - async def edit_document_docx_set_header_async( + async def edit_document_docx_set_header( self, - input: DocxSetHeaderRequest, + input: DocxSetHeaderRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6187,12 +7559,28 @@ async def edit_document_docx_set_header_async( Set the header in a Word Document (DOCX). Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxSetHeader`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/docx/set-header" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6206,6 +7594,7 @@ async def edit_document_docx_set_header_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6213,9 +7602,9 @@ async def edit_document_docx_set_header_async( return json.loads(response.text) - async def edit_document_docx_update_table_cell_async( + async def edit_document_docx_update_table_cell( self, - input: UpdateDocxTableCellRequest, + input: UpdateDocxTableCellRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6228,13 +7617,29 @@ async def edit_document_docx_update_table_cell_async( Sets the contents of a table cell into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxUpdateTableCell`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/update-table-cell" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6248,6 +7653,7 @@ async def edit_document_docx_update_table_cell_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6255,9 +7661,9 @@ async def edit_document_docx_update_table_cell_async( return json.loads(response.text) - async def edit_document_docx_update_table_row_async( + async def edit_document_docx_update_table_row( self, - input: UpdateDocxTableRowRequest, + input: UpdateDocxTableRowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6271,13 +7677,29 @@ async def edit_document_docx_update_table_row_async( Sets the contents of a table row into a DOCX Document and returns the result. Call Finish Editing on the output URL to complete the operation. + + Swagger operation ID: `EditDocument_DocxUpdateTableRow`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/docx/update-table-row" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6291,6 +7713,7 @@ async def edit_document_docx_update_table_row_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6298,9 +7721,9 @@ async def edit_document_docx_update_table_row_async( return json.loads(response.text) - async def edit_document_finish_editing_async( + async def edit_document_finish_editing( self, - input: FinishEditingRequest, + input: FinishEditingRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6313,12 +7736,28 @@ async def edit_document_finish_editing_async( Once done editing a document, download the result. Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result. + + Swagger operation ID: `EditDocument_FinishEditing`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/finish-editing" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6332,13 +7771,14 @@ async def edit_document_finish_editing_async( request_url, response.status, response.text, + response=response, ) return response.content - async def edit_document_pptx_delete_slides_async( + async def edit_document_pptx_delete_slides( self, - input: RemovePptxSlidesRequest, + input: RemovePptxSlidesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6350,12 +7790,28 @@ async def edit_document_pptx_delete_slides_async( Edits the input PowerPoint PPTX presentation document to remove the specified slides + + Swagger operation ID: `EditDocument_PptxDeleteSlides`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/pptx/delete-slides" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6369,13 +7825,14 @@ async def edit_document_pptx_delete_slides_async( request_url, response.status, response.text, + response=response, ) return response.content - async def edit_document_pptx_replace_async( + async def edit_document_pptx_replace( self, - input: ReplaceStringRequest, + input: ReplaceStringRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6387,12 +7844,28 @@ async def edit_document_pptx_replace_async( Replace all instances of a string in an Office PowerPoint Document (pptx) + + Swagger operation ID: `EditDocument_PptxReplace`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/pptx/replace-all" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6406,13 +7879,14 @@ async def edit_document_pptx_replace_async( request_url, response.status, response.text, + response=response, ) return response.content - async def edit_document_xlsx_clear_cell_by_index_async( + async def edit_document_xlsx_clear_cell_by_index( self, - input: ClearXlsxCellRequest, + input: ClearXlsxCellRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6424,13 +7898,29 @@ async def edit_document_xlsx_clear_cell_by_index_async( Clears, sets to blank, the contents of a specific cell in an Excel XLSX spreadsheet, worksheet + + Swagger operation ID: `EditDocument_XlsxClearCellByIndex`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/xlsx/clear-cell/by-index" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6444,6 +7934,7 @@ async def edit_document_xlsx_clear_cell_by_index_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6451,9 +7942,9 @@ async def edit_document_xlsx_clear_cell_by_index_async( return json.loads(response.text) - async def edit_document_xlsx_create_blank_spreadsheet_async( + async def edit_document_xlsx_create_blank_spreadsheet( self, - input: CreateBlankSpreadsheetRequest, + input: CreateBlankSpreadsheetRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6464,12 +7955,28 @@ async def edit_document_xlsx_create_blank_spreadsheet_async( Create a blank Excel XLSX spreadsheet Returns a blank Excel XLSX Spreadsheet (XLSX) format file + + Swagger operation ID: `EditDocument_XlsxCreateBlankSpreadsheet`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/xlsx/create/blank" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6483,6 +7990,7 @@ async def edit_document_xlsx_create_blank_spreadsheet_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6490,9 +7998,9 @@ async def edit_document_xlsx_create_blank_spreadsheet_async( return json.loads(response.text) - async def edit_document_xlsx_create_spreadsheet_from_data_async( + async def edit_document_xlsx_create_spreadsheet_from_data( self, - input: CreateSpreadsheetFromDataRequest, + input: CreateSpreadsheetFromDataRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6504,13 +8012,29 @@ async def edit_document_xlsx_create_spreadsheet_from_data_async( Returns a new Excel XLSX Spreadsheet (XLSX) format file populated with column and row data specified as input + + Swagger operation ID: `EditDocument_XlsxCreateSpreadsheetFromData`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/xlsx/create/from/data" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6524,6 +8048,7 @@ async def edit_document_xlsx_create_spreadsheet_from_data_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6531,9 +8056,9 @@ async def edit_document_xlsx_create_spreadsheet_from_data_async( return json.loads(response.text) - async def edit_document_xlsx_delete_worksheet_async( + async def edit_document_xlsx_delete_worksheet( self, - input: RemoveXlsxWorksheetRequest, + input: RemoveXlsxWorksheetRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6546,13 +8071,29 @@ async def edit_document_xlsx_delete_worksheet_async( Edits the input Excel XLSX spreadsheet document to remove the specified worksheet (tab). Use the Get Worksheets API to enumerate available worksheets in a spreadsheet. + + Swagger operation ID: `EditDocument_XlsxDeleteWorksheet`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/xlsx/delete-worksheet" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6566,6 +8107,7 @@ async def edit_document_xlsx_delete_worksheet_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6573,9 +8115,9 @@ async def edit_document_xlsx_delete_worksheet_async( return json.loads(response.text) - async def edit_document_xlsx_get_cell_by_identifier_async( + async def edit_document_xlsx_get_cell_by_identifier( self, - input: GetXlsxCellByIdentifierRequest, + input: GetXlsxCellByIdentifierRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6587,13 +8129,29 @@ async def edit_document_xlsx_get_cell_by_identifier_async( Returns the value of a specific cell based on its identifier (e.g. A1, B22, C33, etc.) in the Excel Spreadsheet worksheet + + Swagger operation ID: `EditDocument_XlsxGetCellByIdentifier`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/xlsx/get-cell/by-identifier" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6607,6 +8165,7 @@ async def edit_document_xlsx_get_cell_by_identifier_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6614,9 +8173,9 @@ async def edit_document_xlsx_get_cell_by_identifier_async( return json.loads(response.text) - async def edit_document_xlsx_get_cell_by_index_async( + async def edit_document_xlsx_get_cell_by_index( self, - input: GetXlsxCellRequest, + input: GetXlsxCellRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6628,13 +8187,29 @@ async def edit_document_xlsx_get_cell_by_index_async( Returns the value and definition of a specific cell in a specific row in the Excel Spreadsheet worksheet + + Swagger operation ID: `EditDocument_XlsxGetCellByIndex`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/xlsx/get-cell/by-index" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6648,6 +8223,7 @@ async def edit_document_xlsx_get_cell_by_index_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6655,9 +8231,9 @@ async def edit_document_xlsx_get_cell_by_index_async( return json.loads(response.text) - async def edit_document_xlsx_get_columns_async( + async def edit_document_xlsx_get_columns( self, - input: GetXlsxColumnsRequest, + input: GetXlsxColumnsRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6668,12 +8244,28 @@ async def edit_document_xlsx_get_columns_async( Get rows and cells from a Excel XLSX spreadsheet, worksheet Returns the rows and cells defined in the Excel Spreadsheet worksheet + + Swagger operation ID: `EditDocument_XlsxGetColumns`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/xlsx/get-columns" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6687,6 +8279,7 @@ async def edit_document_xlsx_get_columns_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6694,9 +8287,9 @@ async def edit_document_xlsx_get_columns_async( return json.loads(response.text) - async def edit_document_xlsx_get_images_async( + async def edit_document_xlsx_get_images( self, - input: GetXlsxImagesRequest, + input: GetXlsxImagesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6707,12 +8300,28 @@ async def edit_document_xlsx_get_images_async( Get images from a Excel XLSX spreadsheet, worksheet Returns the images defined in the Excel Spreadsheet worksheet + + Swagger operation ID: `EditDocument_XlsxGetImages`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/xlsx/get-images" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6726,6 +8335,7 @@ async def edit_document_xlsx_get_images_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6733,9 +8343,9 @@ async def edit_document_xlsx_get_images_async( return json.loads(response.text) - async def edit_document_xlsx_get_rows_and_cells_async( + async def edit_document_xlsx_get_rows_and_cells( self, - input: GetXlsxRowsAndCellsRequest, + input: GetXlsxRowsAndCellsRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6746,13 +8356,29 @@ async def edit_document_xlsx_get_rows_and_cells_async( Get rows and cells from a Excel XLSX spreadsheet, worksheet Returns the rows and cells defined in the Excel Spreadsheet worksheet + + Swagger operation ID: `EditDocument_XlsxGetRowsAndCells`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/xlsx/get-rows-and-cells" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6766,6 +8392,7 @@ async def edit_document_xlsx_get_rows_and_cells_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6773,9 +8400,9 @@ async def edit_document_xlsx_get_rows_and_cells_async( return json.loads(response.text) - async def edit_document_xlsx_get_styles_async( + async def edit_document_xlsx_get_styles( self, - input: GetXlsxStylesRequest, + input: GetXlsxStylesRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6786,12 +8413,28 @@ async def edit_document_xlsx_get_styles_async( Get styles from a Excel XLSX spreadsheet, worksheet Returns the style defined in the Excel Spreadsheet + + Swagger operation ID: `EditDocument_XlsxGetStyles`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/xlsx/get-styles" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6805,6 +8448,7 @@ async def edit_document_xlsx_get_styles_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6812,9 +8456,9 @@ async def edit_document_xlsx_get_styles_async( return json.loads(response.text) - async def edit_document_xlsx_get_worksheets_async( + async def edit_document_xlsx_get_worksheets( self, - input: GetXlsxWorksheetsRequest, + input: GetXlsxWorksheetsRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6826,12 +8470,28 @@ async def edit_document_xlsx_get_worksheets_async( Returns the worksheets (tabs) defined in the Excel Spreadsheet (XLSX) format file + + Swagger operation ID: `EditDocument_XlsxGetWorksheets`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/edit/xlsx/get-worksheets" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6845,6 +8505,7 @@ async def edit_document_xlsx_get_worksheets_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6852,9 +8513,9 @@ async def edit_document_xlsx_get_worksheets_async( return json.loads(response.text) - async def edit_document_xlsx_insert_worksheet_async( + async def edit_document_xlsx_insert_worksheet( self, - input: InsertXlsxWorksheetRequest, + input: InsertXlsxWorksheetRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6865,13 +8526,29 @@ async def edit_document_xlsx_insert_worksheet_async( Insert a new worksheet into an Excel XLSX spreadsheet Inserts a new worksheet into an Excel Spreadsheet + + Swagger operation ID: `EditDocument_XlsxInsertWorksheet`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/xlsx/insert-worksheet" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6885,6 +8562,7 @@ async def edit_document_xlsx_insert_worksheet_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6892,9 +8570,9 @@ async def edit_document_xlsx_insert_worksheet_async( return json.loads(response.text) - async def edit_document_xlsx_set_cell_by_identifier_async( + async def edit_document_xlsx_set_cell_by_identifier( self, - input: SetXlsxCellByIdentifierRequest, + input: SetXlsxCellByIdentifierRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6907,13 +8585,29 @@ async def edit_document_xlsx_set_cell_by_identifier_async( Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet using its cell identifier (e.g. A1, B22, C33) in the worksheet + + Swagger operation ID: `EditDocument_XlsxSetCellByIdentifier`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/xlsx/set-cell/by-identifier" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6927,6 +8621,7 @@ async def edit_document_xlsx_set_cell_by_identifier_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6934,9 +8629,9 @@ async def edit_document_xlsx_set_cell_by_identifier_async( return json.loads(response.text) - async def edit_document_xlsx_set_cell_by_index_async( + async def edit_document_xlsx_set_cell_by_index( self, - input: SetXlsxCellRequest, + input: SetXlsxCellRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6949,13 +8644,29 @@ async def edit_document_xlsx_set_cell_by_index_async( Sets, updates the contents of a specific cell in an Excel XLSX spreadsheet, worksheet + + Swagger operation ID: `EditDocument_XlsxSetCellByIndex`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/convert/edit/xlsx/set-cell/by-index" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6969,6 +8680,7 @@ async def edit_document_xlsx_set_cell_by_index_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6976,9 +8688,9 @@ async def edit_document_xlsx_set_cell_by_index_async( return json.loads(response.text) - async def convert_web_html_to_docx_async( + async def convert_web_html_to_docx( self, - input: HtmlToOfficeRequest, + input: HtmlToOfficeRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6989,10 +8701,26 @@ async def convert_web_html_to_docx_async( Convert HTML to Word DOCX Document Convert HTML to Office Word Document (DOCX) format + + Swagger operation ID: `ConvertWeb_HtmlToDocx`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/convert/html/to/docx" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7006,13 +8734,14 @@ async def convert_web_html_to_docx_async( request_url, response.status, response.text, + response=response, ) return response.content - async def convert_data_json_to_xml_async( + async def convert_data_json_to_xml( self, - input: ConvertDataJsonToXmlInput, + input: ConvertDataJsonToXmlInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -7023,10 +8752,26 @@ async def convert_data_json_to_xml_async( Convert JSON to XML conversion Convert a JSON object into XML + + Swagger operation ID: `ConvertData_JsonToXml`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/convert/json/to/xml" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7040,6 +8785,7 @@ async def convert_data_json_to_xml_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7047,9 +8793,9 @@ async def convert_data_json_to_xml_async( return json.loads(response.text) - async def convert_template_apply_html_template_async( + async def convert_template_apply_html_template( self, - input: HtmlTemplateApplicationRequest, + input: HtmlTemplateApplicationRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -7061,12 +8807,28 @@ async def convert_template_apply_html_template_async( Apply operations to fill in an HTML template, generating a final HTML result + + Swagger operation ID: `ConvertTemplate_ApplyHtmlTemplate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/template/html/apply" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7080,6 +8842,7 @@ async def convert_template_apply_html_template_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7087,9 +8850,9 @@ async def convert_template_apply_html_template_async( return json.loads(response.text) - async def convert_web_html_to_pdf_async( + async def convert_web_html_to_pdf( self, - input: HtmlToPdfRequest, + input: HtmlToPdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -7101,10 +8864,26 @@ async def convert_web_html_to_pdf_async( Fully renders a website and returns a PDF of the HTML. Javascript, HTML5, CSS and other advanced features are all supported. + + Swagger operation ID: `ConvertWeb_HtmlToPdf`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/convert/web/html/to/pdf" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7118,13 +8897,14 @@ async def convert_web_html_to_pdf_async( request_url, response.status, response.text, + response=response, ) return response.content - async def convert_web_html_to_png_async( + async def convert_web_html_to_png( self, - input: HtmlToPngRequest, + input: HtmlToPngRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -7136,10 +8916,26 @@ async def convert_web_html_to_png_async( Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported. + + Swagger operation ID: `ConvertWeb_HtmlToPng`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/convert/web/html/to/png" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7153,6 +8949,7 @@ async def convert_web_html_to_png_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7160,9 +8957,9 @@ async def convert_web_html_to_png_async( return json.loads(response.text) - async def convert_web_html_to_txt_async( + async def convert_web_html_to_txt( self, - input: HtmlToTextRequest, + input: HtmlToTextRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -7173,10 +8970,26 @@ async def convert_web_html_to_txt_async( Convert HTML string to text (txt) Converts an HTML string input into text (txt); extracts text from HTML + + Swagger operation ID: `ConvertWeb_HtmlToTxt`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/convert/web/html/to/txt" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7190,6 +9003,7 @@ async def convert_web_html_to_txt_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7197,9 +9011,9 @@ async def convert_web_html_to_txt_async( return json.loads(response.text) - async def convert_web_url_to_pdf_async( + async def convert_web_url_to_pdf( self, - input: ScreenshotRequest, + input: ScreenshotRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -7211,10 +9025,26 @@ async def convert_web_url_to_pdf_async( Fully renders a website and returns a PDF of the full page. Javascript, HTML5, CSS and other advanced features are all supported. + + Swagger operation ID: `ConvertWeb_UrlToPdf`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/convert/web/url/to/pdf" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7228,13 +9058,14 @@ async def convert_web_url_to_pdf_async( request_url, response.status, response.text, + response=response, ) return response.content - async def convert_web_url_to_screenshot_async( + async def convert_web_url_to_screenshot( self, - input: ScreenshotRequest, + input: ScreenshotRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -7247,12 +9078,28 @@ async def convert_web_url_to_screenshot_async( Fully renders a website and returns a PNG screenshot of the full page image. Javascript, HTML5, CSS and other advanced features are all supported. + + Swagger operation ID: `ConvertWeb_UrlToScreenshot`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/convert/web/url/to/screenshot" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7266,13 +9113,14 @@ async def convert_web_url_to_screenshot_async( request_url, response.status, response.text, + response=response, ) return response.content - async def convert_web_url_to_txt_async( + async def convert_web_url_to_txt( self, - input: UrlToTextRequest, + input: UrlToTextRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -7283,10 +9131,26 @@ async def convert_web_url_to_txt_async( Convert website URL page to text (txt) Converts a website URL page into text (txt); extracts text from HTML + + Swagger operation ID: `ConvertWeb_UrlToTxt`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/convert/web/url/to/txt" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7300,6 +9164,7 @@ async def convert_web_url_to_txt_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/commondataservice.py b/src/azure/connectors/commondataservice.py index 39483a24..f8ff5611 100644 --- a/src/azure/connectors/commondataservice.py +++ b/src/azure/connectors/commondataservice.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,58 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "CommondataserviceClient", + "ActionsDynamicValuesList", + "AssociateEntityRequest", + "AssociateRecordsPatchItemInput", + "BlobDataSetsMetadata", + "CallbackRegistration", + "DataSet", + "DataSetsList", + "DataSetsMetadata", + "DisplayCollectionName", + "EntitiesDynamicValuesList", + "EntitiesDynamicValuesListItem", + "EntityItem", + "EntityItemList", + "EntityMetadata", + "EntityRelationshipsDynamicValuesList", + "GetItemResponse", + "Item", + "ItemsList", + "ObjectEntity", + "OrganizationsDynamicValuesList", + "OrganizationsDynamicValuesListItem", + "PassThroughNativeQuery", + "PatchItemInput", + "PatchItemResponse", + "PostItemInput", + "PostItemResponse", + "Procedure", + "SearchOutput", + "SearchRequestBody", + "SubscriptionRequest", + "SubscriptionResponse", + "Table", + "TableCapabilitiesMetadata", + "TableFilterRestrictionsMetadata", + "TableMetadata", + "TableSelectRestrictionsMetadata", + "TableSortRestrictionsMetadata", + "TablesList", + "TabularDataSetsMetadata", + "UpdateTriggerSubscriptionRequest", + "UserLocalizedLabel", + "WebhookNotificationContent", + "WebhookNotificationContentForWhenAnActionIsPerformed", + "WhenAnActionIsPerformedSubscriptionRequest", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,8 +80,18 @@ class DataSetsMetadata: Response for GetDataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -39,7 +100,7 @@ class AssociateRecordsPatchItemInput: Associates one row to another on the provided relationship """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -52,8 +113,9 @@ class Item: Response for Associates one row to another on the provided relationship """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -64,10 +126,16 @@ class ItemsList: Response for Retrieves all collection valued relationship items as an expand would """ - value: Optional[List[Item]] = None + value: Optional[ + List[Item | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -79,7 +147,12 @@ class DataSetsList: Response for GetDataSets """ - value: Optional[List[DataSet]] = None + value: Optional[ + List[DataSet | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of datasets""" @@ -89,7 +162,7 @@ class GetItemResponse: Response for Get row (legacy) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -102,26 +175,30 @@ class TableMetadata: Response for Get table metadata - Patch """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Table name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Table title""" - x_ms_permission: Optional[str] = field( + x_ms_permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-permission"}, ) """Table permission""" - x_ms_capabilities: Optional[TableCapabilitiesMetadata] = field( + x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-capabilities"}, ) - schema: Optional[ObjectEntity] = None - referenced_entities: Optional[ObjectEntity] = field( + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referencedEntities"}, ) - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """Url link""" @@ -133,7 +210,7 @@ class ObjectEntity: Response for Retrieves the metadata for multi select column metadata """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -146,7 +223,12 @@ class TablesList: Response for GetTables """ - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Tables""" @@ -156,7 +238,7 @@ class PatchItemInput: Update a row (legacy) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -169,7 +251,7 @@ class PatchItemResponse: Response for Update a row (legacy) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -182,7 +264,7 @@ class PostItemInput: Add a new row (legacy) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -195,7 +277,7 @@ class PostItemResponse: Response for Add a new row (legacy) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -208,25 +290,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -238,15 +324,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -258,30 +346,42 @@ class TableCapabilitiesMetadata: Definition: TableCapabilitiesMetadata """ - sort_restrictions: Optional[TableSortRestrictionsMetadata] = field( + sort_restrictions: Optional[ + TableSortRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortRestrictions"}, ) - filter_restrictions: Optional[TableFilterRestrictionsMetadata] = field( + filter_restrictions: Optional[ + TableFilterRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterRestrictions"}, ) - select_restrictions: Optional[TableSelectRestrictionsMetadata] = field( + select_restrictions: Optional[ + TableSelectRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectRestrictions"}, ) - is_only_server_pagable: Optional[bool] = field( + is_only_server_pagable: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOnlyServerPagable"}, ) """Server paging restrictions""" - filter_function_support: Optional[List[str]] = field( + filter_function_support: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterFunctionSupport"}, ) """List of supported filter capabilities""" - server_paging_options: Optional[List[str]] = field( + server_paging_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serverPagingOptions"}, ) """List of supported server-driven paging capabilities""" @@ -293,15 +393,17 @@ class TableSortRestrictionsMetadata: Definition: TableSortRestrictionsMetadata """ - sortable: Optional[bool] = None + sortable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has sortable columns""" - unsortable_properties: Optional[List[str]] = field( + unsortable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unsortableProperties"}, ) """List of unsortable properties""" - ascending_only_properties: Optional[List[str]] = field( + ascending_only_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ascendingOnlyProperties"}, ) """List of properties which support ascending order only""" @@ -313,15 +415,17 @@ class TableFilterRestrictionsMetadata: Definition: TableFilterRestrictionsMetadata """ - filterable: Optional[bool] = None + filterable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has filterable columns""" - non_filterable_properties: Optional[List[str]] = field( + non_filterable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nonFilterableProperties"}, ) """List of non filterable properties""" - required_properties: Optional[List[str]] = field( + required_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredProperties"}, ) """List of required properties""" @@ -333,7 +437,7 @@ class TableSelectRestrictionsMetadata: Definition: TableSelectRestrictionsMetadata """ - selectable: Optional[bool] = None + selectable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has selectable columns""" @@ -343,8 +447,7 @@ class SubscriptionRequest: Definition: SubscriptionRequest """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "NotificationUrl"}, ) """ @@ -359,17 +462,19 @@ class SubscriptionResponse: Definition: SubscriptionResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the subscription""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """Resource of the subscription request""" - notification_type: Optional[str] = field( + notification_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationType"}, ) """Notification Type""" - notification_url: Optional[str] = field( + notification_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationUrl"}, ) """Notification Url""" @@ -381,13 +486,13 @@ class UpdateTriggerSubscriptionRequest: Definition: UpdateTriggerSubscriptionRequest """ - attribute_filters: Optional[List[str]] = field( + attribute_filters: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AttributeFilters"}, ) """Column filters""" - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "NotificationUrl"}, ) """ @@ -402,14 +507,24 @@ class DataSet: Definition: DataSet """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Dataset name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Dataset display name""" - query: Optional[List[PassThroughNativeQuery]] = None + query: Optional[ + List[PassThroughNativeQuery | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Pass-through Native Queries""" @@ -419,15 +534,21 @@ class Table: Definition: Table """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the table. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the table.""" - dynamic_properties: Optional[Dict[str, str]] = field( + dynamic_properties: Optional[Dict[str, str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """Additional table properties provided by the connector to the clients.""" @@ -439,10 +560,15 @@ class Procedure: Definition: Procedure """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Procedure name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Procedure display name""" @@ -454,8 +580,9 @@ class PassThroughNativeQuery: Definition: PassThroughNativeQuery """ - language: Optional[str] = field( + language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Language"}, ) """Query language""" @@ -467,8 +594,9 @@ class DisplayCollectionName: Definition: DisplayCollectionName """ - user_localized_label: Optional[UserLocalizedLabel] = field( + user_localized_label: Optional[UserLocalizedLabel | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userLocalizedLabel"}, ) """The user localized display name label object.""" @@ -480,7 +608,12 @@ class EntitiesDynamicValuesList: Definition: EntitiesDynamicValuesList """ - value: Optional[List[EntitiesDynamicValuesListItem]] = None + value: Optional[ + List[EntitiesDynamicValuesListItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of tables as dynamic values.""" @@ -490,23 +623,27 @@ class EntitiesDynamicValuesListItem: Definition: EntitiesDynamicValuesListItem """ - metadata_id: Optional[str] = field( + metadata_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "metadataId"}, ) """The metadata id.""" - entity_set_name: Optional[str] = field( + entity_set_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "entitySetName"}, ) """The name of the table.""" - logical_name: Optional[str] = field( + logical_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "logicalName"}, ) """The logical name of the table.""" - display_collection_name: Optional[DisplayCollectionName] = field( + display_collection_name: Optional[DisplayCollectionName | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayCollectionName"}, ) """The display name of the table.""" @@ -518,7 +655,12 @@ class OrganizationsDynamicValuesList: Definition: OrganizationsDynamicValuesList """ - value: Optional[List[OrganizationsDynamicValuesListItem]] = None + value: Optional[ + List[OrganizationsDynamicValuesListItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of organizations as dynamic values.""" @@ -528,14 +670,23 @@ class OrganizationsDynamicValuesListItem: Definition: OrganizationsDynamicValuesListItem """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The organization id.""" - friendly_name: Optional[str] = field( + friendly_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FriendlyName"}, ) """The name of the organization.""" - url: Optional[str] = field(default=None, metadata={"wire_name": "Url"}) + url: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Url"}, + ) """The URL of the organization.""" @@ -545,7 +696,7 @@ class EntityMetadata: Definition: EntityMetadata """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) """Swagger schema""" @@ -555,10 +706,16 @@ class EntityItemList: Definition: EntityItemList """ - value: Optional[List[EntityItem]] = None + value: Optional[ + List[EntityItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The url to fetch next page data.""" @@ -570,8 +727,9 @@ class EntityItem: Definition: EntityItem """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -582,38 +740,38 @@ class CallbackRegistration: Definition: CallbackRegistration """ - version: Optional[int] = None + version: int """The callback registration table version""" - url: Optional[str] = None + url: str """ Callback url to the flow engine. Expected as part of the request and provided by Flow. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Callback registration name. Value will be replaced with workflow id""" - entityname: Optional[str] = None + entityname: str """Choose a table""" - message: Optional[int] = None + message: int """Choose when the flow triggers""" - sdkmessagename: Optional[str] = None + sdkmessagename: Optional[str] = dataclass_field(default=None, kw_only=True) """Choose an option or add your own""" - scope: Optional[int] = None + scope: int """Choose a scope to limit which rows can trigger the flow""" - filteringattributes: Optional[str] = None + filteringattributes: Optional[str] = dataclass_field(default=None, kw_only=True) """ Enter a comma-separated list of column unique names. The flow triggers if any of them are modified """ - filterexpression: Optional[str] = None + filterexpression: Optional[str] = dataclass_field(default=None, kw_only=True) """ Enter an OData style filter expression to determine which rows can trigger the flow """ - postponeuntil: Optional[str] = None + postponeuntil: Optional[str] = dataclass_field(default=None, kw_only=True) """ Enter a time to delay the trigger evaluation, eg. 2020-01-01T10:10:00Z """ - runas: Optional[int] = None + runas: Optional[int] = dataclass_field(default=None, kw_only=True) """Choose the running user for steps where invoker connections are used""" @@ -623,7 +781,7 @@ class UserLocalizedLabel: Definition: UserLocalizedLabel """ - label: Optional[str] = None + label: Optional[str] = dataclass_field(default=None, kw_only=True) """The display name label of the table.""" @@ -633,7 +791,7 @@ class WebhookNotificationContent: Definition: WebhookNotificationContent """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) """Swagger schema""" @@ -643,7 +801,7 @@ class EntityRelationshipsDynamicValuesList: Definition: EntityRelationshipsDynamicValuesList """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of table relationships as dynamic values.""" @@ -653,10 +811,7 @@ class AssociateEntityRequest: Definition: AssociateEntityRequest """ - id: Optional[str] = field( - default=None, - metadata={"wire_name": "@odata.id"}, - ) + id: str = dataclass_field(metadata={"wire_name": "@odata.id"}) """ Enter the row URL using OData ID from a previous step or typing the full URL (eg. @@ -670,7 +825,7 @@ class ActionsDynamicValuesList: Definition: ActionsDynamicValuesList """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of actions as dynamic values""" @@ -680,40 +835,40 @@ class SearchRequestBody: Definition: SearchRequestBody """ - search: Optional[str] = None + search: str """ Enter a search term, eg. Contoso. Searches modifiers like boolean operators, wildcards, fuzzy search, proximity search etc. require the search type full """ - searchtype: Optional[str] = None + searchtype: Optional[str] = dataclass_field(default=None, kw_only=True) """ Enter whether simple or full search syntax should be used (default is simple) """ - searchmode: Optional[str] = None + searchmode: Optional[str] = dataclass_field(default=None, kw_only=True) """ Enter whether any or all of the search terms must be matched (default is any) """ - top: Optional[int] = None + top: Optional[int] = dataclass_field(default=None, kw_only=True) """Enter the number of search results to be listed (default = 50)""" - filter: Optional[str] = None + filter: Optional[str] = dataclass_field(default=None, kw_only=True) """Enter an OData style filter expression to narrow the search""" - entities: Optional[List[str]] = None + entities: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Enter a comma-separated list of tables to be searched (default is all tables) """ - orderby: Optional[List[str]] = None + orderby: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Enter a comma-separated list of column unique names followed by asc or desc """ - facets: Optional[List[str]] = None + facets: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Enter a comma-separated list of facet queries to narrow the search""" - skip: Optional[int] = None + skip: Optional[int] = dataclass_field(default=None, kw_only=True) """Enter the number of search results to be skipped""" - returntotalrecordcount: Optional[bool] = None + returntotalrecordcount: Optional[bool] = dataclass_field(default=None, kw_only=True) """Choose an option""" @@ -723,11 +878,11 @@ class SearchOutput: Definition: SearchOutput """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of rows""" - totalrecordcount: Optional[int] = None + totalrecordcount: Optional[int] = dataclass_field(default=None, kw_only=True) """Total count of results (-1 if returntotalrecordcount is set to false)""" - facets: Optional[Dict[str, Any]] = None + facets: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Facet results""" @@ -737,20 +892,20 @@ class WhenAnActionIsPerformedSubscriptionRequest: Definition: WhenAnActionIsPerformedSubscriptionRequest """ - version: Optional[int] = None + version: int """The callback registration table version.""" - url: Optional[str] = None + url: str """ Callback url to the flow engine. Expected as part of the request and provided by Flow. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Callback registration name. Value will be replaced with workflow id.""" - scope: Optional[int] = None + scope: int """Choose a scope to limit which rows can trigger the flow.""" - entityname: Optional[str] = None + entityname: str """Choose a table to filter actions.""" - sdkmessagename: Optional[str] = None + sdkmessagename: str """Choose an action.""" @@ -760,7 +915,7 @@ class WebhookNotificationContentForWhenAnActionIsPerformed: Definition: WebhookNotificationContentForWhenAnActionIsPerformed """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) """Swagger schema""" @@ -775,7 +930,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -792,8 +947,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -814,7 +969,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -830,16 +985,57 @@ def connector_name(self) -> str: return "commondataservice" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url( + value: str, *, allow_opaque_token: bool = False + ) -> SplitResult: + if allow_opaque_token: + parsed = urlsplit(value) + if ( + not parsed.scheme and not parsed.netloc + and not value.startswith(("/", "?")) + ): + return parsed + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link, allow_opaque_token=True) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) encoded_token = quote(str(next_link), safe='') return f"{self._connection_runtime_url}/nextLink/{encoded_token}" - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -856,7 +1052,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -869,7 +1069,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def get_data_sets_metadata_async( + async def get_data_sets_metadata( self, *, timeout: Optional[float] = None, @@ -879,10 +1079,24 @@ async def get_data_sets_metadata_async( ) -> dict[str, Any] | None: """ GetDataSetsMetadata + + Swagger operation ID: `GetDataSetsMetadata`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/$metadata.json/datasets" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -896,6 +1110,7 @@ async def get_data_sets_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -903,7 +1118,7 @@ async def get_data_sets_metadata_async( return json.loads(response.text) - async def get_next_page_async( + async def get_next_page( self, next_link: str, *, @@ -916,13 +1131,28 @@ async def get_next_page_async( Follows nextLink to retrieve next page of data This operation gets the next page of data. + + Swagger operation ID: `GetNextPage`. + + Args: + next_link: OData nextLink. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/nextLink/{quote(str(next_link), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -936,6 +1166,7 @@ async def get_next_page_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -943,9 +1174,9 @@ async def get_next_page_async( return json.loads(response.text) - async def associate_records_patch_item_async( + async def associate_records_patch_item( self, - input: AssociateRecordsPatchItemInput, + input: AssociateRecordsPatchItemInput | Mapping[str, Any], dataset: str, table: str, id: str, @@ -960,6 +1191,26 @@ async def associate_records_patch_item_async( Associates one row to another on the provided relationship Associates one row to another on the provided relationship + + Swagger operation ID: `AssociateRecordsPatchItem_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Select an Environment. + table: Name of the table. + id: Id of the table row. + relationship: Relationship on which to associate. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -974,7 +1225,7 @@ async def associate_records_patch_item_async( f"/{quote(quote(str(relationship), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -988,6 +1239,7 @@ async def associate_records_patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -995,7 +1247,7 @@ async def associate_records_patch_item_async( return json.loads(response.text) - async def create_attachment_async( + async def create_attachment( self, input: bytes, dataset: str, @@ -1012,6 +1264,25 @@ async def create_attachment_async( Creates Note (annotation) for specified table row Creates Note (annotation) for specified table row. + + Swagger operation ID: `CreateAttachment_V2`. + + Args: + input: The binary request body. + dataset: Select an Environment. + table: Table on which to create Note (annotation). + id: Id of the table row on which to create a Note (annotation). + display_name: Filename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1032,7 +1303,7 @@ async def create_attachment_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -1049,6 +1320,7 @@ async def create_attachment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1056,7 +1328,7 @@ async def create_attachment_async( return json.loads(response.text) - async def delete_attachment_async( + async def delete_attachment( self, dataset: str, table: str, @@ -1072,6 +1344,24 @@ async def delete_attachment_async( Deletes specified attachment on the Note (annotation) Deletes specified attachment on the Note (annotation). + + Swagger operation ID: `DeleteAttachment_V2`. + + Args: + dataset: Select an Environment. + table: Table on which to delete Note (annotation). + id: Id of the table row on which to delete a Note (annotation). + attachment_id: Note (annotation) id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1086,7 +1376,7 @@ async def delete_attachment_async( f"/{quote(quote(str(attachment_id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1100,9 +1390,10 @@ async def delete_attachment_async( request_url, response.status, response.text, + response=response, ) - async def delete_item_async( + async def delete_item( self, dataset: str, table: str, @@ -1117,6 +1408,23 @@ async def delete_item_async( Delete a row (legacy) This operation deletes a row from a table collection + + Swagger operation ID: `DeleteItem_V2`. + + Args: + dataset: Select an Environment. + table: Select a table. + id: Identifier for the row. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1129,7 +1437,7 @@ async def delete_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1143,9 +1451,10 @@ async def delete_item_async( request_url, response.status, response.text, + response=response, ) - async def disassociate_records_post_item_async( + async def disassociate_records_post_item( self, dataset: str, table: str, @@ -1162,6 +1471,25 @@ async def disassociate_records_post_item_async( Disassociates a row from a multi-valued relationship Disassociates a row from a multi-valued relationship + + Swagger operation ID: `DisassociateRecordsPostItem_V2`. + + Args: + dataset: Select an Environment. + table: Name of the table. + id: Id of the table row. + relationship: Relationship on which to associate. + related_id: The item to disassociate. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1178,7 +1506,7 @@ async def disassociate_records_post_item_async( f"/{quote(quote(str(related_id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1192,6 +1520,7 @@ async def disassociate_records_post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1199,7 +1528,7 @@ async def disassociate_records_post_item_async( return json.loads(response.text) - async def disassociate_single_value_record_delete_item_async( + async def disassociate_single_value_record_delete_item( self, dataset: str, table: str, @@ -1215,6 +1544,24 @@ async def disassociate_single_value_record_delete_item_async( Disassociates a row from a single-valued relationship Disassociates a row from a single-valued relationship + + Swagger operation ID: `DisassociateSingleValueRecordDeleteItem_V2`. + + Args: + dataset: Select an Environment. + table: Name of the table. + id: Id of the table row. + relationship: Relationship on which to associate. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1229,7 +1576,7 @@ async def disassociate_single_value_record_delete_item_async( f"/{quote(quote(str(relationship), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1243,6 +1590,7 @@ async def disassociate_single_value_record_delete_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1250,7 +1598,7 @@ async def disassociate_single_value_record_delete_item_async( return json.loads(response.text) - async def get_attachment_content_async( + async def get_attachment_content( self, dataset: str, table: str, @@ -1266,6 +1614,24 @@ async def get_attachment_content_async( Retrieves file content for specified Note (annotation) Retrieves file content for specified Note (annotation). + + Swagger operation ID: `GetAttachmentContent_V2`. + + Args: + dataset: Select an Environment. + table: Table for which to get Note (annotation) content. + id: Id of the table row for which to get Notes (annotations). + attachment_id: Note (annotation) id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1281,7 +1647,7 @@ async def get_attachment_content_async( f"/$value" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1295,11 +1661,12 @@ async def get_attachment_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_collection_relationships_async( + def list_collection_relationships( self, dataset: str, table: str, @@ -1312,11 +1679,34 @@ async def get_collection_relationships_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Retrieves all collection valued relationship items as an expand would Retrieves all collection valued relationship items as an expand would + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetCollectionRelationships_V2`. + + Args: + dataset: Select an Environment. + table: Name of the table. + id: Id of the table row. + collection_type: many to many or not. + relationship: Relationship on which to expand. + target: Target table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1333,63 +1723,122 @@ async def get_collection_relationships_async( f"/TargetTable" f"/{quote(quote(str(target), safe=''), safe='')}" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_data_sets_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_data_sets( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ GetDataSets + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDataSets_V2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/datasets" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_item_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_item( self, dataset: str, table: str, @@ -1404,6 +1853,23 @@ async def get_item_async( Get row (legacy) This operation retrieves the specified row for a table + + Swagger operation ID: `GetItem_V2`. + + Args: + dataset: Select an Environment. + table: Select a table. + id: Identifier for the row. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1416,7 +1882,7 @@ async def get_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1430,6 +1896,7 @@ async def get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1437,7 +1904,7 @@ async def get_item_async( return json.loads(response.text) - async def get_item_attachments_async( + def list_item_attachments( self, dataset: str, table: str, @@ -1447,11 +1914,31 @@ async def get_item_attachments_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Retrieves all Notes (annotations) for the provided table row Id Retrieves all Notes (annotations) for the provided table row Id. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetItemAttachments_V2`. + + Args: + dataset: Select an Environment. + table: Table for which to get Notes (annotations). + id: Id of the table row for which to get Notes (annotations). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1464,50 +1951,96 @@ async def get_item_attachments_async( f"/{quote(quote(str(id), safe=''), safe='')}" f"/attachments" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_items_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_items( self, dataset: str, table: str, + *, apply: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, expand: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List rows (legacy) This operation gets rows for a table - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems_V2`. + + Args: + dataset: Select an Environment. + table: Select a table. + apply: A sequence of OData aggregation transformations. + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + expand: Related entries to include with requested entries (default + = none). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1546,11 +2079,18 @@ async def get_items_async( query_params.append(f"$expand={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1563,23 +2103,32 @@ async def get_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_metadata_for_patch_item_async( + async def get_metadata_for_patch_item( self, dataset: str, table: str, @@ -1593,6 +2142,22 @@ async def get_metadata_for_patch_item_async( Get table metadata - Patch Gets table metadata for patch operation + + Swagger operation ID: `GetMetadataForPatchItem_V2`. + + Args: + dataset: Select an Environment. + table: Select a table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1605,7 +2170,7 @@ async def get_metadata_for_patch_item_async( f"/patchitem" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1619,6 +2184,7 @@ async def get_metadata_for_patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1626,7 +2192,7 @@ async def get_metadata_for_patch_item_async( return json.loads(response.text) - async def get_metadata_for_post_item_async( + async def get_metadata_for_post_item( self, dataset: str, table: str, @@ -1640,6 +2206,22 @@ async def get_metadata_for_post_item_async( Get table metadata - Post Gets table metadata for post operation + + Swagger operation ID: `GetMetadataForPostItem_V2`. + + Args: + dataset: Select an Environment. + table: Select a table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1652,7 +2234,7 @@ async def get_metadata_for_post_item_async( f"/postitem" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1666,6 +2248,7 @@ async def get_metadata_for_post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1673,7 +2256,7 @@ async def get_metadata_for_post_item_async( return json.loads(response.text) - async def get_multi_select_metadata_async( + async def get_multi_select_metadata( self, dataset: str, table: str, @@ -1688,6 +2271,23 @@ async def get_multi_select_metadata_async( Retrieves the metadata for multi select column metadata Retrieves the metadata for multi select column metadata. + + Swagger operation ID: `GetMultiSelectMetadata_V2`. + + Args: + dataset: org name. + table: table name. + item: id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1701,7 +2301,7 @@ async def get_multi_select_metadata_async( f"/MultiSelect" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1715,6 +2315,7 @@ async def get_multi_select_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1722,7 +2323,7 @@ async def get_multi_select_metadata_async( return json.loads(response.text) - async def get_option_set_metadata_async( + async def get_option_set_metadata( self, dataset: str, table: str, @@ -1738,6 +2339,24 @@ async def get_option_set_metadata_async( Retrieves the metadata for choice column metadata Retrieves the metadata for choice column metadata. + + Swagger operation ID: `GetOptionSetMetadata_V2`. + + Args: + dataset: org name. + table: table name. + item: id. + type_: type of choice. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1752,7 +2371,7 @@ async def get_option_set_metadata_async( f"/{quote(str(type_), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1766,6 +2385,7 @@ async def get_option_set_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1773,7 +2393,7 @@ async def get_option_set_metadata_async( return json.loads(response.text) - async def get_table_async( + async def get_table( self, dataset: str, table: str, @@ -1787,6 +2407,22 @@ async def get_table_async( Get table metadata Gets table metadata + + Swagger operation ID: `GetTable_V2`. + + Args: + dataset: Select an Environment. + table: Select atable. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1798,7 +2434,7 @@ async def get_table_async( f"/{quote(quote(str(table), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1812,6 +2448,7 @@ async def get_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1819,7 +2456,7 @@ async def get_table_async( return json.loads(response.text) - async def get_tables_async( + def list_tables( self, dataset: str, *, @@ -1827,9 +2464,27 @@ async def get_tables_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ GetTables + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTables_V2`. + + Args: + dataset: dataset. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1838,31 +2493,52 @@ async def get_tables_async( f"/{quote(quote(str(dataset), safe=''), safe='')}" f"/tables" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def patch_item_async( + return AsyncItemPaged(get_next, extract_data) + + async def patch_item( self, - input: PatchItemInput, + input: PatchItemInput | Mapping[str, Any], dataset: str, table: str, id: str, @@ -1876,6 +2552,25 @@ async def patch_item_async( Update a row (legacy) This operation updates an existing row for a table + + Swagger operation ID: `PatchItem_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Select an Environment. + table: Select a table. + id: Identifier for the row. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1888,7 +2583,7 @@ async def patch_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1902,6 +2597,7 @@ async def patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1909,9 +2605,9 @@ async def patch_item_async( return json.loads(response.text) - async def post_item_async( + async def post_item( self, - input: PostItemInput, + input: PostItemInput | Mapping[str, Any], dataset: str, table: str, *, @@ -1924,6 +2620,24 @@ async def post_item_async( Add a new row (legacy) This operation adds a new row of a table + + Swagger operation ID: `PostItem_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Select an Environment. + table: Select a table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1935,7 +2649,7 @@ async def post_item_async( f"/items" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1949,6 +2663,7 @@ async def post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/documentdb.py b/src/azure/connectors/documentdb.py index b6af71f6..d85523ed 100644 --- a/src/azure/connectors/documentdb.py +++ b/src/azure/connectors/documentdb.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,40 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "DocumentdbClient", + "CosmosDbAccount", + "CosmosDbAccountList", + "CreateStoredProcedureInput", + "CreateStoredProcedureResponse", + "DataWithSensitivityLabelInfo", + "DocumentsCollection", + "DocumentsQuery", + "ExecuteStoredProcedureInput", + "GetAccountResponse", + "GetCollectionResponse", + "GetCollectionsResponse", + "GetDatabaseResponse", + "GetDatabasesResponse", + "GetDocumentResponse", + "GetDocumentsResponse", + "GetStoredProceduresResponse", + "ObjectEntity", + "ObjectWithoutType", + "PostDocumentsRequest", + "PostDocumentsResponse", + "PutDocumentRequest", + "PutDocumentResponse", + "QueryDocumentsResponse", + "QueryRequest", + "QueryResponse", + "ReplaceStoredProcedureInput", + "SensitivityLabelMetadata", +] + # Type Definitions @@ -29,15 +62,32 @@ class PostDocumentsResponse: Response for Create or update document """ - rid: Optional[str] = field(default=None, metadata={"wire_name": "_rid"}) - ts: Optional[int] = field(default=None, metadata={"wire_name": "_ts"}) - self: Optional[str] = field(default=None, metadata={"wire_name": "_self"}) - etag: Optional[str] = field(default=None, metadata={"wire_name": "_etag"}) - attachments: Optional[str] = field( + rid: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_rid"}, + ) + ts: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_ts"}, + ) + self: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_self"}, + ) + etag: Optional[str] = dataclass_field( default=None, + kw_only=True, + metadata={"wire_name": "_etag"}, + ) + attachments: Optional[str] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "_attachments"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -46,11 +96,11 @@ class CreateStoredProcedureInput: Create stored procedure """ - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """ Function that defines the stored procedure, e.g. 'function(params){ ... }' """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """New id of the stored procedure.""" @@ -60,17 +110,33 @@ class CreateStoredProcedureResponse: Response for Create stored procedure """ - etag: Optional[str] = field(default=None, metadata={"wire_name": "_etag"}) + etag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_etag"}, + ) """_etag""" - rid: Optional[str] = field(default=None, metadata={"wire_name": "_rid"}) + rid: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_rid"}, + ) """_rid""" - self: Optional[str] = field(default=None, metadata={"wire_name": "_self"}) + self: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_self"}, + ) """_self""" - ts: Optional[int] = field(default=None, metadata={"wire_name": "_ts"}) + ts: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_ts"}, + ) """_ts""" - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """body""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" @@ -83,7 +149,7 @@ class ObjectWithoutType: Response for Execute stored procedure """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -96,8 +162,11 @@ class GetDocumentResponse: Response for Get a document """ - metadata: Optional[List[DataWithSensitivityLabelInfo]] = field( + metadata: Optional[ + List[DataWithSensitivityLabelInfo | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@metadata"}, ) """List of columns along with their Sensitivity Labels""" @@ -109,13 +178,21 @@ class GetDocumentsResponse: Response for Get all documents """ - rid: Optional[str] = field(default=None, metadata={"wire_name": "_rid"}) - documents: Optional[List[Dict[str, Any]]] = field( + rid: Optional[str] = dataclass_field( default=None, + kw_only=True, + metadata={"wire_name": "_rid"}, + ) + documents: Optional[List[Dict[str, Any]]] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "Documents"}, ) - metadata: Optional[List[DataWithSensitivityLabelInfo]] = field( + metadata: Optional[ + List[DataWithSensitivityLabelInfo | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@metadata"}, ) """List of columns along with their Sensitivity Labels""" @@ -127,15 +204,21 @@ class GetStoredProceduresResponse: Response for Get stored procedures """ - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_count"}, ) """_count""" - rid: Optional[str] = field(default=None, metadata={"wire_name": "_rid"}) + rid: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_rid"}, + ) """_rid""" - stored_procedures: Optional[List[Dict[str, Any]]] = field( + stored_procedures: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StoredProcedures"}, ) """StoredProcedures""" @@ -147,31 +230,48 @@ class QueryDocumentsResponse: Response for Query documents """ - value: Optional[List[ObjectWithoutType]] = None - continuation_token: Optional[str] = field( + value: Optional[ + List[ObjectWithoutType | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, + ) + continuation_token: Optional[str] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "ContinuationToken"}, ) - count: Optional[int] = field(default=None, metadata={"wire_name": "Count"}) - request_charge: Optional[float] = field( + count: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Count"}, + ) + request_charge: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequestCharge"}, ) - session_token: Optional[str] = field( + session_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SessionToken"}, ) - activity_id: Optional[str] = field( + activity_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActivityId"}, ) - metadata: Optional[List[DataWithSensitivityLabelInfo]] = field( + metadata: Optional[ + List[DataWithSensitivityLabelInfo | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@metadata"}, ) """List of columns along with their Sensitivity Labels""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to retrieve the next page.""" @@ -183,8 +283,12 @@ class PutDocumentResponse: Response for Replace a document """ - rid: Optional[str] = field(default=None, metadata={"wire_name": "_rid"}) - id: Optional[str] = None + rid: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_rid"}, + ) + id: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -193,11 +297,11 @@ class ReplaceStoredProcedureInput: Replace stored procedure """ - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """ Function that defines the stored procedure, e.g. 'function(params){ ... }' """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the existing stored procedure.""" @@ -207,7 +311,12 @@ class CosmosDbAccountList: Response for Get Cosmos DB accounts """ - value: Optional[List[CosmosDbAccount]] = None + value: Optional[ + List[CosmosDbAccount | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Azure Cosmos DB account names""" @@ -217,13 +326,19 @@ class GetDatabasesResponse: Response for Get all databases """ - rid: Optional[str] = field(default=None, metadata={"wire_name": "_rid"}) - databases: Optional[List[Dict[str, Any]]] = field( + rid: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_rid"}, + ) + databases: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Databases"}, ) - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_count"}, ) @@ -234,13 +349,19 @@ class GetCollectionsResponse: Response for Get all collections """ - rid: Optional[str] = field(default=None, metadata={"wire_name": "_rid"}) - document_collections: Optional[List[Dict[str, Any]]] = field( + rid: Optional[str] = dataclass_field( default=None, + kw_only=True, + metadata={"wire_name": "_rid"}, + ) + document_collections: Optional[List[Dict[str, Any]]] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "DocumentCollections"}, ) - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_count"}, ) @@ -251,8 +372,9 @@ class DocumentsQuery: Definition: DocumentsQuery """ - query_text: Optional[str] = field( + query_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "QueryText"}, ) """SQL Syntax Query over documents""" @@ -264,7 +386,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -277,22 +399,35 @@ class DocumentsCollection: Definition: DocumentsCollection """ - value: Optional[List[ObjectWithoutType]] = None - continuation_token: Optional[str] = field( + value: Optional[ + List[ObjectWithoutType | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + continuation_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContinuationToken"}, ) - count: Optional[int] = field(default=None, metadata={"wire_name": "Count"}) - request_charge: Optional[float] = field( + count: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Count"}, + ) + request_charge: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequestCharge"}, ) - session_token: Optional[str] = field( + session_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SessionToken"}, ) - activity_id: Optional[str] = field( + activity_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActivityId"}, ) @@ -303,9 +438,17 @@ class GetAccountResponse: Definition: getAccountResponse """ - self: Optional[str] = field(default=None, metadata={"wire_name": "_self"}) - rid: Optional[str] = field(default=None, metadata={"wire_name": "_rid"}) - id: Optional[str] = None + self: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_self"}, + ) + rid: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_rid"}, + ) + id: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -314,19 +457,37 @@ class GetDatabaseResponse: Definition: getDatabaseResponse """ - id: Optional[str] = None - rid: Optional[str] = field(default=None, metadata={"wire_name": "_rid"}) - self: Optional[str] = field(default=None, metadata={"wire_name": "_self"}) - etag: Optional[str] = field(default=None, metadata={"wire_name": "_etag"}) - colls: Optional[str] = field( + id: Optional[str] = dataclass_field(default=None, kw_only=True) + rid: Optional[str] = dataclass_field( default=None, + kw_only=True, + metadata={"wire_name": "_rid"}, + ) + self: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_self"}, + ) + etag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_etag"}, + ) + colls: Optional[str] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "_colls"}, ) - users: Optional[str] = field( + users: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_users"}, ) - ts: Optional[int] = field(default=None, metadata={"wire_name": "_ts"}) + ts: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_ts"}, + ) GetCollectionResponse = List[Dict[str, Any]] @@ -338,7 +499,7 @@ class PostDocumentsRequest: Definition: postDocumentsRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -351,7 +512,7 @@ class PutDocumentRequest: Definition: putDocumentRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -364,7 +525,7 @@ class QueryRequest: Definition: queryRequest """ - query: Optional[str] = None + query: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -373,13 +534,19 @@ class QueryResponse: Definition: queryResponse """ - rid: Optional[str] = field(default=None, metadata={"wire_name": "_rid"}) - count: Optional[float] = field( + rid: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "_rid"}, + ) + count: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_count"}, ) - documents: Optional[List[Any]] = field( + documents: Optional[List[Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Documents"}, ) @@ -390,10 +557,13 @@ class DataWithSensitivityLabelInfo: Definition: DataWithSensitivityLabelInfo """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name""" - sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field( + sensitivity_label_info: Optional[ + List[SensitivityLabelMetadata | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelInfo"}, ) """List of Sensitivity Label Information""" @@ -405,41 +575,47 @@ class SensitivityLabelMetadata: Definition: SensitivityLabelMetadata """ - sensitivity_label_id: Optional[str] = field( + sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelId"}, ) """SensitivityLabel Id.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel name.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """SensitivityLabel displayName info""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel details on tooltip.""" - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """SensitivityLabel priority.""" - color: Optional[str] = None + color: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel color.""" - is_encrypted: Optional[bool] = field( + is_encrypted: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEncrypted"}, ) """ is SensitivityLabel Encrypted.""" - is_enabled: Optional[bool] = field( + is_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEnabled"}, ) """Whether SensitivityLabel is Enabled.""" - is_parent: Optional[bool] = field( + is_parent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isParent"}, ) """Whether SensitivityLabel is Parent.""" - parent_sensitivity_label_id: Optional[str] = field( + parent_sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentSensitivityLabelId"}, ) """Parent SensitivityLabel Id.""" @@ -451,10 +627,15 @@ class CosmosDbAccount: Definition: CosmosDbAccount """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the Azure Cosmos DB account.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the Azure Cosmos DB account.""" @@ -471,7 +652,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -488,8 +669,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -510,7 +691,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -526,15 +707,49 @@ def connector_name(self) -> str: return "documentdb" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -551,7 +766,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -564,9 +783,9 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def create_document_async( + async def create_document( self, - input: PostDocumentsRequest, + input: PostDocumentsRequest | Mapping[str, Any], cosmos_db_account_name: str, database_id: str, collection_id: str, @@ -581,6 +800,26 @@ async def create_document_async( Create or update document. When creating a document in DocumentDB, the body must include an id property. + + Swagger operation ID: `CreateDocument_V3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + collection_id: The name of the collection. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -594,7 +833,7 @@ async def create_document_async( f"/docs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -608,6 +847,7 @@ async def create_document_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -615,9 +855,9 @@ async def create_document_async( return json.loads(response.text) - async def create_stored_procedure_async( + async def create_stored_procedure( self, - input: CreateStoredProcedureInput, + input: CreateStoredProcedureInput | Mapping[str, Any], cosmos_db_account_name: str, database_id: str, collection_id: str, @@ -631,6 +871,26 @@ async def create_stored_procedure_async( Create stored procedure Create stored procedure. + + Swagger operation ID: `CreateStoredProcedure_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + collection_id: The name of the collection. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -644,7 +904,7 @@ async def create_stored_procedure_async( f"/sprocs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -658,6 +918,7 @@ async def create_stored_procedure_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -665,7 +926,7 @@ async def create_stored_procedure_async( return json.loads(response.text) - async def delete_document_async( + async def delete_document( self, cosmos_db_account_name: str, database_id: str, @@ -681,6 +942,25 @@ async def delete_document_async( Delete a document Delete a document. + + Swagger operation ID: `DeleteDocument_V2`. + + Args: + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + collection_id: The name of the collection. + document_id: The identifier of the document. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -695,7 +975,7 @@ async def delete_document_async( f"/{quote(str(document_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -709,9 +989,10 @@ async def delete_document_async( request_url, response.status, response.text, + response=response, ) - async def delete_stored_procedure_async( + async def delete_stored_procedure( self, cosmos_db_account_name: str, database_id: str, @@ -727,6 +1008,25 @@ async def delete_stored_procedure_async( Delete stored procedure Delete stored procedure. + + Swagger operation ID: `DeleteStoredProcedure_V2`. + + Args: + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + collection_id: The name of the collection. + sproc_id: The name of the stored procedure. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -741,7 +1041,7 @@ async def delete_stored_procedure_async( f"/{quote(str(sproc_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -755,6 +1055,7 @@ async def delete_stored_procedure_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -762,7 +1063,7 @@ async def delete_stored_procedure_async( return json.loads(response.text) - async def execute_stored_procedure_async( + async def execute_stored_procedure( self, input: ExecuteStoredProcedureInput, cosmos_db_account_name: str, @@ -779,6 +1080,26 @@ async def execute_stored_procedure_async( Execute stored procedure Execute stored procedure in specified collection. + + Swagger operation ID: `ExecuteStoredProcedure_V2`. + + Args: + input: The request body. + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + collection_id: The name of the collection. + sproc_id: The name of the stored procedure. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -793,7 +1114,7 @@ async def execute_stored_procedure_async( f"/{quote(str(sproc_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -807,6 +1128,7 @@ async def execute_stored_procedure_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -814,24 +1136,49 @@ async def execute_stored_procedure_async( return json.loads(response.text) - async def get_document_async( + def list_document( self, cosmos_db_account_name: str, database_id: str, collection_id: str, document_id: str, + *, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get a document Get a document. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDocument_V2`. + + Args: + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + collection_id: The name of the collection. + document_id: The identifier for the document. + extract_sensitivity_label: Specify whether to extract MIP labels. + purview_account_name: Default collection will be queried unless + specified. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -858,45 +1205,90 @@ async def get_document_async( query_params.append(f"purviewAccountName={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def get_documents_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("@metadata", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_documents( self, cosmos_db_account_name: str, database_id: str, collection_id: str, + *, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all documents Get all documents. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDocuments_V3`. + + Args: + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + collection_id: The name of the collection. + extract_sensitivity_label: Specify whether to extract MIP labels. + purview_account_name: Default collection will be queried unless + specified. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -922,29 +1314,50 @@ async def get_documents_async( query_params.append(f"purviewAccountName={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("Documents", []): + yield item - async def get_stored_procedures_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_stored_procedures( self, cosmos_db_account_name: str, database_id: str, @@ -959,6 +1372,24 @@ async def get_stored_procedures_async( Get stored procedures Get stored procedures in the specified collection. + + Swagger operation ID: `GetStoredProcedures_V2`. + + Args: + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + collection_id: The name of the collection. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -972,7 +1403,7 @@ async def get_stored_procedures_async( f"/sprocs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -986,6 +1417,7 @@ async def get_stored_procedures_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -993,32 +1425,62 @@ async def get_stored_procedures_async( return json.loads(response.text) - async def query_documents_async( + def list_query_documents( self, cosmos_db_account_name: str, database_id: str, container_id: str, + *, query_text: Optional[str] = None, partition_key: Optional[str] = None, max_item_count: Optional[int] = None, - continuation_token: Optional[str] = None, consistency_level: Optional[str] = None, session_token: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Query documents Query documents. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `QueryDocuments_V5`. + + Args: + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + container_id: The name of the container. + query_text: SQL query. If empty, will return all documents. + partition_key: Value must be provided according to its type + (\"string\", 42, 0.5). If empty, all partitions will be used to + search for documents. + max_item_count: An integer indicating the maximum number of items + to be returned per page. + consistency_level: Consistency level required for the feed + (query/read feed) operation. + session_token: The session token for use with session consistency. + extract_sensitivity_label: Specify whether to extract MIP labels. + purview_account_name: Default collection will be queried unless + specified. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1047,11 +1509,6 @@ async def query_documents_async( if isinstance(max_item_count, bool): value = value.lower() query_params.append(f"maxItemCount={quote(value, safe='')}") - if continuation_token is not None: - value = str(continuation_token) - if isinstance(continuation_token, bool): - value = value.lower() - query_params.append(f"continuationToken={quote(value, safe='')}") if consistency_level is not None: value = str(consistency_level) if isinstance(consistency_level, bool): @@ -1074,11 +1531,18 @@ async def query_documents_async( query_params.append(f"purviewAccountName={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1091,25 +1555,34 @@ async def query_documents_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def replace_document_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def replace_document( self, - input: PutDocumentRequest, + input: PutDocumentRequest | Mapping[str, Any], cosmos_db_account_name: str, database_id: str, collection_id: str, @@ -1124,6 +1597,27 @@ async def replace_document_async( Replace a document Replace a document. + + Swagger operation ID: `ReplaceDocument_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + collection_id: The name of the collection. + document_id: The identifier of the document. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1138,7 +1632,7 @@ async def replace_document_async( f"/{quote(str(document_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1152,6 +1646,7 @@ async def replace_document_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1159,9 +1654,9 @@ async def replace_document_async( return json.loads(response.text) - async def replace_stored_procedure_async( + async def replace_stored_procedure( self, - input: ReplaceStoredProcedureInput, + input: ReplaceStoredProcedureInput | Mapping[str, Any], cosmos_db_account_name: str, database_id: str, collection_id: str, @@ -1176,6 +1671,27 @@ async def replace_stored_procedure_async( Replace stored procedure Replace stored procedure. + + Swagger operation ID: `ReplaceStoredProcedure_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + collection_id: The name of the collection. + sproc_id: The name of the stored procedure. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1190,7 +1706,7 @@ async def replace_stored_procedure_async( f"/{quote(str(sproc_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1204,6 +1720,7 @@ async def replace_stored_procedure_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1211,43 +1728,81 @@ async def replace_stored_procedure_async( return json.loads(response.text) - async def get_cosmos_db_accounts_async( + def list_cosmos_db_accounts( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Cosmos DB accounts This operation list the user's Azure Cosmos DB accounts. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetCosmosDbAccounts`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/cosmosdbaccounts" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_databases_async( + async def get_databases( self, cosmos_db_account_name: str, *, @@ -1260,13 +1815,29 @@ async def get_databases_async( Get all databases Get all databases. + + Swagger operation ID: `GetDatabases_V2`. + + Args: + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/cosmosdb/{quote(str(cosmos_db_account_name), safe='')}/dbs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1280,6 +1851,7 @@ async def get_databases_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1287,7 +1859,7 @@ async def get_databases_async( return json.loads(response.text) - async def get_collections_async( + async def get_collections( self, cosmos_db_account_name: str, database_id: str, @@ -1301,6 +1873,23 @@ async def get_collections_async( Get all collections Get all collections. + + Swagger operation ID: `GetCollections_V2`. + + Args: + cosmos_db_account_name: The Azure Cosmos DB account name (without + documents.azure.com). + database_id: The name of the database. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1312,7 +1901,7 @@ async def get_collections_async( f"/colls" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1326,6 +1915,7 @@ async def get_collections_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/docusign.py b/src/azure/connectors/docusign.py index fad0f069..1b3b76b5 100644 --- a/src/azure/connectors/docusign.py +++ b/src/azure/connectors/docusign.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,129 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "DocusignClient", + "AccountCustomFields", + "Activity", + "ActivityListResponseEnvelope", + "AddDocumentsResponse", + "AddDocumentsToEnvelopeInput", + "AddRecipientTabsResponse", + "AddRecipientToEnvelopeRequest", + "AddRemindersResponse", + "AddVerificationToRecipientResponse", + "AdditionalRecipientData", + "AdditionalRecipientParamsSchema", + "AdditionalURL", + "AdditionalURLForSenderView", + "AnchorTabSchema", + "ApiError", + "ApplyTemplatesToDocumentsInput", + "AuditResponse", + "BuildNumberResponse", + "BuildNumberSchema", + "BulkSendListGuid", + "CombinedEmailBodyAndCustomFields", + "CompositeTemplateSchema", + "CompositeTemplatesResponse", + "CreateBulkSendListInput", + "CreateEnvelopeResponse", + "CreateHookEnvelopeInput", + "CreateHookEnvelopeResponse", + "CreateOrgHookEnvelopeInput", + "CreateOrgHookEnvelopeResponse", + "DeclineReasonWithoutType", + "DocGenFormField", + "DocGenFormFieldsResponse", + "DocumentRecord", + "DocumentRecordListResponseEnvelope", + "DocumentType", + "DocumentTypesResponse", + "DynamicRecipients", + "DynamicSigners", + "DynamicSigningUrlFields", + "EmailSummary", + "EmailSummaryResponse", + "EmbeddedSenderResponse", + "EmbeddedSigningResponse", + "Envelope", + "EnvelopeCustomFieldResponse", + "EnvelopeDocument", + "EnvelopeDocumentField", + "EnvelopeIDsResponse", + "EnvelopeIds", + "EnvelopeResendResponse", + "EnvelopeTemplate", + "EnvelopeVoidResponse", + "FilteredEnvelopeListResponse", + "FilteredEnvelopes", + "FilteredSalesCopilotEnvelopeListResponse", + "Folder", + "FolderItem", + "FontName", + "FontNamesResponse", + "GetDocGenTemplateTabsResponse", + "GetDocumentsResponse", + "GetDynamicRecipientsResponse", + "GetDynamicSignersResponse", + "GetLoginAccountsResponse", + "GetOrganizationsResponse", + "GetWorkFlowIdsResponse", + "KeySales", + "KeySalesResponse", + "ListDocumentsResponse", + "ListEnvelopeDocumentFieldsResponse", + "ListEnvelopesResponse", + "ListFoldersResponse", + "ListRecipientsResponse", + "ListSigningGroupResponse", + "ListTabsResponse", + "ListTemplateDocumentsResponse", + "ListTemplatesResponse", + "LoginAccount", + "MaestroInputVariables", + "OnEnvelopeStatusChangesResponse", + "Organization", + "RecipientTab", + "RecipientTabsResponse", + "RecipientType", + "RecipientTypesResponse", + "SalesCopilotFilteredEnvelopes", + "SendDraftEnvelopeResponse", + "SignatureType", + "SignatureTypesResponse", + "Signer", + "SignerRequest", + "SigningGroup", + "StaticResponseForAnchorTabSchemaResponse", + "StaticResponseForBuildNumberSchemaResponse", + "StaticResponseForCompositeTemplatesResponse", + "StaticResponseForEmbeddedSenderSchemaResponse", + "StaticResponseForEmbeddedSigningSchemaResponse", + "StaticResponseForRecipientTypeSchemaResponse", + "StaticResponseForVerificationTypeSchemaResponse", + "Tab", + "TabType", + "TabTypesResponse", + "TriggerMaestroFlowResponse", + "UpdateDocgenFormFieldsInput", + "UpdateEnvelopeCustomFieldResponse", + "UpdateEnvelopePrefillTabsInput", + "UpdateRecipientTabsValuesInput", + "WebhookEnvelopeResponse", + "WebhookOrganizationResponse", + "WebhookRequest", + "WorkflowDefPayloadSchema", + "WorkflowDefinition", + "WorkflowDefinitionResponse", + "WorkflowDefinitionsResponse", + "WorkflowId", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,29 +151,22 @@ class CreateOrgHookEnvelopeInput: When a Docusign Connect event occurs (Organization-level) """ - all_users: Optional[str] = field( - default=None, - metadata={"wire_name": "allUsers"}, - ) - allow_envelope_publish: Optional[str] = field( - default=None, + all_users: str = dataclass_field(metadata={"wire_name": "allUsers"}) + allow_envelope_publish: str = dataclass_field( metadata={"wire_name": "allowEnvelopePublish"}, ) - include_document_fields: Optional[str] = field( - default=None, + include_document_fields: str = dataclass_field( metadata={"wire_name": "includeDocumentFields"}, ) - requires_acknowledgement: Optional[str] = field( - default=None, + requires_acknowledgement: str = dataclass_field( metadata={"wire_name": "requiresAcknowledgement"}, ) - url_to_publish_to: Optional[str] = field( - default=None, + url_to_publish_to: str = dataclass_field( metadata={"wire_name": "urlToPublishTo"}, ) - name: Optional[str] = None + name: str """Name your Connect configuration (for example, \"Envelope Events\").""" - events: Optional[List[str]] = None + events: List[str] """Select an event. To include another event, select \"Add new item.\"""" @@ -61,7 +176,7 @@ class CreateOrgHookEnvelopeResponse: Response for When a Docusign Connect event occurs (Organization-level) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -74,8 +189,9 @@ class DocGenFormFieldsResponse: Response for Get document generation form fields from envelope """ - docgen_fields: Optional[List[DocGenFormField]] = field( + docgen_fields: Optional[List[DocGenFormField | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "docgenFields"}, ) """Docgen Fields""" @@ -90,7 +206,7 @@ class GetDocGenTemplateTabsResponse: Response for Get document generation form fields from template (bulk send templates only) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -103,7 +219,7 @@ class EnvelopeVoidResponse: Response for Void the envelope """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -116,7 +232,7 @@ class EnvelopeResendResponse: Response for Resend the envelope """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -129,8 +245,9 @@ class AddRemindersResponse: Response for Add reminders for an envelope """ - reminder_enabled: Optional[str] = field( + reminder_enabled: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderEnabled"}, ) """Reminder enabled""" @@ -142,7 +259,12 @@ class ListTabsResponse: Response for Get document tabs from envelope """ - tabs: Optional[List[Tab]] = None + tabs: Optional[ + List[Tab | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Tabs""" @@ -155,8 +277,11 @@ class ListEnvelopeDocumentFieldsResponse: Response for Get document custom fields from envelope """ - envelope_document_fields: Optional[List[EnvelopeDocumentField]] = field( + envelope_document_fields: Optional[ + List[EnvelopeDocumentField | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeDocumentFields"}, ) """Document Custom Fields""" @@ -168,19 +293,21 @@ class CompositeTemplatesResponse: Response for Create envelope using composite templates """ - envelope_id: Optional[str] = field( + envelope_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeId"}, ) """The id of the envelope.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status of the envelope.""" - status_date_time: Optional[str] = field( + status_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusDateTime"}, ) """The datetime the status was set.""" - uri: Optional[str] = None + uri: Optional[str] = dataclass_field(default=None, kw_only=True) """The URI for the envelope in DocuSign.""" @@ -190,10 +317,16 @@ class FilteredEnvelopeListResponse: Response for List envelopes """ - value: Optional[List[FilteredEnvelopes]] = None + value: Optional[ + List[FilteredEnvelopes | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Filtered envelopes""" - has_more_results: Optional[bool] = field( + has_more_results: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasMoreResults"}, ) """ @@ -208,24 +341,27 @@ class CreateEnvelopeResponse: Response for Create envelope using template """ - envelope_id: Optional[str] = field( + envelope_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeId"}, ) """The id of the envelope.""" - template_id: Optional[str] = field( + template_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "templateId"}, ) """The id of the template.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status of the envelope.""" - status_date_time: Optional[str] = field( + status_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusDateTime"}, ) """The datetime the status was set.""" - uri: Optional[str] = None + uri: Optional[str] = dataclass_field(default=None, kw_only=True) """The URI for the envelope in DocuSign.""" @@ -235,7 +371,7 @@ class SendDraftEnvelopeResponse: Response for Send envelope """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -248,19 +384,21 @@ class EnvelopeCustomFieldResponse: Response for Get envelope custom field info """ - field_id: Optional[str] = field( + field_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fieldId"}, ) """The id of the envelope custom field.""" - field_type: Optional[str] = field( + field_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fieldType"}, ) """The type of the envelope custom field.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the envelope custom field.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the envelope custom field.""" @@ -270,19 +408,21 @@ class UpdateEnvelopeCustomFieldResponse: Response for Update envelope custom field """ - field_id: Optional[str] = field( + field_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fieldId"}, ) """The id of the envelope custom field.""" - field_type: Optional[str] = field( + field_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fieldType"}, ) """The type of the envelope custom field.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the envelope custom field.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the envelope custom field.""" @@ -292,7 +432,7 @@ class EmbeddedSenderResponse: Response for Generate Embedded Sender URL """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The url of embedded sender view.""" @@ -302,11 +442,17 @@ class ListRecipientsResponse: Response for List recipients from an envelope """ - envelope_id: Optional[str] = field( + envelope_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeId"}, ) - signers: Optional[List[Signer]] = None + signers: Optional[ + List[Signer | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Signers""" @@ -316,37 +462,43 @@ class Signer: Response for Get recipient info from envelope """ - routing_order: Optional[str] = field( + routing_order: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "routingOrder"}, ) """The signing order of the recipient in the document.""" - role_name: Optional[str] = field( + role_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "roleName"}, ) """The role of the signer.""" - recipient_id: Optional[str] = field( + recipient_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientId"}, ) """The id the recipient.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the recipient.""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """The email of the recipient.""" - recipient_type: Optional[str] = field( + recipient_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientType"}, ) """The type the recipient.""" - verification_type: Optional[str] = field( + verification_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "verificationType"}, ) """The type of verification.""" - recipient_id_guid: Optional[str] = field( + recipient_id_guid: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientIdGuid"}, ) """The recipient GUID.""" @@ -358,7 +510,7 @@ class AuditResponse: Response for Get audit event list """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -371,7 +523,7 @@ class AddVerificationToRecipientResponse: Response for Add verification type to a recipient """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -384,8 +536,9 @@ class ApplyTemplatesToDocumentsInput: Apply a template to documents """ - document_templates: Optional[List[Dict[str, Any]]] = field( + document_templates: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "documentTemplates"}, ) """Document Templates""" @@ -397,10 +550,11 @@ class CreateBulkSendListInput: Create bulk send list """ - csv: Optional[str] = None + csv: Optional[str] = dataclass_field(default=None, kw_only=True) """Upload CSV File""" - raw_output: Optional[Dict[str, Any]] = field( + raw_output: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "rawOutput"}, ) """Document generation fields""" @@ -412,8 +566,9 @@ class BulkSendListGuid: Response for Create bulk send list """ - list_id: Optional[str] = field( + list_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "listId"}, ) """Bulk send list guid""" @@ -425,8 +580,9 @@ class GetLoginAccountsResponse: Response for Login """ - login_accounts: Optional[List[LoginAccount]] = field( + login_accounts: Optional[List[LoginAccount | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "loginAccounts"}, ) """Login accounts""" @@ -438,8 +594,11 @@ class ListTemplatesResponse: Response for List templates """ - envelope_templates: Optional[List[EnvelopeTemplate]] = field( + envelope_templates: Optional[ + List[EnvelopeTemplate | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeTemplates"}, ) """The available envelope templates.""" @@ -451,7 +610,7 @@ class AddDocumentsToEnvelopeInput: Add documents to an envelope """ - documents: Optional[List[Dict[str, Any]]] = None + documents: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -460,13 +619,17 @@ class AddDocumentsResponse: Response for Add documents to an envelope """ - envelope_id: Optional[str] = field( + envelope_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeId"}, ) """The id of the envelope.""" - envelope_documents: Optional[List[EnvelopeDocument]] = field( + envelope_documents: Optional[ + List[EnvelopeDocument | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeDocuments"}, ) """The documents attached to the envelope.""" @@ -478,8 +641,11 @@ class ListTemplateDocumentsResponse: Response for List documents from a template """ - template_documents: Optional[List[EnvelopeDocument]] = field( + template_documents: Optional[ + List[EnvelopeDocument | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "templateDocuments"}, ) """Documents attached to a template.""" @@ -491,8 +657,11 @@ class ListDocumentsResponse: Response for List documents from an envelope """ - envelope_documents: Optional[List[EnvelopeDocument]] = field( + envelope_documents: Optional[ + List[EnvelopeDocument | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeDocuments"}, ) """The documents attached to the envelope.""" @@ -504,20 +673,23 @@ class EnvelopeDocument: Response for Get document info from envelope """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the document.""" - document_id: Optional[str] = field( + document_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "documentId"}, ) """The id of the document.""" - document_id_guid: Optional[str] = field( + document_id_guid: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "documentIdGuid"}, ) """The guid of the document.""" - error_details: Optional[Dict[str, Any]] = field( + error_details: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "errorDetails"}, ) """The error details of the document.""" @@ -529,38 +701,43 @@ class Tab: Response for Get info for recipient tab """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the tab.""" - tab_type: Optional[str] = field( + tab_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tabType"}, ) """The type of the tab.""" - tab_label: Optional[str] = field( + tab_label: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tabLabel"}, ) """The label of the tab.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the tab.""" - tab_id: Optional[str] = field( + tab_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tabId"}, ) """The id of the tab.""" - document_id: Optional[str] = field( + document_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "documentId"}, ) """The id of the document.""" - recipient_id: Optional[str] = field( + recipient_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientId"}, ) """The id of the recipient.""" - prefill: Optional[bool] = None + prefill: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether the tab is of prefill type.""" - selected: Optional[str] = None + selected: Optional[str] = dataclass_field(default=None, kw_only=True) """If tabs is checkbox, indicates whether the tab is selected.""" @@ -570,8 +747,9 @@ class AddRecipientTabsResponse: Response for Add tabs for a recipient on an envelope """ - recipient_tabs: Optional[List[RecipientTab]] = field( + recipient_tabs: Optional[List[RecipientTab | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientTabs"}, ) """The tabs added to a recipient.""" @@ -586,8 +764,9 @@ class RecipientTabsResponse: Response for Get recipient tabs from envelope """ - recipient_tabs: Optional[List[Tab]] = field( + recipient_tabs: Optional[List[Tab | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientTabs"}, ) """Recipient tab""" @@ -599,7 +778,7 @@ class TriggerMaestroFlowResponse: Response for Start Docusign workflow """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -612,7 +791,7 @@ class BuildNumberResponse: Response for Show build Number (For reference only. Do not include in a flow for execution) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -625,29 +804,22 @@ class CreateHookEnvelopeInput: When a Docusign Connect event occurs (Account-level) """ - all_users: Optional[str] = field( - default=None, - metadata={"wire_name": "allUsers"}, - ) - allow_envelope_publish: Optional[str] = field( - default=None, + all_users: str = dataclass_field(metadata={"wire_name": "allUsers"}) + allow_envelope_publish: str = dataclass_field( metadata={"wire_name": "allowEnvelopePublish"}, ) - include_document_fields: Optional[str] = field( - default=None, + include_document_fields: str = dataclass_field( metadata={"wire_name": "includeDocumentFields"}, ) - requires_acknowledgement: Optional[str] = field( - default=None, + requires_acknowledgement: str = dataclass_field( metadata={"wire_name": "requiresAcknowledgement"}, ) - url_to_publish_to: Optional[str] = field( - default=None, + url_to_publish_to: str = dataclass_field( metadata={"wire_name": "urlToPublishTo"}, ) - name: Optional[str] = None + name: str """Name your Connect configuration (for example, \"Envelope Events\").""" - events: Optional[List[str]] = None + events: List[str] """Select an event. To include another event, select \"Add new item.\"""" @@ -657,7 +829,7 @@ class CreateHookEnvelopeResponse: Response for When a Docusign Connect event occurs (Account-level) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -670,7 +842,7 @@ class EmbeddedSigningResponse: Response for Generate Embedded Signing URL """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The url of embedded signing view.""" @@ -683,7 +855,12 @@ class GetOrganizationsResponse: Response for Get organizations """ - organizations: Optional[List[Organization]] = None + organizations: Optional[ + List[Organization | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """list of organizations""" @@ -693,7 +870,12 @@ class ListFoldersResponse: Response for List folders """ - folders: Optional[List[Folder]] = None + folders: Optional[ + List[Folder | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Folders""" @@ -703,8 +885,9 @@ class ListEnvelopesResponse: Response for List envelopes """ - folder_items: Optional[List[FolderItem]] = field( + folder_items: Optional[List[FolderItem | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "folderItems"}, ) """The envelopes within a folder.""" @@ -716,8 +899,9 @@ class RecipientTypesResponse: Response for StaticResponseForRecipientTypes """ - tab_types: Optional[List[RecipientType]] = field( + tab_types: Optional[List[RecipientType | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tabTypes"}, ) """Recipient types""" @@ -729,8 +913,9 @@ class SignatureTypesResponse: Response for StaticResponseForSignatureTypes """ - tab_types: Optional[List[SignatureType]] = field( + tab_types: Optional[List[SignatureType | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tabTypes"}, ) """Signature types""" @@ -742,8 +927,9 @@ class ListSigningGroupResponse: Response for GetSigningGroups """ - signing_groups: Optional[List[SigningGroup]] = field( + signing_groups: Optional[List[SigningGroup | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "signingGroups"}, ) """List of all signing groups""" @@ -755,8 +941,9 @@ class TabTypesResponse: Response for StaticResponseForTabTypes """ - tab_types: Optional[List[TabType]] = field( + tab_types: Optional[List[TabType | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tabTypes"}, ) """Tab types""" @@ -768,8 +955,11 @@ class WorkflowDefinitionsResponse: Response for Get Maestro Workflow Definitions """ - workflow_definitions: Optional[List[WorkflowDefinition]] = field( + workflow_definitions: Optional[ + List[WorkflowDefinition | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WorkflowDefinitions"}, ) """WorkflowDefinitions""" @@ -781,8 +971,9 @@ class GetWorkFlowIdsResponse: Response for Get All Workflow Ids """ - workflow_ids: Optional[List[WorkflowId]] = field( + workflow_ids: Optional[List[WorkflowId | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "workflowIds"}, ) """Workflow ID""" @@ -794,12 +985,23 @@ class WorkflowDefinitionResponse: Response for Get Maestro Workflow Definition """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Id""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Name""" - payload_schema: Optional[List[WorkflowDefPayloadSchema]] = field( + payload_schema: Optional[ + List[WorkflowDefPayloadSchema | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PayloadSchema"}, ) @@ -810,7 +1012,7 @@ class GetDynamicSignersResponse: Response for Get the signers of a template in dynamic schema format """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -823,7 +1025,7 @@ class GetDynamicRecipientsResponse: Response for Get the signers of a template in dynamic schema format """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -836,7 +1038,7 @@ class StaticResponseForRecipientTypeSchemaResponse: Response for StaticResponseForRecipientTypeSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -849,7 +1051,7 @@ class StaticResponseForVerificationTypeSchemaResponse: Response for StaticResponseForVerificationTypeSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -862,7 +1064,7 @@ class StaticResponseForEmbeddedSenderSchemaResponse: Response for StaticResponseForEmbeddedSenderSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -875,7 +1077,7 @@ class StaticResponseForEmbeddedSigningSchemaResponse: Response for StaticResponseForEmbeddedSigningSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -888,7 +1090,7 @@ class StaticResponseForBuildNumberSchemaResponse: Response for StaticResponseForBuildNumberSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -901,7 +1103,7 @@ class StaticResponseForAnchorTabSchemaResponse: Response for StaticResponseForAnchorTabSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -914,7 +1116,7 @@ class StaticResponseForCompositeTemplatesResponse: Response for StaticResponseForCompositeTemplates """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -927,29 +1129,21 @@ class WebhookRequest: Definition: WebhookRequest """ - all_users: Optional[str] = field( - default=None, - metadata={"wire_name": "allUsers"}, - ) - allow_envelope_publish: Optional[str] = field( - default=None, + all_users: str = dataclass_field(metadata={"wire_name": "allUsers"}) + allow_envelope_publish: str = dataclass_field( metadata={"wire_name": "allowEnvelopePublish"}, ) - include_document_fields: Optional[str] = field( - default=None, + include_document_fields: str = dataclass_field( metadata={"wire_name": "includeDocumentFields"}, ) - requires_acknowledgement: Optional[str] = field( - default=None, + requires_acknowledgement: str = dataclass_field( metadata={"wire_name": "requiresAcknowledgement"}, ) - url_to_publish_to: Optional[str] = field( - default=None, + url_to_publish_to: str = dataclass_field( metadata={"wire_name": "urlToPublishTo"}, ) - name: Optional[str] = None - envelope_events: Optional[str] = field( - default=None, + name: str + envelope_events: str = dataclass_field( metadata={"wire_name": "envelopeEvents"}, ) @@ -960,7 +1154,7 @@ class WebhookEnvelopeResponse: Definition: WebhookEnvelopeResponse """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -969,7 +1163,7 @@ class WebhookOrganizationResponse: Definition: WebhookOrganizationResponse """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -978,9 +1172,17 @@ class WorkflowDefinition: Definition: WorkflowDefinition """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Id""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Name""" @@ -990,12 +1192,17 @@ class WorkflowDefPayloadSchema: Definition: WorkflowDefPayloadSchema """ - property_name: Optional[str] = field( + property_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PropertyName"}, ) """Name""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) """Type""" @@ -1005,7 +1212,7 @@ class MaestroInputVariables: Definition: MaestroInputVariables """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1018,7 +1225,7 @@ class DynamicSigners: Definition: DynamicSigners """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1031,7 +1238,7 @@ class DynamicRecipients: Definition: DynamicRecipients """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1044,7 +1251,7 @@ class AdditionalRecipientParamsSchema: Definition: AdditionalRecipientParamsSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1057,7 +1264,7 @@ class AdditionalRecipientData: Definition: AdditionalRecipientData """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1070,7 +1277,7 @@ class AdditionalURLForSenderView: Definition: AdditionalURLForSenderView """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1083,7 +1290,7 @@ class AdditionalURL: Definition: AdditionalURL """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1096,7 +1303,7 @@ class DynamicSigningUrlFields: Definition: DynamicSigningUrlFields """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1109,7 +1316,7 @@ class BuildNumberSchema: Definition: BuildNumberSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1122,7 +1329,7 @@ class AccountCustomFields: Definition: AccountCustomFields """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1135,7 +1342,7 @@ class AnchorTabSchema: Definition: AnchorTabSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1148,7 +1355,7 @@ class CompositeTemplateSchema: Definition: CompositeTemplateSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1161,7 +1368,12 @@ class AddRecipientToEnvelopeRequest: Definition: AddRecipientToEnvelopeRequest """ - signers: Optional[List[SignerRequest]] = None + signers: Optional[ + List[SignerRequest | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1170,13 +1382,15 @@ class SignerRequest: Definition: SignerRequest """ - routing_order: Optional[str] = field( + routing_order: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "routingOrder"}, ) """The signing order of the recipient in the document.""" - role_name: Optional[str] = field( + role_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "roleName"}, ) """The role of the signer.""" @@ -1188,7 +1402,12 @@ class OnEnvelopeStatusChangesResponse: Definition: OnEnvelopeStatusChangesResponse """ - envelopes: Optional[List[Envelope]] = None + envelopes: Optional[ + List[Envelope | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Envelopes""" @@ -1198,13 +1417,15 @@ class EnvelopeIds: Definition: EnvelopeIds """ - email_subject: Optional[str] = field( + email_subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "emailSubject"}, ) """Title of the envelope""" - envelope_id: Optional[str] = field( + envelope_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeId"}, ) """Envelope ID""" @@ -1216,34 +1437,37 @@ class FilteredEnvelopes: Definition: FilteredEnvelopes """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the envelope""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the envelope activity""" - envelope_id: Optional[str] = field( + envelope_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeId"}, ) """Envelope ID""" - documents: Optional[str] = None + documents: Optional[str] = dataclass_field(default=None, kw_only=True) """List of document names""" - recipients: Optional[str] = None + recipients: Optional[str] = dataclass_field(default=None, kw_only=True) """List of recipient names""" - sender: Optional[str] = None + sender: Optional[str] = dataclass_field(default=None, kw_only=True) """Sender name""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the envelope""" - status_date: Optional[str] = field( + status_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusDate"}, ) """Last status update of the activity""" - date_sent: Optional[str] = field( + date_sent: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dateSent"}, ) """Envelope sent date""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """URL of the envelope""" @@ -1253,17 +1477,19 @@ class SalesCopilotFilteredEnvelopes: Definition: SalesCopilotFilteredEnvelopes """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the envelope""" - sub_title: Optional[str] = field( + sub_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subTitle"}, ) """SubTitle of the envelope""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """URL of the envelope""" - additional_properties_for_sales_envelope: Optional[Dict[str, Any]] = field( + additional_properties_for_sales_envelope: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "additionalPropertiesForSalesEnvelope"}, ) """Additional Properties""" @@ -1275,19 +1501,17 @@ class Activity: Definition: Activity """ - title: Optional[str] = None + title: str """This output indicates the title of the activity in the citation card.""" - description: Optional[str] = None + description: str """This output indicates the description of the insight.""" - date_time: Optional[str] = field( - default=None, - metadata={"wire_name": "dateTime"}, - ) + date_time: str = dataclass_field(metadata={"wire_name": "dateTime"}) """This output indicates the time associated with the insight.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """This output indicates the URL to open insight.""" - additional_properties: Optional[Dict[str, Any]] = field( + additional_properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "additionalProperties"}, ) """ @@ -1302,15 +1526,12 @@ class EmailSummary: Definition: EmailSummary """ - title: Optional[str] = field(default=None, metadata={"wire_name": "Title"}) + title: str = dataclass_field(metadata={"wire_name": "Title"}) """ This output indicates the title of the partner section and should include only the partner's name. """ - description: Optional[str] = field( - default=None, - metadata={"wire_name": "Description"}, - ) + description: str = dataclass_field(metadata={"wire_name": "Description"}) """ This output indicates the text you would like to be included in the email summary. @@ -1323,22 +1544,24 @@ class KeySales: Definition: KeySales """ - title: Optional[str] = field(default=None, metadata={"wire_name": "Title"}) + title: str = dataclass_field(metadata={"wire_name": "Title"}) """This output indicates the title of citation card for the insight.""" - description: Optional[str] = None + description: str """ This output indicates the text of the insight to be included in key sales info. """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """This output indicates the URL to learn more about the insight.""" - date_time: Optional[str] = field( + date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dateTime"}, ) """This output indicates the time associated with the insight.""" - additional_properties: Optional[Dict[str, Any]] = field( + additional_properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "additionalProperties"}, ) """ @@ -1353,52 +1576,42 @@ class DocumentRecord: Definition: DocumentRecord """ - record_id: Optional[str] = field( - default=None, - metadata={"wire_name": "recordId"}, - ) + record_id: str = dataclass_field(metadata={"wire_name": "recordId"}) """ This output uniquely identifies each related record returned by the action. """ - record_type_display_name: Optional[str] = field( - default=None, + record_type_display_name: str = dataclass_field( metadata={"wire_name": "recordTypeDisplayName"}, ) """ This output indicates the display name of record type of each related record returned by the action. """ - record_type_plural_display_name: Optional[str] = field( - default=None, + record_type_plural_display_name: str = dataclass_field( metadata={"wire_name": "recordTypePluralDisplayName"}, ) """ This output indicates the plural display name of the record type of each related record returned by the action. """ - record_type: Optional[str] = field( - default=None, - metadata={"wire_name": "recordType"}, - ) + record_type: str = dataclass_field(metadata={"wire_name": "recordType"}) """ This output indicates the type of each related record returned by the action. """ - record_title: Optional[str] = field( - default=None, - metadata={"wire_name": "recordTitle"}, - ) + record_title: str = dataclass_field(metadata={"wire_name": "recordTitle"}) """ This output indicates the title of each related record returned by the action. """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """ This output indicates the URL of each related record returned by the action. """ - additional_properties: Optional[Dict[str, Any]] = field( + additional_properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "additionalProperties"}, ) """Additional Properties""" @@ -1410,35 +1623,41 @@ class Envelope: Definition: Envelope """ - documents_uri: Optional[str] = field( + documents_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "documentsUri"}, ) """The URI for the document in DocuSign.""" - envelope_id: Optional[str] = field( + envelope_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeId"}, ) """The id of the envelope.""" - envelope_uri: Optional[str] = field( + envelope_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeUri"}, ) """The URI for the envelope in DocuSign.""" - notification_uri: Optional[str] = field( + notification_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationUri"}, ) """The URI for the notifications.""" - recipients_uri: Optional[str] = field( + recipients_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientsUri"}, ) """The URI for the recipients of the envelope in DocuSign.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status of the envelope.""" - status_changed_date_time: Optional[str] = field( + status_changed_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusChangedDateTime"}, ) """The datetime the status changed.""" @@ -1450,13 +1669,15 @@ class CombinedEmailBodyAndCustomFields: Definition: CombinedEmailBodyAndCustomFields """ - email_blurb: Optional[str] = field( + email_blurb: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "emailBlurb"}, ) """Body of the email.""" - account_custom_fields: Optional[AccountCustomFields] = field( + account_custom_fields: Optional[AccountCustomFields | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountCustomFields"}, ) @@ -1467,7 +1688,12 @@ class EnvelopeIDsResponse: Definition: EnvelopeIDsResponse """ - envelopes: Optional[List[EnvelopeIds]] = None + envelopes: Optional[ + List[EnvelopeIds | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """list of envelope ids""" @@ -1477,10 +1703,16 @@ class FilteredSalesCopilotEnvelopeListResponse: Definition: FilteredSalesCopilotEnvelopeListResponse """ - value: Optional[List[SalesCopilotFilteredEnvelopes]] = None + value: Optional[ + List[SalesCopilotFilteredEnvelopes | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Filtered envelopes""" - has_more_results: Optional[bool] = field( + has_more_results: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasMoreResults"}, ) @@ -1491,10 +1723,16 @@ class ActivityListResponseEnvelope: Definition: ActivityListResponseEnvelope """ - value: Optional[List[Activity]] = None + value: Optional[ + List[Activity | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Related activies""" - has_more_results: Optional[bool] = field( + has_more_results: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasMoreResults"}, ) @@ -1505,10 +1743,16 @@ class EmailSummaryResponse: Definition: EmailSummaryResponse """ - value: Optional[List[EmailSummary]] = None + value: Optional[ + List[EmailSummary | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Key Sales""" - has_more_results: Optional[bool] = field( + has_more_results: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasMoreResults"}, ) @@ -1519,10 +1763,16 @@ class KeySalesResponse: Definition: KeySalesResponse """ - value: Optional[List[KeySales]] = None + value: Optional[ + List[KeySales | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Key Sales""" - has_more_results: Optional[bool] = field( + has_more_results: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasMoreResults"}, ) @@ -1533,10 +1783,16 @@ class DocumentRecordListResponseEnvelope: Definition: DocumentRecordListResponseEnvelope """ - value: Optional[List[DocumentRecord]] = None + value: Optional[ + List[DocumentRecord | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Related records""" - has_more_results: Optional[bool] = field( + has_more_results: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasMoreResults"}, ) @@ -1547,19 +1803,18 @@ class ApiError: Definition: ApiError """ - error_code: Optional[str] = field( - default=None, - metadata={"wire_name": "errorCode"}, - ) - error_message: Optional[str] = field( + error_code: str = dataclass_field(metadata={"wire_name": "errorCode"}) + error_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "errorMessage"}, ) - activity_id: Optional[str] = field( + activity_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "activityId"}, ) - details: Optional[Dict[str, Any]] = None + details: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1568,9 +1823,9 @@ class Organization: Definition: organization """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the organization.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the organization.""" @@ -1580,10 +1835,9 @@ class LoginAccount: Definition: LoginAccount """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the account. """ - account_id_guid: Optional[str] = field( - default=None, + account_id_guid: str = dataclass_field( metadata={"wire_name": "accountIdGuid"}, ) """The GUID of the account.""" @@ -1595,8 +1849,9 @@ class DocumentTypesResponse: Definition: DocumentTypesResponse """ - document_types: Optional[List[DocumentType]] = field( + document_types: Optional[List[DocumentType | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "documentTypes"}, ) """Document types""" @@ -1608,18 +1863,23 @@ class DocGenFormField: Definition: DocGenFormField """ - document_id: Optional[str] = field( + document_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "documentId"}, ) """Document Id.""" - label: Optional[str] = None + label: Optional[str] = dataclass_field(default=None, kw_only=True) """Label.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value.""" @@ -1629,8 +1889,9 @@ class FontNamesResponse: Definition: FontNamesResponse """ - font_names: Optional[List[FontName]] = field( + font_names: Optional[List[FontName | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fontNames"}, ) """Font names""" @@ -1642,7 +1903,7 @@ class DocumentType: Definition: DocumentType """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The type of a document.""" @@ -1652,9 +1913,13 @@ class TabType: Definition: TabType """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Display name of the tab.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type of the tab.""" @@ -1664,9 +1929,13 @@ class WorkflowId: Definition: WorkflowID """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of workflowID""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type of workflowID""" @@ -1676,9 +1945,13 @@ class RecipientType: Definition: RecipientType """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Display name of the recipient type.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type of the recipient.""" @@ -1688,9 +1961,13 @@ class SignatureType: Definition: SignatureType """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Display name of the signature type.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type of the signature.""" @@ -1700,7 +1977,7 @@ class FontName: Definition: FontName """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of a font metadata.""" @@ -1710,13 +1987,13 @@ class SigningGroup: Definition: SigningGroup """ - signing_group_id: Optional[str] = field( - default=None, + signing_group_id: str = dataclass_field( metadata={"wire_name": "signingGroupId"}, ) """The ID of the signing group.""" - group_name: Optional[str] = field( + group_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "groupName"}, ) """The name of the signing group.""" @@ -1728,12 +2005,9 @@ class EnvelopeTemplate: Definition: EnvelopeTemplate """ - template_id: Optional[str] = field( - default=None, - metadata={"wire_name": "templateId"}, - ) + template_id: str = dataclass_field(metadata={"wire_name": "templateId"}) """The id of the template.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the template.""" @@ -1743,10 +2017,11 @@ class Folder: Definition: Folder """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the folder.""" - folder_id: Optional[str] = field( + folder_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "folderId"}, ) """The id of the folder.""" @@ -1758,12 +2033,13 @@ class FolderItem: Definition: FolderItem """ - envelope_id: Optional[str] = field( + envelope_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "envelopeId"}, ) """The id of the envelope.""" - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """The subject of the envelope.""" @@ -1773,13 +2049,15 @@ class RecipientTab: Definition: RecipientTab """ - tab_id: Optional[str] = field( + tab_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tabId"}, ) """The id of the tab.""" - tab_type: Optional[str] = field( + tab_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tabType"}, ) """The type of the tab.""" @@ -1791,9 +2069,9 @@ class EnvelopeDocumentField: Definition: EnvelopeDocumentField """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the custom field.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the custom field.""" @@ -1803,7 +2081,7 @@ class DeclineReasonWithoutType: Definition: DeclineReasonWithoutType """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1821,7 +2099,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1838,8 +2116,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1860,7 +2138,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1875,7 +2153,84 @@ def __init__( def connector_name(self) -> str: return "docusign" - async def get_docgen_form_fields_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_docgen_form_fields( self, account_id: str, envelope_id: str, @@ -1884,11 +2239,30 @@ async def get_docgen_form_fields_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get document generation form fields from envelope Get document generation form fields from envelope + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDocgenFormFields`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1898,29 +2272,50 @@ async def get_docgen_form_fields_async( f"/{quote(str(envelope_id), safe='')}" f"/docGenFormFields" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("docgenFields", []): + yield item - async def update_docgen_form_fields_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def update_docgen_form_fields( self, input: UpdateDocgenFormFieldsInput, account_id: str, @@ -1936,6 +2331,24 @@ async def update_docgen_form_fields_async( Update document generation form fields from envelope Update document generation form fields from envelope + + Swagger operation ID: `UpdateDocgenFormFields`. + + Args: + input: The request body. + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + document_guid: Document GUID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1953,7 +2366,7 @@ async def update_docgen_form_fields_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1967,9 +2380,10 @@ async def update_docgen_form_fields_async( request_url, response.status, response.text, + response=response, ) - async def get_doc_gen_template_tabs_async( + async def get_doc_gen_template_tabs( self, account_id: str, template_id: str, @@ -1985,6 +2399,22 @@ async def get_doc_gen_template_tabs_async( Get document generation form fields from template (bulk send templates only) + + Swagger operation ID: `GetDocGenTemplateTabs`. + + Args: + account_id: Enter or select an account ID. + template_id: Enter or select a template ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1994,7 +2424,7 @@ async def get_doc_gen_template_tabs_async( f"/{quote(str(template_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2008,6 +2438,7 @@ async def get_doc_gen_template_tabs_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2015,7 +2446,7 @@ async def get_doc_gen_template_tabs_async( return json.loads(response.text) - async def void_envelope_async( + async def void_envelope( self, account_id: str, envelope_id: str, @@ -2030,6 +2461,23 @@ async def void_envelope_async( Void the envelope Void the envelope. + + Swagger operation ID: `VoidEnvelope`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + voided_reason: Voided reason. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2047,7 +2495,7 @@ async def void_envelope_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2061,6 +2509,7 @@ async def void_envelope_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2068,7 +2517,7 @@ async def void_envelope_async( return json.loads(response.text) - async def resend_envelope_async( + async def resend_envelope( self, envelope_id: str, *, @@ -2083,6 +2532,21 @@ async def resend_envelope_async( This action resends a Docusign envelope or sends a reminder to recipients who need to sign a Docusign agreement based on a provided EnvelopeId. + + Swagger operation ID: `ResendEnvelope`. + + Args: + envelope_id: Enter an envelope ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2093,7 +2557,7 @@ async def resend_envelope_async( f"/resendEnvelope" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2107,6 +2571,7 @@ async def resend_envelope_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2114,15 +2579,15 @@ async def resend_envelope_async( return json.loads(response.text) - async def add_reminders_async( + async def add_reminders( self, account_id: str, envelope_id: str, reminder_enabled: bool, reminder_delay: str, reminder_frequency: str, - expire_after: Optional[str] = None, *, + expire_after: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2132,6 +2597,28 @@ async def add_reminders_async( Add reminders for an envelope Add reminders for an envelope + + Swagger operation ID: `AddReminders`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + reminder_enabled: When set to false the reminders are disabled. + Default is false. + reminder_delay: Add number of days after which recipient receives + reminder email. + reminder_frequency: Add number of days between reminder emails. + expire_after: Add number of days before expiry. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2162,7 +2649,7 @@ async def add_reminders_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2176,6 +2663,7 @@ async def add_reminders_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2183,7 +2671,7 @@ async def add_reminders_async( return json.loads(response.text) - async def get_envelope_document_tabs_async( + def list_envelope_document_tabs( self, account_id: str, envelope_id: str, @@ -2193,11 +2681,31 @@ async def get_envelope_document_tabs_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get document tabs from envelope Get document tabs from envelope + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetEnvelopeDocumentTabs`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + document_id: Enter a document ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2209,29 +2717,50 @@ async def get_envelope_document_tabs_async( f"/{quote(str(document_id), safe='')}" f"/tabs" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("tabs", []): + yield item + + return None, items() - async def update_envelope_prefill_tabs_async( + return AsyncItemPaged(get_next, extract_data) + + async def update_envelope_prefill_tabs( self, input: UpdateEnvelopePrefillTabsInput, account_id: str, @@ -2247,6 +2776,24 @@ async def update_envelope_prefill_tabs_async( Update envelope prefill tabs Update values for a list of prefill tabs + + Swagger operation ID: `UpdateEnvelopePrefillTabs`. + + Args: + input: The request body. + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + document_id: Enter a document ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2259,7 +2806,7 @@ async def update_envelope_prefill_tabs_async( f"/tabs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2273,9 +2820,10 @@ async def update_envelope_prefill_tabs_async( request_url, response.status, response.text, + response=response, ) - async def get_template_document_tabs_async( + def list_template_document_tabs( self, account_id: str, template_id: str, @@ -2285,11 +2833,31 @@ async def get_template_document_tabs_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get document tabs from template Get document tabs from template + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTemplateDocumentTabs`. + + Args: + account_id: Enter or select an account ID. + template_id: Enter or select a template ID. + document_id: Enter a document ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2301,29 +2869,50 @@ async def get_template_document_tabs_async( f"/{quote(str(document_id), safe='')}" f"/tabs" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("tabs", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_envelope_document_fields_async( + def list_envelope_document_fields( self, account_id: str, envelope_id: str, @@ -2333,11 +2922,31 @@ async def get_envelope_document_fields_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get document custom fields from envelope Get document custom fields from envelope + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetEnvelopeDocumentFields`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + document_id: Enter a document ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2349,37 +2958,58 @@ async def get_envelope_document_fields_async( f"/{quote(str(document_id), safe='')}" f"/fields" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("envelopeDocumentFields", []): + yield item - async def composite_templates_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def composite_templates( self, - input: CompositeTemplateSchema, + input: CompositeTemplateSchema | Mapping[str, Any], account_id: str, email_subject: str, status: str, + *, email_body: Optional[str] = None, merge_roles_on_draft: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2389,6 +3019,27 @@ async def composite_templates_async( Create envelope using composite templates Create envelope using composite templates + + Swagger operation ID: `CompositeTemplates`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + email_subject: Subject of the email. + status: Envelope status. + email_body: Body of the email. + merge_roles_on_draft: Merge roles and delete empty recipients. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2419,7 +3070,7 @@ async def composite_templates_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2433,6 +3084,7 @@ async def composite_templates_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2440,9 +3092,10 @@ async def composite_templates_async( return json.loads(response.text) - async def search_list_envelopes_async( + async def search_list_envelopes( self, account_id: str, + *, recipient_name: Optional[str] = None, recipient_email_id: Optional[str] = None, envelope_title: Optional[str] = None, @@ -2456,7 +3109,6 @@ async def search_list_envelopes_async( skip: Optional[int] = None, from_date: Optional[str] = None, to_date: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2471,6 +3123,39 @@ async def search_list_envelopes_async( title, description, Envelope ID, document names, sender names, envelope status, status date, date sent, and a URL of the envelope which can be used as a link to view the envelope in Docusign. + + Swagger operation ID: `SearchListEnvelopes`. + + Args: + account_id: Enter or select an account ID. + recipient_name: This action lists envelopes based on recipient + name. + recipient_email_id: Filters envelopes by recipient email. + envelope_title: Filters envelopes by envelope subject. + custom_field_name: This action lists envelopes based on a name of + its custom fields. + custom_field_value: Filters by custom field value. + search_text: Enter one keyword to find matches in envelope + subjects, recipients, and custom fields. + envelope_status: This action lists envelopes based on status of the + envelope. + folder_ids: Filters envelopes by the selected folder. + order_by: Sorts envelopes in the selected order. + top: Specify the number of envelopes to return (default is 10; + maximum is 1,000). + skip: Specify the number of envelopes to skip from the start. + from_date: Enter start date-time in UTC format: 2017-05-02T01:44z. + to_date: Enter end date-time in UTC format: 2017-05-02T01:44z. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2548,7 +3233,7 @@ async def search_list_envelopes_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2562,6 +3247,7 @@ async def search_list_envelopes_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2569,7 +3255,7 @@ async def search_list_envelopes_async( return json.loads(response.text) - async def create_envelope_from_template_no_recipients_async( + async def create_envelope_from_template_no_recipients( self, account_id: str, template_id: str, @@ -2584,6 +3270,23 @@ async def create_envelope_from_template_no_recipients_async( Create envelope using template Create a new envelope using a specified template. + + Swagger operation ID: `CreateEnvelopeFromTemplateNoRecipients`. + + Args: + account_id: Enter or select an account ID. + template_id: Enter or select a template ID. + status: Envelope status. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2604,7 +3307,7 @@ async def create_envelope_from_template_no_recipients_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2618,6 +3321,7 @@ async def create_envelope_from_template_no_recipients_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2625,15 +3329,15 @@ async def create_envelope_from_template_no_recipients_async( return json.loads(response.text) - async def send_envelope_async( + async def send_envelope( self, - input: DynamicSigners, + input: DynamicSigners | Mapping[str, Any], account_id: str, status: str, template_id: str, + *, email_subject: Optional[str] = None, email_body: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2644,6 +3348,27 @@ async def send_envelope_async( Create a new envelope using a specified template and specify recipients. + + Swagger operation ID: `SendEnvelope`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + status: Envelope status. + template_id: Enter or select a template ID. + email_subject: Email subject. + email_body: Email body. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2671,7 +3396,7 @@ async def send_envelope_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2685,6 +3410,7 @@ async def send_envelope_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2692,14 +3418,14 @@ async def send_envelope_async( return json.loads(response.text) - async def send_envelope_with_recipient_fields_async( + async def send_envelope_with_recipient_fields( self, - input: DynamicRecipients, + input: DynamicRecipients | Mapping[str, Any], account_id: str, template_id: str, + *, merge_roles_on_draft: Optional[str] = None, email_subject: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2709,6 +3435,26 @@ async def send_envelope_with_recipient_fields_async( Create envelope using template with recipients and tabs Create envelope using template with recipients and tabs + + Swagger operation ID: `SendEnvelopeWithRecipientFields`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + template_id: Enter or select a template ID. + merge_roles_on_draft: Merge roles and delete empty recipients. + email_subject: Email subject. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2735,7 +3481,7 @@ async def send_envelope_with_recipient_fields_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2749,6 +3495,7 @@ async def send_envelope_with_recipient_fields_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2756,7 +3503,7 @@ async def send_envelope_with_recipient_fields_async( return json.loads(response.text) - async def send_draft_envelope_async( + async def send_draft_envelope( self, account_id: str, envelope_id: str, @@ -2770,6 +3517,22 @@ async def send_draft_envelope_async( Send envelope Send an existing envelope. + + Swagger operation ID: `SendDraftEnvelope`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2779,7 +3542,7 @@ async def send_draft_envelope_async( f"/{quote(str(envelope_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2793,6 +3556,7 @@ async def send_draft_envelope_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2800,7 +3564,7 @@ async def send_draft_envelope_async( return json.loads(response.text) - async def get_envelope_custom_field_async( + async def get_envelope_custom_field( self, account_id: str, envelope_id: str, @@ -2815,6 +3579,23 @@ async def get_envelope_custom_field_async( Get envelope custom field info Get envelope custom field info. + + Swagger operation ID: `GetEnvelopeCustomField`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + field_name: Custom Field Name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2832,7 +3613,7 @@ async def get_envelope_custom_field_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2846,6 +3627,7 @@ async def get_envelope_custom_field_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2853,7 +3635,7 @@ async def get_envelope_custom_field_async( return json.loads(response.text) - async def update_envelope_custom_field_async( + async def update_envelope_custom_field( self, account_id: str, envelope_id: str, @@ -2871,6 +3653,26 @@ async def update_envelope_custom_field_async( Update envelope custom field Update value for the specified envelope custom field + + Swagger operation ID: `UpdateEnvelopeCustomField`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + field_id: Custom Field ID. + field_type: Custom Field Type. + name: Custom Field Name. + value: Custom Field Value. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2900,7 +3702,7 @@ async def update_envelope_custom_field_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2914,6 +3716,7 @@ async def update_envelope_custom_field_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2921,9 +3724,9 @@ async def update_envelope_custom_field_async( return json.loads(response.text) - async def generate_embedded_sender_url_async( + async def generate_embedded_sender_url( self, - input: AdditionalURLForSenderView, + input: AdditionalURLForSenderView | Mapping[str, Any], account_id: str, envelope_id: str, open_in: str, @@ -2938,6 +3741,26 @@ async def generate_embedded_sender_url_async( Generate Embedded Sender URL Generate Embedded Sender URL + + Swagger operation ID: `GenerateEmbeddedSenderURL`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + open_in: Open in. + return_url: Return URL. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2960,7 +3783,7 @@ async def generate_embedded_sender_url_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2974,6 +3797,7 @@ async def generate_embedded_sender_url_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2981,7 +3805,7 @@ async def generate_embedded_sender_url_async( return json.loads(response.text) - async def get_recipient_status_async( + async def get_recipient_status( self, account_id: str, envelope_id: str, @@ -2995,6 +3819,22 @@ async def get_recipient_status_async( List recipients from an envelope List recipients from an envelope + + Swagger operation ID: `GetRecipientStatus`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3005,7 +3845,7 @@ async def get_recipient_status_async( f"/recipients" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3019,6 +3859,7 @@ async def get_recipient_status_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3026,7 +3867,7 @@ async def get_recipient_status_async( return json.loads(response.text) - async def remove_recipient_from_envelope_async( + async def remove_recipient_from_envelope( self, account_id: str, envelope_id: str, @@ -3042,6 +3883,24 @@ async def remove_recipient_from_envelope_async( Remove recipient from an envelope Remove recipient from an envelope + + Swagger operation ID: `RemoveRecipientFromEnvelope`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + folder_id: Folder ID. + remove_recipient_from_envelope_recipient_id: Recipient ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3063,7 +3922,7 @@ async def remove_recipient_from_envelope_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -3077,6 +3936,7 @@ async def remove_recipient_from_envelope_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3084,15 +3944,15 @@ async def remove_recipient_from_envelope_async( return json.loads(response.text) - async def get_recipient_fields_async( + async def get_recipient_fields( self, account_id: str, envelope_id: str, + *, recipient_email: Optional[str] = None, area_code: Optional[str] = None, phone_number: Optional[str] = None, recipient_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3102,6 +3962,26 @@ async def get_recipient_fields_async( Get recipient info from envelope Get recipient info from envelope + + Swagger operation ID: `GetRecipientFields`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + recipient_email: Recipient email. + area_code: Area code of the recipient. + phone_number: Phone number of the recipient. + recipient_id: Enter a recipient ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3135,7 +4015,7 @@ async def get_recipient_fields_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3149,6 +4029,7 @@ async def get_recipient_fields_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3156,7 +4037,7 @@ async def get_recipient_fields_async( return json.loads(response.text) - async def get_audit_events_async( + async def get_audit_events( self, account_id: str, envelope_id: str, @@ -3170,6 +4051,22 @@ async def get_audit_events_async( Get audit event list Get audit event list + + Swagger operation ID: `GetAuditEvents`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3180,7 +4077,7 @@ async def get_audit_events_async( f"/audit_events" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3194,6 +4091,7 @@ async def get_audit_events_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3201,9 +4099,9 @@ async def get_audit_events_async( return json.loads(response.text) - async def add_verification_to_recipient_async( + async def add_verification_to_recipient( self, - input: AdditionalRecipientData, + input: AdditionalRecipientData | Mapping[str, Any], account_id: str, envelope_id: str, recipient_id: str, @@ -3219,6 +4117,27 @@ async def add_verification_to_recipient_async( Add verification type to a recipient Add verification type to a recipient. + + Swagger operation ID: `AddVerificationToRecipient`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + recipient_id: Enter a recipient ID. + recipient_type: Enter or select a recipient type. + verification_type: Verification type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3245,7 +4164,7 @@ async def add_verification_to_recipient_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -3259,6 +4178,7 @@ async def add_verification_to_recipient_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3266,13 +4186,14 @@ async def add_verification_to_recipient_async( return json.loads(response.text) - async def update_envelope_recipient_async( + async def update_envelope_recipient( self, - input: AdditionalRecipientParamsSchema, + input: AdditionalRecipientParamsSchema | Mapping[str, Any], account_id: str, envelope_id: str, recipient_id: str, recipient_type: str, + *, signature_type: Optional[str] = None, client_user_id: Optional[str] = None, embedded_recipient_start_u_r_l: Optional[str] = None, @@ -3285,7 +4206,6 @@ async def update_envelope_recipient_async( country_code: Optional[str] = None, phone_number: Optional[str] = None, signing_group_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3295,6 +4215,41 @@ async def update_envelope_recipient_async( Update recipient on an envelope Update recipient on an envelope + + Swagger operation ID: `UpdateEnvelopeRecipient`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + recipient_id: Enter a recipient ID. + recipient_type: Recipient type. + signature_type: DocuSign standards-based-signature (SBS) types. + client_user_id: Client user ID for embedded signer. + embedded_recipient_start_u_r_l: A sender-provided URL string for + redirecting an embedded recipient. + routing_order: The signing order of the recipient. + email_notification_language: Language for the email notification. + email_notification_subject: Subject of the email notification. + email_notification_body: Body of the email notification. + note: Custom note for the recipient. + role_name: Role name associated with the recipient. + country_code: For SMS notifications, the country code, without + leading + sign. + phone_number: Signer email or SMS phone required. Exclude country + code for phone number. + signing_group_id: Signing Group. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3377,7 +4332,7 @@ async def update_envelope_recipient_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -3391,6 +4346,7 @@ async def update_envelope_recipient_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3398,14 +4354,14 @@ async def update_envelope_recipient_async( return json.loads(response.text) - async def apply_templates_to_documents_async( + async def apply_templates_to_documents( self, - input: ApplyTemplatesToDocumentsInput, + input: ApplyTemplatesToDocumentsInput | Mapping[str, Any], account_id: str, envelope_id: str, template_id: str, - preserve_template_recipient: Optional[str] = None, *, + preserve_template_recipient: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3415,6 +4371,26 @@ async def apply_templates_to_documents_async( Apply a template to documents Apply a template to documents + + Swagger operation ID: `ApplyTemplatesToDocuments`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + template_id: Enter or select a template ID. + preserve_template_recipient: False. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3437,7 +4413,7 @@ async def apply_templates_to_documents_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3451,11 +4427,12 @@ async def apply_templates_to_documents_async( request_url, response.status, response.text, + response=response, ) - async def create_bulk_send_list_async( + async def create_bulk_send_list( self, - input: CreateBulkSendListInput, + input: CreateBulkSendListInput | Mapping[str, Any], account_id: str, name: str, *, @@ -3468,6 +4445,24 @@ async def create_bulk_send_list_async( Create bulk send list Create bulk send list + + Swagger operation ID: `CreateBulkSendList`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + name: Bulk send list name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3481,7 +4476,7 @@ async def create_bulk_send_list_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3495,6 +4490,7 @@ async def create_bulk_send_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3502,7 +4498,7 @@ async def create_bulk_send_list_async( return json.loads(response.text) - async def bulk_send_async( + async def bulk_send( self, account_id: str, bulk_send_list_id: str, @@ -3517,6 +4513,24 @@ async def bulk_send_async( Bulk send envelope using template Bulk send envelope using template + + Swagger operation ID: `BulkSend`. + + Args: + account_id: Enter or select an account ID. + bulk_send_list_id: Bulk send list GUID. + envelope_or_template_id: Enter the template ID, or choose a + template from the dropdown. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3534,7 +4548,7 @@ async def bulk_send_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -3548,6 +4562,7 @@ async def bulk_send_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3555,43 +4570,81 @@ async def bulk_send_async( return json.loads(response.text) - async def get_login_accounts_async( + def list_login_accounts( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Login Login + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetLoginAccounts`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/oauth/userinfo" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("loginAccounts", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_envelope_templates_async( + def list_envelope_templates( self, account_id: str, *, @@ -3599,41 +4652,80 @@ async def get_envelope_templates_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List templates List templates for a specific account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetEnvelopeTemplates`. + + Args: + account_id: Enter or select an account ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/accounts/{quote(str(account_id), safe='')}/templates" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("envelopeTemplates", []): + yield item - async def add_documents_to_envelope_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def add_documents_to_envelope( self, - input: AddDocumentsToEnvelopeInput, + input: AddDocumentsToEnvelopeInput | Mapping[str, Any], account_id: str, envelope_id: str, *, @@ -3646,6 +4738,24 @@ async def add_documents_to_envelope_async( Add documents to an envelope Add documents to an envelope. + + Swagger operation ID: `AddDocumentsToEnvelope`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3656,7 +4766,7 @@ async def add_documents_to_envelope_async( f"/documents" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -3670,6 +4780,7 @@ async def add_documents_to_envelope_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3677,7 +4788,7 @@ async def add_documents_to_envelope_async( return json.loads(response.text) - async def list_template_documents_async( + def list_template_documents( self, account_id: str, template_id: str, @@ -3686,11 +4797,30 @@ async def list_template_documents_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List documents from a template List documents from a template + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListTemplateDocuments`. + + Args: + account_id: Enter or select an account ID. + template_id: Enter or select a template ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3700,29 +4830,50 @@ async def list_template_documents_async( f"/{quote(str(template_id), safe='')}" f"/documents" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("templateDocuments", []): + yield item + + return None, items() - async def list_envelope_documents_async( + return AsyncItemPaged(get_next, extract_data) + + def list_envelope_documents( self, account_id: str, envelope_id: str, @@ -3731,11 +4882,30 @@ async def list_envelope_documents_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List documents from an envelope List documents from an envelope + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListEnvelopeDocuments`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3745,29 +4915,50 @@ async def list_envelope_documents_async( f"/{quote(str(envelope_id), safe='')}" f"/envelopeDocuments" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("envelopeDocuments", []): + yield item + + return None, items() - async def get_envelope_document_info_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_envelope_document_info( self, account_id: str, envelope_id: str, @@ -3782,6 +4973,23 @@ async def get_envelope_document_info_async( Get document info from envelope Get document info from envelope + + Swagger operation ID: `GetEnvelopeDocumentInfo`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + document_name: File name with extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3799,7 +5007,7 @@ async def get_envelope_document_info_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3813,6 +5021,7 @@ async def get_envelope_document_info_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3820,7 +5029,7 @@ async def get_envelope_document_info_async( return json.loads(response.text) - async def get_tab_info_async( + async def get_tab_info( self, account_id: str, envelope_id: str, @@ -3836,6 +5045,24 @@ async def get_tab_info_async( Get info for recipient tab Returns the value of the tab for the given recipient + + Swagger operation ID: `GetTabInfo`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + recipient_id: Enter a recipient ID. + tab_label: Tab label. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3855,7 +5082,7 @@ async def get_tab_info_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3869,6 +5096,7 @@ async def get_tab_info_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3876,9 +5104,9 @@ async def get_tab_info_async( return json.loads(response.text) - async def add_recipient_tabs_async( + async def add_recipient_tabs( self, - input: AnchorTabSchema, + input: AnchorTabSchema | Mapping[str, Any], account_id: str, envelope_id: str, recipient_id: str, @@ -3893,6 +5121,26 @@ async def add_recipient_tabs_async( Add tabs for a recipient on an envelope Add tabs for a recipient on an envelope + + Swagger operation ID: `AddRecipientTabs`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + recipient_id: Enter a recipient ID. + tab_type: Tab type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3912,7 +5160,7 @@ async def add_recipient_tabs_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3926,6 +5174,7 @@ async def add_recipient_tabs_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3933,7 +5182,7 @@ async def add_recipient_tabs_async( return json.loads(response.text) - async def update_recipient_tabs_values_async( + async def update_recipient_tabs_values( self, input: UpdateRecipientTabsValuesInput, account_id: str, @@ -3949,6 +5198,24 @@ async def update_recipient_tabs_values_async( Update recipient tab values on an envelope Update recipient tab values on an envelope + + Swagger operation ID: `UpdateRecipientTabsValues`. + + Args: + input: The request body. + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + recipient_id: Enter a recipient ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3961,7 +5228,7 @@ async def update_recipient_tabs_values_async( f"/tabs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -3975,9 +5242,10 @@ async def update_recipient_tabs_values_async( request_url, response.status, response.text, + response=response, ) - async def get_envelope_recipient_tabs_async( + def list_envelope_recipient_tabs( self, account_id: str, envelope_id: str, @@ -3987,11 +5255,31 @@ async def get_envelope_recipient_tabs_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get recipient tabs from envelope Get recipient tabs from envelope + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetEnvelopeRecipientTabs`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + recipient_id: Enter a recipient ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4003,31 +5291,52 @@ async def get_envelope_recipient_tabs_async( f"/{quote(str(recipient_id), safe='')}" f"/recipientTabs" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("recipientTabs", []): + yield item + + return None, items() - async def trigger_maestro_flow_async( + return AsyncItemPaged(get_next, extract_data) + + async def trigger_maestro_flow( self, - input: MaestroInputVariables, + input: MaestroInputVariables | Mapping[str, Any], account_id: str, workflow_id: str, instance_name: str, @@ -4041,6 +5350,26 @@ async def trigger_maestro_flow_async( Start Docusign workflow Start Docusign workflow + + Swagger operation ID: `TriggerMaestroFlow`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + workflow_id: Enter the workflow ID or select the workflow name from + the dropdown. + instance_name: Name of the workflow instance. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4058,7 +5387,7 @@ async def trigger_maestro_flow_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4072,6 +5401,7 @@ async def trigger_maestro_flow_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4079,9 +5409,9 @@ async def trigger_maestro_flow_async( return json.loads(response.text) - async def build_number_async( + async def build_number( self, - input: BuildNumberSchema, + input: BuildNumberSchema | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4093,10 +5423,26 @@ async def build_number_async( execution) Identifier for the currently deployed build. + + Swagger operation ID: `BuildNumber`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/build_number" - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -4110,6 +5456,7 @@ async def build_number_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4117,12 +5464,13 @@ async def build_number_async( return json.loads(response.text) - async def add_recipient_to_envelope_async( + async def add_recipient_to_envelope( self, - input: AdditionalRecipientParamsSchema, + input: AdditionalRecipientParamsSchema | Mapping[str, Any], account_id: str, envelope_id: str, recipient_type: str, + *, client_user_id: Optional[str] = None, recipient_id: Optional[str] = None, embedded_recipient_start_u_r_l: Optional[str] = None, @@ -4137,7 +5485,6 @@ async def add_recipient_to_envelope_async( signing_group_id: Optional[str] = None, signature_type: Optional[str] = None, workflow_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4147,6 +5494,43 @@ async def add_recipient_to_envelope_async( Add recipient to an envelope Add recipient to an envelope. + + Swagger operation ID: `AddRecipientToEnvelopeV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + recipient_type: Enter or select a recipient type. + client_user_id: Client user ID for embedded signer. + recipient_id: Enter a recipient ID. + embedded_recipient_start_u_r_l: A sender-provided URL string for + redirecting an embedded recipient. + routing_order: The signing order of the recipient. + email_notification_language: Language for the email notification. + email_notification_subject: Subject of the email notification. + email_notification_body: Body of the email notification. + note: Custom note for the recipient. + role_name: Role name associated with the recipient. + country_code: For SMS notifications, the country code, without + leading + sign. + phone_number: Signer email or SMS phone required. Exclude country + code for phone number. + signing_group_id: Signing Group. + signature_type: DocuSign standards-based-signature (SBS) types. + workflow_id: IDV workflows with pen signature types must be + selected here. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4235,7 +5619,7 @@ async def add_recipient_to_envelope_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4249,6 +5633,7 @@ async def add_recipient_to_envelope_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4256,9 +5641,9 @@ async def add_recipient_to_envelope_async( return json.loads(response.text) - async def create_blank_envelope_async( + async def create_blank_envelope( self, - input: CombinedEmailBodyAndCustomFields, + input: CombinedEmailBodyAndCustomFields | Mapping[str, Any], account_id: str, email_subject: str, *, @@ -4271,6 +5656,24 @@ async def create_blank_envelope_async( Create envelope Create a new blank envelope. + + Swagger operation ID: `CreateBlankEnvelopeV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + email_subject: Subject of the email. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4287,7 +5690,7 @@ async def create_blank_envelope_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4301,6 +5704,7 @@ async def create_blank_envelope_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4308,9 +5712,9 @@ async def create_blank_envelope_async( return json.loads(response.text) - async def generate_embedded_signing_url_async( + async def generate_embedded_signing_url( self, - input: DynamicSigningUrlFields, + input: DynamicSigningUrlFields | Mapping[str, Any], account_id: str, envelope_id: str, is_in_person_signer: str, @@ -4326,6 +5730,27 @@ async def generate_embedded_signing_url_async( Generate Embedded Signing URL Generate Embedded Signing URL + + Swagger operation ID: `GenerateEmbeddedSigningURLV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + is_in_person_signer: Yes/No. + authentication_method: Authentication Method. + return_url: Return URL. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4352,7 +5777,7 @@ async def generate_embedded_signing_url_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4366,6 +5791,7 @@ async def generate_embedded_signing_url_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4373,13 +5799,13 @@ async def generate_embedded_signing_url_async( return json.loads(response.text) - async def get_documents_async( + async def get_documents( self, account_id: str, envelope_id: str, document_id: str, - language: Optional[str] = None, *, + language: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4389,6 +5815,25 @@ async def get_documents_async( Get documents from an envelope Get documents from an envelope + + Swagger operation ID: `GetDocumentsV2`. + + Args: + account_id: Enter or select an account ID. + envelope_id: Enter an envelope ID. + document_id: Enter \"string(document ID)\" to get a single + document, or select a format. + language: Select language. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4409,7 +5854,7 @@ async def get_documents_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4423,6 +5868,7 @@ async def get_documents_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4430,18 +5876,35 @@ async def get_documents_async( return json.loads(response.text) - async def get_organizations_async( + def list_organizations( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get organizations Get organizations + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetOrganizations`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/Management/v2/organizations" @@ -4450,29 +5913,50 @@ async def get_organizations_async( query_params.append("mode=" + quote("org_admin", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("organizations", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_account_custom_fields_async( + async def get_account_custom_fields( self, account_id: str, *, @@ -4485,6 +5969,21 @@ async def get_account_custom_fields_async( Get account custom fields Get the custom fields for a specified account. + + Swagger operation ID: `GetAccountCustomFields`. + + Args: + account_id: Account id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4493,7 +5992,7 @@ async def get_account_custom_fields_async( f"/account_custom_fields" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4507,9 +6006,10 @@ async def get_account_custom_fields_async( request_url, response.status, response.text, + response=response, ) - async def get_folder_list_async( + def list_get_folder( self, account_id: str, *, @@ -4517,39 +6017,78 @@ async def get_folder_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List folders List folders for a specific account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetFolderList`. + + Args: + account_id: Account id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/accounts/{quote(str(account_id), safe='')}/folders" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("folders", []): + yield item + + return None, items() - async def get_folder_envelope_list_async( + return AsyncItemPaged(get_next, extract_data) + + def list_get_folder_envelope( self, account_id: str, folder_id: str, @@ -4558,11 +6097,30 @@ async def get_folder_envelope_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List envelopes List envelopes under a particular folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetFolderEnvelopeList`. + + Args: + account_id: Enter or select an account ID. + folder_id: Folder id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4571,101 +6129,198 @@ async def get_folder_envelope_list_async( f"/folders" f"/{quote(str(folder_id), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("folderItems", []): + yield item + + return None, items() - async def static_response_for_recipient_types_async( + return AsyncItemPaged(get_next, extract_data) + + def list_static_response_for_recipient_types( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ StaticResponseForRecipientTypes Get recipient types. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `StaticResponseForRecipientTypes`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/recipient_types" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("tabTypes", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def static_response_for_signature_types_async( + def list_static_response_for_signature_types( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ StaticResponseForSignatureTypes Get signature types. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `StaticResponseForSignatureTypes`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/signature_types" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("tabTypes", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_signing_groups_async( + def list_signing_groups( self, account_id: str, *, @@ -4673,75 +6328,152 @@ async def get_signing_groups_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ GetSigningGroups List signing groups for a specific account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetSigningGroups`. + + Args: + account_id: Account id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/accounts/{quote(str(account_id), safe='')}/signing_groups" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("signingGroups", []): + yield item + + return None, items() - async def static_response_for_tab_types_async( + return AsyncItemPaged(get_next, extract_data) + + def list_static_response_for_tab_types( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ StaticResponseForTabTypes Get tab types. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `StaticResponseForTabTypes`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/tab_types" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("tabTypes", []): + yield item + + return None, items() - async def get_maestro_workflow_definitions_async( + return AsyncItemPaged(get_next, extract_data) + + def list_maestro_workflow_definitions( self, account_id: str, *, @@ -4749,39 +6481,78 @@ async def get_maestro_workflow_definitions_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Maestro Workflow Definitions Get Maestro Workflow Definitions + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMaestroWorkflowDefinitions`. + + Args: + account_id: accountId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/accounts/{quote(str(account_id), safe='')}/maestro-workflows" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("WorkflowDefinitions", []): + yield item - async def get_all_workflow_i_ds_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_all_workflow_i_ds( self, account_id: str, *, @@ -4789,11 +6560,29 @@ async def get_all_workflow_i_ds_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get All Workflow Ids Get All workflow ids + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllWorkflowIDs`. + + Args: + account_id: Account id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4801,29 +6590,50 @@ async def get_all_workflow_i_ds_async( f"/{quote(str(account_id), safe='')}" f"/all_identity_verification" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("workflowIds", []): + yield item - async def get_maestro_workflow_definition_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_maestro_workflow_definition( self, account_id: str, workflow_id: str, @@ -4837,6 +6647,22 @@ async def get_maestro_workflow_definition_async( Get Maestro Workflow Definition Get Maestro Workflow Definition + + Swagger operation ID: `GetMaestroWorkflowDefinition`. + + Args: + account_id: accountId. + workflow_id: workflowId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4846,7 +6672,7 @@ async def get_maestro_workflow_definition_async( f"/{quote(str(workflow_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4860,6 +6686,7 @@ async def get_maestro_workflow_definition_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4867,7 +6694,7 @@ async def get_maestro_workflow_definition_async( return json.loads(response.text) - async def get_dynamic_signers_async( + async def get_dynamic_signers( self, account_id: str, template_id: str, @@ -4881,6 +6708,22 @@ async def get_dynamic_signers_async( Get the signers of a template in dynamic schema format Get the signers of a template in dynamic schema format. + + Swagger operation ID: `GetDynamicSigners`. + + Args: + account_id: Account to get the signers for. + template_id: Template to get the signers for. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4892,7 +6735,7 @@ async def get_dynamic_signers_async( f"/recipients" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4906,6 +6749,7 @@ async def get_dynamic_signers_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4913,7 +6757,7 @@ async def get_dynamic_signers_async( return json.loads(response.text) - async def get_dynamic_recipients_async( + async def get_dynamic_recipients( self, account_id: str, template_id: str, @@ -4927,6 +6771,22 @@ async def get_dynamic_recipients_async( Get the signers of a template in dynamic schema format Get the signers of a template in dynamic schema format. + + Swagger operation ID: `GetDynamicRecipients`. + + Args: + account_id: Account to get the signers for. + template_id: Template to get the signers for. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4937,7 +6797,7 @@ async def get_dynamic_recipients_async( f"/{quote(str(template_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4951,6 +6811,7 @@ async def get_dynamic_recipients_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4958,11 +6819,11 @@ async def get_dynamic_recipients_async( return json.loads(response.text) - async def static_response_for_recipient_type_schema_async( + async def static_response_for_recipient_type_schema( self, recipient_type: str, - signature_type: Optional[str] = None, *, + signature_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4972,6 +6833,22 @@ async def static_response_for_recipient_type_schema_async( StaticResponseForRecipientTypeSchema Get schema for a specific recipient type. + + Swagger operation ID: `StaticResponseForRecipientTypeSchema`. + + Args: + recipient_type: recipient type. + signature_type: signature type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/recipienttype_schema" query_params = [] @@ -4987,7 +6864,7 @@ async def static_response_for_recipient_type_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5001,6 +6878,7 @@ async def static_response_for_recipient_type_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5008,7 +6886,7 @@ async def static_response_for_recipient_type_schema_async( return json.loads(response.text) - async def static_response_for_verification_type_schema_async( + async def static_response_for_verification_type_schema( self, verification_type: str, *, @@ -5021,6 +6899,21 @@ async def static_response_for_verification_type_schema_async( StaticResponseForVerificationTypeSchema Get schema for a verification type. + + Swagger operation ID: `StaticResponseForVerificationTypeSchema`. + + Args: + verification_type: Verification Type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/verificationtype_schema" query_params = [] @@ -5031,7 +6924,7 @@ async def static_response_for_verification_type_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5045,6 +6938,7 @@ async def static_response_for_verification_type_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5052,7 +6946,7 @@ async def static_response_for_verification_type_schema_async( return json.loads(response.text) - async def static_response_for_embedded_sender_schema_async( + async def static_response_for_embedded_sender_schema( self, return_url: str, *, @@ -5065,6 +6959,21 @@ async def static_response_for_embedded_sender_schema_async( StaticResponseForEmbeddedSenderSchema Get schema for return URL. + + Swagger operation ID: `StaticResponseForEmbeddedSenderSchema`. + + Args: + return_url: Return URL. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/embeddedSender_schema" query_params = [] @@ -5075,7 +6984,7 @@ async def static_response_for_embedded_sender_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5089,6 +6998,7 @@ async def static_response_for_embedded_sender_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5096,7 +7006,7 @@ async def static_response_for_embedded_sender_schema_async( return json.loads(response.text) - async def static_response_for_embedded_signing_schema_async( + async def static_response_for_embedded_signing_schema( self, return_url: str, is_in_person_signer: str, @@ -5110,6 +7020,22 @@ async def static_response_for_embedded_signing_schema_async( StaticResponseForEmbeddedSigningSchema Get schema for return URL. + + Swagger operation ID: `StaticResponseForEmbeddedSigningSchemaV2`. + + Args: + return_url: Return URL. + is_in_person_signer: Is this an in-person signer? + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/embeddedSigning_schema_v2" @@ -5126,7 +7052,7 @@ async def static_response_for_embedded_signing_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5140,6 +7066,7 @@ async def static_response_for_embedded_signing_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5147,7 +7074,7 @@ async def static_response_for_embedded_signing_schema_async( return json.loads(response.text) - async def static_response_for_build_number_schema_async( + async def static_response_for_build_number_schema( self, *, timeout: Optional[float] = None, @@ -5159,10 +7086,24 @@ async def static_response_for_build_number_schema_async( StaticResponseForBuildNumberSchema Get schema for a build number. + + Swagger operation ID: `StaticResponseForBuildNumberSchema`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/build_number_schema" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5176,6 +7117,7 @@ async def static_response_for_build_number_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5183,7 +7125,7 @@ async def static_response_for_build_number_schema_async( return json.loads(response.text) - async def get_custom_fields_async( + async def get_custom_fields( self, account_id: str, *, @@ -5196,13 +7138,28 @@ async def get_custom_fields_async( Get custom fields from an account Get custom fields from an account + + Swagger operation ID: `GetCustomFields`. + + Args: + account_id: Account id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/accounts/{quote(str(account_id), safe='')}/custom_fields" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5216,9 +7173,10 @@ async def get_custom_fields_async( request_url, response.status, response.text, + response=response, ) - async def static_response_for_anchor_tab_schema_async( + async def static_response_for_anchor_tab_schema( self, tab_type: str, *, @@ -5231,6 +7189,21 @@ async def static_response_for_anchor_tab_schema_async( StaticResponseForAnchorTabSchema Get schema for a specific anchor tab. + + Swagger operation ID: `StaticResponseForAnchorTabSchema`. + + Args: + tab_type: tab type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/anchortab_schema" query_params = [] @@ -5241,7 +7214,7 @@ async def static_response_for_anchor_tab_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5255,6 +7228,7 @@ async def static_response_for_anchor_tab_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5262,7 +7236,7 @@ async def static_response_for_anchor_tab_schema_async( return json.loads(response.text) - async def static_response_for_composite_templates_async( + async def static_response_for_composite_templates( self, *, timeout: Optional[float] = None, @@ -5274,12 +7248,26 @@ async def static_response_for_composite_templates_async( StaticResponseForCompositeTemplates Get schema for a composite templates. + + Swagger operation ID: `StaticResponseForCompositeTemplates`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/composite_templates_schema" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5293,6 +7281,7 @@ async def static_response_for_composite_templates_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/docuware.py b/src/azure/connectors/docuware.py index d3db694f..03e9a69b 100644 --- a/src/azure/connectors/docuware.py +++ b/src/azure/connectors/docuware.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,30 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "DocuwareClient", + "GetDialogFieldsResponse", + "GetDialogsResponse", + "GetDocumentInformationResponse", + "GetFileCabinetFieldsResponse", + "GetFileCabinetsResponse", + "GetOrganizationResponse", + "GetStampFieldsResponse", + "GetStampsResponse", + "ListDocumentsInDocumentTrayResponse", + "PlaceAStampInput", + "PlaceAStampResponse", + "SearchForDocumentsInFileCabinetInput", + "SearchForDocumentsInFileCabinetResponse", + "TransferDocumentInput", + "TransferDocumentResponse", + "UpdateIndexFieldsInput", + "UpdateIndexFieldsResponse", +] + # Type Definitions @@ -29,7 +52,7 @@ class SearchForDocumentsInFileCabinetInput: Search in file cabinet """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -42,10 +65,15 @@ class SearchForDocumentsInFileCabinetResponse: Response for Search in file cabinet """ - count: Optional[int] = field(default=None, metadata={"wire_name": "Count"}) + count: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Count"}, + ) """Count""" - documents: Optional[List[Dict[str, Any]]] = field( + documents: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Documents"}, ) """Documents""" @@ -57,7 +85,11 @@ class GetOrganizationResponse: Response for Get organization """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Name""" @@ -67,8 +99,9 @@ class GetFileCabinetsResponse: Response for Get file cabinets and document trays """ - file_cabinets: Optional[List[Dict[str, Any]]] = field( + file_cabinets: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileCabinets"}, ) """FileCabinets""" @@ -80,53 +113,63 @@ class GetDocumentInformationResponse: Response for Get document information """ - sections: Optional[List[Dict[str, Any]]] = field( + sections: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sections"}, ) """Sections""" - document_id: Optional[int] = field( + document_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DocumentId"}, ) """DocumentId""" - index_fields: Optional[Dict[str, Any]] = field( + index_fields: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IndexFields"}, ) """IndexFields""" - document_title: Optional[str] = field( + document_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DocumentTitle"}, ) """DocumentTitle""" - file_cabinet_id: Optional[str] = field( + file_cabinet_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileCabinetId"}, ) """FileCabinetId""" - total_pages: Optional[int] = field( + total_pages: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TotalPages"}, ) """TotalPages""" - file_size: Optional[int] = field( + file_size: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileSize"}, ) """FileSize""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentType"}, ) """ContentType""" - version_status: Optional[str] = field( + version_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VersionStatus"}, ) """VersionStatus""" - document_flags: Optional[Dict[str, Any]] = field( + document_flags: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DocumentFlags"}, ) """DocumentFlags""" @@ -141,53 +184,63 @@ class UpdateIndexFieldsResponse: Response for Update index fields """ - sections: Optional[List[Dict[str, Any]]] = field( + sections: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sections"}, ) """Sections""" - document_id: Optional[int] = field( + document_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DocumentId"}, ) """DocumentId""" - index_fields: Optional[Dict[str, Any]] = field( + index_fields: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IndexFields"}, ) """IndexFields""" - document_title: Optional[str] = field( + document_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DocumentTitle"}, ) """DocumentTitle""" - file_cabinet_id: Optional[str] = field( + file_cabinet_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileCabinetId"}, ) """FileCabinetId""" - total_pages: Optional[int] = field( + total_pages: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TotalPages"}, ) """TotalPages""" - file_size: Optional[int] = field( + file_size: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileSize"}, ) """FileSize""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentType"}, ) """ContentType""" - version_status: Optional[str] = field( + version_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VersionStatus"}, ) """VersionStatus""" - document_flags: Optional[Dict[str, Any]] = field( + document_flags: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DocumentFlags"}, ) """DocumentFlags""" @@ -199,22 +252,24 @@ class TransferDocumentInput: Transfer documents """ - source_file_cabinet_id: Optional[str] = field( - default=None, + source_file_cabinet_id: str = dataclass_field( metadata={"wire_name": "SourceFileCabinetId"}, ) """Select the source File Cabinet or Document Tray.""" - documents: Optional[List[Dict[str, Any]]] = field( + documents: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Documents"}, ) - keep_source: Optional[bool] = field( + keep_source: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "KeepSource"}, ) """Choose whether the source documents should be deleted or not.""" - fill_intellix: Optional[bool] = field( + fill_intellix: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FillIntellix"}, ) """Choose whether intelligent indexing should be used when storing.""" @@ -226,10 +281,15 @@ class TransferDocumentResponse: Response for Transfer documents """ - count: Optional[int] = field(default=None, metadata={"wire_name": "Count"}) + count: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Count"}, + ) """Count""" - documents: Optional[List[Dict[str, Any]]] = field( + documents: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Documents"}, ) """Documents""" @@ -241,40 +301,35 @@ class PlaceAStampInput: Place a stamp """ - file_number: Optional[int] = field( - default=None, - metadata={"wire_name": "FileNumber"}, - ) + file_number: int = dataclass_field(metadata={"wire_name": "FileNumber"}) """Specify the file/section containing the page to be stamped.""" - page_number: Optional[int] = field( - default=None, - metadata={"wire_name": "PageNumber"}, - ) + page_number: int = dataclass_field(metadata={"wire_name": "PageNumber"}) """Specify the page number to place the stamp on.""" - layer: Optional[int] = field(default=None, metadata={"wire_name": "Layer"}) + layer: int = dataclass_field(metadata={"wire_name": "Layer"}) """Specify the document layer to place the stamp on [1-5]""" - position_x: Optional[float] = field( + position_x: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PositionX"}, ) """[Optional] Position from the left edge of the page in mm.""" - position_y: Optional[float] = field( + position_y: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PositionY"}, ) """[Optional] Position from the upper edge of the page in mm.""" - stamp_id: Optional[str] = field( - default=None, - metadata={"wire_name": "StampId"}, - ) + stamp_id: str = dataclass_field(metadata={"wire_name": "StampId"}) """Select or specify the stamp to be used.""" - password: Optional[str] = field( + password: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Password"}, ) """Specify the password for the stamp (if required).""" - fields: Optional[List[Dict[str, Any]]] = field( + fields: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Fields"}, ) @@ -285,31 +340,47 @@ class PlaceAStampResponse: Response for Place a stamp """ - created: Optional[Dict[str, Any]] = field( + created: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Created"}, ) """Created""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) """Type""" - color: Optional[str] = field(default=None, metadata={"wire_name": "Color"}) + color: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Color"}, + ) """Color""" - rotation: Optional[int] = field( + rotation: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Rotation"}, ) """Rotation""" - transparent: Optional[bool] = field( + transparent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Transparent"}, ) """Transparent""" - stroke_width: Optional[int] = field( + stroke_width: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StrokeWidth"}, ) """StrokeWidth""" - guid: Optional[str] = field(default=None, metadata={"wire_name": "Guid"}) + guid: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Guid"}, + ) """Guid""" @@ -319,8 +390,9 @@ class GetDialogsResponse: Response for Get dialogs """ - dialogs: Optional[List[Dict[str, Any]]] = field( + dialogs: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Dialogs"}, ) """Dialogs""" @@ -332,8 +404,9 @@ class GetStampsResponse: Response for Get stamps """ - stamps: Optional[List[Dict[str, Any]]] = field( + stamps: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Stamps"}, ) """Stamps""" @@ -345,8 +418,9 @@ class GetStampFieldsResponse: Response for Get stamp fields """ - fields: Optional[List[Dict[str, Any]]] = field( + fields: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Fields"}, ) """Fields""" @@ -358,8 +432,9 @@ class GetFileCabinetFieldsResponse: Response for Get file cabinet fields """ - fields: Optional[List[Dict[str, Any]]] = field( + fields: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Fields"}, ) """Fields""" @@ -371,8 +446,9 @@ class GetDialogFieldsResponse: Response for Get dialog fields """ - fields: Optional[List[Dict[str, Any]]] = field( + fields: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Fields"}, ) """Fields""" @@ -384,10 +460,15 @@ class ListDocumentsInDocumentTrayResponse: Response for List documents in document tray """ - count: Optional[int] = field(default=None, metadata={"wire_name": "Count"}) + count: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Count"}, + ) """Count""" - documents: Optional[List[Dict[str, Any]]] = field( + documents: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Documents"}, ) @@ -403,7 +484,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -420,8 +501,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -442,7 +523,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -457,9 +538,86 @@ def __init__( def connector_name(self) -> str: return "docuware" - async def search_for_documents_in_file_cabinet_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def search_for_documents_in_file_cabinet( self, - input: SearchForDocumentsInFileCabinetInput, + input: SearchForDocumentsInFileCabinetInput | Mapping[str, Any], file_cabinet: str, search_dialog_id: str, *, @@ -472,6 +630,24 @@ async def search_for_documents_in_file_cabinet_async( Search in file cabinet Search a file cabinet for documents matching the specified criteria. + + Swagger operation ID: `SearchForDocumentsInFileCabinet`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + file_cabinet: Select the File Cabinet to search. + search_dialog_id: Select the search dialog to use for searching. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -485,7 +661,7 @@ async def search_for_documents_in_file_cabinet_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -499,6 +675,7 @@ async def search_for_documents_in_file_cabinet_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -506,7 +683,7 @@ async def search_for_documents_in_file_cabinet_async( return json.loads(response.text) - async def get_organization_async( + async def get_organization( self, *, timeout: Optional[float] = None, @@ -518,10 +695,24 @@ async def get_organization_async( Get organization Get the organization name. + + Swagger operation ID: `GetOrganization`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Organization" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -535,6 +726,7 @@ async def get_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -542,7 +734,7 @@ async def get_organization_async( return json.loads(response.text) - async def get_file_cabinets_async( + def list_file_cabinets( self, file_cabinet_type: str, *, @@ -550,11 +742,29 @@ async def get_file_cabinets_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get file cabinets and document trays Gets a list of file cabinets and/or document trays. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetFileCabinets`. + + Args: + file_cabinet_type: Select which types you want returned. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/FileCabinets" query_params = [] @@ -564,29 +774,50 @@ async def get_file_cabinets_async( query_params.append(f"FileCabinetType={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("FileCabinets", []): + yield item - async def get_document_information_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_document_information( self, file_cabinet_id: str, document_id: int, @@ -600,6 +831,24 @@ async def get_document_information_async( Get document information Gets information about a document. + + Swagger operation ID: `GetDocumentInformation`. + + Args: + file_cabinet_id: Select the File Cabinet or Document Tray with your + document. + document_id: Specify the ID of the document you want information + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -609,7 +858,7 @@ async def get_document_information_async( f"/{quote(str(document_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -623,6 +872,7 @@ async def get_document_information_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -630,7 +880,7 @@ async def get_document_information_async( return json.loads(response.text) - async def delete_document_async( + async def delete_document( self, file_cabinet_id: str, document_id: int, @@ -644,6 +894,23 @@ async def delete_document_async( Delete a document Deletes a document from a file cabinet or document tray. + + Swagger operation ID: `DeleteDocument`. + + Args: + file_cabinet_id: Select the File Cabinet or Document Tray with your + document. + document_id: Specify the ID of the document you want to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -653,7 +920,7 @@ async def delete_document_async( f"/{quote(str(document_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -667,9 +934,10 @@ async def delete_document_async( request_url, response.status, response.text, + response=response, ) - async def download_file_async( + async def download_file( self, file_cabinet_id: str, document_id: int, @@ -686,6 +954,27 @@ async def download_file_async( Downloads a file/section of a document stored in a file cabinet or document tray. + + Swagger operation ID: `DownloadFile`. + + Args: + file_cabinet_id: Select the File Cabinet or Document Tray with your + document. + document_id: Specify the ID of the document with the file you want + to download. + file_number: Specify the file number of the file you want to + download. + document_format: Select the format for the downloaded document. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -705,7 +994,7 @@ async def download_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -719,11 +1008,12 @@ async def download_file_async( request_url, response.status, response.text, + response=response, ) return response.content - async def download_document_async( + async def download_document( self, file_cabinet_id: str, document_id: int, @@ -738,6 +1028,24 @@ async def download_document_async( Download a document Downloads a document from a file cabinet or document tray. + + Swagger operation ID: `DownloadDocument`. + + Args: + file_cabinet_id: Select the File Cabinet or Document Tray with your + document. + document_id: Specify the ID of the document you want to download. + document_format: Select the format for the downloaded document. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -755,7 +1063,7 @@ async def download_document_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -769,11 +1077,12 @@ async def download_document_async( request_url, response.status, response.text, + response=response, ) return response.content - async def update_index_fields_async( + async def update_index_fields( self, input: UpdateIndexFieldsInput, file_cabinet_id: str, @@ -788,6 +1097,24 @@ async def update_index_fields_async( Update index fields Updates the index fields of a document. + + Swagger operation ID: `UpdateIndexFields`. + + Args: + input: The request body. + file_cabinet_id: Select the File Cabinet with the document to + update. + document_id: Specify the ID of the document to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -798,7 +1125,7 @@ async def update_index_fields_async( f"/Fields" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -812,6 +1139,7 @@ async def update_index_fields_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -819,12 +1147,12 @@ async def update_index_fields_async( return json.loads(response.text) - async def transfer_document_async( + async def transfer_document( self, - input: TransferDocumentInput, + input: TransferDocumentInput | Mapping[str, Any], destination_file_cabinet_id: str, - store_dialog_id: Optional[str] = None, *, + store_dialog_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -835,6 +1163,26 @@ async def transfer_document_async( Moves one or more documents from one file cabinet/document tray to another. + + Swagger operation ID: `TransferDocument`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + destination_file_cabinet_id: Select the destination File Cabinet or + Document Tray. + store_dialog_id: Select the store dialog for indexing the documents + being moved. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -852,7 +1200,7 @@ async def transfer_document_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -866,6 +1214,7 @@ async def transfer_document_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -873,9 +1222,9 @@ async def transfer_document_async( return json.loads(response.text) - async def place_a_stamp_async( + async def place_a_stamp( self, - input: PlaceAStampInput, + input: PlaceAStampInput | Mapping[str, Any], file_cabinet_id: str, document_id: int, *, @@ -888,6 +1237,25 @@ async def place_a_stamp_async( Place a stamp Places a stamp on a document. + + Swagger operation ID: `PlaceAStamp`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + file_cabinet_id: Select the File Cabinet or Document Tray with your + document. + document_id: Specify the ID of the document you want to stamp. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -898,7 +1266,7 @@ async def place_a_stamp_async( f"/Annotation" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -912,6 +1280,7 @@ async def place_a_stamp_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -919,20 +1288,40 @@ async def place_a_stamp_async( return json.loads(response.text) - async def get_dialogs_async( + def list_dialogs( self, file_cabinet: str, - dialog_type: Optional[str] = None, *, + dialog_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get dialogs Gets a list of dialogs for a file cabinet or document tray. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDialogs`. + + Args: + file_cabinet: Select the File Cabinet or Document Tray to get + dialogs from. + dialog_type: Select the type of dialogs to return. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -946,29 +1335,50 @@ async def get_dialogs_async( query_params.append(f"DialogType={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("Dialogs", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_stamps_async( + def list_stamps( self, file_cabinet: str, *, @@ -976,39 +1386,79 @@ async def get_stamps_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get stamps Gets a list of stamps for a file cabinet or document tray. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetStamps`. + + Args: + file_cabinet: Select the File Cabinet or Document Tray to get + stamps from. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/FileCabinets/{quote(str(file_cabinet), safe='')}/Stamps" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("Stamps", []): + yield item - async def get_stamp_fields_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_stamp_fields( self, file_cabinet: str, stamp: str, @@ -1017,11 +1467,31 @@ async def get_stamp_fields_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get stamp fields Gets a list of fields for a stamp. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetStampFields`. + + Args: + file_cabinet: Select the File Cabinet or Document Tray with the + desired stamp. + stamp: Select the stamp to get its fields. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1031,42 +1501,82 @@ async def get_stamp_fields_async( f"/{quote(str(stamp), safe='')}" f"/Fields" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("Fields", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_file_cabinet_fields_async( + def list_file_cabinet_fields( self, file_cabinet: str, - field_type: Optional[str] = None, *, + field_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get file cabinet fields Gets a list of fields for a file cabinet. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetFileCabinetFields`. + + Args: + file_cabinet: Select the File Cabinet to get fields for. + field_type: Select the type of fields to return. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1080,29 +1590,50 @@ async def get_file_cabinet_fields_async( query_params.append(f"FieldType={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("Fields", []): + yield item + + return None, items() - async def get_dialog_fields_async( + return AsyncItemPaged(get_next, extract_data) + + def list_dialog_fields( self, file_cabinet: str, dialog_id: str, @@ -1111,11 +1642,30 @@ async def get_dialog_fields_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get dialog fields Gets the fields for a dialog + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDialogFields`. + + Args: + file_cabinet: Select the File Cabinet. + dialog_id: Select the dialog to get the fields for. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1125,29 +1675,50 @@ async def get_dialog_fields_async( f"/{quote(str(dialog_id), safe='')}" f"/Fields" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("Fields", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_documents_in_document_tray_async( + def list_documents_in_document_tray( self, document_tray: str, *, @@ -1155,34 +1726,73 @@ async def list_documents_in_document_tray_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List documents in document tray List documents from the specified document tray. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListDocumentsInDocumentTray`. + + Args: + document_tray: Select the Document Tray to search. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/DocumentTrays/{quote(str(document_tray), safe='')}/Search" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("Documents", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/dropbox.py b/src/azure/connectors/dropbox.py index d7d85400..624e75ac 100644 --- a/src/azure/connectors/dropbox.py +++ b/src/azure/connectors/dropbox.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,21 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "DropboxClient", + "BlobDataSetsMetadata", + "BlobMetadata", + "BlobMetadataPage", + "BlobMetadataResponse", + "DataSetsMetadata", + "ObjectEntity", + "TabularDataSetsMetadata", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,41 +43,66 @@ class BlobMetadata: Response for Get file metadata """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" @@ -75,8 +114,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -85,25 +134,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -115,15 +168,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -135,7 +190,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -148,41 +203,66 @@ class BlobMetadataResponse: Definition: BlobMetadataResponse """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" @@ -194,7 +274,12 @@ class BlobMetadataPage: Definition: BlobMetadataPage """ - value: Optional[List[BlobMetadata]] = None + value: Optional[ + List[BlobMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Blob metadata collection.""" @@ -209,7 +294,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -226,8 +311,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -248,7 +333,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -263,7 +348,84 @@ def __init__( def connector_name(self) -> str: return "dropbox" - async def get_file_metadata_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def get_file_metadata( self, id: str, *, @@ -276,6 +438,21 @@ async def get_file_metadata_async( Get file metadata This operation gets the metadata for a file. + + Swagger operation ID: `GetFileMetadata`. + + Args: + id: The unique identifier of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -285,7 +462,7 @@ async def get_file_metadata_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -299,6 +476,7 @@ async def get_file_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -306,7 +484,7 @@ async def get_file_metadata_async( return json.loads(response.text) - async def update_file_async( + async def update_file( self, input: bytes, id: str, @@ -320,6 +498,22 @@ async def update_file_async( Update file This operation updates a file. + + Swagger operation ID: `UpdateFile`. + + Args: + input: The binary request body. + id: The unique identifier of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -329,7 +523,7 @@ async def update_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, @@ -346,6 +540,7 @@ async def update_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -353,7 +548,7 @@ async def update_file_async( return json.loads(response.text) - async def delete_file_async( + async def delete_file( self, id: str, *, @@ -366,6 +561,21 @@ async def delete_file_async( Delete file This operation deletes a file. + + Swagger operation ID: `DeleteFile`. + + Args: + id: The unique identifier of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -375,7 +585,7 @@ async def delete_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -389,9 +599,10 @@ async def delete_file_async( request_url, response.status, response.text, + response=response, ) - async def get_file_metadata_by_path_async( + async def get_file_metadata_by_path( self, path: str, *, @@ -404,6 +615,21 @@ async def get_file_metadata_by_path_async( Get file metadata using path This operation gets the metadata of a file using the path. + + Swagger operation ID: `GetFileMetadataByPath`. + + Args: + path: The unique path of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/GetFileByPath" @@ -417,7 +643,7 @@ async def get_file_metadata_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -431,6 +657,7 @@ async def get_file_metadata_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -438,11 +665,11 @@ async def get_file_metadata_by_path_async( return json.loads(response.text) - async def get_file_content_by_path_async( + async def get_file_content_by_path( self, path: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -452,6 +679,23 @@ async def get_file_content_by_path_async( Get file content using path This operation gets the content of a file using the path. + + Swagger operation ID: `GetFileContentByPath`. + + Args: + path: The unique path of the file. + infer_content_type: A boolean value (true, false) to infer + content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -471,7 +715,7 @@ async def get_file_content_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -485,15 +729,16 @@ async def get_file_content_by_path_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_file_content_async( + async def get_file_content( self, id: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -503,6 +748,23 @@ async def get_file_content_async( Get file content This operation gets the content of a file. + + Swagger operation ID: `GetFileContent`. + + Args: + id: The unique identifier of the file. + infer_content_type: A boolean value (true, false) to infer + content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -521,7 +783,7 @@ async def get_file_content_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -535,11 +797,12 @@ async def get_file_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def create_file_async( + async def create_file( self, input: bytes, folder_path: str, @@ -554,6 +817,23 @@ async def create_file_async( Create file This operation creates a file in a folder. + + Swagger operation ID: `CreateFile`. + + Args: + input: The binary request body. + folder_path: The path to the folder. + name: The name of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/datasets/default/files" query_params = [] @@ -569,7 +849,7 @@ async def create_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -586,6 +866,7 @@ async def create_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -593,12 +874,12 @@ async def create_file_async( return json.loads(response.text) - async def copy_file_async( + async def copy_file( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -608,6 +889,23 @@ async def copy_file_async( Copy file This operation copies a file to Dropbox. + + Swagger operation ID: `CopyFile`. + + Args: + source: The url to source file. + destination: The destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/copyFile" @@ -630,7 +928,7 @@ async def copy_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -644,6 +942,7 @@ async def copy_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -651,7 +950,7 @@ async def copy_file_async( return json.loads(response.text) - async def list_folder_async( + def list_folder( self, id: str, *, @@ -659,11 +958,29 @@ async def list_folder_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files in folder This operation gets the list of files and subfolders in a folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListFolder`. + + Args: + id: The unique identifier of the folder. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -672,73 +989,132 @@ async def list_folder_async( f"/folders" f"/{quote(quote(str(id), safe=''), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_root_folder_async( + def list_root_folder( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files in root folder This operation gets the list of files and subfolders in the root folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRootFolder`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/folders" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def extract_folder_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def extract_folder( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -748,6 +1124,23 @@ async def extract_folder_async( Extract archive to folder This operation extracts an archive file into a folder (example: .zip). + + Swagger operation ID: `ExtractFolderV2`. + + Args: + source: The path to the archive file. + destination: The path to extract the archive contents. + overwrite: Overwrites the destination files if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/extractFolderV2" @@ -770,7 +1163,7 @@ async def extract_folder_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -784,6 +1177,7 @@ async def extract_folder_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/dynamicsax.py b/src/azure/connectors/dynamicsax.py index 736bae83..2633706c 100644 --- a/src/azure/connectors/dynamicsax.py +++ b/src/azure/connectors/dynamicsax.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,48 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "DynamicsaxClient", + "AxOnlineProcedureResult", + "BlobDataSetsMetadata", + "BusinessEventData", + "BusinessEventSubscription", + "BusinessEventSubscriptionResponse", + "BusinessEventsList", + "DataSet", + "DataSetsList", + "DataSetsMetadata", + "ExecuteProcedureInput", + "ExportableItem", + "ExportableItemsList", + "GetItemResponse", + "Item", + "ItemsList", + "ObjectEntity", + "PassThroughNativeQuery", + "PatchItemInput", + "PatchItemResponse", + "PostItemInput", + "PostItemResponse", + "Procedure", + "ProcedureMetadata", + "ProceduresList", + "Table", + "TableCapabilitiesMetadata", + "TableFilterRestrictionsMetadata", + "TableMetadata", + "TableSelectRestrictionsMetadata", + "TableSortRestrictionsMetadata", + "TablesList", + "TabularDataSetsMetadata", + "TriggerFieldData", + "TriggerFieldDataList", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,17 +70,19 @@ class BusinessEventSubscriptionResponse: Response for When a Business Event occurs """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the subscription""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """Resource of the subscription request""" - notification_type: Optional[str] = field( + notification_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationType"}, ) """Notification Type""" - notification_url: Optional[str] = field( + notification_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationUrl"}, ) """Notification Url""" @@ -51,7 +94,7 @@ class ExecuteProcedureInput: Execute action """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -64,10 +107,11 @@ class AxOnlineProcedureResult: Response for Execute action """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Output parameter values""" - output_parameters: Optional[Dict[str, ObjectEntity]] = field( + output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OutputParameters"}, ) """Output parameter values""" @@ -79,10 +123,16 @@ class ItemsList: Response for Lists items present in table """ - value: Optional[List[Item]] = None + value: Optional[ + List[Item | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -94,7 +144,7 @@ class PostItemInput: Create record """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -107,7 +157,7 @@ class PostItemResponse: Response for Create record """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -120,7 +170,7 @@ class GetItemResponse: Response for Get a record """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -133,7 +183,7 @@ class PatchItemInput: Update a record """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -146,7 +196,7 @@ class PatchItemResponse: Response for Update a record """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -159,7 +209,12 @@ class TablesList: Response for Get list of entities """ - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Tables""" @@ -169,7 +224,12 @@ class DataSetsList: Response for Get instances """ - value: Optional[List[DataSet]] = None + value: Optional[ + List[DataSet | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of datasets""" @@ -179,7 +239,12 @@ class TriggerFieldDataList: Response for Gets business events categories """ - value: Optional[List[TriggerFieldData]] = None + value: Optional[ + List[TriggerFieldData | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of business event categories""" @@ -189,7 +254,12 @@ class BusinessEventsList: Response for Gets business events """ - value: Optional[List[BusinessEventData]] = None + value: Optional[ + List[BusinessEventData | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of business events""" @@ -199,7 +269,12 @@ class ProceduresList: Response for Get actions """ - value: Optional[List[Procedure]] = None + value: Optional[ + List[Procedure | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Procedures""" @@ -209,11 +284,11 @@ class ProcedureMetadata: Response for Get actions metadata """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Procedure name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Procedure title""" - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -222,26 +297,30 @@ class TableMetadata: Response for Get entity metadata """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Table name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Table title""" - x_ms_permission: Optional[str] = field( + x_ms_permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-permission"}, ) """Table permission""" - x_ms_capabilities: Optional[TableCapabilitiesMetadata] = field( + x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-capabilities"}, ) - schema: Optional[ObjectEntity] = None - referenced_entities: Optional[ObjectEntity] = field( + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referencedEntities"}, ) - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """Url link""" @@ -253,7 +332,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -266,8 +345,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -276,25 +365,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -306,15 +399,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -326,30 +421,42 @@ class TableCapabilitiesMetadata: Definition: TableCapabilitiesMetadata """ - sort_restrictions: Optional[TableSortRestrictionsMetadata] = field( + sort_restrictions: Optional[ + TableSortRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortRestrictions"}, ) - filter_restrictions: Optional[TableFilterRestrictionsMetadata] = field( + filter_restrictions: Optional[ + TableFilterRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterRestrictions"}, ) - select_restrictions: Optional[TableSelectRestrictionsMetadata] = field( + select_restrictions: Optional[ + TableSelectRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectRestrictions"}, ) - is_only_server_pagable: Optional[bool] = field( + is_only_server_pagable: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOnlyServerPagable"}, ) """Server paging restrictions""" - filter_function_support: Optional[List[str]] = field( + filter_function_support: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterFunctionSupport"}, ) """List of supported filter capabilities""" - server_paging_options: Optional[List[str]] = field( + server_paging_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serverPagingOptions"}, ) """List of supported server-driven paging capabilities""" @@ -361,15 +468,17 @@ class TableSortRestrictionsMetadata: Definition: TableSortRestrictionsMetadata """ - sortable: Optional[bool] = None + sortable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has sortable columns""" - unsortable_properties: Optional[List[str]] = field( + unsortable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unsortableProperties"}, ) """List of unsortable properties""" - ascending_only_properties: Optional[List[str]] = field( + ascending_only_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ascendingOnlyProperties"}, ) """List of properties which support ascending order only""" @@ -381,15 +490,17 @@ class TableFilterRestrictionsMetadata: Definition: TableFilterRestrictionsMetadata """ - filterable: Optional[bool] = None + filterable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has filterable columns""" - non_filterable_properties: Optional[List[str]] = field( + non_filterable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nonFilterableProperties"}, ) """List of non filterable properties""" - required_properties: Optional[List[str]] = field( + required_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredProperties"}, ) """List of required properties""" @@ -401,7 +512,7 @@ class TableSelectRestrictionsMetadata: Definition: TableSelectRestrictionsMetadata """ - selectable: Optional[bool] = None + selectable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has selectable columns""" @@ -411,8 +522,7 @@ class BusinessEventSubscription: Definition: BusinessEventSubscription """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "NotificationUrl"}, ) """ @@ -427,12 +537,21 @@ class BusinessEventData: Definition: BusinessEventData """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Business event Id""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Business event data name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Business event data display name""" @@ -444,10 +563,15 @@ class TriggerFieldData: Definition: TriggerFieldData """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Business event data name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Business event data display name""" @@ -459,10 +583,15 @@ class Procedure: Definition: Procedure """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Procedure name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Procedure display name""" @@ -474,14 +603,24 @@ class DataSet: Definition: DataSet """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Dataset name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Dataset display name""" - query: Optional[List[PassThroughNativeQuery]] = None + query: Optional[ + List[PassThroughNativeQuery | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Pass-through Native Queries""" @@ -491,15 +630,21 @@ class Table: Definition: Table """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the table. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the table.""" - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """Additional table properties provided by the connector to the clients.""" @@ -511,8 +656,9 @@ class PassThroughNativeQuery: Definition: PassThroughNativeQuery """ - language: Optional[str] = field( + language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Language"}, ) """Query language""" @@ -524,8 +670,9 @@ class Item: Definition: Item """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -536,7 +683,12 @@ class ExportableItemsList: Definition: ExportableItemsList """ - value: Optional[List[ExportableItem]] = None + value: Optional[ + List[ExportableItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items.""" @@ -546,8 +698,9 @@ class ExportableItem: Definition: ExportableItem """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -563,7 +716,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -580,8 +733,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -602,7 +755,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -618,15 +771,49 @@ def connector_name(self) -> str: return "dynamicsax" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -643,7 +830,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -656,9 +847,9 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def execute_procedure_async( + async def execute_procedure( self, - input: ExecuteProcedureInput, + input: ExecuteProcedureInput | Mapping[str, Any], dataset: str, procedure: str, *, @@ -671,6 +862,24 @@ async def execute_procedure_async( Execute action Execute action + + Swagger operation ID: `ExecuteProcedure`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: The Dynamics 365 for Fin & Ops instance. + procedure: Name of action. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -680,7 +889,7 @@ async def execute_procedure_async( f"/{quote(quote(str(procedure), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -694,6 +903,7 @@ async def execute_procedure_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -701,10 +911,11 @@ async def execute_procedure_async( return json.loads(response.text) - async def get_items_async( + def list_items( self, dataset: str, table: str, + *, apply: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, @@ -712,19 +923,44 @@ async def get_items_async( skip: Optional[int] = None, select: Optional[str] = None, cross_company: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists items present in table Lists items present in table - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems`. + + Args: + dataset: The Dynamics 365 for Fin & Ops instance. + table: Entity name. + apply: A sequence of OData aggregation transformations. + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + select: Specific fields to retrieve from entries (default = all). + cross_company: Query across companies (default = no). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -772,11 +1008,18 @@ async def get_items_async( query_params.append(f"cross-company={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -789,25 +1032,34 @@ async def get_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def post_item_async( + return AsyncItemPaged(get_next, extract_data) + + async def post_item( self, - input: PostItemInput, + input: PostItemInput | Mapping[str, Any], dataset: str, table: str, *, @@ -820,6 +1072,24 @@ async def post_item_async( Create record Create a new record in an entity + + Swagger operation ID: `PostItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: The Dynamics 365 for Fin & Ops instance. + table: Entity name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -830,7 +1100,7 @@ async def post_item_async( f"/items" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -844,6 +1114,7 @@ async def post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -851,7 +1122,7 @@ async def post_item_async( return json.loads(response.text) - async def get_item_async( + async def get_item( self, dataset: str, table: str, @@ -866,6 +1137,23 @@ async def get_item_async( Get a record Retrieves a single record + + Swagger operation ID: `GetItem`. + + Args: + dataset: The Dynamics 365 for Fin & Ops instance. + table: Entity name. + id: Unique identifier of the object to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -877,7 +1165,7 @@ async def get_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -891,6 +1179,7 @@ async def get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -898,7 +1187,7 @@ async def get_item_async( return json.loads(response.text) - async def delete_item_async( + async def delete_item( self, dataset: str, table: str, @@ -913,6 +1202,23 @@ async def delete_item_async( Delete record Deletes a single record in an entity + + Swagger operation ID: `DeleteItem`. + + Args: + dataset: The Dynamics 365 for Fin & Ops instance. + table: Entity name. + id: Unique identifier of the object to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -924,7 +1230,7 @@ async def delete_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -938,11 +1244,12 @@ async def delete_item_async( request_url, response.status, response.text, + response=response, ) - async def patch_item_async( + async def patch_item( self, - input: PatchItemInput, + input: PatchItemInput | Mapping[str, Any], dataset: str, table: str, id: str, @@ -956,6 +1263,25 @@ async def patch_item_async( Update a record Updates a single record in an entity + + Swagger operation ID: `PatchItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: The Dynamics 365 for Fin & Ops instance. + table: Entity name. + id: Unique identifier of the object to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -967,7 +1293,7 @@ async def patch_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -981,6 +1307,7 @@ async def patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -988,7 +1315,7 @@ async def patch_item_async( return json.loads(response.text) - async def get_tables_async( + def list_tables( self, dataset: str, *, @@ -996,75 +1323,152 @@ async def get_tables_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get list of entities Retrieves a list of entities + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTables`. + + Args: + dataset: The Dynamics 365 for Fin & Ops instance. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/datasets/{quote(quote(str(dataset), safe=''), safe='')}/tables" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_data_sets_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_data_sets( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get instances Retrieves a list of accessable Dynamics 365 for Fin & Ops instances + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDataSets`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/datasets" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_business_event_categories_async( + return AsyncItemPaged(get_next, extract_data) + + def list_business_event_categories( self, dataset: str, *, @@ -1072,11 +1476,29 @@ async def get_business_event_categories_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Gets business events categories Gets business events categories. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetBusinessEventCategories`. + + Args: + dataset: Data set. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1084,29 +1506,50 @@ async def get_business_event_categories_async( f"/{quote(quote(str(dataset), safe=''), safe='')}" f"/businesseventcategories" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_business_events_async( + return AsyncItemPaged(get_next, extract_data) + + def list_business_events( self, dataset: str, businesseventcategory: str, @@ -1115,11 +1558,30 @@ async def get_business_events_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Gets business events Gets business events. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetBusinessEvents`. + + Args: + dataset: Data set. + businesseventcategory: Business event category. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1129,29 +1591,50 @@ async def get_business_events_async( f"/{quote(quote(str(businesseventcategory), safe=''), safe='')}" f"/businessevents" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_legal_entities_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_legal_entities( self, dataset: str, businesseventcategory: str, @@ -1161,11 +1644,31 @@ async def get_legal_entities_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Gets legal entities Gets legal entities. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetLegalEntities`. + + Args: + dataset: Data set. + businesseventcategory: Business event category. + businessevent: Business event. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1184,29 +1687,50 @@ async def get_legal_entities_async( query_params.append(f"businessevent={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_procedures_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_procedures( self, dataset: str, *, @@ -1214,11 +1738,29 @@ async def get_procedures_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get actions Get actions + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetProcedures`. + + Args: + dataset: The Dynamics 365 for Fin & Ops instance. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1226,29 +1768,50 @@ async def get_procedures_async( f"/{quote(quote(str(dataset), safe=''), safe='')}" f"/procedures" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - async def get_procedure_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_procedure( self, dataset: str, procedure: str, @@ -1262,6 +1825,22 @@ async def get_procedure_async( Get actions metadata Get actions metadata. + + Swagger operation ID: `GetProcedure`. + + Args: + dataset: The Dynamics 365 for Fin & Ops instance. + procedure: Name of action. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1272,7 +1851,7 @@ async def get_procedure_async( f"/{quote(quote(str(procedure), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1286,6 +1865,7 @@ async def get_procedure_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1293,7 +1873,7 @@ async def get_procedure_async( return json.loads(response.text) - async def get_table_async( + async def get_table( self, dataset: str, table: str, @@ -1307,6 +1887,22 @@ async def get_table_async( Get entity metadata Retrieves metadata for an entity + + Swagger operation ID: `GetTable`. + + Args: + dataset: The Dynamics 365 for Fin & Ops instance. + table: Entity name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1317,7 +1913,7 @@ async def get_table_async( f"/{quote(quote(str(table), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1331,6 +1927,7 @@ async def get_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/elfsquaddata.py b/src/azure/connectors/elfsquaddata.py index 2d78b787..bf4a7643 100644 --- a/src/azure/connectors/elfsquaddata.py +++ b/src/azure/connectors/elfsquaddata.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,22 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "ElfsquaddataClient", + "CreateTriggerInput", + "GetEntitiesResponse", + "GetEntityByIdResponse", + "InvokeFunctionInput", + "InvokeFunctionResponse", + "PostEntityByIdInput", + "PostEntityByIdResponse", + "PutEntityByIdInput", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,10 +44,7 @@ class CreateTriggerInput: Custom trigger """ - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) @dataclass @@ -41,9 +53,10 @@ class GetEntitiesResponse: Response for Get entities """ - value: Optional[List[Any]] = None - next_link: Optional[str] = field( + value: Optional[List[Any]] = dataclass_field(default=None, kw_only=True) + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """Link to get next page of results""" @@ -55,7 +68,7 @@ class PostEntityByIdInput: Create entity """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -68,7 +81,7 @@ class PostEntityByIdResponse: Response for Create entity """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -81,7 +94,7 @@ class GetEntityByIdResponse: Response for Get entity by id """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -94,7 +107,7 @@ class PutEntityByIdInput: Update entity """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -107,7 +120,7 @@ class InvokeFunctionInput: Invoke function """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -120,7 +133,7 @@ class InvokeFunctionResponse: Response for Invoke function """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -138,7 +151,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -155,8 +168,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -177,7 +190,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -193,15 +206,49 @@ def connector_name(self) -> str: return "elfsquaddata" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -218,7 +265,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -231,9 +282,10 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def get_entities_async( + def list_entities( self, entity_name: str, + *, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, @@ -241,19 +293,41 @@ async def get_entities_async( select: Optional[str] = None, expand: Optional[str] = None, count: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get entities Get entities - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `get_entities`. + + Args: + entity_name: Entity name. + top: Top. + skip: Skip. + orderby: Order by. + filter: Filter items. + select: Select properties. + expand: Expand. + count: Count. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -297,11 +371,18 @@ async def get_entities_async( query_params.append(f"$count={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -314,25 +395,34 @@ async def get_entities_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def post_entity_by_id_async( + return AsyncItemPaged(get_next, extract_data) + + async def post_entity_by_id( self, - input: PostEntityByIdInput, + input: PostEntityByIdInput | Mapping[str, Any], entity_name: str, *, timeout: Optional[float] = None, @@ -344,13 +434,30 @@ async def post_entity_by_id_async( Create entity Create entity + + Swagger operation ID: `post_entity_by_id`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + entity_name: Entity name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/data/1/{quote(str(entity_name), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -364,6 +471,7 @@ async def post_entity_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -371,7 +479,7 @@ async def post_entity_by_id_async( return json.loads(response.text) - async def get_entity_by_id_async( + async def get_entity_by_id( self, entity_name: str, id: str, @@ -385,6 +493,22 @@ async def get_entity_by_id_async( Get entity by id Get entity by id + + Swagger operation ID: `get_entity_by_id`. + + Args: + entity_name: Entity name. + id: Identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -393,7 +517,7 @@ async def get_entity_by_id_async( f"/{quote(str(entity_name), safe='')}({quote(str(id), safe='')})" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -407,6 +531,7 @@ async def get_entity_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -414,7 +539,7 @@ async def get_entity_by_id_async( return json.loads(response.text) - async def delete_entity_by_id_async( + async def delete_entity_by_id( self, entity_name: str, id: str, @@ -428,6 +553,22 @@ async def delete_entity_by_id_async( Delete entity Delete entity + + Swagger operation ID: `delete_entity_by_id`. + + Args: + entity_name: Entity name. + id: Identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -436,7 +577,7 @@ async def delete_entity_by_id_async( f"/{quote(str(entity_name), safe='')}({quote(str(id), safe='')})" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -450,11 +591,12 @@ async def delete_entity_by_id_async( request_url, response.status, response.text, + response=response, ) - async def put_entity_by_id_async( + async def put_entity_by_id( self, - input: PutEntityByIdInput, + input: PutEntityByIdInput | Mapping[str, Any], entity_name: str, id: str, *, @@ -467,6 +609,24 @@ async def put_entity_by_id_async( Update entity Update entity + + Swagger operation ID: `put_entity_by_id`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + entity_name: Entity name. + id: Identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -475,7 +635,7 @@ async def put_entity_by_id_async( f"/{quote(str(entity_name), safe='')}({quote(str(id), safe='')})" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -489,11 +649,12 @@ async def put_entity_by_id_async( request_url, response.status, response.text, + response=response, ) - async def invoke_function_async( + async def invoke_function( self, - input: InvokeFunctionInput, + input: InvokeFunctionInput | Mapping[str, Any], function_path: str, *, timeout: Optional[float] = None, @@ -505,13 +666,30 @@ async def invoke_function_async( Invoke function Invoke function + + Swagger operation ID: `invoke_function`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + function_path: Function path. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/{quote(str(function_path), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -525,6 +703,7 @@ async def invoke_function_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -532,7 +711,7 @@ async def invoke_function_async( return json.loads(response.text) - async def get_triggers_async( + async def get_triggers( self, *, timeout: Optional[float] = None, @@ -542,10 +721,24 @@ async def get_triggers_async( ) -> None: """ Get triggers + + Swagger operation ID: `get_triggers`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/data/1/$triggers" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -559,9 +752,10 @@ async def get_triggers_async( request_url, response.status, response.text, + response=response, ) - async def get_schemas_async( + async def get_schemas( self, *, timeout: Optional[float] = None, @@ -571,10 +765,24 @@ async def get_schemas_async( ) -> None: """ Get schemas + + Swagger operation ID: `get_schemas`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/data/1" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -588,9 +796,10 @@ async def get_schemas_async( request_url, response.status, response.text, + response=response, ) - async def get_schema_async( + async def get_schema( self, entity_name: str, *, @@ -601,13 +810,28 @@ async def get_schema_async( ) -> None: """ Get schema + + Swagger operation ID: `get_schema`. + + Args: + entity_name: entity_name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/data/1/{quote(str(entity_name), safe='')}/$schema" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -621,9 +845,10 @@ async def get_schema_async( request_url, response.status, response.text, + response=response, ) - async def get_functions_async( + async def get_functions( self, *, timeout: Optional[float] = None, @@ -633,10 +858,24 @@ async def get_functions_async( ) -> None: """ Get function + + Swagger operation ID: `get_functions`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/data/1/$functions" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -650,9 +889,10 @@ async def get_functions_async( request_url, response.status, response.text, + response=response, ) - async def get_function_definition_async( + async def get_function_definition( self, function_path: str, *, @@ -663,13 +903,28 @@ async def get_function_definition_async( ) -> None: """ Get function definition + + Swagger operation ID: `get_function_definition`. + + Args: + function_path: function_path. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/data/1/$functions/$schema/{quote(str(function_path), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -683,9 +938,10 @@ async def get_function_definition_async( request_url, response.status, response.text, + response=response, ) - async def get_trigger_schema_async( + async def get_trigger_schema( self, trigger_name: str, *, @@ -696,13 +952,28 @@ async def get_trigger_schema_async( ) -> None: """ Get trigger schema + + Swagger operation ID: `get_trigger_schema`. + + Args: + trigger_name: trigger_name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/data/1/$triggers/{quote(str(trigger_name), safe='')}/$schema" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -716,6 +987,7 @@ async def get_trigger_schema_async( request_url, response.status, response.text, + response=response, ) diff --git a/src/azure/connectors/etsy.py b/src/azure/connectors/etsy.py index dcacd417..d0c80f62 100644 --- a/src/azure/connectors/etsy.py +++ b/src/azure/connectors/etsy.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, List, Literal, Any, Mapping from urllib.parse import quote import json @@ -20,6 +20,114 @@ ConnectorResponseHook, ) +__all__ = [ + "EtsyClient", + "ApplicationListingsInventoryRequest", + "ApplicationShopsListingsVariationImagesRequest", + "Channel", + "DestinationRegion", + "DestinationRegion1", + "ErrorSchema", + "Include", + "Includes", + "Includes1", + "ItemDimensionsUnit", + "ItemDimensionsUnit2", + "ItemWeightUnit", + "ItemWeightUnit2", + "ListingCreateInput", + "ListingCreateTranslationInput", + "ListingImage", + "ListingImages", + "ListingInventory", + "ListingInventoryProduct", + "ListingInventoryProductOffering", + "ListingInventoryWithAssociations", + "ListingPropertyValue", + "ListingPropertyValues", + "ListingTranslation", + "ListingUpdateInput", + "ListingUpdateInventoryInput", + "ListingUpdatePropertyInput", + "ListingUpdateTranslationInput", + "ListingUpdateVariationInput", + "ListingUploadImageInput", + "ListingUploadInput", + "ListingVariationImage", + "ListingVariationImages", + "Money", + "Occasion", + "Offering", + "Payment", + "PaymentAccountLedgerEntries", + "PaymentAccountLedgerEntry", + "PaymentAdjustment", + "Payments", + "Pong", + "ProcessingTimeUnit", + "Product", + "ProfileType", + "PropertyValue", + "ReceiptCreateShipmentInput", + "Recipient", + "SellerTaxonomyNode", + "SellerTaxonomyNodes", + "ShippingCarrier", + "ShippingCarrierMailClass", + "ShippingCarriers", + "ShippingCreateDestinationInput", + "ShippingCreateProfileInput", + "ShippingCreateUpgradeInput", + "ShippingUpdateProfileDestinationInput", + "ShippingUpdateProfileInput", + "ShippingUpdateProfileUpgradeInput", + "Shop", + "ShopCreateSectionInput", + "ShopListing", + "ShopListingFile", + "ShopListingFiles", + "ShopListingWithAssociations", + "ShopListings", + "ShopListingsWithAssociations", + "ShopProductionPartner", + "ShopProductionPartners", + "ShopReceipt", + "ShopReceiptShipment", + "ShopReceiptTransaction", + "ShopReceiptTransactions", + "ShopReceipts", + "ShopSection", + "ShopSections", + "ShopShippingProfile", + "ShopShippingProfileDestination", + "ShopShippingProfileDestinations", + "ShopShippingProfileUpgrade", + "ShopShippingProfileUpgrades", + "ShopShippingProfiles", + "ShopUpdateInput", + "Shops", + "SortOn", + "SortOrder", + "State", + "State2", + "TaxonomyNodeProperties", + "TaxonomyNodeProperty", + "TaxonomyPropertyScale", + "TaxonomyPropertyValue", + "TransactionReview", + "TransactionReviews", + "Type", + "Type1", + "User", + "UserAddress", + "UserAddresses", + "VariationImage", + "WhenMade", + "WhenMade2", + "WhoMade", + "WhoMade2", +] + # Type Definitions @@ -29,7 +137,7 @@ class Pong: Response for Ping """ - application_id: Optional[int] = None + application_id: int """The authenticated application's ID""" @@ -39,9 +147,9 @@ class PaymentAccountLedgerEntries: Response for Get a shop payment account ledger's entries """ - count: Optional[int] = None + count: int """The number of payment account ledger entry resources found.""" - results: Optional[List[PaymentAccountLedgerEntry]] = None + results: List[PaymentAccountLedgerEntry | Mapping[str, Any]] """The payment account ledger entry resources found.""" @@ -51,9 +159,9 @@ class Payments: Response for Get a payment from a payment account ledger entry ID """ - count: Optional[int] = None + count: int """The number of payments in the response.""" - results: Optional[List[Payment]] = None + results: List[Payment | Mapping[str, Any]] """A list of payments.""" @@ -63,52 +171,52 @@ class ShopReceipt: Response for Get a receipt """ - receipt_id: Optional[int] = None + receipt_id: int """The numeric ID for the receipt associated to this transaction.""" - receipt_type: Optional[int] = None + receipt_type: int """ The numeric value for the Etsy channel that serviced the purchase: 0 for Etsy.com, 1 for a Pattern shop. """ - seller_user_id: Optional[int] = None + seller_user_id: int """The numeric ID for the user (seller) fulfilling the purchase.""" - seller_email: Optional[str] = None + seller_email: str """The email address string for the seller of the listing.""" - buyer_user_id: Optional[int] = None + buyer_user_id: int """The numeric ID for the user making the purchase.""" - buyer_email: Optional[str] = None + buyer_email: str """The email address string for the buyer of the listing.""" - name: Optional[str] = None + name: str """The name string for the recipient in the shipping address.""" - first_line: Optional[str] = None + first_line: str """ The first address line string for the recipient in the shipping address. """ - second_line: Optional[str] = None + second_line: str """ The optional second address line string for the recipient in the shipping address. """ - city: Optional[str] = None + city: str """The city string for the recipient in the shipping address.""" - state: Optional[str] = None + state: str """The state string for the recipient in the shipping address.""" - zip: Optional[str] = None + zip: str """ The zip code string (not necessarily a number) for the recipient in the shipping address. """ - formatted_address: Optional[str] = None + formatted_address: str """ The formatted shipping address string for the recipient in the shipping address. """ - country_iso: Optional[str] = None + country_iso: str """ The ISO-3166 alpha-2 country code string for the recipient in the shipping address. """ - payment_method: Optional[str] = None + payment_method: str """ The payment method string identifying purchaser's payment method, which must be one of: 'cc' (credit card), 'paypal', 'check', 'mo' (money order), @@ -116,36 +224,36 @@ class ShopReceipt: 'android_pay', 'google_pay', 'klarna', 'k_pay_in_4' (klarna), or 'k_financing' (klarna). """ - payment_email: Optional[str] = None + payment_email: str """ The email address string for the email address to which to send payment confirmation """ - message_from_seller: Optional[str] = None + message_from_seller: str """An optional message string from the seller.""" - message_from_buyer: Optional[str] = None + message_from_buyer: str """An optional message string from the buyer.""" - message_from_payment: Optional[str] = None + message_from_payment: str """The machine-generated acknowledgement string from the payment system.""" - is_paid: Optional[bool] = None + is_paid: bool """When true, buyer paid for this purchase.""" - is_shipped: Optional[bool] = None + is_shipped: bool """When true, seller shipped the products.""" - create_timestamp: Optional[int] = None + create_timestamp: int """The receipt's creation time, in epoch seconds.""" - update_timestamp: Optional[int] = None + update_timestamp: int """The time of the last update to the receipt, in epoch seconds.""" - gift_message: Optional[str] = None + gift_message: str """A gift message string the buyer requests delivered with the product.""" - grandtotal: Optional[Money] = None - subtotal: Optional[Money] = None - total_price: Optional[Money] = None - total_shipping_cost: Optional[Money] = None - total_tax_cost: Optional[Money] = None - total_vat_cost: Optional[Money] = None - discount_amt: Optional[Money] = None - gift_wrap_price: Optional[Money] = None - shipments: Optional[List[ShopReceiptShipment]] = None + grandtotal: Money | Mapping[str, Any] + subtotal: Money | Mapping[str, Any] + total_price: Money | Mapping[str, Any] + total_shipping_cost: Money | Mapping[str, Any] + total_tax_cost: Money | Mapping[str, Any] + total_vat_cost: Money | Mapping[str, Any] + discount_amt: Money | Mapping[str, Any] + gift_wrap_price: Money | Mapping[str, Any] + shipments: List[ShopReceiptShipment | Mapping[str, Any]] """A list of shipment statements for this receipt.""" @@ -155,9 +263,9 @@ class ShopReceipts: Response for Get receipts """ - count: Optional[int] = None + count: int """The number of Shop Receipts found.""" - results: Optional[List[ShopReceipt]] = None + results: List[ShopReceipt | Mapping[str, Any]] """ List of Shop Receipt resources found, with all Shop Receipt fields for each resource. @@ -170,11 +278,11 @@ class ReceiptCreateShipmentInput: Create a Shipment Receipt """ - tracking_code: Optional[str] = None + tracking_code: Optional[str] = dataclass_field(default=None, kw_only=True) """The tracking code for this receipt.""" - carrier_name: Optional[str] = None + carrier_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The carrier name for this receipt.""" - send_bcc: Optional[bool] = None + send_bcc: Optional[bool] = dataclass_field(default=None, kw_only=True) """If true, the shipping notification will be sent to the seller as well""" @@ -184,9 +292,9 @@ class ShopReceiptTransactions: Response for Retrieve a listing's transactions """ - count: Optional[int] = None + count: int """The number of shop receipt transaction resources found.""" - results: Optional[List[ShopReceiptTransaction]] = None + results: List[ShopReceiptTransaction | Mapping[str, Any]] """The shop receipt transaction resources found.""" @@ -196,42 +304,42 @@ class ShopReceiptTransaction: Response for Get a transaction """ - transaction_id: Optional[int] = None + transaction_id: int """The unique numeric ID for a transaction.""" - title: Optional[str] = None + title: str """The title string of the listing purchased in this transaction.""" - description: Optional[str] = None + description: str """The description string of the listing purchased in this transaction.""" - seller_user_id: Optional[int] = None + seller_user_id: int """The numeric user ID for the seller in this transaction.""" - buyer_user_id: Optional[int] = None + buyer_user_id: int """The numeric user ID for the buyer in this transaction.""" - create_timestamp: Optional[int] = None + create_timestamp: int """The transaction's creation date and time, in epoch seconds.""" - paid_timestamp: Optional[int] = None + paid_timestamp: int """The transaction's paid date and time, in epoch seconds.""" - shipped_timestamp: Optional[int] = None + shipped_timestamp: int """The transaction's shipping date and time, in epoch seconds.""" - quantity: Optional[int] = None + quantity: int """The numeric quantity of products purchased in this transaction.""" - listing_image_id: Optional[int] = None + listing_image_id: int """The numeric ID of the primary listing image for this transaction.""" - receipt_id: Optional[int] = None + receipt_id: int """The numeric ID for the receipt associated to this transaction.""" - is_digital: Optional[bool] = None + is_digital: bool """ When true, the transaction recorded the purchase of a digital listing. """ - file_data: Optional[str] = None + file_data: str """A string describing the files purchased in this transaction.""" - listing_id: Optional[int] = None + listing_id: int """The numeric ID for the listing associated to this transaction.""" - transaction_type: Optional[str] = None + transaction_type: str """The type string for the transaction, usually listing""" - product_id: Optional[int] = None + product_id: int """The numeric ID for a specific product purchased from a listing.""" - price: Optional[Money] = None - shipping_cost: Optional[Money] = None + price: Money | Mapping[str, Any] + shipping_cost: Money | Mapping[str, Any] @dataclass @@ -240,9 +348,9 @@ class TransactionReviews: Response for Get reviews """ - count: Optional[int] = None + count: int """The number of TransactionReview resources found.""" - results: Optional[List[TransactionReview]] = None + results: List[TransactionReview | Mapping[str, Any]] """The TransactionReview resources found.""" @@ -252,8 +360,8 @@ class ShippingCarriers: Response for Get shipping carriers """ - count: Optional[int] = None - results: Optional[List[ShippingCarrier]] = None + count: int + results: List[ShippingCarrier | Mapping[str, Any]] @dataclass @@ -262,37 +370,37 @@ class ShopShippingProfile: Response for Get shipping profiles """ - shipping_profile_id: Optional[int] = None + shipping_profile_id: int """The numeric ID of the shipping profile.""" - title: Optional[str] = None + title: str """The name string of this shipping profile.""" - user_id: Optional[int] = None + user_id: int """The numeric ID for the user who owns the shipping profile.""" - min_processing_days: Optional[int] = None + min_processing_days: int """The minimum number of days for processing the listing.""" - max_processing_days: Optional[int] = None + max_processing_days: int """The maximum number of days for processing the listing.""" - processing_days_display_label: Optional[str] = None + processing_days_display_label: str """Translated display label string for processing days.""" - origin_country_iso: Optional[str] = None + origin_country_iso: str """The ISO code of the country from which the listing ships.""" - is_deleted: Optional[bool] = None + is_deleted: bool """When true, someone deleted this shipping profile.""" - shipping_profile_destinations: Optional[List[ShopShippingProfileDestination]] = None + shipping_profile_destinations: List[ShopShippingProfileDestination | Mapping[str, Any]] """ A list of shipping profile destinations available for this shipping profile. """ - shipping_profile_upgrades: Optional[List[ShopShippingProfileUpgrade]] = None + shipping_profile_upgrades: List[ShopShippingProfileUpgrade | Mapping[str, Any]] """ A list of shipping profile upgrades available for this shipping profile. """ - origin_postal_code: Optional[str] = None + origin_postal_code: str """ The postal code string (not necessarily a number) for the location from which the listing ships. """ - profile_type: Optional[ProfileType] = None + profile_type: Optional[ProfileType] = dataclass_field(default=None, kw_only=True) @dataclass @@ -301,38 +409,38 @@ class ShippingCreateProfileInput: Create a shipping profile """ - title: Optional[str] = None + title: str """The name string of this shipping profile.""" - origin_country_iso: Optional[str] = None + origin_country_iso: str """The ISO code of the country from which the listing ships.""" - primary_cost: Optional[float] = None + primary_cost: float """ The cost of shipping to this country/region alone, measured in the store's default currency. """ - secondary_cost: Optional[float] = None + secondary_cost: float """ The cost of shipping to this country/region with another item, measured in the store's default currency. """ - min_processing_time: Optional[int] = None + min_processing_time: int """ The minimum time required to process to ship listings with this shipping profile. """ - max_processing_time: Optional[int] = None + max_processing_time: int """The maximum processing time the listing needs to ship.""" - processing_time_unit: Optional[str] = None + processing_time_unit: Optional[str] = dataclass_field(default=None, kw_only=True) """ The unit used to represent how long a processing time is. A week is equivalent to 5 business days. """ - destination_country_iso: Optional[str] = None + destination_country_iso: Optional[str] = dataclass_field(default=None, kw_only=True) """ The ISO code of the country to which the listing ships. If null, request sets destination to destination region. """ - destination_region: Optional[str] = None + destination_region: Optional[str] = dataclass_field(default=None, kw_only=True) """ The code of the region to which the listing ships. A region represents a set of countries. Supported regions are Europe Union and Non-Europe Union @@ -340,27 +448,27 @@ class ShippingCreateProfileInput: destination country ISO, or everywhere if destination country ISO is also null. """ - origin_postal_code: Optional[str] = None + origin_postal_code: Optional[str] = dataclass_field(default=None, kw_only=True) """ The postal code string (not necessarily a number) for the location from which the listing ships. """ - shipping_carrier_id: Optional[int] = None + shipping_carrier_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ The unique ID of a supported shipping carrier, which is used to calculate an estimated delivery date. """ - mail_class: Optional[str] = None + mail_class: Optional[str] = dataclass_field(default=None, kw_only=True) """ The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. """ - min_delivery_days: Optional[int] = None + min_delivery_days: Optional[int] = dataclass_field(default=None, kw_only=True) """ The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. """ - max_delivery_days: Optional[int] = None + max_delivery_days: Optional[int] = dataclass_field(default=None, kw_only=True) """ The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. @@ -373,24 +481,24 @@ class ShippingUpdateProfileInput: Update a shipping profile """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The name string of this shipping profile.""" - origin_country_iso: Optional[str] = None + origin_country_iso: Optional[str] = dataclass_field(default=None, kw_only=True) """The ISO code of the country from which the listing ships.""" - min_processing_time: Optional[int] = None + min_processing_time: Optional[int] = dataclass_field(default=None, kw_only=True) """ The minimum time required to process to ship listings with this shipping profile. """ - max_processing_time: Optional[int] = None + max_processing_time: Optional[int] = dataclass_field(default=None, kw_only=True) """The maximum processing time the listing needs to ship.""" - processing_time_unit: Optional[str] = None + processing_time_unit: Optional[str] = dataclass_field(default=None, kw_only=True) """ The unit used to represent how long a processing time is. A week is equivalent to 5 business days. If none is provided, the unit is set to business_days. """ - origin_postal_code: Optional[str] = None + origin_postal_code: Optional[str] = dataclass_field(default=None, kw_only=True) """ The postal code string (not necessarily a number) for the location from which the listing ships. @@ -403,9 +511,9 @@ class ShopShippingProfileDestinations: Response for Get profile destinations by shipping profile """ - count: Optional[int] = None + count: int """The number of results.""" - results: Optional[List[ShopShippingProfileDestination]] = None + results: List[ShopShippingProfileDestination | Mapping[str, Any]] """The list of requested resources.""" @@ -415,27 +523,27 @@ class ShippingCreateDestinationInput: Create a shipping profile destination """ - primary_cost: Optional[float] = None + primary_cost: float """ The cost of shipping to this country/region alone, measured in the store's default currency. """ - secondary_cost: Optional[str] = None + secondary_cost: str """ The cost of shipping to this country/region with another item, measured in the store's default currency. """ - destination_country_iso: Optional[str] = None + destination_country_iso: Optional[str] = dataclass_field(default=None, kw_only=True) """destination_country_iso""" - destination_region: Optional[str] = None + destination_region: Optional[str] = dataclass_field(default=None, kw_only=True) """destination_region""" - shipping_carrier_id: Optional[int] = None + shipping_carrier_id: Optional[int] = dataclass_field(default=None, kw_only=True) """shipping_carrier_id""" - mail_class: Optional[str] = None + mail_class: Optional[str] = dataclass_field(default=None, kw_only=True) """mail_class""" - min_delivery_days: Optional[int] = None + min_delivery_days: Optional[int] = dataclass_field(default=None, kw_only=True) """min_delivery_days""" - max_delivery_days: Optional[int] = None + max_delivery_days: Optional[int] = dataclass_field(default=None, kw_only=True) """max_delivery_days""" @@ -445,39 +553,39 @@ class ShopShippingProfileDestination: Response for Create a shipping profile destination """ - shipping_profile_destination_id: Optional[int] = None + shipping_profile_destination_id: int """ The numeric ID of the shipping profile destination in the shipping profile associated with the listing. """ - shipping_profile_id: Optional[int] = None + shipping_profile_id: int """The numeric ID of the shipping profile.""" - origin_country_iso: Optional[str] = None + origin_country_iso: str """The ISO code of the country from which the listing ships.""" - destination_country_iso: Optional[str] = None + destination_country_iso: str """ The ISO code of the country to which the listing ships. If null, request sets destination to destination_region """ - destination_region: Optional[DestinationRegion] = None - primary_cost: Optional[Money] = None - secondary_cost: Optional[Money] = None - shipping_carrier_id: Optional[int] = None + destination_region: DestinationRegion + primary_cost: Money | Mapping[str, Any] + secondary_cost: Money | Mapping[str, Any] + shipping_carrier_id: int """ The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date. """ - mail_class: Optional[str] = None + mail_class: str """ The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. """ - min_delivery_days: Optional[int] = None + min_delivery_days: int """ The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. """ - max_delivery_days: Optional[int] = None + max_delivery_days: int """ The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. @@ -490,21 +598,21 @@ class ShippingUpdateProfileDestinationInput: Update a shipping profile destination """ - primary_cost: Optional[str] = None + primary_cost: Optional[str] = dataclass_field(default=None, kw_only=True) """primary_cost""" - secondary_cost: Optional[str] = None + secondary_cost: Optional[str] = dataclass_field(default=None, kw_only=True) """secondary_cost""" - destination_country_iso: Optional[str] = None + destination_country_iso: Optional[str] = dataclass_field(default=None, kw_only=True) """destination_country_iso""" - destination_region: Optional[str] = None + destination_region: Optional[str] = dataclass_field(default=None, kw_only=True) """destination_region""" - shipping_carrier_id: Optional[int] = None + shipping_carrier_id: Optional[int] = dataclass_field(default=None, kw_only=True) """shipping_carrier_id""" - mail_class: Optional[str] = None + mail_class: Optional[str] = dataclass_field(default=None, kw_only=True) """mail_class""" - min_delivery_days: Optional[int] = None + min_delivery_days: Optional[int] = dataclass_field(default=None, kw_only=True) """min_delivery_days""" - max_delivery_days: Optional[int] = None + max_delivery_days: Optional[int] = dataclass_field(default=None, kw_only=True) """max_delivery_days""" @@ -514,9 +622,9 @@ class ShopShippingProfileUpgrades: Response for Get shipping profile upgrades """ - count: Optional[int] = None + count: int """The number of results.""" - results: Optional[List[ShopShippingProfileUpgrade]] = None + results: List[ShopShippingProfileUpgrade | Mapping[str, Any]] """The list of requested resources.""" @@ -526,32 +634,32 @@ class ShippingCreateUpgradeInput: Create a shipping profile upgrade """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """The type of the shipping upgrade. Domestic (0) or international (1).""" - upgrade_name: Optional[str] = None + upgrade_name: str """ Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority. """ - price: Optional[float] = None + price: float """Additional cost of adding the shipping upgrade.""" - secondary_price: Optional[float] = None + secondary_price: float """ Additional cost of adding the shipping upgrade for each additional item. """ - shipping_carrier_id: Optional[int] = None + shipping_carrier_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date. """ - mail_class: Optional[str] = None + mail_class: Optional[str] = dataclass_field(default=None, kw_only=True) """ The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. """ - min_delivery_days: Optional[int] = None + min_delivery_days: Optional[int] = dataclass_field(default=None, kw_only=True) """min_delivery_days""" - max_delivery_days: Optional[int] = None + max_delivery_days: Optional[int] = dataclass_field(default=None, kw_only=True) """ The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. @@ -564,45 +672,45 @@ class ShopShippingProfileUpgrade: Response for Create a shipping profile upgrade """ - shipping_profile_id: Optional[int] = None + shipping_profile_id: int """The numeric ID of the base shipping profile.""" - upgrade_id: Optional[int] = None + upgrade_id: int """The numeric ID that is associated with a shipping upgrade""" - upgrade_name: Optional[str] = None + upgrade_name: str """ Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority. """ - type_: Optional[Type] = field(default=None, metadata={"wire_name": "type"}) - rank: Optional[int] = None + type_: Type = dataclass_field(metadata={"wire_name": "type"}) + rank: int """ The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing. """ - language: Optional[str] = None + language: str """ The IETF language tag for the language of the shipping profile. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru. """ - price: Optional[Money] = None - secondary_price: Optional[Money] = None - shipping_carrier_id: Optional[int] = None + price: Money | Mapping[str, Any] + secondary_price: Money | Mapping[str, Any] + shipping_carrier_id: int """ The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date. """ - mail_class: Optional[str] = None + mail_class: str """ The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. """ - min_delivery_days: Optional[int] = None + min_delivery_days: int """ The minimum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. """ - max_delivery_days: Optional[int] = None + max_delivery_days: int """ The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. @@ -615,32 +723,36 @@ class ShippingUpdateProfileUpgradeInput: Update a shipping profile upgrade """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type of the shipping upgrade. Domestic (0) or international (1).""" - upgrade_name: Optional[str] = None + upgrade_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name for the shipping upgrade shown to shoppers at checkout, e.g. USPS Priority. """ - price: Optional[float] = None + price: Optional[float] = dataclass_field(default=None, kw_only=True) """Additional cost of adding the shipping upgrade.""" - secondary_price: Optional[float] = None + secondary_price: Optional[float] = dataclass_field(default=None, kw_only=True) """ Additional cost of adding the shipping upgrade for each additional item. """ - shipping_carrier_id: Optional[int] = None + shipping_carrier_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ The unique ID of a supported shipping carrier, which is used to calculate an Estimated Delivery Date. """ - mail_class: Optional[str] = None + mail_class: Optional[str] = dataclass_field(default=None, kw_only=True) """ The unique ID string of a shipping carrier's mail class, which is used to calculate an estimated delivery date. """ - min_delivery_days: Optional[int] = None + min_delivery_days: Optional[int] = dataclass_field(default=None, kw_only=True) """min_delivery_days""" - max_delivery_days: Optional[int] = None + max_delivery_days: Optional[int] = dataclass_field(default=None, kw_only=True) """ The maximum number of business days a buyer can expect to wait to receive their purchased item once it has shipped. @@ -653,17 +765,17 @@ class ShopUpdateInput: Update a shop """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """A brief heading string for the shop's main page.""" - announcement: Optional[str] = None + announcement: Optional[str] = dataclass_field(default=None, kw_only=True) """ An announcement string to buyers that displays on the shop's homepage. """ - sale_message: Optional[str] = None + sale_message: Optional[str] = dataclass_field(default=None, kw_only=True) """ A message string sent to users who complete a purchase from this shop. """ - digital_sale_message: Optional[str] = None + digital_sale_message: Optional[str] = dataclass_field(default=None, kw_only=True) """ A message string sent to users who purchase a digital item from this shop. """ @@ -675,120 +787,119 @@ class Shop: Response for Update a shop """ - shop_id: Optional[int] = None + shop_id: int """The unique positive non-zero numeric ID for an Etsy Shop.""" - user_id: Optional[int] = None + user_id: int """The numeric user ID of the user who owns this shop.""" - shop_name: Optional[str] = None + shop_name: str """The shop's name string.""" - create_date: Optional[int] = None + create_date: int """The date and time this shop was created, in epoch seconds.""" - title: Optional[str] = None + title: str """A brief heading string for the shop's main page.""" - announcement: Optional[str] = None + announcement: str """ An announcement string to buyers that displays on the shop's homepage. """ - currency_code: Optional[str] = None + currency_code: str """ The ISO (alphabetic) code for the shop's currency. The shop displays all prices in this currency by default. """ - is_vacation: Optional[bool] = None + is_vacation: bool """When true, this shop is not accepting purchases.""" - vacation_message: Optional[str] = None + vacation_message: str """The shop's message string displayed when is_vacation is true.""" - sale_message: Optional[str] = None + sale_message: str """ A message string sent to users who complete a purchase from this shop. """ - digital_sale_message: Optional[str] = None + digital_sale_message: str """ A message string sent to users who purchase a digital item from this shop. """ - update_date: Optional[int] = None + update_date: int """The date and time of the last update to the shop, in epoch seconds.""" - listing_active_count: Optional[int] = None + listing_active_count: int """The number of active listings in the shop.""" - digital_listing_count: Optional[int] = None + digital_listing_count: int """The number of digital listings in the shop.""" - login_name: Optional[str] = None + login_name: str """The shop owner's login name string.""" - accepts_custom_requests: Optional[bool] = None + accepts_custom_requests: bool """When true, the shop accepts customization requests.""" - policy_welcome: Optional[str] = None + policy_welcome: str """The shop's policy welcome string (may be blank).""" - policy_payment: Optional[str] = None + policy_payment: str """The shop's payment policy string (may be blank).""" - policy_shipping: Optional[str] = None + policy_shipping: str """The shop's shipping policy string (may be blank).""" - policy_refunds: Optional[str] = None + policy_refunds: str """The shop's refund policy string (may be blank).""" - policy_additional: Optional[str] = None + policy_additional: str """The shop's additional policies string (may be blank).""" - policy_seller_info: Optional[str] = None + policy_seller_info: str """The shop's seller infomation string (may be blank).""" - policy_update_date: Optional[int] = None + policy_update_date: int """ The date and time of the last update to the shop's policies, in epoch seconds. """ - policy_has_private_receipt_info: Optional[bool] = None + policy_has_private_receipt_info: bool """When true, EU receipts display private info.""" - has_unstructured_policies: Optional[bool] = None + has_unstructured_policies: bool """When true, the shop displays additional unstructured policy fields.""" - policy_privacy: Optional[str] = None + policy_privacy: str """The shop's privacy policy string (may be blank).""" - vacation_autoreply: Optional[str] = None + vacation_autoreply: str """ The shop's automatic reply string displayed in new conversations when is_vacation is true. """ - url: Optional[str] = None + url: str """The URL string for this shop.""" - image_url760x100: Optional[str] = field( - default=None, + image_url760x100: str = dataclass_field( metadata={"wire_name": "image_url_760x100"}, ) """The URL string for this shop's banner image.""" - num_favorers: Optional[int] = None + num_favorers: int """The number of users who marked this shop a favorite.""" - languages: Optional[List[str]] = None + languages: List[str] """A list of language strings for the shop's enrolled languages.""" - icon_url_fullxfull: Optional[str] = None + icon_url_fullxfull: str """The URL string for this shop's icon image.""" - is_using_structured_policies: Optional[bool] = None + is_using_structured_policies: bool """When true, the shop accepted using structured policies.""" - has_onboarded_structured_policies: Optional[bool] = None + has_onboarded_structured_policies: bool """ When true, the shop accepted OR declined after viewing structured policies onboarding. """ - include_dispute_form_link: Optional[bool] = None + include_dispute_form_link: bool """ When true, this shop's policies include a link to an EU online dispute form. """ - is_direct_checkout_onboarded: Optional[bool] = None + is_direct_checkout_onboarded: bool """When true, the shop has onboarded onto Etsy Payments.""" - is_calculated_eligible: Optional[bool] = None + is_calculated_eligible: bool """ When true, the shop is elegible for calculated shipping profiles. (Only available in the US and Canada) """ - is_opted_in_to_buyer_promise: Optional[bool] = None + is_opted_in_to_buyer_promise: bool """When true, the shop opted in to buyer promise.""" - is_shop_us_based: Optional[bool] = None + is_shop_us_based: bool """When true, the shop is based in the US.""" - transaction_sold_count: Optional[int] = None + transaction_sold_count: int """The total number of sales transactions for this shop""" - shipping_from_country_iso: Optional[str] = None + shipping_from_country_iso: str """The country iso the shop is shipping from.""" - shop_location_country_iso: Optional[str] = None + shop_location_country_iso: str """The country iso where the shop is located.""" - review_count: Optional[int] = None + review_count: int """Number of reviews of shop listings in the past year.""" - review_average: Optional[float] = None + review_average: float """Average rating based on reviews of shop listings in the past year.""" @@ -798,9 +909,9 @@ class Shops: Response for Search shops """ - count: Optional[int] = None + count: int """The total number of Shops""" - results: Optional[List[Shop]] = None + results: List[Shop | Mapping[str, Any]] """The Shop resources.""" @@ -810,9 +921,9 @@ class ShopSections: Response for Get shop sections """ - count: Optional[int] = None + count: int """The number of results.""" - results: Optional[List[ShopSection]] = None + results: List[ShopSection | Mapping[str, Any]] """The list of requested resources.""" @@ -822,7 +933,7 @@ class ShopCreateSectionInput: Create a shop section """ - title: Optional[str] = None + title: str """The title string for a shop section.""" @@ -832,18 +943,18 @@ class ShopSection: Response for Create a shop section """ - shop_section_id: Optional[int] = None + shop_section_id: int """The numeric ID of a section in a specific Etsy shop.""" - title: Optional[str] = None + title: str """The title string for a shop section.""" - rank: Optional[int] = None + rank: int """ The positive non-zero numeric position of this section in the section display order for a shop, with rank 1 sections appearing first. """ - user_id: Optional[int] = None + user_id: int """The numeric ID of the user who owns this shop section.""" - active_listing_count: Optional[int] = None + active_listing_count: int """The number of active listings in one section of a specific Etsy shop.""" @@ -853,38 +964,38 @@ class User: Response for Get user """ - user_id: Optional[int] = None + user_id: int """ The numeric ID of a user. This number is also a valid shop ID for the user's shop. """ - login_name: Optional[str] = None + login_name: str """The user's login name string.""" - primary_email: Optional[str] = None + primary_email: str """An email address string for the user's primary email address.""" - first_name: Optional[str] = None + first_name: str """The user's first name.""" - last_name: Optional[str] = None + last_name: str """The user's last name.""" - create_timestamp: Optional[int] = None + create_timestamp: int """The date and time the user created their account, in epoch seconds.""" - referred_by_user_id: Optional[int] = None + referred_by_user_id: int """The numeric ID of the user who referred this user.""" - use_new_inventory_endpoints: Optional[bool] = None + use_new_inventory_endpoints: bool """Deprecated. Always true.""" - is_seller: Optional[bool] = None + is_seller: bool """True if the user is seller.""" - bio: Optional[str] = None + bio: str """The user's biography.""" - gender: Optional[str] = None + gender: str """The user's gender.""" - birth_month: Optional[str] = None + birth_month: str """The user's month of birth.""" - birth_day: Optional[str] = None + birth_day: str """The user's day of birth.""" - transaction_buy_count: Optional[int] = None + transaction_buy_count: int """The number of transactions where the user has bought.""" - transaction_sold_count: Optional[int] = None + transaction_sold_count: int """The number of transactions where the user has sold.""" @@ -894,27 +1005,27 @@ class UserAddress: Response for Get user's address """ - user_address_id: Optional[int] = None + user_address_id: int """The numeric ID of the user's address.""" - user_id: Optional[int] = None + user_id: int """The user's numeric ID.""" - name: Optional[str] = None + name: str """The user's name for this address.""" - first_line: Optional[str] = None + first_line: str """The first line of the user's address.""" - second_line: Optional[str] = None + second_line: str """The second line of the user's address.""" - city: Optional[str] = None + city: str """The city field of the user's address.""" - state: Optional[str] = None + state: str """The state field of the user's address.""" - zip: Optional[str] = None + zip: str """The zip code field of the user's address.""" - iso_country_code: Optional[str] = None + iso_country_code: str """The ISO code of the country in this address.""" - country_name: Optional[str] = None + country_name: str """The name of the user's country.""" - is_default_shipping_address: Optional[bool] = None + is_default_shipping_address: bool """Is this the user's default shipping address.""" @@ -924,9 +1035,9 @@ class UserAddresses: Response for Get user addresses """ - count: Optional[int] = None + count: int """The number of UserAddress records being returned.""" - results: Optional[List[UserAddress]] = None + results: List[UserAddress | Mapping[str, Any]] """An array of UserAddress resources.""" @@ -936,9 +1047,9 @@ class SellerTaxonomyNodes: Response for Get seller taxonomy nodes """ - count: Optional[int] = None + count: int """The number of results.""" - results: Optional[List[SellerTaxonomyNode]] = None + results: List[SellerTaxonomyNode | Mapping[str, Any]] """The list of requested resources.""" @@ -948,9 +1059,9 @@ class TaxonomyNodeProperties: Response for Get product properties by taxonomy ID """ - count: Optional[int] = None + count: int """The number of results.""" - results: Optional[List[TaxonomyNodeProperty]] = None + results: List[TaxonomyNodeProperty | Mapping[str, Any]] """The list of requested resources.""" @@ -960,9 +1071,9 @@ class ShopListings: Response for Get listings by shop """ - count: Optional[int] = None + count: int """The number of shop listing resources found.""" - results: Optional[List[ShopListing]] = None + results: List[ShopListing | Mapping[str, Any]] """The shop listing resources found.""" @@ -972,126 +1083,126 @@ class ListingCreateInput: Create a draft listing """ - quantity: Optional[int] = None + quantity: int """ The positive non-zero number of products available for purchase in the listing. """ - title: Optional[str] = None + title: str """ The listing's title string. Valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{P}\\p{Sm}\\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each. """ - description: Optional[str] = None + description: str """A description string of the product for sale in the listing.""" - price: Optional[float] = None + price: float """ The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price. """ - who_made: Optional[str] = None + who_made: str """ An string inidcated who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'. """ - when_made: Optional[str] = None + when_made: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string for the era in which the maker made the product in this listing. Helps buyers locate the listing under the Vintage heading. Requires 'is_supply' and 'who_made'. """ - taxonomy_id: Optional[int] = None + taxonomy_id: int """ The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop. """ - shipping_profile_id: Optional[int] = None + shipping_profile_id: int """The numeric ID of the shipping profile associated with the listing.""" - materials: Optional[str] = None + materials: Optional[str] = dataclass_field(default=None, kw_only=True) """ A array of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}]/u) """ - shop_section_id: Optional[int] = None + shop_section_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numeric ID of the shop section for this listing.""" - processing_min: Optional[int] = None + processing_min: Optional[int] = dataclass_field(default=None, kw_only=True) """The minimum number of days required to process this listing.""" - processing_max: Optional[int] = None + processing_max: Optional[int] = dataclass_field(default=None, kw_only=True) """The maximum number of days required to process this listing.""" - tags: Optional[str] = None + tags: Optional[str] = dataclass_field(default=None, kw_only=True) """ An array of tag strings for the listing. Valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}-'™©®]/u) """ - recipient: Optional[str] = None + recipient: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string indicating a person for whom this product would make an appropriate gift. """ - occasion: Optional[str] = None + occasion: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string indicating an occassion for which this product would make an appropriate gift. """ - styles: Optional[str] = None + styles: Optional[str] = dataclass_field(default=None, kw_only=True) """ An array of style strings for this listing, each of which is free-form text string such as Formal, or Steampunk. A Listing may have up to two styles. Valid style strings contain only letters, numbers, and whitespace characters. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}]/u) """ - item_weight: Optional[float] = None + item_weight: Optional[float] = dataclass_field(default=None, kw_only=True) """ The numeric weight of the product measured in units set in item weight unit. """ - item_length: Optional[int] = None + item_length: Optional[int] = dataclass_field(default=None, kw_only=True) """ The numeric length of the product measured in units set in item dimensions unit. """ - item_width: Optional[float] = None + item_width: Optional[float] = dataclass_field(default=None, kw_only=True) """ The numeric width of the product measured in units set in 'item dimensions unit'. """ - item_height: Optional[float] = None + item_height: Optional[float] = dataclass_field(default=None, kw_only=True) """ The numeric height of the product measured in units set in 'item dimensions unit'. """ - item_weight_unit: Optional[str] = None + item_weight_unit: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string defining the units used to measure the weight of the product. """ - item_dimensions_unit: Optional[str] = None + item_dimensions_unit: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string defining the units used to measure the dimensions of the product. """ - is_personalizable: Optional[bool] = None + is_personalizable: Optional[bool] = dataclass_field(default=None, kw_only=True) """When true, this listing is personalizable.""" - image_ids: Optional[str] = None + image_ids: Optional[str] = dataclass_field(default=None, kw_only=True) """ An array of numeric image IDs of the images in a listing, which can include up to 10 images. """ - is_supply: Optional[bool] = None + is_supply: Optional[bool] = dataclass_field(default=None, kw_only=True) """ When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who made' and 'when made'. """ - is_customizable: Optional[bool] = None + is_customizable: Optional[bool] = dataclass_field(default=None, kw_only=True) """ When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders. """ - is_taxable: Optional[bool] = None + is_taxable: Optional[bool] = dataclass_field(default=None, kw_only=True) """ When true, applicable shop tax rates apply to this listing at checkout. """ @@ -1103,146 +1214,146 @@ class ShopListing: Response for Create a draft listing """ - listing_id: Optional[int] = None + listing_id: int """The numeric ID for the listing associated to this transaction.""" - user_id: Optional[int] = None + user_id: int """The numeric ID for the user posting the listing.""" - shop_id: Optional[int] = None + shop_id: int """The unique positive non-zero numeric ID for an Etsy Shop.""" - title: Optional[str] = None + title: str """ The listing's title string. Valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\\\\p{L}\\\\p{Nd}\\\\p{P}\\\\p{Sm}\\\\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each. """ - description: Optional[str] = None + description: str """A description string of the product for sale in the listing.""" - state: Optional[State] = None - creation_timestamp: Optional[int] = None + state: State + creation_timestamp: int """The listing's creation time, in epoch seconds.""" - ending_timestamp: Optional[int] = None + ending_timestamp: int """The listing's expiration time, in epoch seconds.""" - original_creation_timestamp: Optional[int] = None + original_creation_timestamp: int """The listing's creation time, in epoch seconds.""" - last_modified_timestamp: Optional[int] = None + last_modified_timestamp: int """The time of the last update to the listing, in epoch seconds.""" - state_timestamp: Optional[int] = None + state_timestamp: int """The date and time of the last state change of this listing.""" - quantity: Optional[int] = None + quantity: int """ The positive non-zero number of products available for purchase in the listing. Note: The listing quantity is the sum of available offering quantities. You can request the quantities for individual offerings from the ListingInventory resource using the get listing inventory endpoint. """ - shop_section_id: Optional[int] = None + shop_section_id: int """The numeric ID of a section in a specific Etsy shop.""" - featured_rank: Optional[int] = None + featured_rank: int """ The positive non-zero numeric position in the featured listings of the shop, with rank 1 listings appearing in the left-most position in featured listing on a shop's home page. """ - url: Optional[str] = None + url: str """The full URL to the listing's page on Etsy.""" - num_favorers: Optional[int] = None + num_favorers: int """The number of users who marked this listing a favorite.""" - non_taxable: Optional[bool] = None + non_taxable: bool """ When true, applicable shop tax rates do not apply to this listing at checkout. """ - is_customizable: Optional[bool] = None + is_customizable: bool """ When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders. """ - is_personalizable: Optional[bool] = None + is_personalizable: bool """When true, this listing is personalizable. The default value is null.""" - personalization_is_required: Optional[bool] = None + personalization_is_required: bool """ When true, this listing requires personalization. The default value is null. """ - personalization_char_count_max: Optional[int] = None + personalization_char_count_max: int """ This an integer value representing the maximum length for the personalization message entered by the buyer. """ - personalization_instructions: Optional[str] = None + personalization_instructions: str """ When true, this listing requires personalization. The default value is null. """ - listing_type: Optional[bool] = None + listing_type: bool """ An enumerated type string that indicates whether the listing is physical or a digital download. """ - tags: Optional[List[str]] = None + tags: List[str] """ A list of tag strings for the listing. Valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\\\\p{L}\\\\p{Nd}\\\\p{Zs}\\\\-'™©®]/u) Default value is null. """ - materials: Optional[List[str]] = None + materials: List[str] """ A list of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\\\\p{L}\\\\p{Nd}\\\\p{Zs}]/u) Default value is null. """ - shipping_profile_id: Optional[int] = None + shipping_profile_id: int """The numeric ID of the shipping profile associated with the listing.""" - processing_min: Optional[int] = None + processing_min: int """ The minimum number of days required to process this listing. Default value is null. """ - processing_max: Optional[int] = None + processing_max: int """ The maximum number of days required to process this listing. Default value is null. """ - who_made: Optional[WhoMade] = None - when_made: Optional[WhenMade] = None - is_supply: Optional[bool] = None + who_made: WhoMade + when_made: WhenMade + is_supply: bool """ When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who_made' and 'when_made'. """ - item_weight: Optional[float] = None + item_weight: float """ The numeric weight of the product measured in units set in item weight unit. Default value is null. If set, the value must be greater than 0. """ - item_weight_unit: Optional[ItemWeightUnit] = None - item_length: Optional[float] = None + item_weight_unit: ItemWeightUnit + item_length: float """ The numeric length of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0. """ - item_width: Optional[float] = None + item_width: float """ The numeric width of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0. """ - item_height: Optional[float] = None + item_height: float """ The numeric length of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0. """ - item_dimensions_unit: Optional[ItemDimensionsUnit] = None - is_private: Optional[bool] = None + item_dimensions_unit: ItemDimensionsUnit + is_private: bool """ When true, this is a private listing intendend for a specific buyer and hidden from shop view. """ - recipient: Optional[Recipient] = None - occasion: Optional[Occasion] = None - style: Optional[List[str]] = None + recipient: Recipient + occasion: Occasion + style: List[str] """ An array of style strings for this listing, each of which is free-form text string such as Formal, or Steampunk. A Listing may have up to two styles. @@ -1250,11 +1361,11 @@ class ShopListing: characters. (regex: /[^\\\\p{L}\\\\p{Nd}\\\\p{Zs}]/u) Default value is null. """ - file_data: Optional[str] = None + file_data: str """A string describing the files attached to a digital listing.""" - has_variations: Optional[bool] = None + has_variations: bool """When true, the listing has variations.""" - should_auto_renew: Optional[bool] = None + should_auto_renew: bool """ When true, renews a listing for four months upon expriation. If set to true when previously false, etsy.com renews the listing before it expires, but @@ -1262,13 +1373,13 @@ class ShopListing: expiration date. Any unused time remaining on the listing is lost. Renewals result in charges to a user's bill. """ - language: Optional[str] = None + language: str """ The IETF language tag for the default language of the listing. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`, `ru`. """ - price: Optional[Money] = None - taxonomy_id: Optional[int] = None + price: Money | Mapping[str, Any] + taxonomy_id: int """ The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop. See seller taxonomy for more information. @@ -1281,9 +1392,9 @@ class ShopListingsWithAssociations: Response for Get listings by ID """ - count: Optional[int] = None + count: int """The number of shop listing resources found.""" - results: Optional[List[ShopListing]] = None + results: List[ShopListing | Mapping[str, Any]] """The shop listing resources found.""" @@ -1293,11 +1404,11 @@ class ListingUpdatePropertyInput: Update a listing property """ - value_ids: Optional[int] = None + value_ids: int """The numeric ID of a single Etsy.com measurement scale.""" - values: Optional[str] = None + values: str """An array of value strings for multiple Etsy listing property values.""" - scale_id: Optional[int] = None + scale_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numeric ID of a single Etsy.com measurement scale.""" @@ -1307,17 +1418,17 @@ class ListingPropertyValue: Response for Update a listing property """ - property_id: Optional[int] = None + property_id: int """The numeric ID of the Property.""" - property_name: Optional[str] = None + property_name: str """The name of the Property.""" - scale_id: Optional[int] = None + scale_id: int """The numeric ID of the scale (if any).""" - scale_name: Optional[str] = None + scale_name: str """The label used to describe the chosen scale (if any).""" - value_ids: Optional[List[int]] = None + value_ids: List[int] """The numeric IDs of the property values""" - values: Optional[List[str]] = None + values: List[str] """The property values""" @@ -1327,9 +1438,9 @@ class ListingPropertyValues: Response for Get a listing's properties """ - count: Optional[int] = None + count: int """The number of shop listing resources found.""" - results: Optional[List[ListingPropertyValue]] = None + results: List[ListingPropertyValue | Mapping[str, Any]] """The shop listing resources found.""" @@ -1339,136 +1450,136 @@ class ListingUpdateInput: Update a listing """ - quantity: Optional[int] = None + quantity: Optional[int] = dataclass_field(default=None, kw_only=True) """ The positive non-zero number of products available for purchase in the listing. """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """ The listing's title string. Valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{P}\\p{Sm}\\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each. """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """A description string of the product for sale in the listing.""" - price: Optional[float] = None + price: Optional[float] = dataclass_field(default=None, kw_only=True) """ The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price. """ - who_made: Optional[str] = None + who_made: Optional[str] = dataclass_field(default=None, kw_only=True) """ An string inidcated who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'. """ - when_made: Optional[str] = None + when_made: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string for the era in which the maker made the product in this listing. Helps buyers locate the listing under the Vintage heading. Requires 'is_supply' and 'who_made'. """ - taxonomy_id: Optional[int] = None + taxonomy_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop. """ - shipping_profile_id: Optional[int] = None + shipping_profile_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numeric ID of the shipping profile associated with the listing.""" - materials: Optional[str] = None + materials: Optional[str] = dataclass_field(default=None, kw_only=True) """ A array of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}]/u) """ - shop_section_id: Optional[int] = None + shop_section_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numeric ID of the shop section for this listing.""" - processing_min: Optional[int] = None + processing_min: Optional[int] = dataclass_field(default=None, kw_only=True) """The minimum number of days required to process this listing.""" - processing_max: Optional[int] = None + processing_max: Optional[int] = dataclass_field(default=None, kw_only=True) """The maximum number of days required to process this listing.""" - tags: Optional[str] = None + tags: Optional[str] = dataclass_field(default=None, kw_only=True) """ An array of tag strings for the listing. Valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}-'™©®]/u) """ - recipient: Optional[str] = None + recipient: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string indicating a person for whom this product would make an appropriate gift. """ - occasion: Optional[str] = None + occasion: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string indicating an occassion for which this product would make an appropriate gift. """ - styles: Optional[str] = None + styles: Optional[str] = dataclass_field(default=None, kw_only=True) """ An array of style strings for this listing, each of which is free-form text string such as Formal, or Steampunk. A Listing may have up to two styles. Valid style strings contain only letters, numbers, and whitespace characters. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}]/u) """ - item_weight: Optional[float] = None + item_weight: Optional[float] = dataclass_field(default=None, kw_only=True) """ The numeric weight of the product measured in units set in item weight unit. """ - item_length: Optional[int] = None + item_length: Optional[int] = dataclass_field(default=None, kw_only=True) """ The numeric length of the product measured in units set in item dimensions unit. """ - item_width: Optional[float] = None + item_width: Optional[float] = dataclass_field(default=None, kw_only=True) """ The numeric width of the product measured in units set in 'item dimensions unit'. """ - item_height: Optional[float] = None + item_height: Optional[float] = dataclass_field(default=None, kw_only=True) """ The numeric height of the product measured in units set in 'item dimensions unit'. """ - item_weight_unit: Optional[str] = None + item_weight_unit: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string defining the units used to measure the weight of the product. """ - item_dimensions_unit: Optional[str] = None + item_dimensions_unit: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string defining the units used to measure the dimensions of the product. """ - is_personalizable: Optional[bool] = None + is_personalizable: Optional[bool] = dataclass_field(default=None, kw_only=True) """When true, this listing is personalizable.""" - image_ids: Optional[str] = None + image_ids: Optional[str] = dataclass_field(default=None, kw_only=True) """ An array of numeric image IDs of the images in a listing, which can include up to 10 images. """ - is_supply: Optional[bool] = None + is_supply: Optional[bool] = dataclass_field(default=None, kw_only=True) """ When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who made' and 'when made'. """ - is_customizable: Optional[bool] = None + is_customizable: Optional[bool] = dataclass_field(default=None, kw_only=True) """ When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders. """ - is_taxable: Optional[bool] = None + is_taxable: Optional[bool] = dataclass_field(default=None, kw_only=True) """ When true, applicable shop tax rates apply to this listing at checkout. """ - featured_rank: Optional[int] = None + featured_rank: Optional[int] = dataclass_field(default=None, kw_only=True) """ The positive non-zero numeric position in the featured listings of the shop with rank 1 listings appearing in the left-most position in featured listing on a shop's home page. """ - should_auto_renew: Optional[bool] = None + should_auto_renew: Optional[bool] = dataclass_field(default=None, kw_only=True) """ When true, renews a listing for four months upon expriation. If set to true when previously false, etsy.com renews the listing before it expires, but @@ -1476,9 +1587,13 @@ class ListingUpdateInput: expiration date. Any unused time remaining on the listing is lost. Renewals result in charges to a user's bill. """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Indicates whether the listing is physical or a digital download.""" - channels: Optional[str] = None + channels: Optional[str] = dataclass_field(default=None, kw_only=True) """ An array of enumerated channel ID strings. A channel is a venue for sellers to reach buyers in order to make sales. @@ -1491,24 +1606,24 @@ class ShopListingFile: Response for Get a file from a listing """ - listing_file_id: Optional[int] = None + listing_file_id: int """The unique numeric ID of a file associated with a digital listing.""" - listing_id: Optional[int] = None + listing_id: int """The numeric ID for the listing associated to this transaction.""" - rank: Optional[int] = None + rank: int """ The numeric index of the display order position of this file in the listing, starting at 1. """ - filename: Optional[str] = None + filename: str """The file name string for a file associated with a digital listing.""" - filesize: Optional[str] = None + filesize: str """A human-readable format size string for the size of a file.""" - size_bytes: Optional[int] = None + size_bytes: int """A number indicating the size of a file, measured in bytes.""" - filetype: Optional[str] = None + filetype: str """A type string indicating a file's MIME type.""" - create_timestamp: Optional[int] = None + create_timestamp: int """ The unique numeric timestamp of a file associated with a digital listing. """ @@ -1520,9 +1635,9 @@ class ShopListingFiles: Response for Get all listing files """ - count: Optional[int] = None + count: int """The number of ShopListingFiles being returned..""" - results: Optional[List[ShopListingFile]] = None + results: List[ShopListingFile | Mapping[str, Any]] """An array of ShopListingFile resources.""" @@ -1532,13 +1647,13 @@ class ListingUploadInput: Upload a listing file """ - listing_file_id: Optional[int] = None + listing_file_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique numeric ID of a file associated with a digital listing.""" - file: Optional[str] = None + file: str """A binary file to upload.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The file name string of a file to upload""" - rank: Optional[int] = None + rank: Optional[int] = dataclass_field(default=None, kw_only=True) """ The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a @@ -1552,80 +1667,71 @@ class ListingImage: Response for Get a listing image """ - listing_id: Optional[int] = None + listing_id: int """The numeric ID for the listing associated to this transaction.""" - listing_image_id: Optional[int] = None + listing_image_id: int """The numeric ID of the primary listing image for this transaction.""" - hex_code: Optional[str] = None + hex_code: str """The webhex string for the image's average color, in webhex notation.""" - red: Optional[int] = None + red: int """ The numeric red value equal to the image's average red value, from 0-255 (RGB color). """ - green: Optional[int] = None + green: int """ The numeric red value equal to the image's average red value, from 0-255 (RGB color). """ - blue: Optional[int] = None + blue: int """ The numeric red value equal to the image's average red value, from 0-255 (RGB color). """ - hue: Optional[int] = None + hue: int """ The numeric hue equal to the image's average hue, from 0-360 (HSV color). """ - saturation: Optional[int] = None + saturation: int """ The numeric saturation equal to the image's average saturation, from 0-100 (HSV color). """ - brightness: Optional[int] = None + brightness: int """ The numeric brightness equal to the image's average brightness, from 0-100 (HSV color). """ - is_black_and_white: Optional[bool] = None + is_black_and_white: bool """When true, the image is in black & white.""" - creation_tsz: Optional[int] = None + creation_tsz: int """The listing image's creation time, in epoch seconds.""" - rank: Optional[int] = None + rank: int """ The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing. """ - url75x75: Optional[str] = field( - default=None, - metadata={"wire_name": "url_75x75"}, - ) + url75x75: str = dataclass_field(metadata={"wire_name": "url_75x75"}) """The url string for a 75x75 pixel thumbnail of the image.""" - url170x135: Optional[str] = field( - default=None, - metadata={"wire_name": "url_170x135"}, - ) + url170x135: str = dataclass_field(metadata={"wire_name": "url_170x135"}) """The url string for a 170x135 pixel thumbnail of the image.""" - url570x_n: Optional[str] = field( - default=None, - metadata={"wire_name": "url_570xN"}, - ) + url570x_n: str = dataclass_field(metadata={"wire_name": "url_570xN"}) """ The url string for a thumbnail of the image, no more than 570 pixels wide with variable height. """ - url_fullxfull: Optional[str] = None + url_fullxfull: str """ The url string for the full-size image, up to 3000 pixels in each dimension. """ - full_height: Optional[int] = None + full_height: int """ The numeric height, measured in pixels, of the full-sized image referenced in url_fullxfull. """ - full_width: Optional[int] = None + full_width: int """ The numeric width, measured in pixels, of the full-sized image referenced in url_fullxfull. @@ -1638,9 +1744,9 @@ class ListingImages: Response for Get a listing's images """ - count: Optional[int] = None + count: int """The number of results.""" - results: Optional[List[ListingImage]] = None + results: List[ListingImage | Mapping[str, Any]] """The list of requested resources.""" @@ -1650,19 +1756,19 @@ class ListingUploadImageInput: Upload a listing image """ - image: Optional[str] = None + image: Optional[str] = dataclass_field(default=None, kw_only=True) """The file name string of a file to upload.""" - listing_image_id: Optional[int] = None + listing_image_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numeric ID of the primary listing image for this transaction.""" - rank: Optional[int] = None + rank: Optional[int] = dataclass_field(default=None, kw_only=True) """ The positive non-zero numeric position in the images displayed in a listing, with rank 1 images appearing in the left-most position in a listing. """ - overwrite: Optional[bool] = None + overwrite: Optional[bool] = dataclass_field(default=None, kw_only=True) """When true, this request replaces the existing image at a given rank.""" - is_watermarked: Optional[bool] = None + is_watermarked: Optional[bool] = dataclass_field(default=None, kw_only=True) """When true, indicates that the uploaded image has a watermark.""" @@ -1672,33 +1778,33 @@ class ListingInventoryWithAssociations: Response for Get a listing's inventory """ - products: Optional[List[ListingInventoryProduct]] = None + products: List[ListingInventoryProduct | Mapping[str, Any]] """ A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase. """ - price_on_property: Optional[List[int]] = None + price_on_property: List[int] """ An array of unique listing property ID integers for the properties that change product prices, if any. For example, if you charge specific prices for different sized products in the same listing, then this array contains the property ID for size. """ - quantity_on_property: Optional[List[int]] = None + quantity_on_property: List[int] """ An array of unique listing property ID integers for the properties that change the quantity of the products, if any. For example, if you stock specific quantities of different colored products in the same listing, then this array contains the property ID for color. """ - sku_on_property: Optional[List[int]] = None + sku_on_property: List[int] """ An array of unique listing property ID integers for the properties that change the product SKU, if any. For example, if you use specific skus for different colored products in the same listing, then this array contains the property ID for color. """ - listing: Optional[ShopListing] = None + listing: ShopListing | Mapping[str, Any] @dataclass @@ -1707,26 +1813,26 @@ class ListingUpdateInventoryInput: Update a listing's inventory """ - products: Optional[str] = None + products: str """ A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase. """ - price_on_property: Optional[str] = None + price_on_property: Optional[str] = dataclass_field(default=None, kw_only=True) """ An array of unique listing property ID integers for the properties that change product prices, if any. For example, if you charge specific prices for different sized products in the same listing, then this array contains the property ID for size. """ - quantity_on_property: Optional[str] = None + quantity_on_property: Optional[str] = dataclass_field(default=None, kw_only=True) """ An array of unique listing property ID integers for the properties that change the quantity of the products, if any. For example, if you stock specific quantities of different colored products in the same listing, then this array contains the property ID for color. """ - sku_on_property: Optional[str] = None + sku_on_property: Optional[str] = dataclass_field(default=None, kw_only=True) """ An array of unique listing property ID integers for the properties that change the product SKU, if any. For example, if you use specific skus for @@ -1741,26 +1847,26 @@ class ListingInventory: Response for Update a listing's inventory """ - products: Optional[List[ListingInventoryProduct]] = None + products: List[ListingInventoryProduct | Mapping[str, Any]] """ A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase. """ - price_on_property: Optional[List[int]] = None + price_on_property: List[int] """ An array of unique listing property ID integers for the properties that change product prices, if any. For example, if you charge specific prices for different sized products in the same listing, then this array contains the property ID for size. """ - quantity_on_property: Optional[List[int]] = None + quantity_on_property: List[int] """ An array of unique listing property ID integers for the properties that change the quantity of the products, if any. For example, if you stock specific quantities of different colored products in the same listing, then this array contains the property ID for color. """ - sku_on_property: Optional[List[int]] = None + sku_on_property: List[int] """ An array of unique listing property ID integers for the properties that change the product SKU, if any. For example, if you use specific skus for @@ -1775,15 +1881,15 @@ class ListingInventoryProductOffering: Response for Get a listing's offering """ - offering_id: Optional[int] = None + offering_id: int """The ID for the product offering""" - quantity: Optional[int] = None + quantity: int """The quantity the product offering""" - is_enabled: Optional[bool] = None + is_enabled: bool """Whether or not the offering can be shown to buyers.""" - is_deleted: Optional[bool] = None + is_deleted: bool """Whether or not the offering has been deleted.""" - price: Optional[Money] = None + price: Money | Mapping[str, Any] @dataclass @@ -1792,15 +1898,15 @@ class ListingInventoryProduct: Response for Get a listing's product """ - product_id: Optional[int] = None + product_id: int """The numeric ID for a specific product purchased from a listing.""" - sku: Optional[str] = None + sku: str """The SKU string for the product""" - is_deleted: Optional[bool] = None + is_deleted: bool """When true, someone deleted this product.""" - offerings: Optional[List[ListingInventoryProductOffering]] = None + offerings: List[ListingInventoryProductOffering | Mapping[str, Any]] """A list of product offering entries for this product.""" - property_values: Optional[List[ListingPropertyValue]] = None + property_values: List[ListingPropertyValue | Mapping[str, Any]] """A list of property value entries for this product.""" @@ -1810,17 +1916,17 @@ class ListingTranslation: Response for Get a listing's translation """ - listing_id: Optional[int] = None + listing_id: int """The numeric ID for the Listing.""" - language: Optional[str] = None + language: str """ The IETF language tag (e.g. 'fr') for the language of this translation. """ - title: Optional[str] = None + title: str """The title of the Listing of this Translation.""" - description: Optional[str] = None + description: str """The description of the Listing of this Translation.""" - tags: Optional[List[str]] = None + tags: List[str] """The tags of the Listing of this Translation.""" @@ -1830,11 +1936,11 @@ class ListingCreateTranslationInput: Create a listing translation """ - title: Optional[str] = None + title: str """The title of the Listing of this Translation.""" - description: Optional[str] = None + description: str """The description of the Listing of this Translation.""" - tags: Optional[str] = None + tags: Optional[str] = dataclass_field(default=None, kw_only=True) """The tags of the Listing of this Translation.""" @@ -1844,11 +1950,11 @@ class ListingUpdateTranslationInput: Update a listing translation """ - title: Optional[str] = None + title: str """The title of the Listing of this Translation.""" - description: Optional[str] = None + description: str """The description of the Listing of this Translation.""" - tags: Optional[str] = None + tags: Optional[str] = dataclass_field(default=None, kw_only=True) """The tags of the Listing of this Translation.""" @@ -1858,9 +1964,9 @@ class ListingVariationImages: Response for Get listing's variation images """ - count: Optional[int] = None + count: int """The count of variation images.""" - results: Optional[List[ListingVariationImage]] = None + results: List[ListingVariationImage | Mapping[str, Any]] """The variation images results.""" @@ -1870,7 +1976,7 @@ class ListingUpdateVariationInput: Update a listing's variation images """ - variation_images: Optional[str] = None + variation_images: str """A array of variation image data.""" @@ -1880,11 +1986,11 @@ class Money: Definition: Money """ - amount: Optional[int] = None + amount: int """The amount of represented by this data.""" - divisor: Optional[int] = None + divisor: int """The divisor to render the amount.""" - currency_code: Optional[str] = None + currency_code: str """The ISO currency code for this data.""" @@ -1894,7 +2000,7 @@ class ErrorSchema: Definition: ErrorSchema """ - error: Optional[str] = None + error: str """The error code.""" @@ -1904,146 +2010,146 @@ class ShopListingWithAssociations: Definition: ShopListingWithAssociations """ - listing_id: Optional[int] = None + listing_id: int """The numeric ID for the listing associated to this transaction.""" - user_id: Optional[int] = None + user_id: int """The numeric ID for the user posting the listing.""" - shop_id: Optional[int] = None + shop_id: int """The unique positive non-zero numeric ID for an Etsy Shop.""" - title: Optional[str] = None + title: str """ The listing's title string. Valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, ™, ©, and ®. (regex: /[^\\\\p{L}\\\\p{Nd}\\\\p{P}\\\\p{Sm}\\\\p{Zs}™©®]/u) You can only use the %, :, & and + characters once each. """ - description: Optional[str] = None + description: str """A description string of the product for sale in the listing.""" - state: Optional[State] = None - creation_timestamp: Optional[int] = None + state: State + creation_timestamp: int """The listing's creation time, in epoch seconds.""" - ending_timestamp: Optional[int] = None + ending_timestamp: int """The listing's expiration time, in epoch seconds.""" - original_creation_timestamp: Optional[int] = None + original_creation_timestamp: int """The listing's creation time, in epoch seconds.""" - last_modified_timestamp: Optional[int] = None + last_modified_timestamp: int """The time of the last update to the listing, in epoch seconds.""" - state_timestamp: Optional[int] = None + state_timestamp: int """The date and time of the last state change of this listing.""" - quantity: Optional[int] = None + quantity: int """ The positive non-zero number of products available for purchase in the listing. Note: The listing quantity is the sum of available offering quantities. You can request the quantities for individual offerings from the ListingInventory resource using the get listing inventory endpoint. """ - shop_section_id: Optional[int] = None + shop_section_id: int """The numeric ID of a section in a specific Etsy shop.""" - featured_rank: Optional[int] = None + featured_rank: int """ The positive non-zero numeric position in the featured listings of the shop, with rank 1 listings appearing in the left-most position in featured listing on a shop's home page. """ - url: Optional[str] = None + url: str """The full URL to the listing's page on Etsy.""" - num_favorers: Optional[int] = None + num_favorers: int """The number of users who marked this listing a favorite.""" - non_taxable: Optional[bool] = None + non_taxable: bool """ When true, applicable shop tax rates do not apply to this listing at checkout. """ - is_customizable: Optional[bool] = None + is_customizable: bool """ When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders. """ - is_personalizable: Optional[bool] = None + is_personalizable: bool """When true, this listing is personalizable. The default value is null.""" - personalization_is_required: Optional[bool] = None + personalization_is_required: bool """ When true, this listing requires personalization. The default value is null. """ - personalization_char_count_max: Optional[int] = None + personalization_char_count_max: int """ This an integer value representing the maximum length for the personalization message entered by the buyer. """ - personalization_instructions: Optional[str] = None + personalization_instructions: str """ When true, this listing requires personalization. The default value is null. """ - listing_type: Optional[bool] = None + listing_type: bool """ An enumerated type string that indicates whether the listing is physical or a digital download. """ - tags: Optional[List[str]] = None + tags: List[str] """ A list of tag strings for the listing. Valid tag strings contain only letters, numbers, whitespace characters, -, ', ™, ©, and ®. (regex: /[^\\\\p{L}\\\\p{Nd}\\\\p{Zs}\\\\-'™©®]/u) Default value is null. """ - materials: Optional[List[str]] = None + materials: List[str] """ A list of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\\\\p{L}\\\\p{Nd}\\\\p{Zs}]/u) Default value is null. """ - shipping_profile_id: Optional[int] = None + shipping_profile_id: int """The numeric ID of the shipping profile associated with the listing.""" - processing_min: Optional[int] = None + processing_min: int """ The minimum number of days required to process this listing. Default value is null. """ - processing_max: Optional[int] = None + processing_max: int """ The maximum number of days required to process this listing. Default value is null. """ - who_made: Optional[WhoMade] = None - when_made: Optional[WhenMade] = None - is_supply: Optional[bool] = None + who_made: WhoMade + when_made: WhenMade + is_supply: bool """ When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who_made' and 'when_made'. """ - item_weight: Optional[float] = None + item_weight: float """ The numeric weight of the product measured in units set in item weight unit. Default value is null. If set, the value must be greater than 0. """ - item_weight_unit: Optional[ItemWeightUnit] = None - item_length: Optional[float] = None + item_weight_unit: ItemWeightUnit + item_length: float """ The numeric length of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0. """ - item_width: Optional[float] = None + item_width: float """ The numeric width of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0. """ - item_height: Optional[float] = None + item_height: float """ The numeric length of the product measured in units set in item dimensions unit. Default value is null. If set, the value must be greater than 0. """ - item_dimensions_unit: Optional[ItemDimensionsUnit] = None - is_private: Optional[bool] = None + item_dimensions_unit: ItemDimensionsUnit + is_private: bool """ When true, this is a private listing intendend for a specific buyer and hidden from shop view. """ - recipient: Optional[Recipient] = None - occasion: Optional[Occasion] = None - style: Optional[List[str]] = None + recipient: Recipient + occasion: Occasion + style: List[str] """ An array of style strings for this listing, each of which is free-form text string such as Formal, or Steampunk. A Listing may have up to two styles. @@ -2051,11 +2157,11 @@ class ShopListingWithAssociations: characters. (regex: /[^\\\\p{L}\\\\p{Nd}\\\\p{Zs}]/u) Default value is null. """ - file_data: Optional[str] = None + file_data: str """A string describing the files attached to a digital listing.""" - has_variations: Optional[bool] = None + has_variations: bool """When true, the listing has variations.""" - should_auto_renew: Optional[bool] = None + should_auto_renew: bool """ When true, renews a listing for four months upon expriation. If set to true when previously false, etsy.com renews the listing before it expires, but @@ -2063,25 +2169,25 @@ class ShopListingWithAssociations: expiration date. Any unused time remaining on the listing is lost. Renewals result in charges to a user's bill. """ - language: Optional[str] = None + language: str """ The IETF language tag for the default language of the listing. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`, `ru`. """ - price: Optional[Money] = None - taxonomy_id: Optional[int] = None + price: Money | Mapping[str, Any] + taxonomy_id: int """ The numeric taxonomy ID of the listing. The seller manages listing taxonomy IDs for their shop. See seller taxonomy for more information. """ - user: Optional[User] = None - shop: Optional[Shop] = None - images: Optional[List[ListingImage]] = None + user: User | Mapping[str, Any] + shop: Shop | Mapping[str, Any] + images: List[ListingImage | Mapping[str, Any]] """ Represents a list of listing image resources, each of which contains the reference URLs and metadata for an image """ - production_partners: Optional[List[ShopProductionPartner]] = None + production_partners: List[ShopProductionPartner | Mapping[str, Any]] """Represents a list of production partners for a shop.""" @@ -2091,11 +2197,11 @@ class ShopProductionPartner: Definition: ShopProductionPartner """ - production_partner_id: Optional[int] = None + production_partner_id: int """The numeric ID of a production partner.""" - partner_name: Optional[str] = None + partner_name: str """The name or title of the production partner.""" - location: Optional[str] = None + location: str """A string representing the production partner location.""" @@ -2105,11 +2211,11 @@ class ListingVariationImage: Definition: ListingVariationImage """ - property_id: Optional[int] = None + property_id: int """The numeric ID of the Property.""" - value_id: Optional[int] = None + value_id: int """The numeric ID of the Value.""" - image_id: Optional[int] = None + image_id: int """The numeric ID of the Image.""" @@ -2119,31 +2225,31 @@ class PaymentAccountLedgerEntry: Definition: PaymentAccountLedgerEntry """ - entry_id: Optional[int] = None + entry_id: int """The ledger entry's numeric ID.""" - ledger_id: Optional[int] = None + ledger_id: int """The ledger's numeric ID.""" - sequence_number: Optional[int] = None + sequence_number: int """ The sequence allows ledger entries to be sorted chronologically. The higher the sequence, the more recent the entry. """ - amount: Optional[int] = None + amount: int """The amount of money credited to the ledger.""" - currency: Optional[str] = None + currency: str """The currency of the entry on the ledger.""" - description: Optional[str] = None + description: str """ Details what kind of ledger entry this is: a payment, refund, reversal of a failed refund, disbursement, returned disbursement, recoupment, miscellaneous credit, miscellaneous debit, or bill payment. """ - balance: Optional[int] = None + balance: int """ The amount of money in the shop's ledger the moment after this entry was applied. """ - create_date: Optional[int] = None + create_date: int """The date and time the ledger entry was created in Epoch seconds..""" @@ -2153,53 +2259,58 @@ class Payment: Definition: Payment """ - payment_id: Optional[int] = None + payment_id: int """A unique numeric ID for a payment to a specific Etsy shop.""" - buyer_user_id: Optional[int] = None + buyer_user_id: int """The numeric ID for the user who paid the purchase.""" - shop_id: Optional[int] = None + shop_id: int """The unique positive non-zero numeric ID for an Etsy Shop.""" - receipt_id: Optional[int] = None + receipt_id: int """The numeric ID for the receipt associated to this transaction.""" - amount_gross: Optional[Money] = None - amount_fees: Optional[Money] = None - amount_net: Optional[Money] = None - posted_gross: Optional[Money] = None - posted_fees: Optional[Money] = None - posted_net: Optional[Money] = None - adjusted_gross: Optional[Money] = None - adjusted_fees: Optional[Money] = None - adjusted_net: Optional[Money] = None - currency: Optional[str] = None + amount_gross: Money | Mapping[str, Any] + amount_fees: Money | Mapping[str, Any] + amount_net: Money | Mapping[str, Any] + posted_gross: Optional[Money | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + posted_fees: Optional[Money | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + posted_net: Optional[Money | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + adjusted_gross: Optional[ + Money | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + adjusted_fees: Optional[Money | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + adjusted_net: Optional[Money | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + currency: str """The ISO (alphabetic) code string for the payment's currency.""" - shop_currency: Optional[str] = None + shop_currency: str """ The ISO (alphabetic) code for the shop's currency. The shop displays all prices in this currency by default. """ - buyer_currency: Optional[str] = None + buyer_currency: str """The currency string of the buyer.""" - shipping_user_id: Optional[int] = None + shipping_user_id: int """The numeric ID of the user to which the seller ships the order.""" - shipping_address_id: Optional[int] = None + shipping_address_id: int """The numeric id identifying the shipping address.""" - billing_address_id: Optional[int] = None + billing_address_id: int """The numeric ID identifying the billing address of the buyer.""" - status: Optional[str] = None + status: str """ A string indicating the current status of the payment, most commonly settled or authed. """ - shipped_timestamp: Optional[int] = None + shipped_timestamp: int """The transaction's shipping date and time, in epoch seconds.""" - create_timestamp: Optional[int] = None + create_timestamp: int """The transaction's creation date and time, in epoch seconds.""" - update_timestamp: Optional[int] = None + update_timestamp: int """ The date and time of the last change to the payment adjustment in epoch seconds. """ - payment_adjustments: Optional[List[PaymentAdjustment]] = None + payment_adjustments: List[PaymentAdjustment | Mapping[str, Any]] """ List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified. @@ -2212,35 +2323,35 @@ class PaymentAdjustment: Definition: PaymentAdjustment """ - payment_adjustment_id: Optional[int] = None + payment_adjustment_id: int """The numeric ID for a payment adjustment.""" - payment_id: Optional[int] = None + payment_id: int """A unique numeric ID for a payment to a specific Etsy shop.""" - status: Optional[str] = None + status: str """The status string of the payment adjustment.""" - is_success: Optional[bool] = None + is_success: bool """ When true, the payment adjustment was or is likely to complete successfully. """ - user_id: Optional[int] = None + user_id: int """The numeric ID for the user (seller) fulfilling the purchase.""" - reason_code: Optional[str] = None + reason_code: str """A human-readable string describing the reason for the refund.""" - total_adjustment_amount: Optional[int] = None + total_adjustment_amount: int """The total numeric amount of the refund in the payment currency.""" - shop_total_adjustment_amount: Optional[int] = None + shop_total_adjustment_amount: int """The numeric amount of the refund in the shop currency.""" - buyer_total_adjustment_amount: Optional[int] = None + buyer_total_adjustment_amount: int """The numeric amount of the refund in the buyer currency.""" - total_fee_adjustment_amount: Optional[int] = None + total_fee_adjustment_amount: int """ The numeric amount of card processing fees associated with a payment adjustment. """ - create_timestamp: Optional[int] = None + create_timestamp: int """The transaction's creation date and time, in epoch seconds.""" - update_timestamp: Optional[int] = None + update_timestamp: int """ The date and time of the last change to the payment adjustment in epoch seconds. @@ -2253,19 +2364,19 @@ class ShopReceiptShipment: Definition: ShopReceiptShipment """ - receipt_shipping_id: Optional[int] = None + receipt_shipping_id: int """The unique numeric ID of a Shop Receipt Shipment record.""" - shipment_notification_timestamp: Optional[int] = None + shipment_notification_timestamp: int """ The time at which Etsy notified the buyer of the shipment event, in epoch seconds. """ - carrier_name: Optional[str] = None + carrier_name: str """ The name string for the carrier/company responsible for delivering the shipment. """ - tracking_code: Optional[str] = None + tracking_code: str """ The tracking code string provided by the carrier/company for the shipment. """ @@ -2277,29 +2388,29 @@ class TransactionReview: Definition: TransactionReview """ - shop_id: Optional[int] = None + shop_id: int """The shop's numeric ID.""" - listing_id: Optional[int] = None + listing_id: int """The ID of the shop listing that the TransactionReview belongs to.""" - buyer_user_id: Optional[int] = None + buyer_user_id: int """ The numeric ID of the user who was the buyer in this transaction. Note: This field may be absent, depending on the buyer's privacy settings. """ - rating: Optional[int] = None + rating: int """Rating value on scale from 1 to 5""" - review: Optional[str] = None + review: str """A message left by the author, explaining the feedback.""" - language: Optional[str] = None + language: str """The language of the TransactionReview""" - image_url_fullxfull: Optional[str] = None + image_url_fullxfull: str """ The url to a photo provided with the feedback, dimensions fullxfull. Note: This field may be absent, depending on the buyer's privacy settings. """ - create_timestamp: Optional[int] = None + create_timestamp: int """The date and time the TransactionReview was created in epoch seconds.""" - update_timestamp: Optional[int] = None + update_timestamp: int """The date and time the TransactionReview was updated in epoch seconds.""" @@ -2309,7 +2420,7 @@ class SellerTaxonomyNode: Definition: SellerTaxonomyNode """ - id: Optional[int] = None + id: int """ The unique numeric ID of an Etsy taxonomy node, which is a metadata category for listings organized into the seller taxonomy hierarchy tree. @@ -2321,21 +2432,21 @@ class SellerTaxonomyNode: associated property names and IDs for EU shoe sizes, such as property `value_id`:1394, and `name`:38. """ - level: Optional[int] = None + level: int """ The integer depth of this taxonomy node in the seller taxonomy tree, with roots at level 0. """ - name: Optional[str] = None + name: str """The name string for this taxonomy node.""" - parent_id: Optional[int] = None + parent_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numeric taxonomy ID of the parent of this node.""" - children: Optional[List[SellerTaxonomyNode]] = None + children: List[SellerTaxonomyNode | Mapping[str, Any]] """ An array of taxonomy nodes for all the direct children of this taxonomy node in the seller taxanomy tree. """ - full_path_taxonomy_ids: Optional[List[int]] = None + full_path_taxonomy_ids: List[int] """ An array of taxonomy IDs including this node and all of its direct parents in the seller taxonomy tree up to a root node. They are listed in order @@ -2349,27 +2460,27 @@ class TaxonomyNodeProperty: Definition: TaxonomyNodeProperty """ - property_id: Optional[int] = None + property_id: int """The unique numeric ID of this product property.""" - name: Optional[str] = None + name: str """The name string for this taxonomy node.""" - display_name: Optional[str] = None + display_name: str """The human-readable product property name string.""" - scales: Optional[List[TaxonomyPropertyScale]] = None + scales: List[TaxonomyPropertyScale | Mapping[str, Any]] """A list of available scales.""" - is_required: Optional[bool] = None + is_required: bool """ When true, listings assigned eligible taxonomy IDs require this property. """ - supports_attributes: Optional[bool] = None + supports_attributes: bool """When true, you can use this property in listing attributes.""" - supports_variations: Optional[bool] = None + supports_variations: bool """When true, you can use this property in listing variations.""" - is_multivalued: Optional[bool] = None + is_multivalued: bool """When true, you can assign multiple property values to this property""" - possible_values: Optional[List[TaxonomyPropertyValue]] = None + possible_values: List[TaxonomyPropertyValue | Mapping[str, Any]] """A list of supported property value strings for this property.""" - selected_values: Optional[List[TaxonomyPropertyValue]] = None + selected_values: List[TaxonomyPropertyValue | Mapping[str, Any]] """ A list of property value strings automatically and always selected for the given property. @@ -2382,11 +2493,11 @@ class TaxonomyPropertyScale: Definition: TaxonomyPropertyScale """ - scale_id: Optional[int] = None + scale_id: int """The unique numeric ID of a scale.""" - display_name: Optional[str] = None + display_name: str """The name string for a scale.""" - description: Optional[str] = None + description: str """The description string for a scale.""" @@ -2396,15 +2507,15 @@ class TaxonomyPropertyValue: Definition: TaxonomyPropertyValue """ - value_id: Optional[int] = None + value_id: int """The numeric ID of this property value.""" - name: Optional[str] = None + name: str """The name string of this property value.""" - scale_id: Optional[int] = None + scale_id: int """ The numeric scale ID of the scale to which this property value belongs. """ - equal_to: Optional[List[int]] = None + equal_to: List[int] """ A list of numeric property value IDs this property value is equal to (if any). @@ -2417,13 +2528,13 @@ class ShippingCarrier: Definition: ShippingCarrier """ - shipping_carrier_id: Optional[int] = None + shipping_carrier_id: int """The numeric ID of this shipping carrier.""" - name: Optional[str] = None + name: str """The name of this shipping carrier.""" - domestic_classes: Optional[List[ShippingCarrierMailClass]] = None + domestic_classes: List[ShippingCarrierMailClass | Mapping[str, Any]] """Set of domestic mail classes of this shipping carrier.""" - international_classes: Optional[List[ShippingCarrierMailClass]] = None + international_classes: List[ShippingCarrierMailClass | Mapping[str, Any]] """Set of international mail classes of this shipping carrier.""" @@ -2433,9 +2544,9 @@ class ShippingCarrierMailClass: Definition: ShippingCarrierMailClass """ - mail_class_key: Optional[str] = None + mail_class_key: str """The unique identifier of this mail class.""" - name: Optional[str] = None + name: str """The name of this mail class.""" @@ -2445,9 +2556,9 @@ class ShopProductionPartners: Definition: ShopProductionPartners """ - count: Optional[int] = None + count: int """The number of results.""" - results: Optional[List[ShopProductionPartner]] = None + results: List[ShopProductionPartner | Mapping[str, Any]] """The list of requested resources.""" @@ -2457,8 +2568,8 @@ class ShopShippingProfiles: Definition: ShopShippingProfiles """ - count: Optional[int] = None - results: Optional[List[ShopShippingProfile]] = None + count: int + results: List[ShopShippingProfile | Mapping[str, Any]] Channel = Literal["etsy.com", "wholesale", "pattern", "sell_on_facebook"] @@ -2534,11 +2645,11 @@ class Offering: Definition: Offering """ - price: Optional[float] = None + price: Optional[float] = dataclass_field(default=None, kw_only=True) """The price of the product.""" - quantity: Optional[int] = None + quantity: Optional[int] = dataclass_field(default=None, kw_only=True) """How many of this product are available?""" - is_enabled: Optional[bool] = None + is_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the offering is shown to buyers""" @@ -2551,11 +2662,21 @@ class Product: Definition: Product """ - sku: Optional[str] = None + sku: Optional[str] = dataclass_field(default=None, kw_only=True) """The SKU string for the product""" - property_values: Optional[List[PropertyValue]] = None + property_values: Optional[ + List[PropertyValue | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of property value entries for this product.""" - offerings: Optional[List[Offering]] = None + offerings: Optional[ + List[Offering | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of product offering entries for this product.""" @@ -2568,23 +2689,23 @@ class PropertyValue: Definition: PropertyValue """ - property_id: Optional[int] = None + property_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique ID of an Etsy listing property.""" - value_ids: Optional[List[int]] = None + value_ids: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """ An array of unique IDs of multiple Etsy listing property values. For example, if your listing offers different sizes of a product, then the value ID list contains value IDs for each size. """ - scale_id: Optional[int] = None + scale_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ The numeric ID of a single Etsy.com measurement scale. For example, for shoe size, there are three `scale_id`s available - *UK*, *US/Canada*, and *EU*, where *US/Canada* has `scale_id` 19. """ - property_name: Optional[str] = None + property_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the property, in the requested locale language.""" - values: Optional[List[str]] = None + values: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """A list of property value entries for this product.""" @@ -2633,26 +2754,26 @@ class ApplicationListingsInventoryRequest: Definition: V3ApplicationListingsInventoryRequest """ - products: Optional[List[Product]] = None + products: List[Product | Mapping[str, Any]] """ A JSON array of products available in a listing, even if only one product. All field names in the JSON blobs are lowercase. """ - price_on_property: Optional[List[int]] = None + price_on_property: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """ An array of unique listing property ID integers for the properties that change product prices, if any. For example, if you charge specific prices for different sized products in the same listing, then this array contains the property ID for size. """ - quantity_on_property: Optional[List[int]] = None + quantity_on_property: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """ An array of unique listing property ID integers for the properties that change the quantity of the products, if any. For example, if you stock specific quantities of different colored products in the same listing, then this array contains the property ID for color. """ - sku_on_property: Optional[List[int]] = None + sku_on_property: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """ An array of unique listing property ID integers for the properties that change the product SKU, if any. For example, if you use specific skus for @@ -2667,7 +2788,7 @@ class ApplicationShopsListingsVariationImagesRequest: Definition: V3ApplicationShopsListingsVariationImagesRequest """ - variation_images: Optional[List[VariationImage]] = None + variation_images: List[VariationImage | Mapping[str, Any]] """A list of variation image data.""" @@ -2677,9 +2798,9 @@ class VariationImage: Definition: VariationImage """ - property_id: Optional[int] = None - value_id: Optional[int] = None - image_id: Optional[int] = None + property_id: Optional[int] = dataclass_field(default=None, kw_only=True) + value_id: Optional[int] = dataclass_field(default=None, kw_only=True) + image_id: Optional[int] = dataclass_field(default=None, kw_only=True) WhenMade2 = Literal[ @@ -2745,7 +2866,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -2762,8 +2883,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -2784,7 +2905,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -2799,7 +2920,7 @@ def __init__( def connector_name(self) -> str: return "etsy" - async def ping_async( + async def ping( self, *, timeout: Optional[float] = None, @@ -2811,10 +2932,24 @@ async def ping_async( Ping Check to confirm connectivity to the Etsy API with an application. + + Swagger operation ID: `Ping`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/openapi-ping" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2828,6 +2963,7 @@ async def ping_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2835,14 +2971,14 @@ async def ping_async( return json.loads(response.text) - async def payment_ledger_entries_async( + async def payment_ledger_entries( self, shop_id: int, min_created: int, max_created: int, + *, limit: Optional[int] = None, offset: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2852,6 +2988,28 @@ async def payment_ledger_entries_async( Get a shop payment account ledger's entries Retrieve the entries of a shop's payment account ledger. + + Swagger operation ID: `PaymentLedgerEntries`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + min_created: The earliest unix timestamp for when a record was + created. + max_created: The latest unix timestamp for when a record was + created. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2882,7 +3040,7 @@ async def payment_ledger_entries_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2896,6 +3054,7 @@ async def payment_ledger_entries_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2903,7 +3062,7 @@ async def payment_ledger_entries_async( return json.loads(response.text) - async def payment_get_entry_id_async( + async def payment_get_entry_id( self, shop_id: int, ledger_entry_ids: str, @@ -2917,6 +3076,22 @@ async def payment_get_entry_id_async( Get a payment from a payment account ledger entry ID Get a Payment from a Payment Account Ledger Entry ID, if applicable. + + Swagger operation ID: `PaymentGetEntryID`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + ledger_entry_ids: Array of integers. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2934,7 +3109,7 @@ async def payment_get_entry_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2948,6 +3123,7 @@ async def payment_get_entry_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2955,7 +3131,7 @@ async def payment_get_entry_id_async( return json.loads(response.text) - async def payment_get_receipt_async( + async def payment_get_receipt( self, shop_id: int, receipt_id: str, @@ -2970,6 +3146,23 @@ async def payment_get_receipt_async( Retrieves a payment from a specific receipt, identified by receipt ID, from a specific shop, identified by shop ID. + + Swagger operation ID: `PaymentGetReceipt`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + receipt_id: The numeric ID for the receipt associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2980,7 +3173,7 @@ async def payment_get_receipt_async( f"/payments" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2994,6 +3187,7 @@ async def payment_get_receipt_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3001,7 +3195,7 @@ async def payment_get_receipt_async( return json.loads(response.text) - async def payments_get_async( + async def payments_get( self, shop_id: int, payment_ids: str, @@ -3016,6 +3210,22 @@ async def payments_get_async( Retrieves a list of payments from a shop identified by shop ID. You can also filter results using a list of payment IDs. + + Swagger operation ID: `PaymentsGet`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + payment_ids: A comma-separated array of Payment IDs numbers. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3029,7 +3239,7 @@ async def payments_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3043,6 +3253,7 @@ async def payments_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3050,7 +3261,7 @@ async def payments_get_async( return json.loads(response.text) - async def receipt_get_async( + async def receipt_get( self, shop_id: int, receipt_id: int, @@ -3064,6 +3275,23 @@ async def receipt_get_async( Get a receipt Retrieves a receipt, identified by a receipt ID, from an Etsy shop. + + Swagger operation ID: `ReceiptGet`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + receipt_id: The numeric ID for the receipt associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3073,7 +3301,7 @@ async def receipt_get_async( f"/{quote(str(receipt_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3087,6 +3315,7 @@ async def receipt_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3094,9 +3323,10 @@ async def receipt_get_async( return json.loads(response.text) - async def receipts_get_async( + async def receipts_get( self, shop_id: int, + *, min_created: Optional[int] = None, max_created: Optional[int] = None, min_last_modified: Optional[int] = None, @@ -3105,7 +3335,6 @@ async def receipts_get_async( offset: Optional[int] = None, was_paid: Optional[bool] = None, was_shipped: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3116,6 +3345,36 @@ async def receipts_get_async( Requests the shop receipts from a specific shop, unfiltered or filtered by receipt ID range or offset, date, paid, and/or shipped purchases. + + Swagger operation ID: `ReceiptsGet`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + min_created: The earliest unix timestamp for when a record was + created. + max_created: The latest unix timestamp for when a record was + created. + min_last_modified: The earliest unix timestamp for when a record + last changed. + max_last_modified: The latest unix timestamp for when a record last + changed. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + was_paid: When true, the seller received payment for the product(s) + in this receipt. + was_shipped: When true, the seller shipped the product(s) in this + receipt. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3165,7 +3424,7 @@ async def receipts_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3179,6 +3438,7 @@ async def receipts_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3186,9 +3446,9 @@ async def receipts_get_async( return json.loads(response.text) - async def receipt_create_shipment_async( + async def receipt_create_shipment( self, - input: ReceiptCreateShipmentInput, + input: ReceiptCreateShipmentInput | Mapping[str, Any], shop_id: int, receipt_id: int, *, @@ -3206,6 +3466,24 @@ async def receipt_create_shipment_async( the buyer User. When send BCC is true, Etsy sends shipping notifications to the seller as well. When tracking code and carrier name aren't sent, the receipt is marked as shipped only. + + Swagger operation ID: `ReceiptCreateShipment`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + receipt_id: The receipt to submit tracking for. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3216,7 +3494,7 @@ async def receipt_create_shipment_async( f"/tracking" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3230,6 +3508,7 @@ async def receipt_create_shipment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3237,13 +3516,13 @@ async def receipt_create_shipment_async( return json.loads(response.text) - async def transactions_listing_async( + async def transactions_listing( self, shop_id: int, listing_id: int, + *, limit: Optional[int] = None, offset: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3253,6 +3532,26 @@ async def transactions_listing_async( Retrieve a listing's transactions Retrieves the list of transactions associated with a listing. + + Swagger operation ID: `TransactionsListing`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3276,7 +3575,7 @@ async def transactions_listing_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3290,6 +3589,7 @@ async def transactions_listing_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3297,7 +3597,7 @@ async def transactions_listing_async( return json.loads(response.text) - async def transaction_receipt_async( + async def transaction_receipt( self, shop_id: int, receipt_id: int, @@ -3311,6 +3611,23 @@ async def transaction_receipt_async( Get a receipt's transaction Retrieves the list of transactions associated with a specific receipt. + + Swagger operation ID: `TransactionReceipt`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + receipt_id: The numeric ID for the receipt associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3321,7 +3638,7 @@ async def transaction_receipt_async( f"/transactions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3335,6 +3652,7 @@ async def transaction_receipt_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3342,7 +3660,7 @@ async def transaction_receipt_async( return json.loads(response.text) - async def transaction_get_async( + async def transaction_get( self, shop_id: int, transaction_id: int, @@ -3356,6 +3674,22 @@ async def transaction_get_async( Get a transaction Retrieves a transaction by transaction ID. + + Swagger operation ID: `TransactionGet`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + transaction_id: The unique numeric ID for a transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3365,7 +3699,7 @@ async def transaction_get_async( f"/{quote(str(transaction_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3379,6 +3713,7 @@ async def transaction_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3386,12 +3721,12 @@ async def transaction_get_async( return json.loads(response.text) - async def transaction_get_shop_async( + async def transaction_get_shop( self, shop_id: int, + *, limit: Optional[int] = None, offset: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3401,6 +3736,24 @@ async def transaction_get_shop_async( Get a shop's transaction Retrieves the list of transactions associated with a shop. + + Swagger operation ID: `TransactionGetShop`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3420,7 +3773,7 @@ async def transaction_get_shop_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3434,6 +3787,7 @@ async def transaction_get_shop_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3441,12 +3795,12 @@ async def transaction_get_shop_async( return json.loads(response.text) - async def reviews_get_async( + async def reviews_get( self, shop_id: int, + *, limit: Optional[int] = None, offset: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3456,6 +3810,24 @@ async def reviews_get_async( Get reviews Retrieves the reviews from a shop given its ID. + + Swagger operation ID: `ReviewsGet`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3475,7 +3847,7 @@ async def reviews_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3489,6 +3861,7 @@ async def reviews_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3496,7 +3869,7 @@ async def reviews_get_async( return json.loads(response.text) - async def shipping_carriers_async( + async def shipping_carriers( self, origin_country_iso: str, *, @@ -3510,6 +3883,22 @@ async def shipping_carriers_async( Retrieves a list of available shipping carriers and the mail classes associated with them for a given country. + + Swagger operation ID: `ShippingCarriers`. + + Args: + origin_country_iso: The ISO code of the country from which the + listing ships. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/shipping-carriers" query_params = [] @@ -3520,7 +3909,7 @@ async def shipping_carriers_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3534,6 +3923,7 @@ async def shipping_carriers_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3541,7 +3931,7 @@ async def shipping_carriers_async( return json.loads(response.text) - async def shipping_profiles_async( + async def shipping_profiles( self, shop_id: int, *, @@ -3555,13 +3945,28 @@ async def shipping_profiles_async( Retrieves a list of shipping profiles available in the specific Etsy shop identified by its shop ID. + + Swagger operation ID: `ShippingProfiles`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/shops/{quote(str(shop_id), safe='')}/shipping-profiles" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3575,6 +3980,7 @@ async def shipping_profiles_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3582,9 +3988,9 @@ async def shipping_profiles_async( return json.loads(response.text) - async def shipping_create_profile_async( + async def shipping_create_profile( self, - input: ShippingCreateProfileInput, + input: ShippingCreateProfileInput | Mapping[str, Any], shop_id: int, *, timeout: Optional[float] = None, @@ -3599,13 +4005,30 @@ async def shipping_create_profile_async( region when creating a shipping profile, but not both. Only one is required. You must pass either a shipping carrier ID and mail class, or both min and max delivery days. + + Swagger operation ID: `ShippingCreateProfile`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/shops/{quote(str(shop_id), safe='')}/shipping-profiles" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3619,6 +4042,7 @@ async def shipping_create_profile_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3626,7 +4050,7 @@ async def shipping_create_profile_async( return json.loads(response.text) - async def shipping_get_profile_async( + async def shipping_get_profile( self, shop_id: int, shipping_profile_id: int, @@ -3640,6 +4064,23 @@ async def shipping_get_profile_async( Get a shipping profile Retrieves a shipping profile referenced by shipping profile ID. + + Swagger operation ID: `ShippingGetProfile`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shipping_profile_id: The numeric ID of the shipping profile + associated with the listing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3649,7 +4090,7 @@ async def shipping_get_profile_async( f"/{quote(str(shipping_profile_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3663,9 +4104,10 @@ async def shipping_get_profile_async( request_url, response.status, response.text, + response=response, ) - async def shipping_delete_profile_async( + async def shipping_delete_profile( self, shop_id: int, shipping_profile_id: int, @@ -3679,6 +4121,23 @@ async def shipping_delete_profile_async( Delete a shipping profile Deletes a shipping profile by given ID. + + Swagger operation ID: `ShippingDeleteProfile`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shipping_profile_id: The numeric ID of the shipping profile + associated with the listing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3688,7 +4147,7 @@ async def shipping_delete_profile_async( f"/{quote(str(shipping_profile_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -3702,6 +4161,7 @@ async def shipping_delete_profile_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3709,9 +4169,9 @@ async def shipping_delete_profile_async( return json.loads(response.text) - async def shipping_update_profile_async( + async def shipping_update_profile( self, - input: ShippingUpdateProfileInput, + input: ShippingUpdateProfileInput | Mapping[str, Any], shop_id: int, shipping_profile_id: int, *, @@ -3724,6 +4184,25 @@ async def shipping_update_profile_async( Update a shipping profile Changes the settings in a shipping profile. + + Swagger operation ID: `ShippingUpdateProfile`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shipping_profile_id: The numeric ID of the shipping profile + associated with the listing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3733,7 +4212,7 @@ async def shipping_update_profile_async( f"/{quote(str(shipping_profile_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -3747,6 +4226,7 @@ async def shipping_update_profile_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3754,13 +4234,13 @@ async def shipping_update_profile_async( return json.loads(response.text) - async def shipping_get_destinations_async( + async def shipping_get_destinations( self, shop_id: int, shipping_profile_id: int, + *, limit: Optional[int] = None, offset: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3771,6 +4251,26 @@ async def shipping_get_destinations_async( Retrieves a list of shipping destination objects associated with a shipping profile. + + Swagger operation ID: `ShippingGetDestinations`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shipping_profile_id: The numeric ID of the shipping profile + associated with the listing. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3794,7 +4294,7 @@ async def shipping_get_destinations_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3808,6 +4308,7 @@ async def shipping_get_destinations_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3815,9 +4316,9 @@ async def shipping_get_destinations_async( return json.loads(response.text) - async def shipping_create_destination_async( + async def shipping_create_destination( self, - input: ShippingCreateDestinationInput, + input: ShippingCreateDestinationInput | Mapping[str, Any], shop_id: int, shipping_profile_id: int, *, @@ -3839,6 +4340,25 @@ async def shipping_create_destination_async( default destination is everywhere. You must also either assign both a shipping carrier ID and mail class or both min delivery days and max delivery days. + + Swagger operation ID: `ShippingCreateDestination`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shipping_profile_id: The numeric ID of the shipping profile + associated with the listing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3849,7 +4369,7 @@ async def shipping_create_destination_async( f"/destinations" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3863,6 +4383,7 @@ async def shipping_create_destination_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3870,7 +4391,7 @@ async def shipping_create_destination_async( return json.loads(response.text) - async def shipping_delete_profile_destination_async( + async def shipping_delete_profile_destination( self, shop_id: int, shipping_profile_id: int, @@ -3890,6 +4411,26 @@ async def shipping_delete_profile_destination_async( cannot delete the final shipping destination for any shipping profile. To delete the final shipping destination from a shipping profile, you must delete the entire shipping profile. + + Swagger operation ID: `ShippingDeleteProfileDestination`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shipping_profile_id: The numeric ID of the shipping profile + associated with the listing. + shipping_profile_destination_id: The numeric ID of the shipping + profile destination in the shipping profile associated with the + listing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3901,7 +4442,7 @@ async def shipping_delete_profile_destination_async( f"/{quote(str(shipping_profile_destination_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -3915,11 +4456,12 @@ async def shipping_delete_profile_destination_async( request_url, response.status, response.text, + response=response, ) - async def shipping_update_profile_destination_async( + async def shipping_update_profile_destination( self, - input: ShippingUpdateProfileDestinationInput, + input: ShippingUpdateProfileDestinationInput | Mapping[str, Any], shop_id: int, shipping_profile_id: str, shipping_profile_destination_id: str, @@ -3934,6 +4476,27 @@ async def shipping_update_profile_destination_async( Updates an existing shipping destination, which can set or reassign the shipping cost, carrier, and class for a destination. + + Swagger operation ID: `ShippingUpdateProfileDestination`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shipping_profile_id: The numeric ID of the shipping profile + associated with the listing. + shipping_profile_destination_id: The numeric ID of the shipping + profile destinationassociated with the listing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3945,7 +4508,7 @@ async def shipping_update_profile_destination_async( f"/{quote(str(shipping_profile_destination_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -3959,6 +4522,7 @@ async def shipping_update_profile_destination_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3966,7 +4530,7 @@ async def shipping_update_profile_destination_async( return json.loads(response.text) - async def shipping_get_profile_upgrades_async( + async def shipping_get_profile_upgrades( self, shop_id: int, shipping_profile_id: int, @@ -3981,6 +4545,23 @@ async def shipping_get_profile_upgrades_async( Retrieves the list of shipping profile upgrades assigned to a specific shipping profile. + + Swagger operation ID: `ShippingGetProfileUpgrades`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shipping_profile_id: The numeric ID of the shipping profile + associated with the listing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3991,7 +4572,7 @@ async def shipping_get_profile_upgrades_async( f"/upgrades" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4005,6 +4586,7 @@ async def shipping_get_profile_upgrades_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4012,9 +4594,9 @@ async def shipping_get_profile_upgrades_async( return json.loads(response.text) - async def shipping_create_upgrade_async( + async def shipping_create_upgrade( self, - input: ShippingCreateUpgradeInput, + input: ShippingCreateUpgradeInput | Mapping[str, Any], shop_id: int, shipping_profile_id: int, *, @@ -4028,6 +4610,25 @@ async def shipping_create_upgrade_async( Creates a new shipping profile upgrade, which can establish a price for a shipping option, such as an alternate carrier or faster delivery. + + Swagger operation ID: `ShippingCreateUpgrade`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shipping_profile_id: The numeric ID of the shipping profile + associated with the listing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4038,7 +4639,7 @@ async def shipping_create_upgrade_async( f"/upgrades" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4052,6 +4653,7 @@ async def shipping_create_upgrade_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4059,7 +4661,7 @@ async def shipping_create_upgrade_async( return json.loads(response.text) - async def shipping_delete_profile_upgrade_async( + async def shipping_delete_profile_upgrade( self, shop_id: int, shipping_profile_id: int, @@ -4075,6 +4677,24 @@ async def shipping_delete_profile_upgrade_async( Deletes a shipping profile upgrade and removes the upgrade option from every listing that uses the associated shipping profile. + + Swagger operation ID: `ShippingDeleteProfileUpgrade`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shipping_profile_id: The numeric ID of the shipping profile. + upgrade_id: The numeric ID that is associated with a shipping + upgrade. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4086,7 +4706,7 @@ async def shipping_delete_profile_upgrade_async( f"/{quote(str(upgrade_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -4100,11 +4720,12 @@ async def shipping_delete_profile_upgrade_async( request_url, response.status, response.text, + response=response, ) - async def shipping_update_profile_upgrade_async( + async def shipping_update_profile_upgrade( self, - input: ShippingUpdateProfileUpgradeInput, + input: ShippingUpdateProfileUpgradeInput | Mapping[str, Any], shop_id: int, shipping_profile_id: int, upgrade_id: int, @@ -4119,6 +4740,27 @@ async def shipping_update_profile_upgrade_async( Updates a shipping profile upgrade and updates any listings that use the shipping profile. + + Swagger operation ID: `ShippingUpdateProfileUpgrade`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shipping_profile_id: The numeric ID of the shipping profile + associated with the listing. + upgrade_id: The numeric ID that is associated with a shipping + upgrade. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4130,7 +4772,7 @@ async def shipping_update_profile_upgrade_async( f"/{quote(str(upgrade_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -4144,6 +4786,7 @@ async def shipping_update_profile_upgrade_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4151,9 +4794,9 @@ async def shipping_update_profile_upgrade_async( return json.loads(response.text) - async def shop_update_async( + async def shop_update( self, - input: ShopUpdateInput, + input: ShopUpdateInput | Mapping[str, Any], shop_id: int, *, timeout: Optional[float] = None, @@ -4166,13 +4809,30 @@ async def shop_update_async( Update a shop. Assumes that all string parameters are provided in the shop's primary language. + + Swagger operation ID: `ShopUpdate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/shops/{quote(str(shop_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -4186,6 +4846,7 @@ async def shop_update_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4193,7 +4854,7 @@ async def shop_update_async( return json.loads(response.text) - async def shop_get_by_owner_id_async( + async def shop_get_by_owner_id( self, user_id: str, *, @@ -4206,13 +4867,28 @@ async def shop_get_by_owner_id_async( Get shop by owner ID Retrieves the shop identified by the shop owner's user ID. + + Swagger operation ID: `ShopGetByOwnerID`. + + Args: + user_id: The numeric user ID of the user who owns this shop. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/users/{quote(str(user_id), safe='')}/shops" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4226,6 +4902,7 @@ async def shop_get_by_owner_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4233,12 +4910,12 @@ async def shop_get_by_owner_id_async( return json.loads(response.text) - async def shop_search_async( + async def shop_search( self, shop_name: str, + *, limit: Optional[int] = None, offset: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4248,6 +4925,24 @@ async def shop_search_async( Search shops Returns a list of shops with the matching name. + + Swagger operation ID: `ShopSearch`. + + Args: + shop_name: The shop's name string. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/shops" query_params = [] @@ -4268,7 +4963,7 @@ async def shop_search_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4282,6 +4977,7 @@ async def shop_search_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4289,7 +4985,7 @@ async def shop_search_async( return json.loads(response.text) - async def shop_get_sections_async( + async def shop_get_sections( self, shop_id: int, *, @@ -4303,13 +4999,28 @@ async def shop_get_sections_async( Retrieves the list of shop sections in a specific shop identified by shop ID. + + Swagger operation ID: `ShopGetSections`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/shops/{quote(str(shop_id), safe='')}/sections" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4323,6 +5034,7 @@ async def shop_get_sections_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4330,9 +5042,9 @@ async def shop_get_sections_async( return json.loads(response.text) - async def shop_create_section_async( + async def shop_create_section( self, - input: ShopCreateSectionInput, + input: ShopCreateSectionInput | Mapping[str, Any], shop_id: int, *, timeout: Optional[float] = None, @@ -4344,13 +5056,30 @@ async def shop_create_section_async( Create a shop section Creates a new section in a specific shop. + + Swagger operation ID: `ShopCreateSection`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/shops/{quote(str(shop_id), safe='')}/sections" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4364,6 +5093,7 @@ async def shop_create_section_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4371,7 +5101,7 @@ async def shop_create_section_async( return json.loads(response.text) - async def user_get_async( + async def user_get( self, user_id: int, *, @@ -4384,13 +5114,28 @@ async def user_get_async( Get user Returns user profile for the user identified by a user ID. + + Swagger operation ID: `UserGet`. + + Args: + user_id: The unique positive non-zero numeric ID for an user. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/users/{quote(str(user_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4404,6 +5149,7 @@ async def user_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4411,7 +5157,7 @@ async def user_get_async( return json.loads(response.text) - async def shop_get_section_async( + async def shop_get_section( self, shop_id: int, shop_section_id: int, @@ -4425,6 +5171,23 @@ async def shop_get_section_async( Get shop section Retrieves a shop section, referenced by section ID and shop ID. + + Swagger operation ID: `ShopGetSection`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shop_section_id: The numeric ID of a section in a specific Etsy + shop. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4434,7 +5197,7 @@ async def shop_get_section_async( f"/{quote(str(shop_section_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4448,6 +5211,7 @@ async def shop_get_section_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4455,7 +5219,7 @@ async def shop_get_section_async( return json.loads(response.text) - async def user_get_address_async( + async def user_get_address( self, user_address_id: int, *, @@ -4469,13 +5233,28 @@ async def user_get_address_async( Retrieves the user's address. Development for this endpoint is in progress. It will only return a 501 response. + + Swagger operation ID: `UserGetAddress`. + + Args: + user_address_id: The numeric ID of the user's address. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/user/addresses/{quote(str(user_address_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4489,6 +5268,7 @@ async def user_get_address_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4496,11 +5276,11 @@ async def user_get_address_async( return json.loads(response.text) - async def user_get_addresses_async( + async def user_get_addresses( self, + *, limit: Optional[int] = None, offset: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4510,6 +5290,23 @@ async def user_get_addresses_async( Get user addresses Retrieve a list of user addresses. + + Swagger operation ID: `UserGetAddresses`. + + Args: + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/user/addresses" query_params = [] @@ -4526,7 +5323,7 @@ async def user_get_addresses_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4540,6 +5337,7 @@ async def user_get_addresses_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4547,7 +5345,7 @@ async def user_get_addresses_async( return json.loads(response.text) - async def listing_get_taxonomy_nodes_async( + async def listing_get_taxonomy_nodes( self, *, timeout: Optional[float] = None, @@ -4559,10 +5357,24 @@ async def listing_get_taxonomy_nodes_async( Get seller taxonomy nodes Retrieves the full hierarchy tree of seller taxonomy nodes. + + Swagger operation ID: `ListingGetTaxonomyNodes`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/seller-taxonomy/nodes" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4576,6 +5388,7 @@ async def listing_get_taxonomy_nodes_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4583,7 +5396,7 @@ async def listing_get_taxonomy_nodes_async( return json.loads(response.text) - async def listing_get_properties_by_taxonomy_async( + async def listing_get_properties_by_taxonomy( self, taxonomy_id: str, *, @@ -4597,6 +5410,23 @@ async def listing_get_properties_by_taxonomy_async( Retrieves a list of product properties, with applicable scales and values, supported for a specific seller taxonomy ID. + + Swagger operation ID: `ListingGetPropertiesByTaxonomy`. + + Args: + taxonomy_id: The unique numeric ID of an Etsy taxonomy node, which + is a metadata category for listings organized into the seller + taxonomy hierarchy tree. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4606,7 +5436,7 @@ async def listing_get_properties_by_taxonomy_async( f"/properties" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4620,6 +5450,7 @@ async def listing_get_properties_by_taxonomy_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4627,15 +5458,15 @@ async def listing_get_properties_by_taxonomy_async( return json.loads(response.text) - async def listing_get_shop_async( + async def listing_get_shop( self, shop_id: int, + *, state: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort_on: Optional[str] = None, sort_order: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4646,6 +5477,28 @@ async def listing_get_shop_async( Returns listings that belong to a Shop. Listings can be filtered using the state parameter. + + Swagger operation ID: `ListingGetShop`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + state: An enumerated string from any of: active or inactive. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + sort_on: The value to sort a search result of listings on. + sort_order: The ascending(up) or descending(down) order to sort + listings by. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4680,7 +5533,7 @@ async def listing_get_shop_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4694,6 +5547,7 @@ async def listing_get_shop_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4701,9 +5555,9 @@ async def listing_get_shop_async( return json.loads(response.text) - async def listing_create_async( + async def listing_create( self, - input: ListingCreateInput, + input: ListingCreateInput | Mapping[str, Any], shop_id: int, *, timeout: Optional[float] = None, @@ -4715,13 +5569,30 @@ async def listing_create_async( Create a draft listing Creates a physical draft listing product in a shop on the Etsy channel. + + Swagger operation ID: `ListingCreate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/shops/{quote(str(shop_id), safe='')}/listings" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4735,6 +5606,7 @@ async def listing_create_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4742,11 +5614,11 @@ async def listing_create_async( return json.loads(response.text) - async def listing_get_async( + async def listing_get( self, listing_id: int, - includes: Optional[str] = None, *, + includes: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4756,6 +5628,24 @@ async def listing_get_async( Get a listing Retrieves a listing record by listing ID. + + Swagger operation ID: `ListingGet`. + + Args: + listing_id: The numeric ID for the listing associated to this + transaction. + includes: An enumerated string that attaches a valid association. + Acceptable inputs are 'shop', 'images' and 'user'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4770,7 +5660,7 @@ async def listing_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4784,9 +5674,10 @@ async def listing_get_async( request_url, response.status, response.text, + response=response, ) - async def listing_delete_async( + async def listing_delete( self, listing_id: int, *, @@ -4802,13 +5693,29 @@ async def listing_delete_async( the state is one of the following: SOLD_OUT, DRAFT, EXPIRED, INACTIVE, ACTIVE and is_available or ACTIVE and has seller flags: SUPRESSED (frozen), VACATION, CUSTOM_SHOPS (pattern), SELL_ON_FACEBOOK + + Swagger operation ID: `ListingDelete`. + + Args: + listing_id: The numeric ID for the listing associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/listings/{quote(str(listing_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -4822,10 +5729,12 @@ async def listing_delete_async( request_url, response.status, response.text, + response=response, ) - async def listing_get_active_async( + async def listing_get_active( self, + *, limit: Optional[int] = None, offset: Optional[int] = None, keywords: Optional[str] = None, @@ -4835,7 +5744,6 @@ async def listing_get_active_async( max_price: Optional[float] = None, taxonomy_id: Optional[int] = None, shop_location: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4846,6 +5754,38 @@ async def listing_get_active_async( A list of all active listings on Etsy paginated by their creation date. Without sort order listings will be returned newest-first by default. + + Swagger operation ID: `ListingGetActive`. + + Args: + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + keywords: Search term or phrase that must appear in all results. + sort_on: The value to sort a search result of listings on. NOTE: + sort on only works when combined with one of the search options + (keywords, region, etc.). + sort_order: The ascending(up) or descending(down) order to sort + listings by. NOTE: sort_order only works when combined with one + of the search options (keywords, region, etc.). + min_price: The minimum price of listings to be returned by a search + result. + max_price: The maximum price of listings to be returned by a search + result. + taxonomy_id: The numeric taxonomy ID of the listing. The seller + manages listing taxonomy IDs for their shop. + shop_location: Filters by shop location. If location cannot be + parsed, Etsy responds with an error. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/listings/active" query_params = [] @@ -4897,7 +5837,7 @@ async def listing_get_active_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4911,6 +5851,7 @@ async def listing_get_active_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4918,13 +5859,13 @@ async def listing_get_active_async( return json.loads(response.text) - async def listing_get_active_by_shop_async( + async def listing_get_active_by_shop( self, shop_id: int, + *, limit: Optional[int] = None, offset: Optional[int] = None, keywords: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4935,6 +5876,25 @@ async def listing_get_active_by_shop_async( Retrieves a list of all active listings on Etsy in a specific shop, paginated by listing creation date. + + Swagger operation ID: `ListingGetActiveByShop`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + keywords: Search term or phrase that must appear in all results. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4959,7 +5919,7 @@ async def listing_get_active_by_shop_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4973,6 +5933,7 @@ async def listing_get_active_by_shop_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4980,11 +5941,11 @@ async def listing_get_active_by_shop_async( return json.loads(response.text) - async def listing_get_by_id_async( + async def listing_get_by_id( self, listing_ids: str, - includes: Optional[str] = None, *, + includes: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4995,6 +5956,23 @@ async def listing_get_by_id_async( Allows to query multiple listing IDs at once. Limit 100 IDs maximum per query. + + Swagger operation ID: `ListingGetByID`. + + Args: + listing_ids: The array of numeric IDs for the listings in a + specific Etsy shop. + includes: An enumerated string that attaches a valid association. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/listings/batch" query_params = [] @@ -5010,7 +5988,7 @@ async def listing_get_by_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5024,6 +6002,7 @@ async def listing_get_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5031,12 +6010,12 @@ async def listing_get_by_id_async( return json.loads(response.text) - async def listing_get_featured_async( + async def listing_get_featured( self, shop_id: int, + *, limit: Optional[int] = None, offset: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5046,6 +6025,24 @@ async def listing_get_featured_async( Get featured listings by shop Retrieves listings associated to a shop that are featured. + + Swagger operation ID: `ListingGetFeatured`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5065,7 +6062,7 @@ async def listing_get_featured_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5079,6 +6076,7 @@ async def listing_get_featured_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5086,7 +6084,7 @@ async def listing_get_featured_async( return json.loads(response.text) - async def listing_delete_property_async( + async def listing_delete_property( self, shop_id: int, listing_id: int, @@ -5101,6 +6099,24 @@ async def listing_delete_property_async( Delete a listing property Deletes a property from a listing. + + Swagger operation ID: `ListingDeleteProperty`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + property_id: The unique ID of an Etsy listing property. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5112,7 +6128,7 @@ async def listing_delete_property_async( f"/{quote(str(property_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5126,11 +6142,12 @@ async def listing_delete_property_async( request_url, response.status, response.text, + response=response, ) - async def listing_update_property_async( + async def listing_update_property( self, - input: ListingUpdatePropertyInput, + input: ListingUpdatePropertyInput | Mapping[str, Any], shop_id: int, listing_id: int, property_id: int, @@ -5147,6 +6164,26 @@ async def listing_update_property_async( a listing. Each offering requires both a value and a value ID that are valid for a scale ID assigned to the listing or that you assign to the listing with this request. + + Swagger operation ID: `ListingUpdateProperty`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + property_id: The unique ID of an Etsy listing property. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5158,7 +6195,7 @@ async def listing_update_property_async( f"/{quote(str(property_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5172,6 +6209,7 @@ async def listing_update_property_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5179,7 +6217,7 @@ async def listing_update_property_async( return json.loads(response.text) - async def listing_get_property_async( + async def listing_get_property( self, listing_id: int, property_id: int, @@ -5194,6 +6232,23 @@ async def listing_get_property_async( Retrieves a listing's property. Development for this endpoint is in progress. It will only return a 501 response. + + Swagger operation ID: `ListingGetProperty`. + + Args: + listing_id: The numeric ID for the listing associated to this + transaction. + property_id: The unique ID of an Etsy listing property. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5203,7 +6258,7 @@ async def listing_get_property_async( f"/{quote(str(property_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5217,6 +6272,7 @@ async def listing_get_property_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5224,7 +6280,7 @@ async def listing_get_property_async( return json.loads(response.text) - async def listing_get_properties_async( + async def listing_get_properties( self, shop_id: int, listing_id: int, @@ -5238,6 +6294,23 @@ async def listing_get_properties_async( Get a listing's properties Returns a list of a listing's properties. + + Swagger operation ID: `ListingGetProperties`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5248,7 +6321,7 @@ async def listing_get_properties_async( f"/properties" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5262,6 +6335,7 @@ async def listing_get_properties_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5269,9 +6343,9 @@ async def listing_get_properties_async( return json.loads(response.text) - async def listing_update_async( + async def listing_update( self, - input: ListingUpdateInput, + input: ListingUpdateInput | Mapping[str, Any], shop_id: int, listing_id: int, *, @@ -5285,6 +6359,25 @@ async def listing_update_async( Updates a listing, identified by a listing ID, for a specific shop identified by a shop ID. + + Swagger operation ID: `ListingUpdate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5294,7 +6387,7 @@ async def listing_update_async( f"/{quote(str(listing_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5308,6 +6401,7 @@ async def listing_update_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5315,13 +6409,13 @@ async def listing_update_async( return json.loads(response.text) - async def listing_get_by_receipt_async( + async def listing_get_by_receipt( self, shop_id: int, receipt_id: int, + *, limit: Optional[int] = None, offset: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5331,6 +6425,27 @@ async def listing_get_by_receipt_async( Get listings by shop receipt Gets all listings associated with a receipt. + + Swagger operation ID: `ListingGetByReceipt`. + + Args: + shop_id: The numeric ID for the receipt associated to this + transaction. + receipt_id: The unique positive non-zero numeric ID for an Etsy + Shop. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5354,7 +6469,7 @@ async def listing_get_by_receipt_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5368,6 +6483,7 @@ async def listing_get_by_receipt_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5375,15 +6491,15 @@ async def listing_get_by_receipt_async( return json.loads(response.text) - async def listing_get_by_section_id_async( + async def listing_get_by_section_id( self, shop_id: int, shop_section_ids: str, + *, limit: Optional[int] = None, offset: Optional[int] = None, sort_on: Optional[str] = None, sort_order: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5393,6 +6509,29 @@ async def listing_get_by_section_id_async( Get listings by shop section ID Retrieves all the listings from the section of a specific shop. + + Swagger operation ID: `ListingGetBySectionID`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + shop_section_ids: A array of numeric IDs for all sections in a + specific Etsy shop. + limit: The maximum number of results to return. + offset: The number of records to skip before selecting the first + result. + sort_on: The value to sort a search result of listings on. + sort_order: The ascending(up) or descending(down) order to sort + listings by. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5426,7 +6565,7 @@ async def listing_get_by_section_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5440,6 +6579,7 @@ async def listing_get_by_section_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5447,7 +6587,7 @@ async def listing_get_by_section_id_async( return json.loads(response.text) - async def listing_get_file_async( + async def listing_get_file( self, shop_id: int, listing_id: int, @@ -5463,6 +6603,25 @@ async def listing_get_file_async( Retrieves a single file associated with the given digital listing. Requesting a file from a physical listing returns an empty result. + + Swagger operation ID: `ListingGetFile`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + listing_file_id: The unique numeric ID of a file associated with a + digital listing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5474,7 +6633,7 @@ async def listing_get_file_async( f"/{quote(str(listing_file_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5488,6 +6647,7 @@ async def listing_get_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5495,7 +6655,7 @@ async def listing_get_file_async( return json.loads(response.text) - async def listing_delete_file_async( + async def listing_delete_file( self, shop_id: int, listing_id: int, @@ -5513,6 +6673,25 @@ async def listing_delete_file_async( converts into a physical listing. The response to a delete request returns a list of the remaining file records associated with the given listing. + + Swagger operation ID: `ListingDeleteFile`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + listing_file_id: The unique numeric ID of a file associated with a + digital listing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5524,7 +6703,7 @@ async def listing_delete_file_async( f"/{quote(str(listing_file_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5538,9 +6717,10 @@ async def listing_delete_file_async( request_url, response.status, response.text, + response=response, ) - async def listing_get_files_async( + async def listing_get_files( self, shop_id: int, listing_id: int, @@ -5555,6 +6735,24 @@ async def listing_get_files_async( Retrieves all the files associated with the given digital listing. Requesting files from a physical listing returns an empty result. + + Swagger operation ID: `ListingGetFiles`. + + Args: + shop_id: The numeric ID for the listing associated to this + transaction. + listing_id: The unique positive non-zero numeric ID for an Etsy + Shop. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5565,7 +6763,7 @@ async def listing_get_files_async( f"/files" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5579,6 +6777,7 @@ async def listing_get_files_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5586,9 +6785,9 @@ async def listing_get_files_async( return json.loads(response.text) - async def listing_upload_async( + async def listing_upload( self, - input: ListingUploadInput, + input: ListingUploadInput | Mapping[str, Any], shop_id: int, listing_id: int, *, @@ -5606,6 +6805,25 @@ async def listing_upload_async( upload. Associating an existing file to a physical listing converts the physical listing into a digital listing, which removes all shipping costs and any product and inventory variations. + + Swagger operation ID: `ListingUpload`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5616,7 +6834,7 @@ async def listing_upload_async( f"/files" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5630,6 +6848,7 @@ async def listing_upload_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5637,7 +6856,7 @@ async def listing_upload_async( return json.loads(response.text) - async def listing_get_image_async( + async def listing_get_image( self, shop_id: int, listing_id: int, @@ -5653,6 +6872,25 @@ async def listing_get_image_async( Retrieves the references and metadata for a listing image with a specific image ID. + + Swagger operation ID: `ListingGetImage`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + listing_image_id: The numeric ID of the primary listing image for + this transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5664,7 +6902,7 @@ async def listing_get_image_async( f"/{quote(str(listing_image_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5678,6 +6916,7 @@ async def listing_get_image_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5685,7 +6924,7 @@ async def listing_get_image_async( return json.loads(response.text) - async def listing_delete_image_async( + async def listing_delete_image( self, shop_id: int, listing_id: int, @@ -5702,6 +6941,25 @@ async def listing_delete_image_async( Deletes a listing image. A copy of the file remains on our servers, and so a deleted image may be re-associated with the listing without re-uploading the original image. + + Swagger operation ID: `ListingDeleteImage`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + listing_image_id: The numeric ID of the primary listing image for + this transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5713,7 +6971,7 @@ async def listing_delete_image_async( f"/{quote(str(listing_image_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5727,9 +6985,10 @@ async def listing_delete_image_async( request_url, response.status, response.text, + response=response, ) - async def listing_get_images_async( + async def listing_get_images( self, shop_id: int, listing_id: int, @@ -5744,6 +7003,23 @@ async def listing_get_images_async( Retrieves all listing image resources for a listing with a specific listing ID. + + Swagger operation ID: `ListingGetImages`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5754,7 +7030,7 @@ async def listing_get_images_async( f"/images" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5768,6 +7044,7 @@ async def listing_get_images_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5775,9 +7052,9 @@ async def listing_get_images_async( return json.loads(response.text) - async def listing_upload_image_async( + async def listing_upload_image( self, - input: ListingUploadImageInput, + input: ListingUploadImageInput | Mapping[str, Any], shop_id: int, listing_id: int, *, @@ -5796,6 +7073,25 @@ async def listing_upload_image_async( parameter. When a request contains both image and listing image ID parameter values, the endpoint uploads the image in the image parameter only. + + Swagger operation ID: `ListingUploadImage`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5806,7 +7102,7 @@ async def listing_upload_image_async( f"/images" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5820,6 +7116,7 @@ async def listing_upload_image_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5827,11 +7124,11 @@ async def listing_upload_image_async( return json.loads(response.text) - async def listing_get_inventory_async( + async def listing_get_inventory( self, listing_id: int, - includes: Optional[str] = None, *, + includes: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5844,6 +7141,23 @@ async def listing_get_inventory_async( using the Etsy.com inventory tools have no inventory records. This endpoint returns SKU data if you are the owner of the inventory records being fetched. + + Swagger operation ID: `ListingGetInventory`. + + Args: + listing_id: The numeric ID for the listing associated to this + transaction. + includes: An enumerated string that attaches an valid association. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5858,7 +7172,7 @@ async def listing_get_inventory_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5872,6 +7186,7 @@ async def listing_get_inventory_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5879,9 +7194,9 @@ async def listing_get_inventory_async( return json.loads(response.text) - async def listing_update_inventory_async( + async def listing_update_inventory( self, - input: ListingUpdateInventoryInput, + input: ListingUpdateInventoryInput | Mapping[str, Any], listing_id: str, *, timeout: Optional[float] = None, @@ -5897,13 +7212,31 @@ async def listing_update_inventory_async( and/or price are incompatible with values in on property fields. When setting a price, assign a float equal to amount divided by divisor as specified in the money resource. + + Swagger operation ID: `ListingUpdateInventory`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + listing_id: The numeric ID for the listing associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/listings/{quote(str(listing_id), safe='')}/inventory" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5917,6 +7250,7 @@ async def listing_update_inventory_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5924,7 +7258,7 @@ async def listing_update_inventory_async( return json.loads(response.text) - async def listing_get_offering_async( + async def listing_get_offering( self, listing_id: int, product_id: int, @@ -5939,6 +7273,26 @@ async def listing_get_offering_async( Get a listing's offering Get an offering for a listing. + + Swagger operation ID: `ListingGetOffering`. + + Args: + listing_id: The numeric ID for the listing associated to this + transaction. + product_id: The numeric ID for the product associated to this + transaction. + product_offering_id: The numeric ID for the product offering + associated to this transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5950,7 +7304,7 @@ async def listing_get_offering_async( f"/{quote(str(product_offering_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5964,6 +7318,7 @@ async def listing_get_offering_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5971,7 +7326,7 @@ async def listing_get_offering_async( return json.loads(response.text) - async def listing_get_product_async( + async def listing_get_product( self, listing_id: int, product_id: int, @@ -5985,6 +7340,23 @@ async def listing_get_product_async( Get a listing's product Retrieve a listing product by ID. + + Swagger operation ID: `ListingGetProduct`. + + Args: + listing_id: The listing to return a listing product for. + product_id: The numeric ID for a specific product purchased from a + listing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5995,7 +7367,7 @@ async def listing_get_product_async( f"/{quote(str(product_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6009,6 +7381,7 @@ async def listing_get_product_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6016,7 +7389,7 @@ async def listing_get_product_async( return json.loads(response.text) - async def listing_get_translation_async( + async def listing_get_translation( self, shop_id: int, listing_id: int, @@ -6031,6 +7404,25 @@ async def listing_get_translation_async( Get a listing's translation Returns the translation for a listing in the given language. + + Swagger operation ID: `ListingGetTranslation`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + language: The IETF language tag for the language of this + translation. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6042,7 +7434,7 @@ async def listing_get_translation_async( f"/{quote(str(language), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6056,6 +7448,7 @@ async def listing_get_translation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6063,9 +7456,9 @@ async def listing_get_translation_async( return json.loads(response.text) - async def listing_create_translation_async( + async def listing_create_translation( self, - input: ListingCreateTranslationInput, + input: ListingCreateTranslationInput | Mapping[str, Any], shop_id: int, listing_id: int, language: str, @@ -6079,6 +7472,27 @@ async def listing_create_translation_async( Create a listing translation Creates a listing translation by listing ID and language. + + Swagger operation ID: `ListingCreateTranslation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + language: The IETF language tag for the language of this + translation. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6090,7 +7504,7 @@ async def listing_create_translation_async( f"/{quote(str(language), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6104,6 +7518,7 @@ async def listing_create_translation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6111,9 +7526,9 @@ async def listing_create_translation_async( return json.loads(response.text) - async def listing_update_translation_async( + async def listing_update_translation( self, - input: ListingUpdateTranslationInput, + input: ListingUpdateTranslationInput | Mapping[str, Any], shop_id: int, listing_id: int, language: str, @@ -6127,6 +7542,27 @@ async def listing_update_translation_async( Update a listing translation Updates a listing translation by listing ID and language. + + Swagger operation ID: `ListingUpdateTranslation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + language: The IETF language tag for the language of this + translation. Ex: de, en, es, fr, it, ja, nl, pl, pt, ru. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6138,7 +7574,7 @@ async def listing_update_translation_async( f"/{quote(str(language), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -6152,6 +7588,7 @@ async def listing_update_translation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6159,7 +7596,7 @@ async def listing_update_translation_async( return json.loads(response.text) - async def listing_get_variation_async( + async def listing_get_variation( self, shop_id: int, listing_id: int, @@ -6173,6 +7610,23 @@ async def listing_get_variation_async( Get listing's variation images Gets all variation images on a listing. + + Swagger operation ID: `ListingGetVariation`. + + Args: + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6183,7 +7637,7 @@ async def listing_get_variation_async( f"/variation-images" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6197,6 +7651,7 @@ async def listing_get_variation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6204,9 +7659,9 @@ async def listing_get_variation_async( return json.loads(response.text) - async def listing_update_variation_async( + async def listing_update_variation( self, - input: ListingUpdateVariationInput, + input: ListingUpdateVariationInput | Mapping[str, Any], shop_id: int, listing_id: int, *, @@ -6219,6 +7674,25 @@ async def listing_update_variation_async( Update a listing's variation images Creates variation images on a listing. + + Swagger operation ID: `ListingUpdateVariation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + shop_id: The unique positive non-zero numeric ID for an Etsy Shop. + listing_id: The numeric ID for the listing associated to this + transaction. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6229,7 +7703,7 @@ async def listing_update_variation_async( f"/variation-images" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6243,6 +7717,7 @@ async def listing_update_variation_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/eventbrite.py b/src/azure/connectors/eventbrite.py index 8708f543..687efc0f 100644 --- a/src/azure/connectors/eventbrite.py +++ b/src/azure/connectors/eventbrite.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,23 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "EventbriteClient", + "CreateEventResponse", + "GetCategoriesResponse", + "GetEventsForOrganizationResponse", + "GetEventsForOrganizerResponse", + "GetMyEventsResponse", + "GetMyVenuesResponse", + "GetOrdersResponse", + "GetOrganizationsResponse", + "GetOrganizersResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,27 +45,27 @@ class CreateEventResponse: Response for Create event """ - name: Optional[Dict[str, Any]] = None - description: Optional[Dict[str, Any]] = None - id: Optional[str] = None + name: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + description: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the event.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The URL of the event.""" - start: Optional[Dict[str, Any]] = None - end: Optional[Dict[str, Any]] = None - created: Optional[str] = None + start: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + end: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + created: Optional[str] = dataclass_field(default=None, kw_only=True) """The date-time the event was created at.""" - changed: Optional[str] = None + changed: Optional[str] = dataclass_field(default=None, kw_only=True) """The date-time the event was changed at.""" - capacity: Optional[int] = None + capacity: Optional[int] = dataclass_field(default=None, kw_only=True) """The capacity of the event.""" - online_event: Optional[bool] = None + online_event: Optional[bool] = dataclass_field(default=None, kw_only=True) """A boolean indicating whether or not the event is online.""" - organizer_id: Optional[str] = None + organizer_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the organizer of the event.""" - venue_id: Optional[str] = None + venue_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the venue of the event.""" - category_id: Optional[str] = None + category_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the category of the event.""" @@ -68,7 +84,7 @@ class GetOrganizersResponse: Response for Get organizers """ - organizers: Optional[List[Dict[str, Any]]] = None + organizers: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -77,7 +93,7 @@ class GetMyVenuesResponse: Response for Get venues """ - venues: Optional[List[Dict[str, Any]]] = None + venues: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -86,7 +102,7 @@ class GetCategoriesResponse: Response for Get categories """ - categories: Optional[List[Dict[str, Any]]] = None + categories: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -95,7 +111,7 @@ class GetMyEventsResponse: Response for Get organization events """ - events: Optional[List[Dict[str, Any]]] = None + events: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) GetEventsForOrganizerResponse = List[Dict[str, Any]] @@ -112,7 +128,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -129,8 +145,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -151,7 +167,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -166,7 +182,84 @@ def __init__( def connector_name(self) -> str: return "eventbrite" - async def create_event_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def create_event( self, organization_id: str, event_name_html: str, @@ -176,6 +269,7 @@ async def create_event_async( event_start_timezone: str, event_end_timezone: str, event_currency: str, + *, event_organizer_id: Optional[str] = None, event_venue_id: Optional[str] = None, event_category_id: Optional[str] = None, @@ -188,7 +282,6 @@ async def create_event_async( event_hide_start_date: Optional[bool] = None, event_hide_end_date: Optional[bool] = None, event_show_remaining: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -198,6 +291,43 @@ async def create_event_async( Create event Create a new Eventbrite event. + + Swagger operation ID: `CreateEventV2`. + + Args: + organization_id: Select the organization. + event_name_html: The name of the event. + event_description_html: The description on the event page. + event_start_utc: Start time (UTC format Ex. 2020-01-12T12:00:00Z). + event_end_utc: End time (UTC format Ex. 2020-01-13T15:00:00Z). + event_start_timezone: Timezone of the event. + event_end_timezone: Timezone of the event. + event_currency: Currency for this Event's transactions. + event_organizer_id: The organizer of the event. + event_venue_id: A previously-created venue to associate with this + event. + event_category_id: The category of the event. + event_password: Password needed to see the event in unlisted mode. + event_capacity: Set specific capacity (if omitted, sums ticket + capacities). + event_shareable: If users can share the event on social media. + event_invite_only: Only invited users can see the event page. + event_online_event: Whether the event is online-only (no venue). + event_listed: If the event is publicly listed and searchable. + event_hide_start_date: Whether the start date should be hidden. + event_hide_end_date: Whether the end date should be hidden. + event_show_remaining: If the remaining number of tickets is + publicly visible on the event page. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -295,7 +425,7 @@ async def create_event_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -309,6 +439,7 @@ async def create_event_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -316,13 +447,14 @@ async def create_event_async( return json.loads(response.text) - async def update_event_async( + async def update_event( self, id: str, organization_id: str, event_start_timezone: str, event_end_timezone: str, event_currency: str, + *, event_name_html: Optional[str] = None, event_description_html: Optional[str] = None, event_start_utc: Optional[str] = None, @@ -339,7 +471,6 @@ async def update_event_async( event_hide_start_date: Optional[bool] = None, event_hide_end_date: Optional[bool] = None, event_show_remaining: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -349,6 +480,45 @@ async def update_event_async( Update event Update an existing event. + + Swagger operation ID: `UpdateEventV2`. + + Args: + id: Event to update. + organization_id: Select the organization. + event_start_timezone: Timezone of the event. + event_end_timezone: Timezone of the event. + event_currency: Currency for this Event's transactions. + event_name_html: The name of the event. + event_description_html: The description on the event page. + event_start_utc: Start time (UTC format Ex. 2017-01-12T13:45:30Z). + event_end_utc: End time (UTC format Ex. 2017-01-12T16:45:30Z). + event_organizer_id: The organizer of the event. + event_venue_id: A previously-created venue to associate with this + event. + event_category_id: The category of the event. + event_password: Password needed to see the event in unlisted mode. + event_capacity: Set specific capacity (if omitted, sums ticket + capacities). + event_shareable: Set specific capacity (if omitted, sums ticket + capacities). + event_invite_only: Only invited users can see the event page. + event_online_event: Whether the event is online-only (no venue). + event_listed: If the event is publicly listed and searchable. + event_hide_start_date: Whether the start date should be hidden. + event_hide_end_date: Whether the start date should be hidden. + event_show_remaining: If the remaining number of tickets is + publicly visible on the event page. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -454,7 +624,7 @@ async def update_event_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -468,6 +638,7 @@ async def update_event_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -475,45 +646,83 @@ async def update_event_async( return json.loads(response.text) - async def get_organizations_async( + def list_organizations( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ GetOrganizations Get a list of organizations for your account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetOrganizations`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v3/users/me/organizations/" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_organizers_async( + return AsyncItemPaged(get_next, extract_data) + + def list_organizers( self, organization_id: str, *, @@ -521,11 +730,29 @@ async def get_organizers_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get organizers Get a list of organizers for organization. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetOrganizersV2`. + + Args: + organization_id: Select the organization. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -534,29 +761,50 @@ async def get_organizers_async( f"/{quote(str(organization_id), safe='')}" f"/organizers" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("organizers", []): + yield item + + return None, items() - async def get_my_venues_async( + return AsyncItemPaged(get_next, extract_data) + + def list_my_venues( self, organization_id: str, *, @@ -564,75 +812,152 @@ async def get_my_venues_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get venues Get venues for organization. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMyVenuesV2`. + + Args: + organization_id: Select the organization. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v3/organizations/{quote(str(organization_id), safe='')}/venues/" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("venues", []): + yield item - async def get_categories_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_categories( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get categories Get the Eventbrite event categories. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetCategories`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v3/categories/" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("categories", []): + yield item - async def get_organization_events_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_organization_events( self, organization_id: str, order_by: str, @@ -642,11 +967,31 @@ async def get_organization_events_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get organization events Get organization events. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetOrganizationEvents`. + + Args: + organization_id: Select the organization. + order_by: Order of the returned events. + status: Status of the returned events. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -663,27 +1008,48 @@ async def get_organization_events_async( query_params.append(f"status={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("events", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/eventhubs.py b/src/azure/connectors/eventhubs.py index efa27f86..3c8e6167 100644 --- a/src/azure/connectors/eventhubs.py +++ b/src/azure/connectors/eventhubs.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,19 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "EventhubsClient", + "Event", + "ObjectEntity", + "SendEvent", + "SendEventsInput", + "SystemProperties", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,22 +41,25 @@ class Event: Response for When events are available in Event Hub """ - content_data: Optional[ObjectEntity] = field( + content_data: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentData"}, ) - properties: Optional[Dict[str, ObjectEntity]] = field( + properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Key-value pairs for each application property""" - system_properties: Optional[SystemProperties] = field( + system_properties: Optional[SystemProperties | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SystemProperties"}, ) -SendEventsInput = List["SendEvent"] +SendEventsInput = List["SendEvent | Mapping[str, Any]"] @dataclass @@ -53,7 +68,7 @@ class ObjectEntity: Response for Generate event schema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -66,23 +81,27 @@ class SystemProperties: Definition: SystemProperties """ - enqueued_time_utc: Optional[str] = field( + enqueued_time_utc: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnqueuedTimeUtc"}, ) """Enqueued time""" - offset: Optional[str] = field( + offset: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Offset"}, ) """Offset in a partition""" - partition_key: Optional[str] = field( + partition_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PartitionKey"}, ) """Partition Key""" - sequence_number: Optional[int] = field( + sequence_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SequenceNumber"}, ) """Sequence number""" @@ -94,13 +113,15 @@ class SendEvent: Definition: SendEvent """ - content_data: Optional[str] = field( + content_data: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentData"}, ) """Content of the event""" - properties: Optional[Dict[str, ObjectEntity]] = field( + properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Key-value pairs for each application property""" @@ -117,7 +138,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -134,8 +155,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -156,7 +177,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -171,12 +192,89 @@ def __init__( def connector_name(self) -> str: return "eventhubs" - async def send_event_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def send_event( self, - input: SendEvent, + input: SendEvent | Mapping[str, Any], event_hub_name: str, - partition_key: Optional[str] = None, *, + partition_key: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -186,6 +284,24 @@ async def send_event_async( Send event Send event. + + Swagger operation ID: `SendEvent`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + event_hub_name: Name of the Event Hub. + partition_key: Partition key. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -200,7 +316,7 @@ async def send_event_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -214,9 +330,10 @@ async def send_event_async( request_url, response.status, response.text, + response=response, ) - async def send_events_async( + async def send_events( self, input: SendEventsInput, event_hub_name: str, @@ -231,6 +348,23 @@ async def send_events_async( Send one or more events to the Event Hub partition Send one or more events to the Event Hub partition. + + Swagger operation ID: `SendEvents`. + + Args: + input: The request body. + event_hub_name: Name of the Event Hub. + partition_key: Partition key. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -244,7 +378,7 @@ async def send_events_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -258,81 +392,158 @@ async def send_events_async( request_url, response.status, response.text, + response=response, ) - async def get_event_hubs_async( + def list_event_hubs( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get all Event Hubs in a namespace Get all Event Hubs in a namespace. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetEventHubs`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/eventhubs" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page: + yield item + + return None, items() - async def get_content_types_async( + return AsyncItemPaged(get_next, extract_data) + + def list_content_types( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get all content types Get all content types. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetContentTypes`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/contenttypes" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page: + yield item + + return None, items() - async def get_consumer_groups_async( + return AsyncItemPaged(get_next, extract_data) + + def list_consumer_groups( self, event_hub_name: str, *, @@ -340,11 +551,29 @@ async def get_consumer_groups_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get all the consumer groups for an event hub Get all the consumer groups for an event hub. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetConsumerGroups`. + + Args: + event_hub_name: The Event Hub name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/consumergroups" query_params = [] @@ -354,29 +583,50 @@ async def get_consumer_groups_async( query_params.append(f"eventHubName={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page: + yield item + + return None, items() - async def get_partition_keys_async( + return AsyncItemPaged(get_next, extract_data) + + def list_partition_keys( self, event_hub_name: str, *, @@ -384,11 +634,29 @@ async def get_partition_keys_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get all partition keys in an Event Hub Get all partition keys in an Event Hub. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetPartitionKeys`. + + Args: + event_hub_name: The Event Hub name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/partitions" query_params = [] @@ -398,33 +666,54 @@ async def get_partition_keys_async( query_params.append(f"eventHubName={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page: + yield item - async def generate_event_schema_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def generate_event_schema( self, content_type: str, - content_schema: Optional[str] = None, *, + content_schema: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -434,6 +723,22 @@ async def generate_event_schema_async( Generate event schema Generate event schema V2. + + Swagger operation ID: `GenerateEventSchemaV2`. + + Args: + content_type: Content type. + content_schema: content schema of the event. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/eventschemaV2" query_params = [] @@ -449,7 +754,7 @@ async def generate_event_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -463,6 +768,7 @@ async def generate_event_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/excelonline.py b/src/azure/connectors/excelonline.py index efcd3f69..93e735a5 100644 --- a/src/azure/connectors/excelonline.py +++ b/src/azure/connectors/excelonline.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,33 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "ExcelonlineClient", + "BlobDataSetsMetadata", + "BlobMetadata", + "CreateWorksheetInput", + "DataSetsMetadata", + "GetAllWorksheetsResponse", + "GetColumnsResponse", + "GetTablesResponse", + "Item", + "ItemsList", + "ObjectEntity", + "Table", + "TableCapabilitiesMetadata", + "TableFilterRestrictionsMetadata", + "TableMetadata", + "TableSelectRestrictionsMetadata", + "TableSortRestrictionsMetadata", + "TableToCreate", + "TablesList", + "TabularDataSetsMetadata", + "WorksheetMetadata", +] + # Type Definitions @@ -29,26 +55,30 @@ class TableMetadata: Response for Create table """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Table name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Table title""" - x_ms_permission: Optional[str] = field( + x_ms_permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-permission"}, ) """Table permission""" - x_ms_capabilities: Optional[TableCapabilitiesMetadata] = field( + x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-capabilities"}, ) - schema: Optional[ObjectEntity] = None - referenced_entities: Optional[ObjectEntity] = field( + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referencedEntities"}, ) - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """Url link""" @@ -60,10 +90,16 @@ class ItemsList: Response for List rows present in a table """ - value: Optional[List[Item]] = None + value: Optional[ + List[Item | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -75,8 +111,9 @@ class Item: Response for Get a row """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -87,7 +124,12 @@ class GetAllWorksheetsResponse: Response for Get worksheets """ - value: Optional[List[WorksheetMetadata]] = None + value: Optional[ + List[WorksheetMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -96,7 +138,7 @@ class CreateWorksheetInput: Create worksheet """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Worksheet name.""" @@ -106,13 +148,13 @@ class WorksheetMetadata: Response for Create worksheet """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Worksheet Id.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Worksheet name.""" - position: Optional[int] = None + position: Optional[int] = dataclass_field(default=None, kw_only=True) """Worksheet position.""" - visibility: Optional[str] = None + visibility: Optional[str] = dataclass_field(default=None, kw_only=True) """Worksheet visibility.""" @@ -122,7 +164,7 @@ class GetTablesResponse: Response for Get tables """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -131,7 +173,7 @@ class GetColumnsResponse: Response for Get table columns """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -140,8 +182,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -150,25 +202,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -180,15 +236,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -200,15 +258,17 @@ class TableToCreate: Definition: TableToCreate """ - table_name: Optional[str] = field( + table_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableName"}, ) """Enter the Excel table name.""" - range: Optional[str] = field(default=None, metadata={"wire_name": "Range"}) + range: str = dataclass_field(metadata={"wire_name": "Range"}) """Enter the table address using A1 notation.""" - columns_names: Optional[str] = field( + columns_names: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ColumnsNames"}, ) """Enter the columns names separated by ';' or ','.""" @@ -220,30 +280,42 @@ class TableCapabilitiesMetadata: Definition: TableCapabilitiesMetadata """ - sort_restrictions: Optional[TableSortRestrictionsMetadata] = field( + sort_restrictions: Optional[ + TableSortRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortRestrictions"}, ) - filter_restrictions: Optional[TableFilterRestrictionsMetadata] = field( + filter_restrictions: Optional[ + TableFilterRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterRestrictions"}, ) - select_restrictions: Optional[TableSelectRestrictionsMetadata] = field( + select_restrictions: Optional[ + TableSelectRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectRestrictions"}, ) - is_only_server_pagable: Optional[bool] = field( + is_only_server_pagable: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOnlyServerPagable"}, ) """Server paging restrictions""" - filter_function_support: Optional[List[str]] = field( + filter_function_support: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterFunctionSupport"}, ) """List of supported filter capabilities""" - server_paging_options: Optional[List[str]] = field( + server_paging_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serverPagingOptions"}, ) """List of supported server-driven paging capabilities""" @@ -255,7 +327,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -268,15 +340,17 @@ class TableSortRestrictionsMetadata: Definition: TableSortRestrictionsMetadata """ - sortable: Optional[bool] = None + sortable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has sortable columns""" - unsortable_properties: Optional[List[str]] = field( + unsortable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unsortableProperties"}, ) """List of unsortable properties""" - ascending_only_properties: Optional[List[str]] = field( + ascending_only_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ascendingOnlyProperties"}, ) """List of properties which support ascending order only""" @@ -288,15 +362,17 @@ class TableFilterRestrictionsMetadata: Definition: TableFilterRestrictionsMetadata """ - filterable: Optional[bool] = None + filterable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has filterable columns""" - non_filterable_properties: Optional[List[str]] = field( + non_filterable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nonFilterableProperties"}, ) """List of non filterable properties""" - required_properties: Optional[List[str]] = field( + required_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredProperties"}, ) """List of required properties""" @@ -308,7 +384,7 @@ class TableSelectRestrictionsMetadata: Definition: TableSelectRestrictionsMetadata """ - selectable: Optional[bool] = None + selectable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has selectable columns""" @@ -318,7 +394,12 @@ class TablesList: Definition: TablesList """ - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Tables""" @@ -328,15 +409,21 @@ class Table: Definition: Table """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the table. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the table.""" - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """Additional table properties provided by the connector to the clients.""" @@ -348,24 +435,39 @@ class BlobMetadata: Definition: BlobMetadata """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ @@ -385,7 +487,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -402,8 +504,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -424,7 +526,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -440,15 +542,49 @@ def connector_name(self) -> str: return "excelonline" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -465,7 +601,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -478,9 +618,9 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def create_table_async( + async def create_table( self, - input: TableToCreate, + input: TableToCreate | Mapping[str, Any], drive: str, file: str, *, @@ -493,6 +633,24 @@ async def create_table_async( Create table Create a new table in the Excel workbook. + + Swagger operation ID: `CreateTable`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -507,7 +665,7 @@ async def create_table_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -521,6 +679,7 @@ async def create_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -528,13 +687,13 @@ async def create_table_async( return json.loads(response.text) - async def create_id_column_async( + async def create_id_column( self, drive: str, file: str, table: str, - id_column: Optional[str] = None, *, + id_column: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -545,6 +704,24 @@ async def create_id_column_async( Add a key column to an Excel table. The new column will be appended to the right. The new key column must be unique in the table. + + Swagger operation ID: `CreateIdColumn`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + id_column: Provide the key column name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -567,7 +744,7 @@ async def create_id_column_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -581,32 +758,59 @@ async def create_id_column_async( request_url, response.status, response.text, + response=response, ) - async def get_items_async( + def list_items( self, drive: str, file: str, table: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, date_time_format: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List rows present in a table List rows present in a table. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + filter: An ODATA filter query to restrict the entries returned. + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + select: Comma-separated list of columns to retrieve (first 500 by + default). + date_time_format: DateTime Format. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -652,11 +856,18 @@ async def get_items_async( query_params.append(f"dateTimeFormat={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -669,31 +880,40 @@ async def get_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_item_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_item( self, drive: str, file: str, table: str, id: str, id_column: str, - date_time_format: Optional[str] = None, *, + date_time_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -704,6 +924,26 @@ async def get_item_async( Get a row using a key column. This action will retrieve all the values of the specified row given a column and key column. + + Swagger operation ID: `GetItem`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + id: Enter the key value. + id_column: Select a column from the drop-down. + date_time_format: DateTime Format. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -730,7 +970,7 @@ async def get_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -744,6 +984,7 @@ async def get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -751,7 +992,7 @@ async def get_item_async( return json.loads(response.text) - async def delete_item_async( + async def delete_item( self, drive: str, file: str, @@ -768,6 +1009,25 @@ async def delete_item_async( Delete a row Delete a row using a key column. + + Swagger operation ID: `DeleteItem`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + id: Enter the key value. + id_column: Select a column from the drop-down. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -789,7 +1049,7 @@ async def delete_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -803,18 +1063,19 @@ async def delete_item_async( request_url, response.status, response.text, + response=response, ) - async def patch_item_async( + async def patch_item( self, - input: Item, + input: Item | Mapping[str, Any], drive: str, file: str, table: str, id: str, id_column: str, - date_time_format: Optional[str] = None, *, + date_time_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -827,6 +1088,28 @@ async def patch_item_async( specified cells and columns left blank will not be updated. In order to append (instead of overwrite) a value, use the \"Get a row\" action to retrieve the content first. + + Swagger operation ID: `PatchItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + id: Enter the key value. + id_column: Select a column from the drop-down. + date_time_format: DateTime Format. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -853,7 +1136,7 @@ async def patch_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -867,6 +1150,7 @@ async def patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -874,7 +1158,7 @@ async def patch_item_async( return json.loads(response.text) - async def get_all_worksheets_async( + def list_all_worksheets( self, drive: str, file: str, @@ -883,11 +1167,30 @@ async def get_all_worksheets_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get worksheets Get a list of worksheets in the Excel workbook. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllWorksheets`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -904,31 +1207,52 @@ async def get_all_worksheets_async( query_params.append("source=" + quote("me", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def create_worksheet_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_worksheet( self, - input: CreateWorksheetInput, + input: CreateWorksheetInput | Mapping[str, Any], drive: str, file: str, *, @@ -941,6 +1265,24 @@ async def create_worksheet_async( Create worksheet Create a new worksheet in the Excel workbook. + + Swagger operation ID: `CreateWorksheet`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -958,7 +1300,7 @@ async def create_worksheet_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -972,6 +1314,7 @@ async def create_worksheet_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -979,7 +1322,7 @@ async def create_worksheet_async( return json.loads(response.text) - async def get_tables_async( + def list_tables( self, drive: str, file: str, @@ -988,11 +1331,30 @@ async def get_tables_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get tables Get a list of tables in the Excel workbook. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTables`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1009,36 +1371,57 @@ async def get_tables_async( query_params.append("source=" + quote("me", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def add_row_async( + return AsyncItemPaged(get_next, extract_data) + + async def add_row( self, - input: Item, + input: Item | Mapping[str, Any], drive: str, file: str, table: str, - date_time_format: Optional[str] = None, *, + date_time_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1048,6 +1431,26 @@ async def add_row_async( Add a row into a table Add a new row into the Excel table. + + Swagger operation ID: `AddRowV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + date_time_format: DateTime Format. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1072,7 +1475,7 @@ async def add_row_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1086,6 +1489,7 @@ async def add_row_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1093,7 +1497,7 @@ async def add_row_async( return json.loads(response.text) - async def get_columns_async( + def list_columns( self, drive: str, file: str, @@ -1103,11 +1507,31 @@ async def get_columns_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get table columns Get table columns. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetColumns`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1126,24 +1550,45 @@ async def get_columns_async( query_params.append("source=" + quote("me", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/excelonlinebusiness.py b/src/azure/connectors/excelonlinebusiness.py index 9c2c186f..627043ef 100644 --- a/src/azure/connectors/excelonlinebusiness.py +++ b/src/azure/connectors/excelonlinebusiness.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,50 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "ExcelonlinebusinessClient", + "BlobDataSetsMetadata", + "BlobMetadata", + "Comment", + "CommentDetails", + "CommentsList", + "CreateFileMetadata", + "CreateWorksheetInput", + "DataSetsMetadata", + "GetAllWorksheetsResponse", + "GetColumnsResponse", + "GetDrivesResponse", + "GetItemResponse", + "GetSingleScriptResponse", + "GetSourcesResponse", + "GetTablesResponse", + "Item", + "ItemsList", + "ObjectEntity", + "RawAndFormattedTableSchema", + "RunScriptProdInput", + "RunScriptProdResponse", + "ScriptParameters", + "ScriptReturnValues", + "SensitivityLabelMetadata", + "Table", + "TableCapabilitiesMetadata", + "TableFilterRestrictionsMetadata", + "TableMetadata", + "TableSelectRestrictionsMetadata", + "TableSortRestrictionsMetadata", + "TableToCreate", + "TablesList", + "TabularDataSetsMetadata", + "TabularItem", + "TabularItemsList", + "WorkbookRange", + "WorksheetMetadata", +] + # Type Definitions @@ -29,26 +72,30 @@ class TableMetadata: Response for Create table """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Table name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Table title""" - x_ms_permission: Optional[str] = field( + x_ms_permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-permission"}, ) """Table permission""" - x_ms_capabilities: Optional[TableCapabilitiesMetadata] = field( + x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-capabilities"}, ) - schema: Optional[ObjectEntity] = None - referenced_entities: Optional[ObjectEntity] = field( + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referencedEntities"}, ) - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """Url link""" @@ -60,14 +107,23 @@ class ItemsList: Response for List rows present in a table """ - value: Optional[List[Item]] = None + value: Optional[ + List[Item | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items""" - sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field( + sensitivity_label_info: Optional[ + List[SensitivityLabelMetadata | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelInfo"}, ) - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -79,7 +135,12 @@ class CommentsList: Response for List all comments present in a workbook """ - value: Optional[List[Comment]] = None + value: Optional[ + List[Comment | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Comments""" @@ -89,12 +150,13 @@ class Comment: Response for Get a comment present in a workbook """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique identifier for the comment.""" - content: Optional[str] = None + content: Optional[str] = dataclass_field(default=None, kw_only=True) """The content of the comment.""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """The content type of the comment.""" @@ -106,12 +168,16 @@ class GetItemResponse: Response for Get a row """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) - sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field( + sensitivity_label_info: Optional[ + List[SensitivityLabelMetadata | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelInfo"}, ) @@ -122,8 +188,9 @@ class Item: Response for Update a row """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -134,9 +201,17 @@ class GetAllWorksheetsResponse: Response for Get worksheets """ - value: Optional[List[WorksheetMetadata]] = None - sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field( + value: Optional[ + List[WorksheetMetadata | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, + ) + sensitivity_label_info: Optional[ + List[SensitivityLabelMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelInfo"}, ) @@ -147,7 +222,7 @@ class CreateWorksheetInput: Create worksheet """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Worksheet name.""" @@ -157,13 +232,13 @@ class WorksheetMetadata: Response for Create worksheet """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Worksheet Id.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Worksheet name.""" - position: Optional[int] = None + position: Optional[int] = dataclass_field(default=None, kw_only=True) """Worksheet position.""" - visibility: Optional[str] = None + visibility: Optional[str] = dataclass_field(default=None, kw_only=True) """Worksheet visibility.""" @@ -173,9 +248,12 @@ class GetTablesResponse: Response for Get tables """ - value: Optional[List[Dict[str, Any]]] = None - sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field( + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + sensitivity_label_info: Optional[ + List[SensitivityLabelMetadata | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelInfo"}, ) @@ -186,7 +264,7 @@ class RunScriptProdInput: Run script from SharePoint library """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -199,7 +277,7 @@ class RunScriptProdResponse: Response for Run script from SharePoint library """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -212,7 +290,7 @@ class GetSourcesResponse: Response for Get sources """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -221,7 +299,7 @@ class GetDrivesResponse: Response for Get drives """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -230,7 +308,7 @@ class GetColumnsResponse: Response for Get table columns """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -239,8 +317,9 @@ class GetSingleScriptResponse: Response for Gets one script """ - parameter_info: Optional[Dict[str, Any]] = field( + parameter_info: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parameterInfo"}, ) @@ -251,13 +330,15 @@ class CreateFileMetadata: Definition: CreateFileMetadata """ - file_name: Optional[str] = field( + file_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileName"}, ) """Name of the newly created file""" - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebUrl"}, ) """URL to open the file in the browser on your OneDrive""" @@ -269,8 +350,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -279,25 +370,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -309,15 +404,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -329,7 +426,12 @@ class TablesList: Definition: TablesList """ - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Tables""" @@ -339,15 +441,21 @@ class Table: Definition: Table """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the table. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the table.""" - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """Additional table properties provided by the connector to the clients.""" @@ -359,15 +467,17 @@ class TableToCreate: Definition: TableToCreate """ - table_name: Optional[str] = field( + table_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableName"}, ) """Enter the Excel table name.""" - range: Optional[str] = field(default=None, metadata={"wire_name": "Range"}) + range: str = dataclass_field(metadata={"wire_name": "Range"}) """Enter the table address using A1 notation.""" - columns_names: Optional[str] = field( + columns_names: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ColumnsNames"}, ) """Enter the columns names separated by ';' or ','.""" @@ -379,30 +489,42 @@ class TableCapabilitiesMetadata: Definition: TableCapabilitiesMetadata """ - sort_restrictions: Optional[TableSortRestrictionsMetadata] = field( + sort_restrictions: Optional[ + TableSortRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortRestrictions"}, ) - filter_restrictions: Optional[TableFilterRestrictionsMetadata] = field( + filter_restrictions: Optional[ + TableFilterRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterRestrictions"}, ) - select_restrictions: Optional[TableSelectRestrictionsMetadata] = field( + select_restrictions: Optional[ + TableSelectRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectRestrictions"}, ) - is_only_server_pagable: Optional[bool] = field( + is_only_server_pagable: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOnlyServerPagable"}, ) """Server paging restrictions""" - filter_function_support: Optional[List[str]] = field( + filter_function_support: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterFunctionSupport"}, ) """List of supported filter capabilities""" - server_paging_options: Optional[List[str]] = field( + server_paging_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serverPagingOptions"}, ) """List of supported server-driven paging capabilities""" @@ -414,7 +536,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -427,15 +549,17 @@ class TableSortRestrictionsMetadata: Definition: TableSortRestrictionsMetadata """ - sortable: Optional[bool] = None + sortable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has sortable columns""" - unsortable_properties: Optional[List[str]] = field( + unsortable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unsortableProperties"}, ) """List of unsortable properties""" - ascending_only_properties: Optional[List[str]] = field( + ascending_only_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ascendingOnlyProperties"}, ) """List of properties which support ascending order only""" @@ -447,15 +571,17 @@ class TableFilterRestrictionsMetadata: Definition: TableFilterRestrictionsMetadata """ - filterable: Optional[bool] = None + filterable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has filterable columns""" - non_filterable_properties: Optional[List[str]] = field( + non_filterable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nonFilterableProperties"}, ) """List of non filterable properties""" - required_properties: Optional[List[str]] = field( + required_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredProperties"}, ) """List of required properties""" @@ -467,7 +593,7 @@ class TableSelectRestrictionsMetadata: Definition: TableSelectRestrictionsMetadata """ - selectable: Optional[bool] = None + selectable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has selectable columns""" @@ -477,10 +603,11 @@ class CommentDetails: Definition: CommentDetails """ - content: Optional[str] = None + content: Optional[str] = dataclass_field(default=None, kw_only=True) """The content of the comment.""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """The content type of the comment.""" @@ -492,7 +619,12 @@ class TabularItemsList: Definition: TabularItemsList """ - value: Optional[List[TabularItem]] = None + value: Optional[ + List[TabularItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items""" @@ -502,8 +634,9 @@ class TabularItem: Definition: TabularItem """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -514,7 +647,7 @@ class ScriptParameters: Definition: ScriptParameters """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -527,7 +660,7 @@ class ScriptReturnValues: Definition: ScriptReturnValues """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -540,8 +673,9 @@ class RawAndFormattedTableSchema: Definition: RawAndFormattedTableSchema """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -552,24 +686,39 @@ class BlobMetadata: Definition: BlobMetadata """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ @@ -584,41 +733,47 @@ class SensitivityLabelMetadata: Definition: SensitivityLabelMetadata """ - sensitivity_label_id: Optional[str] = field( + sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelId"}, ) """SensitivityLabel Id.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel name.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """SensitivityLabel displayName info""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel details on tooltip.""" - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """SensitivityLabel priority.""" - color: Optional[str] = None + color: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel color.""" - is_encrypted: Optional[bool] = field( + is_encrypted: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEncrypted"}, ) """ is SensitivityLabel Encrypted.""" - is_enabled: Optional[bool] = field( + is_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEnabled"}, ) """Whether SensitivityLabel is Enabled.""" - is_parent: Optional[bool] = field( + is_parent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isParent"}, ) """Whether SensitivityLabel is Parent.""" - parent_sensitivity_label_id: Optional[str] = field( + parent_sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentSensitivityLabelId"}, ) """Parent SensitivityLabel Id.""" @@ -630,44 +785,52 @@ class WorkbookRange: Definition: WorkbookRange """ - address: Optional[str] = None + address: Optional[str] = dataclass_field(default=None, kw_only=True) """Range address including the sheet name, e.g. Sheet1!A1:D10.""" - address_local: Optional[str] = field( + address_local: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "addressLocal"}, ) - cell_count: Optional[int] = field( + cell_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "cellCount"}, ) - column_count: Optional[int] = field( + column_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnCount"}, ) - row_count: Optional[int] = field( + row_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "rowCount"}, ) - column_index: Optional[int] = field( + column_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnIndex"}, ) - row_index: Optional[int] = field( + row_index: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "rowIndex"}, ) - values: Optional[List[List[Any]]] = None + values: Optional[List[List[Any]]] = dataclass_field(default=None, kw_only=True) """2-D array of cell values.""" - text: Optional[List[List[str]]] = None + text: Optional[List[List[str]]] = dataclass_field(default=None, kw_only=True) """2-D array of display text.""" - formulas: Optional[List[List[str]]] = None + formulas: Optional[List[List[str]]] = dataclass_field(default=None, kw_only=True) """2-D array of formulas.""" - number_format: Optional[List[List[str]]] = field( + number_format: Optional[List[List[str]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "numberFormat"}, ) - value_types: Optional[List[List[str]]] = field( + value_types: Optional[List[List[str]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "valueTypes"}, ) """2-D array of value type names (e.g. String, Double, Empty).""" @@ -684,7 +847,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -701,8 +864,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -723,7 +886,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -739,15 +902,49 @@ def connector_name(self) -> str: return "excelonlinebusiness" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -764,7 +961,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -777,9 +978,9 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def create_table_async( + async def create_table( self, - input: TableToCreate, + input: TableToCreate | Mapping[str, Any], drive: str, file: str, source: str, @@ -793,6 +994,28 @@ async def create_table_async( Create table Create a new table in the Excel workbook. + + Swagger operation ID: `CreateTable`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (the colons are required). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -810,7 +1033,7 @@ async def create_table_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -824,6 +1047,7 @@ async def create_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -831,14 +1055,14 @@ async def create_table_async( return json.loads(response.text) - async def create_id_column_async( + async def create_id_column( self, drive: str, file: str, table: str, source: str, - id_column: Optional[str] = None, *, + id_column: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -849,6 +1073,28 @@ async def create_id_column_async( Add a key column to an Excel table. The new column will be appended to the right. + + Swagger operation ID: `CreateIdColumn`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (the colons are required). + id_column: Provide the key column name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -874,7 +1120,7 @@ async def create_id_column_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -888,14 +1134,16 @@ async def create_id_column_async( request_url, response.status, response.text, + response=response, ) - async def get_items_async( + def list_items( self, drive: str, file: str, table: str, source: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, @@ -904,19 +1152,52 @@ async def get_items_async( date_time_format: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List rows present in a table List rows present in a table. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (the colons are required). + filter: An ODATA filter query to restrict the entries returned. + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + select: Comma-separated list of columns to retrieve (first 500 by + default). + date_time_format: DateTime Format. + extract_sensitivity_label: A boolean whether to extract sensitivity + label Id for associated artefact. + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -975,11 +1256,18 @@ async def get_items_async( query_params.append(f"fetchSensitivityLabelMetadata={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -992,37 +1280,69 @@ async def get_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_comments_async( + def list_comments( self, drive: str, file: str, - source: Optional[str] = None, *, + source: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all comments present in a workbook List all comments present in a workbook. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetComments`. + + Args: + drive: Ask user to select a document library from the drop-down. + file: Ask user to select an Excel file through File Browse. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (the colons are required). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1041,35 +1361,56 @@ async def get_comments_async( query_params.append(f"source={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_comment_async( + async def get_comment( self, drive: str, file: str, commentid: str, - source: Optional[str] = None, *, + source: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1079,6 +1420,27 @@ async def get_comment_async( Get a comment present in a workbook Get a comment present in a workbook. + + Swagger operation ID: `GetComment`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + commentid: Provide a comment Id . + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (the colons are required). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1099,7 +1461,7 @@ async def get_comment_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1113,6 +1475,7 @@ async def get_comment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1120,14 +1483,14 @@ async def get_comment_async( return json.loads(response.text) - async def reply_comment_async( + async def reply_comment( self, - input: CommentDetails, + input: CommentDetails | Mapping[str, Any], drive: str, file: str, commentid: str, - source: Optional[str] = None, *, + source: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1137,6 +1500,29 @@ async def reply_comment_async( Reply to a comment present in a workbook Reply to a comment present in a workbook. + + Swagger operation ID: `ReplyComment`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + drive: Ask user to select a document library from the drop-down. + file: Ask user to select an Excel file through File Browse. + commentid: Provide a comment Id . + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (the colons are required). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1158,7 +1544,7 @@ async def reply_comment_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1172,6 +1558,7 @@ async def reply_comment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1179,7 +1566,7 @@ async def reply_comment_async( return json.loads(response.text) - async def get_item_async( + async def get_item( self, drive: str, file: str, @@ -1187,10 +1574,10 @@ async def get_item_async( id: str, source: str, id_column: str, + *, date_time_format: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1200,6 +1587,34 @@ async def get_item_async( Get a row Get a row using a key column. + + Swagger operation ID: `GetItem`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + id: Enter the key value. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (the colons are required). + id_column: Select a column from the drop-down. + date_time_format: DateTime Format. + extract_sensitivity_label: A boolean whether to extract sensitivity + label Id for associated artefact. + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1239,7 +1654,7 @@ async def get_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1253,6 +1668,7 @@ async def get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1260,7 +1676,7 @@ async def get_item_async( return json.loads(response.text) - async def delete_item_async( + async def delete_item( self, drive: str, file: str, @@ -1278,6 +1694,29 @@ async def delete_item_async( Delete a row Delete a row using a key column. + + Swagger operation ID: `DeleteItem`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + id: Enter the key value. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (the colons are required). + id_column: Select a column from the drop-down. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1302,7 +1741,7 @@ async def delete_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1316,19 +1755,20 @@ async def delete_item_async( request_url, response.status, response.text, + response=response, ) - async def patch_item_async( + async def patch_item( self, - input: Item, + input: Item | Mapping[str, Any], drive: str, file: str, table: str, id: str, source: str, id_column: str, - date_time_format: Optional[str] = None, *, + date_time_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1341,6 +1781,32 @@ async def patch_item_async( specified cells and columns left blank will not be updated. In order to append (instead of overwrite) a value, use the \"Get a row\" action to retrieve the content first. + + Swagger operation ID: `PatchItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + id: Enter the key value. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (the colons are required). + id_column: Select a column from the drop-down. + date_time_format: DateTime Format. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1370,7 +1836,7 @@ async def patch_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1384,6 +1850,7 @@ async def patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1391,23 +1858,50 @@ async def patch_item_async( return json.loads(response.text) - async def get_all_worksheets_async( + def list_all_worksheets( self, drive: str, file: str, source: str, + *, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get worksheets Get a list of worksheets in the Excel workbook. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllWorksheets`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (colons are required). + extract_sensitivity_label: A boolean whether to extract sensitivity + label Id for associated artefact. + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1437,31 +1931,52 @@ async def get_all_worksheets_async( query_params.append(f"fetchSensitivityLabelMetadata={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def create_worksheet_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_worksheet( self, - input: CreateWorksheetInput, + input: CreateWorksheetInput | Mapping[str, Any], drive: str, file: str, source: str, @@ -1475,6 +1990,28 @@ async def create_worksheet_async( Create worksheet Create a new worksheet in the Excel workbook. + + Swagger operation ID: `CreateWorksheet`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (colons are required). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1495,7 +2032,7 @@ async def create_worksheet_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1509,6 +2046,7 @@ async def create_worksheet_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1516,23 +2054,50 @@ async def create_worksheet_async( return json.loads(response.text) - async def get_tables_async( + def list_tables( self, drive: str, file: str, source: str, + *, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get tables Get a list of tables in the Excel workbook. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTables`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (colons are required). + extract_sensitivity_label: A boolean whether to extract sensitivity + label Id for associated artefact. + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1562,37 +2127,58 @@ async def get_tables_async( query_params.append(f"fetchSensitivityLabelMetadata={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def add_row_async( + async def add_row( self, - input: Item, + input: Item | Mapping[str, Any], drive: str, file: str, table: str, source: str, - date_time_format: Optional[str] = None, *, + date_time_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1602,6 +2188,30 @@ async def add_row_async( Add a row into a table Add a new row into the Excel table. + + Swagger operation ID: `AddRowV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (colons are required). + date_time_format: DateTime Format. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1629,7 +2239,7 @@ async def add_row_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1643,6 +2253,7 @@ async def add_row_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1650,9 +2261,9 @@ async def add_row_async( return json.loads(response.text) - async def run_script_prod_async( + async def run_script_prod( self, - input: RunScriptProdInput, + input: RunScriptProdInput | Mapping[str, Any], drive: str, file: str, script_drive: str, @@ -1670,6 +2281,37 @@ async def run_script_prod_async( Runs an Office Script against an Excel workbook. Use this action when the script is saved outside of the default location. + + Swagger operation ID: `RunScriptProdV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + drive: Select a document library from the drop-down. + file: Select an Excel workbook through File Browse. + script_drive: Select the SharePoint library of your Office Script + file (.osts) from the drop-down. + script_id: Select an Office Script file (.osts) in a SharePoint + library from the drop-down. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (colons are required). + script_source: Select from the drop-down or specify one of the + following: - \"me\" - \"SharePoint Site URL\" - + \"users/someone's UPN\" - \"groups/group Id\" - + \"sites/SharePoint Site URL:/teams/team name:\" (the colons are + required). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1695,7 +2337,7 @@ async def run_script_prod_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1709,6 +2351,7 @@ async def run_script_prod_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1716,19 +2359,37 @@ async def run_script_prod_async( return json.loads(response.text) - async def get_sources_async( + def list_sources( self, - top: Optional[str] = None, *, + top: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get sources Get a list of sources. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetSources`. + + Args: + top: Top. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/codeless/v1.0/sources" query_params = [] @@ -1739,29 +2400,50 @@ async def get_sources_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_drives_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_drives( self, source: str, *, @@ -1769,11 +2451,32 @@ async def get_drives_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get drives Get a list of drives. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDrives`. + + Args: + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (colons are required). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/codeless/v1.0/drives" query_params = [] @@ -1783,29 +2486,50 @@ async def get_drives_async( query_params.append(f"source={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_columns_async( + def list_columns( self, drive: str, file: str, @@ -1816,11 +2540,35 @@ async def get_columns_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get table columns Get table columns. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetColumns`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (colons are required). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1842,29 +2590,50 @@ async def get_columns_async( query_params.append(f"source={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - async def get_table_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_table( self, drive: str, file: str, @@ -1880,6 +2649,27 @@ async def get_table_async( Get metadata of a table Get metadata of a table. + + Swagger operation ID: `GetTable`. + + Args: + drive: Select a document library from the drop-down. + file: Select an Excel file through File Browse. + table: Select a table from the drop-down. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (colons are required). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1902,7 +2692,7 @@ async def get_table_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1916,6 +2706,7 @@ async def get_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1923,7 +2714,7 @@ async def get_table_async( return json.loads(response.text) - async def get_single_script_async( + async def get_single_script( self, script_source: str, script_drive: str, @@ -1938,6 +2729,23 @@ async def get_single_script_async( Gets one script Gets one of the scripts. + + Swagger operation ID: `GetSingleScriptV2`. + + Args: + script_source: script source. + script_drive: script drive. + script_id: Script chosen to use. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1959,7 +2767,7 @@ async def get_single_script_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1973,6 +2781,7 @@ async def get_single_script_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/formstackforms.py b/src/azure/connectors/formstackforms.py index a421362d..dee193bb 100644 --- a/src/azure/connectors/formstackforms.py +++ b/src/azure/connectors/formstackforms.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Any, Mapping from urllib.parse import quote import json @@ -20,6 +20,14 @@ ConnectorResponseHook, ) +__all__ = [ + "FormstackformsClient", + "FormstackFormSubmittedInput", + "FormstackFormSubmittedResponse", + "GetAvailableFormsResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,13 +37,13 @@ class FormstackFormSubmittedInput: Triggers when a form is submitted """ - url: Optional[str] = None + url: str """url""" - content_type: Optional[str] = None + content_type: str """content type""" - file_transfer_type: Optional[str] = None + file_transfer_type: str """file transfer type""" - standardize_field_values: Optional[bool] = None + standardize_field_values: bool """standardize field values""" @@ -45,7 +53,7 @@ class FormstackFormSubmittedResponse: Response for Triggers when a form is submitted """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -54,9 +62,9 @@ class GetAvailableFormsResponse: Response for Get Available Forms """ - forms: Optional[List[Dict[str, Any]]] = None + forms: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """forms""" - total: Optional[int] = None + total: Optional[int] = dataclass_field(default=None, kw_only=True) """total""" @@ -71,7 +79,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -88,8 +96,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -110,7 +118,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -125,7 +133,7 @@ def __init__( def connector_name(self) -> str: return "formstackforms" - async def get_available_forms_async( + async def get_available_forms( self, *, timeout: Optional[float] = None, @@ -137,10 +145,24 @@ async def get_available_forms_async( Get Available Forms Returns all available forms + + Swagger operation ID: `GetAvailableForms`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v2/form/" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -154,6 +176,7 @@ async def get_available_forms_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -161,7 +184,7 @@ async def get_available_forms_async( return json.loads(response.text) - async def get_form_schema_async( + async def get_form_schema( self, form_id: int, *, @@ -174,6 +197,21 @@ async def get_form_schema_async( Returns Form Schema from Webhook API Used for the x-ms-dynamic-schema + + Swagger operation ID: `GetFormSchema`. + + Args: + form_id: form_id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -184,7 +222,7 @@ async def get_form_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -198,6 +236,7 @@ async def get_form_schema_async( request_url, response.status, response.text, + response=response, ) diff --git a/src/azure/connectors/freshservice.py b/src/azure/connectors/freshservice.py index 709417d4..dbbe5ca7 100644 --- a/src/azure/connectors/freshservice.py +++ b/src/azure/connectors/freshservice.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Any, Mapping from urllib.parse import quote import json @@ -20,6 +20,20 @@ ConnectorResponseHook, ) +__all__ = [ + "FreshserviceClient", + "AddNoteRequest", + "AddNoteResponse", + "CreateTicketRequest", + "CreateUpdateTicketResponse", + "ListTicketResponse", + "ListUsersResponse", + "TicketResponse", + "UpdateTicketRequest", + "UpdateTicketResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +43,7 @@ class AddNoteResponse: Response for Add a note to a ticket """ - conversation: Optional[Dict[str, Any]] = None + conversation: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -38,7 +52,7 @@ class CreateUpdateTicketResponse: Response for Create a ticket """ - ticket: Optional[Dict[str, Any]] = None + ticket: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -47,48 +61,52 @@ class ListTicketResponse: Response for When a ticket is created """ - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - department_id: Optional[int] = None - due_by: Optional[str] = None + department_id: Optional[int] = dataclass_field(default=None, kw_only=True) + due_by: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - group_id: Optional[int] = None + group_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of Group to which the ticket is assigned.""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique Id of the ticket.""" - is_escalated: Optional[bool] = None + is_escalated: Optional[bool] = dataclass_field(default=None, kw_only=True) """Set to true if an escalation was sent.""" - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """A number representing the priority of the ticket.""" - requester_id: Optional[int] = None + requester_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ User-id of the requester. For existing contacts, requester_id can be passed instead of email. """ - responder_id: Optional[int] = None + responder_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the agent to whom the ticket is assigned.""" - source: Optional[int] = None + source: Optional[int] = dataclass_field(default=None, kw_only=True) """ A number representing the channel through which the ticket was created. """ - spam: Optional[bool] = None + spam: Optional[bool] = dataclass_field(default=None, kw_only=True) """Set as true if the ticket is marked as spam.""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """A number representing the status of the ticket.""" - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """Ticket subject.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type property field as defined in ticket fields.""" - updated_at: Optional[str] = None + updated_at: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - description_text: Optional[str] = None + description_text: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the problem.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ HTML content of the ticket. Description and description_html should not be passed together. """ - to_emails: Optional[List[str]] = None + to_emails: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Email addresses to which the incoming ticket email was sent.""" @@ -98,39 +116,39 @@ class CreateTicketRequest: Definition: CreateTicket_Request """ - requester_id: Optional[int] = None + requester_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ User-id of the requester. One of the Requester ID, Requester Email and Requester Phone is required """ - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """ Email of the requester. One of the Requester ID, Requester Email and Requester Phone is required """ - phone: Optional[str] = None + phone: Optional[str] = dataclass_field(default=None, kw_only=True) """ Phone number of the requester. One of the Requester ID, Requester Email and Requester Phone is required """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the requester. This is a required field only if Requester Phone value is provided """ - subject: Optional[str] = None + subject: str """The subject of the ticket.""" - status: Optional[str] = None + status: str """Status of the ticket.""" - priority: Optional[str] = None + priority: str """The priority of the ticket (such as Low, Medium, or High).""" - description: Optional[str] = None + description: str """The description of the ticket.""" - urgency: Optional[str] = None + urgency: Optional[str] = dataclass_field(default=None, kw_only=True) """Urgency of the problem (such as Low, Medium or High).""" - impact: Optional[str] = None + impact: Optional[str] = dataclass_field(default=None, kw_only=True) """Impact of the problem (such as Low, Medium or High).""" - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """The channel through which the ticket was created.""" @@ -140,22 +158,22 @@ class UpdateTicketRequest: Definition: UpdateTicket_Request """ - requester_id: Optional[int] = None + requester_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ User-id of the requester. For existing contacts, requester_id can be passed instead of email. """ - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """The subject of the ticket.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the ticket.""" - priority: Optional[str] = None + priority: Optional[str] = dataclass_field(default=None, kw_only=True) """The priority of the ticket (such as Low, Medium, or High).""" - urgency: Optional[str] = None + urgency: Optional[str] = dataclass_field(default=None, kw_only=True) """Urgency of the problem (such as Low, Medium or High).""" - impact: Optional[str] = None + impact: Optional[str] = dataclass_field(default=None, kw_only=True) """Impact of the problem (such as Low, Medium or High).""" - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """The channel through which the ticket was created.""" @@ -165,9 +183,9 @@ class AddNoteRequest: Definition: AddNote_Request """ - body: Optional[str] = None + body: str """The note to be added to the ticket.""" - private: Optional[bool] = None + private: Optional[bool] = dataclass_field(default=None, kw_only=True) """Set to true if message is private.""" @@ -177,85 +195,85 @@ class TicketResponse: Definition: Ticket_Response """ - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - deleted: Optional[bool] = None + deleted: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Set as true if the ticket is deleted/trashed. Deleted tickets will not be considered in any views except 'deleted' filter. """ - department_id_value: Optional[int] = None - display_id: Optional[int] = None + department_id_value: Optional[int] = dataclass_field(default=None, kw_only=True) + display_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Ticket Id specific to your account.""" - due_by: Optional[str] = None + due_by: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - group_id: Optional[int] = None + group_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of Group to which the ticket is assigned.""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique Id of the ticket.""" - impact: Optional[int] = None + impact: Optional[int] = dataclass_field(default=None, kw_only=True) """A number representing the impact of the problem.""" - isescalated: Optional[bool] = None + isescalated: Optional[bool] = dataclass_field(default=None, kw_only=True) """Set to true if an escalation was sent.""" - owner_id: Optional[str] = None + owner_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the agent to whom the problem is assigned.""" - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """A number representing the priority of the ticket.""" - requester_id: Optional[int] = None + requester_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ User-id of the requester. For existing contacts, requester_id can be passed instead of email. """ - responder_id: Optional[int] = None + responder_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the agent to whom the ticket is assigned.""" - source: Optional[int] = None + source: Optional[int] = dataclass_field(default=None, kw_only=True) """ A number representing the channel through which the ticket was created. """ - spam: Optional[bool] = None + spam: Optional[bool] = dataclass_field(default=None, kw_only=True) """Set as true if the ticket is marked as spam.""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """A number representing the status of the ticket.""" - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """Ticket subject.""" - ticket_type: Optional[str] = None + ticket_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type property field as defined in ticket fields.""" - to_email: Optional[str] = None + to_email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address to which the incoming ticket email was sent.""" - updated_at: Optional[str] = None + updated_at: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - urgency: Optional[int] = None + urgency: Optional[int] = dataclass_field(default=None, kw_only=True) """A number representing the urgency of the problem.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the problem.""" - description_html: Optional[str] = None + description_html: Optional[str] = dataclass_field(default=None, kw_only=True) """ HTML content of the ticket. Description and description_html should not be passed together. """ - status_name: Optional[str] = None + status_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the ticket.""" - priority_name: Optional[str] = None + priority_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Priority of the ticket.""" - source_name: Optional[str] = None + source_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The channel through which the ticket was created.""" - responder_name: Optional[str] = None + responder_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the agent to whom the ticket is assigned.""" - to_emails: Optional[List[str]] = None + to_emails: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Email addresses to which the incoming ticket email was sent.""" - department_name: Optional[str] = None + department_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the department.""" - assoc_problem_id: Optional[int] = None + assoc_problem_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the associated problem to the ticket.""" - assoc_change_id: Optional[int] = None + assoc_change_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the associated change to the problem.""" - assoc_change_cause_id: Optional[int] = None + assoc_change_cause_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the change causing the ticket.""" - assoc_asset_id: Optional[int] = None + assoc_asset_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the asset associated to the ticket.""" - urgency_name: Optional[str] = None + urgency_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Urgency of the problem.""" - impact_name: Optional[str] = None + impact_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Impact of the problem.""" @@ -265,7 +283,7 @@ class UpdateTicketResponse: Definition: UpdateTicket_Response """ - ticket: Optional[Dict[str, Any]] = None + ticket: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) ListUsersResponse = List[Dict[str, Any]] @@ -282,7 +300,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -299,8 +317,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -321,7 +339,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -336,9 +354,9 @@ def __init__( def connector_name(self) -> str: return "freshservice" - async def add_note_async( + async def add_note( self, - input: AddNoteRequest, + input: AddNoteRequest | Mapping[str, Any], ticket_id: int, *, timeout: Optional[float] = None, @@ -350,13 +368,30 @@ async def add_note_async( Add a note to a ticket Add a private or public note to a ticket. + + Swagger operation ID: `AddNoteV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + ticket_id: The ticket id to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v2/tickets/{quote(str(ticket_id), safe='')}/notes" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -370,6 +405,7 @@ async def add_note_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -377,9 +413,9 @@ async def add_note_async( return json.loads(response.text) - async def create_ticket_async( + async def create_ticket( self, - input: CreateTicketRequest, + input: CreateTicketRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -390,10 +426,26 @@ async def create_ticket_async( Create a ticket Create a ticket. + + Swagger operation ID: `CreateTicketV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v2/tickets" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -407,6 +459,7 @@ async def create_ticket_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -414,9 +467,9 @@ async def create_ticket_async( return json.loads(response.text) - async def update_ticket_async( + async def update_ticket( self, - input: UpdateTicketRequest, + input: UpdateTicketRequest | Mapping[str, Any], ticket_id: int, *, timeout: Optional[float] = None, @@ -428,13 +481,30 @@ async def update_ticket_async( Update a ticket Update a ticket (only specified values will be updated). + + Swagger operation ID: `UpdateTicketV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + ticket_id: The ticket id to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v2/tickets/{quote(str(ticket_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -448,6 +518,7 @@ async def update_ticket_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/ftp.py b/src/azure/connectors/ftp.py index 6347d2d9..03f0495b 100644 --- a/src/azure/connectors/ftp.py +++ b/src/azure/connectors/ftp.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,21 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "FtpClient", + "BlobDataSetsMetadata", + "BlobMetadata", + "BlobMetadataPage", + "BlobMetadataResponse", + "DataSetsMetadata", + "ObjectEntity", + "TabularDataSetsMetadata", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,41 +43,66 @@ class BlobMetadata: Response for Create file """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" @@ -75,8 +114,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -85,25 +134,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -115,15 +168,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -135,41 +190,66 @@ class BlobMetadataResponse: Definition: BlobMetadataResponse """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" @@ -181,7 +261,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -194,7 +274,12 @@ class BlobMetadataPage: Definition: BlobMetadataPage """ - value: Optional[List[BlobMetadata]] = None + value: Optional[ + List[BlobMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Blob metadata collection.""" @@ -209,7 +294,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -226,8 +311,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -248,7 +333,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -263,7 +348,84 @@ def __init__( def connector_name(self) -> str: return "ftp" - async def create_file_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def create_file( self, input: bytes, folder_path: str, @@ -281,6 +443,23 @@ async def create_file_async( server right after it was created, connector may return HTTP 404 error by it's design. Please use a delay for 1 minute before deleting or renaming newly created file. + + Swagger operation ID: `CreateFile`. + + Args: + input: The binary request body. + folder_path: Select a folder. + name: Name of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/datasets/default/files" query_params = [] @@ -296,7 +475,7 @@ async def create_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -313,6 +492,7 @@ async def create_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -320,7 +500,7 @@ async def create_file_async( return json.loads(response.text) - async def get_file_metadata_async( + async def get_file_metadata( self, id: str, *, @@ -333,6 +513,21 @@ async def get_file_metadata_async( Get file metadata This operation gets the metadata for a file. + + Swagger operation ID: `GetFileMetadata`. + + Args: + id: Select a file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -342,7 +537,7 @@ async def get_file_metadata_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -356,6 +551,7 @@ async def get_file_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -363,7 +559,7 @@ async def get_file_metadata_async( return json.loads(response.text) - async def update_file_async( + async def update_file( self, input: bytes, id: str, @@ -380,6 +576,22 @@ async def update_file_async( server right after it was updated, connector may return HTTP 404 error by it's design. Please use a delay for 1 minute before deleting or renaming recently updated file. + + Swagger operation ID: `UpdateFile`. + + Args: + input: The binary request body. + id: Select a file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -389,7 +601,7 @@ async def update_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, @@ -406,6 +618,7 @@ async def update_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -413,7 +626,7 @@ async def update_file_async( return json.loads(response.text) - async def delete_file_async( + async def delete_file( self, id: str, *, @@ -426,6 +639,21 @@ async def delete_file_async( Delete file This operation deletes a file. + + Swagger operation ID: `DeleteFile`. + + Args: + id: Select a file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -435,7 +663,7 @@ async def delete_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -449,14 +677,15 @@ async def delete_file_async( request_url, response.status, response.text, + response=response, ) - async def copy_file_async( + async def copy_file( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -469,6 +698,23 @@ async def copy_file_async( deleted/renamed on server right after it was copied, connector may return HTTP 404 error by it's design. Please use a delay for 1 minute before deleting or renaming newly created file. + + Swagger operation ID: `CopyFile`. + + Args: + source: Url to source file. + destination: Destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/copyFile" @@ -491,7 +737,7 @@ async def copy_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -505,6 +751,7 @@ async def copy_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -512,7 +759,7 @@ async def copy_file_async( return json.loads(response.text) - async def get_file_metadata_by_path_async( + async def get_file_metadata_by_path( self, path: str, *, @@ -525,6 +772,21 @@ async def get_file_metadata_by_path_async( Get file metadata using path This operation gets the metadata of a file using the file path. + + Swagger operation ID: `GetFileMetadataByPath`. + + Args: + path: Select a file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/GetFileByPath" @@ -538,7 +800,7 @@ async def get_file_metadata_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -552,6 +814,7 @@ async def get_file_metadata_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -559,11 +822,11 @@ async def get_file_metadata_by_path_async( return json.loads(response.text) - async def get_file_content_by_path_async( + async def get_file_content_by_path( self, path: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -573,6 +836,22 @@ async def get_file_content_by_path_async( Get file content using path This operation gets the content of a file using the file path. + + Swagger operation ID: `GetFileContentByPath`. + + Args: + path: Select a file. + infer_content_type: Infer content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -592,7 +871,7 @@ async def get_file_content_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -606,15 +885,16 @@ async def get_file_content_by_path_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_file_content_async( + async def get_file_content( self, id: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -624,6 +904,22 @@ async def get_file_content_async( Get file content This operation gets the content of a file. + + Swagger operation ID: `GetFileContent`. + + Args: + id: Select a file. + infer_content_type: Infer content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -642,7 +938,7 @@ async def get_file_content_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -656,11 +952,12 @@ async def get_file_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def list_folder_async( + def list_folder( self, id: str, *, @@ -668,11 +965,29 @@ async def list_folder_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files in folder This operation gets the list of files and subfolders in a folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListFolder`. + + Args: + id: Select a folder. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -681,74 +996,133 @@ async def list_folder_async( f"/folders" f"/{quote(quote(str(id), safe=''), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_root_folder_async( + def list_root_folder( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files in root folder This operation gets the list of files and subfolders in the root folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRootFolder`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/folders" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def extract_folder_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def extract_folder( self, source: str, destination: str, + *, overwrite: Optional[bool] = None, create_folders: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -758,6 +1132,24 @@ async def extract_folder_async( Extract archive to folder This operation extracts an archive file into a folder (example: .zip). + + Swagger operation ID: `ExtractFolderV2`. + + Args: + source: Path to the archive file. + destination: Path to the destination folder. + overwrite: Overwrites the destination files if set to 'true'. + create_folders: Extracts folders from archive if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/extractFolderV2" @@ -785,7 +1177,7 @@ async def extract_folder_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -799,6 +1191,7 @@ async def extract_folder_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/github.py b/src/azure/connectors/github.py index 4d424cf4..c878b298 100644 --- a/src/azure/connectors/github.py +++ b/src/azure/connectors/github.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,53 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "GithubClient", + "ActionsPublicKey", + "Commit", + "CommitComparison", + "CreateReferenceRequest", + "CreateRepositorySecretRequest", + "CreateRepositoryUsingTemplateRequest", + "DiffEntry", + "GeneralAPIModel", + "GitReference", + "GitUser", + "GraphQlQuery", + "IssueBasicDetailsModel", + "IssueDetailsModel", + "IssueUpdateModel", + "Label", + "LicenseDetails", + "Link", + "Milestone", + "MilestoneUpdateModel", + "MultipleFetchModel", + "MultipleSearchFetchModel", + "PullRequest", + "PullRequestCreateRequest", + "PullRequestFile", + "PullRequestMergeRequest", + "PullRequestMergeResult", + "PullRequestUpdateRequest", + "QueryRequest", + "RepositoryDetails", + "RepositoryDispatchEvent", + "RepositoryMiniDetails", + "RequestReviewersBody", + "SingleSearchFetchModel", + "TeamDetails", + "UserDetailsModel", + "Verification", + "WebhookCreationResponse", + "WebhookPullRequestResponse", + "WebhookRequestBody", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,22 +75,27 @@ class IssueDetailsModel: Response for Create an issue """ - title: Optional[str] = None + title: str """Summary of the issue.""" - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the issue.""" - assignee: Optional[UserDetailsModel] = None - number: Optional[int] = None + assignee: Optional[ + UserDetailsModel | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + number: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique id of the issue.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the issue.""" - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).""" - repository_url: Optional[str] = None + repository_url: Optional[str] = dataclass_field(default=None, kw_only=True) """Web link to the repository.""" -MultipleFetchModel = List["GeneralAPIModel"] +MultipleFetchModel = List["GeneralAPIModel | Mapping[str, Any]"] @dataclass @@ -53,17 +104,17 @@ class ActionsPublicKey: Response for Get a repository public key """ - key_id: Optional[str] = None + key_id: str """The identifier for the key.""" - key: Optional[str] = None + key: str """The Base64 encoded public key.""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique identifier of the key.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Public key url.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Public key title.""" - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time when the key was created.""" @@ -73,182 +124,192 @@ class RepositoryDetails: Response for Create a repository using a template """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique identifier of the repository.""" - node_id: Optional[str] = None + node_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The Node Id of the repository.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the repository.""" - full_name: Optional[str] = None + full_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The full name of the repository.""" - license: Optional[LicenseDetails] = None - forks: Optional[int] = None + license: Optional[ + LicenseDetails | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + forks: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of forks of the repository.""" - permissions: Optional[Dict[str, Any]] = None + permissions: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Permissions on the repository.""" - owner: Optional[UserDetailsModel] = None - private: Optional[bool] = None + owner: Optional[ + UserDetailsModel | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + private: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the repository is private or public.""" - html_url: Optional[str] = None + html_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Html Url of the repository""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the repository""" - fork: Optional[bool] = None + fork: Optional[bool] = dataclass_field(default=None, kw_only=True) """If the repository is a fork?""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The HTTP URL for this repository""" - archive_url: Optional[str] = None + archive_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Archive URL for this repository""" - assignees_url: Optional[str] = None + assignees_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Assignees URL for this repository""" - blobs_url: Optional[str] = None + blobs_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Blobs URL for this repository""" - branches_url: Optional[str] = None + branches_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Branches URL for this repository""" - collaborators_url: Optional[str] = None + collaborators_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Collaborators URL for this repository""" - comments_url: Optional[str] = None + comments_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Comments URL for this repository""" - commits_url: Optional[str] = None + commits_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Commits URL for this repository""" - compare_url: Optional[str] = None + compare_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Compare URL for this repository""" - contents_url: Optional[str] = None + contents_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Contents URL for this repository""" - contributors_url: Optional[str] = None + contributors_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Contributors URL for this repository""" - deployments_url: Optional[str] = None + deployments_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Deployments URL for this repository""" - downloads_url: Optional[str] = None + downloads_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Downloads URL for this repository""" - events_url: Optional[str] = None + events_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Events URL for this repository""" - forks_url: Optional[str] = None + forks_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Forks URL for this repository""" - git_commits_url: Optional[str] = None + git_commits_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Git Commits URL for this repository""" - git_refs_url: Optional[str] = None + git_refs_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Git References URL for this repository""" - git_tags_url: Optional[str] = None + git_tags_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Git Tags URL for this repository""" - git_url: Optional[str] = None + git_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Git URL for this repository""" - issue_comment_url: Optional[str] = None + issue_comment_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The issue comment URL for this repository""" - issue_events_url: Optional[str] = None + issue_events_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The issue events URL for this repository""" - issues_url: Optional[str] = None + issues_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The issues URL for this repository""" - keys_url: Optional[str] = None + keys_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The keys URL for this repository""" - labels_url: Optional[str] = None + labels_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The labels URL for this repository""" - languages_url: Optional[str] = None + languages_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The languages URL for this repository""" - merges_url: Optional[str] = None + merges_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The merges URL for this repository""" - milestones_url: Optional[str] = None + milestones_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The milestones URL for this repository""" - notifications_url: Optional[str] = None + notifications_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The notifications URL for this repository""" - pulls_url: Optional[str] = None + pulls_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The pulls URL for this repository""" - releases_url: Optional[str] = None + releases_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The releases URL for this repository""" - ssh_url: Optional[str] = None + ssh_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The SSH URL to clone this repository""" - stargazers_url: Optional[str] = None + stargazers_url: Optional[str] = dataclass_field(default=None, kw_only=True) """ The stargazers (Stargazers are the people that have bookmarked the GitHub repository) URL for this repository """ - statuses_url: Optional[str] = None + statuses_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The statuses URL for this repository""" - subscribers_url: Optional[str] = None + subscribers_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The subscribers URL for this repository""" - subscription_url: Optional[str] = None + subscription_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The subscription URL for this repository""" - tags_url: Optional[str] = None + tags_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The tags URL for this repository""" - teams_url: Optional[str] = None + teams_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The teams URL for this repository""" - trees_url: Optional[str] = None + trees_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The trees URL for this repository""" - clone_url: Optional[str] = None + clone_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The clone URL for this repository""" - mirror_url: Optional[str] = None + mirror_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The original mirror URL for this repository""" - hooks_url: Optional[str] = None + hooks_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The hooks URL for this repository""" - svn_url: Optional[str] = None + svn_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The SVN URL for this repository""" - homepage: Optional[str] = None + homepage: Optional[str] = dataclass_field(default=None, kw_only=True) """The homepage for this repository""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language for this repository""" - forks_count: Optional[int] = None + forks_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of forks there are of this repository in the whole network.""" - stargazers_count: Optional[int] = None + stargazers_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of users who have starred the repository.""" - watchers_count: Optional[int] = None + watchers_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of users watching the repository.""" - size: Optional[int] = None + size: Optional[int] = dataclass_field(default=None, kw_only=True) """Size of the repository""" - default_branch: Optional[str] = None + default_branch: Optional[str] = dataclass_field(default=None, kw_only=True) """The default branch of the repository.""" - open_issues_count: Optional[int] = None + open_issues_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of open issues in the repository.""" - is_template: Optional[bool] = None + is_template: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether this repository acts as a template that can be used to generate new repositories. """ - topics: Optional[List[str]] = None + topics: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """List of topics in the repository""" - has_issues: Optional[bool] = None + has_issues: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether issues are enabled.""" - has_projects: Optional[bool] = None + has_projects: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether projects are enabled.""" - has_wiki: Optional[bool] = None + has_wiki: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the wiki is enabled.""" - has_pages: Optional[bool] = None + has_pages: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether pages are enabled.""" - has_downloads: Optional[bool] = None + has_downloads: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether downloads are enabled.""" - archived: Optional[bool] = None + archived: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the repository is archived.""" - disabled: Optional[bool] = None + disabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """Returns whether or not this repository disabled.""" - visibility: Optional[str] = None + visibility: Optional[str] = dataclass_field(default=None, kw_only=True) """The repository visibility: public, private, or internal.""" - pushed_at: Optional[str] = None + pushed_at: Optional[str] = dataclass_field(default=None, kw_only=True) """When the repository was last pushed to.""" - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """the date and time when the repository was created.""" - updated_at: Optional[str] = None + updated_at: Optional[str] = dataclass_field(default=None, kw_only=True) """the date and time when the repository was last updated.""" - allow_rebase_merge: Optional[bool] = None + allow_rebase_merge: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to allow rebase merges for pull requests.""" - template_repository: Optional[Dict[str, Any]] = None - temp_clone_token: Optional[str] = None + template_repository: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + temp_clone_token: Optional[str] = dataclass_field(default=None, kw_only=True) """Temporary authentication token for cloning this repository.""" - allow_squash_merge: Optional[bool] = None + allow_squash_merge: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to allow squash merges for pull requests.""" - delete_branch_on_merge: Optional[bool] = None + delete_branch_on_merge: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to delete head branches when pull requests are merged""" - allow_merge_commit: Optional[bool] = None + allow_merge_commit: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to allow merge commits for pull requests.""" - subscribers_count: Optional[int] = None + subscribers_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of subscribers for the repository.""" - network_count: Optional[int] = None + network_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Repository Network Count""" - open_issues: Optional[int] = None + open_issues: Optional[int] = dataclass_field(default=None, kw_only=True) """Repository open issues.""" - watchers: Optional[int] = None + watchers: Optional[int] = dataclass_field(default=None, kw_only=True) """Repository Watchers.""" - master_branch: Optional[str] = None + master_branch: Optional[str] = dataclass_field(default=None, kw_only=True) """Repository master branch.""" - starred_at: Optional[str] = None + starred_at: Optional[str] = dataclass_field(default=None, kw_only=True) """Repository Starred At""" @@ -258,13 +319,13 @@ class GitReference: Response for Create a reference """ - ref: Optional[str] = None + ref: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the fully qualified reference.""" - node_id: Optional[str] = None + node_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The Node Id of the reference.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The url of the reference.""" - object: Optional[Dict[str, Any]] = None + object: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -273,11 +334,11 @@ class PullRequestMergeResult: Response for Merge a pull request """ - sha: Optional[str] = None + sha: Optional[str] = dataclass_field(default=None, kw_only=True) """SHA for the merge commit.""" - merged: Optional[bool] = None + merged: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether or not the pull request was merged.""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """Merge response message.""" @@ -287,96 +348,131 @@ class PullRequest: Response for Get a pull request """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The HTTP URL for this pull request.""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The Unique Identifier for the pull request.""" - node_id: Optional[str] = None + node_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The Node ID for the pull request.""" - html_url: Optional[str] = None + html_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The HTML URL for the pull request.""" - diff_url: Optional[str] = None + diff_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Diff URL for the pull request.""" - patch_url: Optional[str] = None + patch_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The patch URL for the pull request.""" - issue_url: Optional[str] = None + issue_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The issue URL for the pull request.""" - commits_url: Optional[str] = None + commits_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The commit URL for the pull request.""" - review_comments_url: Optional[str] = None + review_comments_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The review comments URL for the pull request.""" - review_comment_url: Optional[str] = None + review_comment_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The review comment URL for the pull request.""" - comments_url: Optional[str] = None + comments_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Diff URL for the pull request.""" - statuses_url: Optional[str] = None + statuses_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The statuses URL for the pull request.""" - number: Optional[int] = None + number: Optional[int] = dataclass_field(default=None, kw_only=True) """Number uniquely identifying the pull request within its repository.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """State of this Pull Request. Either `open` or `closed`.""" - locked: Optional[bool] = None + locked: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the pull request is locked or not.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the pull request.""" - user: Optional[UserDetailsModel] = None - body: Optional[str] = None + user: Optional[ + UserDetailsModel | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + body: Optional[str] = dataclass_field(default=None, kw_only=True) """The body as Markdown.""" - labels: Optional[List[Label]] = None + labels: Optional[ + List[Label | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of labels associated with the pull request.""" - milestone: Optional[Milestone] = None - active_lock_reason: Optional[str] = None + milestone: Optional[Milestone | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + active_lock_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """Reason that the conversation was locked.""" - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time when the pull request was created.""" - updated_at: Optional[str] = None + updated_at: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time when the pull request was last updated.""" - closed_at: Optional[str] = None + closed_at: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time when the pull request was closed.""" - merged_at: Optional[str] = None + merged_at: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time that the pull request was merged.""" - merge_commit_sha: Optional[str] = None + merge_commit_sha: Optional[str] = dataclass_field(default=None, kw_only=True) """The merge commit Sha of the pull request.""" - assignee: Optional[UserDetailsModel] = None - assignees: Optional[List[UserDetailsModel]] = None + assignee: Optional[ + UserDetailsModel | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + assignees: Optional[ + List[UserDetailsModel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of assignees for the pull request.""" - requested_reviewers: Optional[List[UserDetailsModel]] = None + requested_reviewers: Optional[ + List[UserDetailsModel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of Users assigned to this pull request.""" - requested_teams: Optional[List[TeamDetails]] = None + requested_teams: Optional[ + List[TeamDetails | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of requested teams to this pull request.""" - head: Optional[Dict[str, Any]] = None + head: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Head""" - base: Optional[Dict[str, Any]] = None + base: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Base""" - author_association: Optional[str] = None + author_association: Optional[str] = dataclass_field(default=None, kw_only=True) """Author's association with the subject of the comment.""" - draft: Optional[bool] = None + draft: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether or not the pull request is a draft.""" - merged: Optional[bool] = None + merged: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether or not the pull request was merged.""" - mergeable: Optional[bool] = None + mergeable: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether or not the pull request can be merged based on the existence of merge conflicts. """ - rebaseable: Optional[bool] = None + rebaseable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether or not the pull request is rebaseable.""" - mergeable_state: Optional[str] = None + mergeable_state: Optional[str] = dataclass_field(default=None, kw_only=True) """The mergeable state of the pull request.""" - merged_by: Optional[UserDetailsModel] = None - comments: Optional[int] = None + merged_by: Optional[ + UserDetailsModel | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + comments: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of comments in this pull request.""" - review_comments: Optional[int] = None + review_comments: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of review comments in this pull request.""" - maintainer_can_modify: Optional[bool] = None + maintainer_can_modify: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether maintainers can modify the pull request.""" - commits: Optional[int] = None + commits: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of commits in this pull request.""" - additions: Optional[int] = None + additions: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of additions in this pull request.""" - deletions: Optional[int] = None + deletions: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of deletions in this pull request.""" - changed_files: Optional[int] = None + changed_files: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of changed files in this pull request.""" @@ -386,25 +482,25 @@ class PullRequestFile: Response for Get the list of files from a pull request """ - sha: Optional[str] = None + sha: Optional[str] = dataclass_field(default=None, kw_only=True) """The sha for the file.""" - filename: Optional[str] = None + filename: Optional[str] = dataclass_field(default=None, kw_only=True) """The file name.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The modification status for the file.""" - additions: Optional[int] = None + additions: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of additions made to the file.""" - deletions: Optional[int] = None + deletions: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of deletions made to the file.""" - changes: Optional[int] = None + changes: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of changes made to the file.""" - blob_url: Optional[str] = None + blob_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The blob Url for the file.""" - raw_url: Optional[str] = None + raw_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The Raw Url for the file.""" - contents_url: Optional[str] = None + contents_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The contents Url for the file.""" - patch: Optional[str] = None + patch: Optional[str] = dataclass_field(default=None, kw_only=True) """The patch content for the file.""" @@ -414,29 +510,44 @@ class CommitComparison: Response for Compare two commits """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Url for the comparison""" - html_url: Optional[str] = None + html_url: Optional[str] = dataclass_field(default=None, kw_only=True) """Html Url for the comparison""" - permalink_url: Optional[str] = None + permalink_url: Optional[str] = dataclass_field(default=None, kw_only=True) """Permanent Url for the comparison """ - diff_url: Optional[str] = None + diff_url: Optional[str] = dataclass_field(default=None, kw_only=True) """Diff Url""" - patch_url: Optional[str] = None + patch_url: Optional[str] = dataclass_field(default=None, kw_only=True) """Patch Url""" - base_commit: Optional[Commit] = None - merge_base_commit: Optional[Commit] = None - status: Optional[str] = None + base_commit: Optional[Commit | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + merge_base_commit: Optional[ + Commit | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the comparision eg. diverged etc.,""" - ahead_by: Optional[int] = None + ahead_by: Optional[int] = dataclass_field(default=None, kw_only=True) """ahead by base branch""" - behind_by: Optional[int] = None + behind_by: Optional[int] = dataclass_field(default=None, kw_only=True) """behind_by base branch""" - total_commits: Optional[int] = None + total_commits: Optional[int] = dataclass_field(default=None, kw_only=True) """total commits""" - commits: Optional[List[Commit]] = None + commits: Optional[ + List[Commit | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """commits""" - files: Optional[List[DiffEntry]] = None + files: Optional[ + List[DiffEntry | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """files""" @@ -446,18 +557,22 @@ class WebhookCreationResponse: Response for When a pull request is created or modified """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) - id: Optional[int] = None - name: Optional[str] = None - active: Optional[bool] = None - events: Optional[List[str]] = None - config: Optional[Dict[str, Any]] = None - updated_at: Optional[str] = None - created_at: Optional[str] = None - url: Optional[str] = None - test_url: Optional[str] = None - ping_url: Optional[str] = None - last_response: Optional[Dict[str, Any]] = None + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) + id: Optional[int] = dataclass_field(default=None, kw_only=True) + name: Optional[str] = dataclass_field(default=None, kw_only=True) + active: Optional[bool] = dataclass_field(default=None, kw_only=True) + events: Optional[List[str]] = dataclass_field(default=None, kw_only=True) + config: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + updated_at: Optional[str] = dataclass_field(default=None, kw_only=True) + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) + url: Optional[str] = dataclass_field(default=None, kw_only=True) + test_url: Optional[str] = dataclass_field(default=None, kw_only=True) + ping_url: Optional[str] = dataclass_field(default=None, kw_only=True) + last_response: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -466,36 +581,41 @@ class Milestone: Response for Update a milestone """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The HTTP URL for the milestone.""" - html_url: Optional[str] = None + html_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The HTML URL for the milestone.""" - labels_url: Optional[str] = None + labels_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The labels URL for the milestone.""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The Unique Identifier for the milestone.""" - node_id: Optional[str] = None + node_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The Node ID for the milestone.""" - number: Optional[int] = None + number: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of the milestone.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The state of the milestone.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the milestone.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the milestone.""" - creator: Optional[UserDetailsModel] = None - open_issues: Optional[int] = None + creator: Optional[ + UserDetailsModel | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + open_issues: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of open issues for the repository.""" - closed_issues: Optional[int] = None + closed_issues: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of closed issues for the repository.""" - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time when the milestone was created.""" - updated_at: Optional[str] = None + updated_at: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time when the milestone was last updated.""" - closed_at: Optional[str] = None + closed_at: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time when the milestone was closed.""" - due_on: Optional[str] = None + due_on: Optional[str] = dataclass_field(default=None, kw_only=True) """The due date of the milestone.""" @@ -505,67 +625,71 @@ class UserDetailsModel: Response for Get the authenticated user """ - login: Optional[str] = None + login: Optional[str] = dataclass_field(default=None, kw_only=True) """User Login.""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """User Id.""" - node_id: Optional[str] = None + node_id: Optional[str] = dataclass_field(default=None, kw_only=True) """User Node Id.""" - avatar_url: Optional[str] = None + avatar_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User Avatar Url.""" - gravatar_id: Optional[str] = None + gravatar_id: Optional[str] = dataclass_field(default=None, kw_only=True) """User Gravatar Id.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """User Url.""" - html_url: Optional[str] = None + html_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User Html Url.""" - followers_url: Optional[str] = None + followers_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User FollowersUrl""" - following_url: Optional[str] = None + following_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User Following Url.""" - gists_url: Optional[str] = None + gists_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User Gists Url.""" - starred_url: Optional[str] = None + starred_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User Starred Url.""" - subscriptions_url: Optional[str] = None + subscriptions_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User Subscriptions Url.""" - organizations_url: Optional[str] = None + organizations_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User Organizations Url.""" - repos_url: Optional[str] = None + repos_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User Repos Url.""" - events_url: Optional[str] = None + events_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User Events Url.""" - received_events_url: Optional[str] = None + received_events_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User Received Events Url.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """User Type.""" - site_admin: Optional[bool] = None + site_admin: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is User Site Admin?""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """User Name.""" - company: Optional[str] = None + company: Optional[str] = dataclass_field(default=None, kw_only=True) """User Company.""" - blog: Optional[str] = None + blog: Optional[str] = dataclass_field(default=None, kw_only=True) """User Blog.""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """User Location.""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """User Email.""" - hireable: Optional[bool] = None + hireable: Optional[bool] = dataclass_field(default=None, kw_only=True) """User Hireable?""" - bio: Optional[str] = None + bio: Optional[str] = dataclass_field(default=None, kw_only=True) """User Bio.""" - public_repos: Optional[int] = None + public_repos: Optional[int] = dataclass_field(default=None, kw_only=True) """User Public Repos.""" - public_gists: Optional[int] = None + public_gists: Optional[int] = dataclass_field(default=None, kw_only=True) """User Public Gists.""" - followers: Optional[int] = None + followers: Optional[int] = dataclass_field(default=None, kw_only=True) """User Followers.""" - following: Optional[int] = None + following: Optional[int] = dataclass_field(default=None, kw_only=True) """User Following.""" - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """User Created At.""" - updated_at: Optional[str] = None + updated_at: Optional[str] = dataclass_field(default=None, kw_only=True) """User Updated At.""" @@ -575,7 +699,7 @@ class GeneralAPIModel: Response for Check if a user is a repository collaborator """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -588,7 +712,12 @@ class MultipleSearchFetchModel: Response for Find issues by state and keyword """ - body: Optional[List[GeneralAPIModel]] = None + body: Optional[ + List[GeneralAPIModel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """body of result""" @@ -598,9 +727,9 @@ class IssueBasicDetailsModel: Definition: IssueBasicDetailsModel """ - title: Optional[str] = None + title: str """Summary of the issue.""" - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the issue.""" @@ -610,7 +739,12 @@ class SingleSearchFetchModel: Definition: SingleSearchFetchModel """ - body: Optional[List[GeneralAPIModel]] = None + body: Optional[ + List[GeneralAPIModel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """body of result""" @@ -620,21 +754,21 @@ class IssueUpdateModel: Definition: IssueUpdateModel """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Summary of the issue.""" - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the issue.""" - assignee: Optional[str] = None + assignee: Optional[str] = dataclass_field(default=None, kw_only=True) """Assignee of the issue.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The open or close state of an issue. Can be one of open or closed.""" - state_reason: Optional[str] = None + state_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """The reason for change of state.""" - milestone: Optional[str] = None + milestone: Optional[str] = dataclass_field(default=None, kw_only=True) """Number of milestones to associate with issue.""" - labels: Optional[List[str]] = None + labels: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """labels associated with the issue.""" - assignees: Optional[List[str]] = None + assignees: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """UserSnames to assign to the issue.""" @@ -644,13 +778,13 @@ class MilestoneUpdateModel: Definition: MilestoneUpdateModel """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Summary of the milestone.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The open or close state of the milestone.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """A description of the milestone.""" - due_on: Optional[str] = None + due_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Due date of the milestone.""" @@ -660,16 +794,16 @@ class Verification: Definition: Verification """ - verified: Optional[bool] = None + verified: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Indicates whether GitHub considers the signature in this commit to be verified. """ - reason: Optional[str] = None + reason: Optional[str] = dataclass_field(default=None, kw_only=True) """The reason for verified value.""" - payload: Optional[str] = None + payload: Optional[str] = dataclass_field(default=None, kw_only=True) """The value that was signed.""" - signature: Optional[str] = None + signature: Optional[str] = dataclass_field(default=None, kw_only=True) """The signature that was extracted from the commit.""" @@ -679,11 +813,11 @@ class GitUser: Definition: GitUser """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """User Name""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email""" - date: Optional[str] = None + date: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of Commit.""" @@ -693,7 +827,7 @@ class GraphQlQuery: Definition: GraphQlQuery """ - query: Optional[str] = None + query: Optional[str] = dataclass_field(default=None, kw_only=True) """query""" @@ -703,27 +837,27 @@ class DiffEntry: Definition: DiffEntry """ - filename: Optional[str] = None + filename: Optional[str] = dataclass_field(default=None, kw_only=True) """Changed File Name.""" - additions: Optional[int] = None + additions: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of additions in the file""" - deletions: Optional[int] = None + deletions: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of Deletions in the file""" - changes: Optional[int] = None + changes: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of Changes in the file""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the change modified, renamed etc.,""" - raw_url: Optional[str] = None + raw_url: Optional[str] = dataclass_field(default=None, kw_only=True) """Raw Url link to the file""" - blob_url: Optional[str] = None + blob_url: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob Url link to the file""" - patch: Optional[str] = None + patch: Optional[str] = dataclass_field(default=None, kw_only=True) """Actual changes made to the file.""" - sha: Optional[str] = None + sha: Optional[str] = dataclass_field(default=None, kw_only=True) """SHA of the change.""" - contents_url: Optional[str] = None + contents_url: Optional[str] = dataclass_field(default=None, kw_only=True) """File Contents Url.""" - previous_filename: Optional[str] = None + previous_filename: Optional[str] = dataclass_field(default=None, kw_only=True) """Previous FileName if the FileName is changed""" @@ -733,22 +867,37 @@ class Commit: Definition: Commit """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The HTTP URL for the commit.""" - sha: Optional[str] = None + sha: Optional[str] = dataclass_field(default=None, kw_only=True) """SHA of the commit""" - node_id: Optional[str] = None + node_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Node Id of the commit.""" - html_url: Optional[str] = None + html_url: Optional[str] = dataclass_field(default=None, kw_only=True) """HTML Url of the commit""" - comments_url: Optional[str] = None + comments_url: Optional[str] = dataclass_field(default=None, kw_only=True) """Comments Url of the commit""" - commit: Optional[Dict[str, Any]] = None - author: Optional[UserDetailsModel] = None - committer: Optional[UserDetailsModel] = None - parents: Optional[List[Dict[str, Any]]] = None - stats: Optional[Dict[str, Any]] = None - files: Optional[List[DiffEntry]] = None + commit: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + author: Optional[ + UserDetailsModel | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + committer: Optional[ + UserDetailsModel | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + parents: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + stats: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + files: Optional[ + List[DiffEntry | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -757,9 +906,9 @@ class RepositoryDispatchEvent: Definition: RepositoryDispatchEvent """ - event_type: Optional[str] = None + event_type: Optional[str] = dataclass_field(default=None, kw_only=True) """A custom webhook event name.""" - client_payload: Optional[Dict[str, Any]] = None + client_payload: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ JSON payload with extra information about the webhook event that your action or worklow may use. @@ -772,12 +921,12 @@ class CreateRepositorySecretRequest: Definition: CreateRepositorySecretRequest """ - encrypted_value: Optional[str] = None + encrypted_value: Optional[str] = dataclass_field(default=None, kw_only=True) """ Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an Repository public key action. """ - key_id: Optional[str] = None + key_id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID of the key you used to encrypt the secret.""" @@ -787,16 +936,16 @@ class CreateRepositoryUsingTemplateRequest: Definition: CreateRepositoryUsingTemplateRequest """ - owner: Optional[str] = None + owner: Optional[str] = dataclass_field(default=None, kw_only=True) """ The organization or person who will own the new repository. If left blank, the authenticated user will be the owner. """ - name: Optional[str] = None + name: str """The name of the new repository.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """A short description of the new repository.""" - private: Optional[bool] = None + private: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Either `true` to create a new private repository or `false` to create a new public one. @@ -809,17 +958,17 @@ class LicenseDetails: Definition: LicenseDetails """ - key: Optional[str] = None + key: Optional[str] = dataclass_field(default=None, kw_only=True) """The lowercased SPDX Id of the license.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The license full name specified by https://spdx.org/licenses.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """URL to the license on https://choosealicense.com.""" - spdx_id: Optional[str] = None + spdx_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Short identifier specified by https://spdx.org/licenses.""" - node_id: Optional[str] = None + node_id: Optional[str] = dataclass_field(default=None, kw_only=True) """License Node Id.""" - html_url: Optional[str] = None + html_url: Optional[str] = dataclass_field(default=None, kw_only=True) """License HTML URL.""" @@ -829,44 +978,49 @@ class RepositoryMiniDetails: Definition: RepositoryMiniDetails """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique identifier of the repository.""" - node_id: Optional[str] = None + node_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The Node Id of the repository.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the repository.""" - full_name: Optional[str] = None + full_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The full name of the repository.""" - permissions: Optional[Dict[str, Any]] = None + permissions: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Permissions on the repository.""" - owner: Optional[UserDetailsModel] = None - private: Optional[bool] = None + owner: Optional[ + UserDetailsModel | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + private: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the repository is private or public.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the repository""" - homepage: Optional[str] = None + homepage: Optional[str] = dataclass_field(default=None, kw_only=True) """The homepage for this repository""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language for this repository""" - archived: Optional[bool] = None + archived: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the repository is archived.""" - disabled: Optional[bool] = None + disabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """Returns whether or not this repository disabled.""" - visibility: Optional[str] = None + visibility: Optional[str] = dataclass_field(default=None, kw_only=True) """The repository visibility: public, private, or internal.""" - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """the date and time when the repository was created.""" - updated_at: Optional[str] = None + updated_at: Optional[str] = dataclass_field(default=None, kw_only=True) """the date and time when the repository was last updated.""" - allow_rebase_merge: Optional[bool] = None + allow_rebase_merge: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to allow rebase merges for pull requests.""" - allow_squash_merge: Optional[bool] = None + allow_squash_merge: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to allow squash merges for pull requests.""" - delete_branch_on_merge: Optional[bool] = None + delete_branch_on_merge: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to delete head branches when pull requests are merged""" - allow_merge_commit: Optional[bool] = None + allow_merge_commit: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to allow merge commits for pull requests.""" - master_branch: Optional[str] = None + master_branch: Optional[str] = dataclass_field(default=None, kw_only=True) """Repository master branch.""" @@ -876,13 +1030,13 @@ class CreateReferenceRequest: Definition: CreateReferenceRequest """ - ref: Optional[str] = None + ref: str """ The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. """ - sha: Optional[str] = None + sha: str """The SHA1 value for this reference.""" @@ -892,25 +1046,25 @@ class PullRequestCreateRequest: Definition: PullRequestCreateRequest """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the new pull request.""" - head: Optional[str] = None + head: str """ The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. """ - base: Optional[str] = None + base: str """ The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. """ - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """The contents of the pull request.""" - maintainer_can_modify: Optional[bool] = None + maintainer_can_modify: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether maintainers can modify the pull request.""" - draft: Optional[bool] = None + draft: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether the pull request is a draft.""" @@ -920,20 +1074,23 @@ class PullRequestMergeRequest: Definition: PullRequestMergeRequest """ - commit_title: Optional[str] = field( + commit_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "commitTitle"}, ) """Title for the automatic commit message.""" - commit_message: Optional[str] = field( + commit_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "commitMessage"}, ) """Extra detail to append to automatic commit message.""" - sha: Optional[str] = None + sha: Optional[str] = dataclass_field(default=None, kw_only=True) """SHA that pull request head must match to allow merge.""" - merge_method: Optional[str] = field( + merge_method: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mergeMethod"}, ) """ @@ -948,19 +1105,19 @@ class PullRequestUpdateRequest: Definition: PullRequestUpdateRequest """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the pull request.""" - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """The contents of the pull request.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """State of this Pull Request. Either `open` or `closed`.""" - base: Optional[str] = None + base: Optional[str] = dataclass_field(default=None, kw_only=True) """ The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. """ - maintainer_can_modify: Optional[bool] = None + maintainer_can_modify: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether maintainers can modify the pull request.""" @@ -970,19 +1127,19 @@ class Label: Definition: Label """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The Unique Identifier for the label.""" - node_id: Optional[str] = None + node_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The Node ID for the label.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """URL for the label""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the label.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """A brief description of this label.""" - color: Optional[str] = None + color: Optional[str] = dataclass_field(default=None, kw_only=True) """6-character hex code, without the leading #, identifying the color""" - default: Optional[bool] = None + default: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether or not this is a default label.""" @@ -992,29 +1149,29 @@ class TeamDetails: Definition: TeamDetails """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique identifier of the team.""" - node_id: Optional[str] = None + node_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The Node ID for the team.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """URL for the team.""" - members_url: Optional[str] = None + members_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The HTTP URL for the team members.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the team""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the team""" - permission: Optional[str] = None + permission: Optional[str] = dataclass_field(default=None, kw_only=True) """Permission that the team will have for its repositories""" - privacy: Optional[str] = None + privacy: Optional[str] = dataclass_field(default=None, kw_only=True) """The level of privacy this team should have""" - html_url: Optional[str] = None + html_url: Optional[str] = dataclass_field(default=None, kw_only=True) """HTML Url of the team.""" - repositories_url: Optional[str] = None + repositories_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The HTTP URL for this team's repositories.""" - slug: Optional[str] = None + slug: Optional[str] = dataclass_field(default=None, kw_only=True) """The slug corresponding to the team.""" - ldap_dn: Optional[str] = None + ldap_dn: Optional[str] = dataclass_field(default=None, kw_only=True) """Distinguished Name (DN) that team maps to within LDAP environment""" @@ -1024,7 +1181,7 @@ class Link: Definition: Link """ - href: Optional[str] = None + href: str @dataclass @@ -1033,11 +1190,16 @@ class WebhookPullRequestResponse: Definition: WebhookPullRequestResponse """ - action: Optional[str] = None + action: Optional[str] = dataclass_field(default=None, kw_only=True) """The action that was performed.""" - number: Optional[int] = None + number: Optional[int] = dataclass_field(default=None, kw_only=True) """The pull request number.""" - pull_request: Optional[PullRequest] = None + pull_request: Optional[ + PullRequest | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1046,13 +1208,13 @@ class WebhookRequestBody: Definition: WebhookRequestBody """ - active: Optional[bool] = None + active: bool """State of the Trigger, always set to true""" - name: Optional[str] = None + name: str """Name of the trigger""" - config: Optional[Dict[str, Any]] = None + config: Dict[str, Any] """Configuration of the Trigger""" - events: Optional[List[str]] = None + events: List[str] """Webhook events to listen on""" @@ -1062,8 +1224,8 @@ class RequestReviewersBody: Definition: RequestReviewersBody """ - reviewers: Optional[List[str]] = None - team_reviewers: Optional[List[str]] = None + reviewers: Optional[List[str]] = dataclass_field(default=None, kw_only=True) + team_reviewers: Optional[List[str]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1072,12 +1234,12 @@ class QueryRequest: Definition: QueryRequest """ - jsonrpc: Optional[str] = None - id: Optional[str] = None - method: Optional[str] = None - params: Optional[Dict[str, Any]] = None - result: Optional[Dict[str, Any]] = None - error: Optional[Dict[str, Any]] = None + jsonrpc: Optional[str] = dataclass_field(default=None, kw_only=True) + id: Optional[str] = dataclass_field(default=None, kw_only=True) + method: Optional[str] = dataclass_field(default=None, kw_only=True) + params: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + result: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + error: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) # Client Class @@ -1091,7 +1253,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1108,8 +1270,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1130,7 +1292,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1145,9 +1307,86 @@ def __init__( def connector_name(self) -> str: return "github" - async def create_issue_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def create_issue( self, - input: IssueBasicDetailsModel, + input: IssueBasicDetailsModel | Mapping[str, Any], repository_owner: str, repository_name: str, *, @@ -1160,6 +1399,24 @@ async def create_issue_async( Create an issue This operation is used to create a new issue for a specific repository. + + Swagger operation ID: `CreateIssue`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1169,7 +1426,7 @@ async def create_issue_async( f"/issues" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1183,6 +1440,7 @@ async def create_issue_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1190,10 +1448,11 @@ async def create_issue_async( return json.loads(response.text) - async def get_issues_async( + def list_issues( self, repository_owner: str, repository_name: str, + *, milestone: Optional[str] = None, state: Optional[str] = None, assignee: Optional[str] = None, @@ -1205,16 +1464,45 @@ async def get_issues_async( since: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all issues of a repository Get all issues of a repository. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetIssues`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + milestone: Filter by milestone. + state: Filter by state. + assignee: Filter by assignee. + creator: Filter by creator. + mentioned: Filter by mentions. + labels: Filter by label names. + sort: Field to sort results by. + direction: Direction of sort. + since: Filter by issues after given date. + per_page: Number of results per page. + page: Page number to display. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1281,29 +1569,50 @@ async def get_issues_async( query_params.append(f"page={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_repository_public_key_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_repository_public_key( self, repository_owner: str, repository_name: str, @@ -1318,6 +1627,22 @@ async def get_repository_public_key_async( Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. + + Swagger operation ID: `GetRepositoryPublicKey`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1329,7 +1654,7 @@ async def get_repository_public_key_async( f"/public-key" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1343,6 +1668,7 @@ async def get_repository_public_key_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1350,9 +1676,9 @@ async def get_repository_public_key_async( return json.loads(response.text) - async def create_update_repository_secret_async( + async def create_update_repository_secret( self, - input: CreateRepositorySecretRequest, + input: CreateRepositorySecretRequest | Mapping[str, Any], repository_owner: str, repository_name: str, secret_name: str, @@ -1367,6 +1693,25 @@ async def create_update_repository_secret_async( Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium. + + Swagger operation ID: `CreateUpdateRepositorySecret`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + secret_name: Name of the secret. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1378,7 +1723,7 @@ async def create_update_repository_secret_async( f"/{quote(str(secret_name), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1392,11 +1737,12 @@ async def create_update_repository_secret_async( request_url, response.status, response.text, + response=response, ) - async def create_repository_using_template_async( + async def create_repository_using_template( self, - input: CreateRepositoryUsingTemplateRequest, + input: CreateRepositoryUsingTemplateRequest | Mapping[str, Any], template_owner: str, template_repository: str, *, @@ -1411,6 +1757,24 @@ async def create_repository_using_template_async( Creates a new repository using a repository template. The authenticated user must own or be a member of an organization that owns the repository. + + Swagger operation ID: `CreateRepositoryUsingTemplate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + template_owner: Name of the template repository owner. + template_repository: Name of the template repository. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1420,7 +1784,7 @@ async def create_repository_using_template_async( f"/generate" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1434,6 +1798,7 @@ async def create_repository_using_template_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1441,7 +1806,7 @@ async def create_repository_using_template_async( return json.loads(response.text) - async def get_repository_by_id_async( + async def get_repository_by_id( self, repository_id: int, *, @@ -1454,13 +1819,28 @@ async def get_repository_by_id_async( Get a repository by Id Gets a repository by Id. + + Swagger operation ID: `GetRepositoryById`. + + Args: + repository_id: Unique Identifier of the repository. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/repositories/{quote(str(repository_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1474,6 +1854,7 @@ async def get_repository_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1481,9 +1862,9 @@ async def get_repository_by_id_async( return json.loads(response.text) - async def create_reference_async( + async def create_reference( self, - input: CreateReferenceRequest, + input: CreateReferenceRequest | Mapping[str, Any], repository_owner: str, repository_name: str, *, @@ -1498,6 +1879,24 @@ async def create_reference_async( Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. + + Swagger operation ID: `CreateReference`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1508,7 +1907,7 @@ async def create_reference_async( f"/refs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1522,6 +1921,7 @@ async def create_reference_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1529,7 +1929,7 @@ async def create_reference_async( return json.loads(response.text) - async def get_reference_async( + async def get_reference( self, repository_owner: str, repository_name: str, @@ -1547,6 +1947,24 @@ async def get_reference_async( parameter must be formatted as `heads/` for branches and `tags/` for tags. If the `reference` doesn't match an existing ref, a `404` is returned. + + Swagger operation ID: `GetReference`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + reference: The ref in the URL must be formatted as heads/ for branches and tags/ for tags. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1558,7 +1976,7 @@ async def get_reference_async( f"/{quote(str(reference), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1572,6 +1990,7 @@ async def get_reference_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1579,9 +1998,9 @@ async def get_reference_async( return json.loads(response.text) - async def merge_pull_request_async( + async def merge_pull_request( self, - input: PullRequestMergeRequest, + input: PullRequestMergeRequest | Mapping[str, Any], repository_owner: str, repository_name: str, pull_number: int, @@ -1595,6 +2014,25 @@ async def merge_pull_request_async( Merge a pull request This operation is used to merge a pull request for the repository. + + Swagger operation ID: `MergePullRequest`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + pull_number: Pull Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1606,7 +2044,7 @@ async def merge_pull_request_async( f"/merge" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1620,6 +2058,7 @@ async def merge_pull_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1627,7 +2066,7 @@ async def merge_pull_request_async( return json.loads(response.text) - async def get_pull_request_async( + async def get_pull_request( self, repository_owner: str, repository_name: str, @@ -1642,6 +2081,23 @@ async def get_pull_request_async( Get a pull request This operation is used to get a pull request for the repository. + + Swagger operation ID: `GetPullRequest`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + pull_number: Pull Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1652,7 +2108,7 @@ async def get_pull_request_async( f"/{quote(str(pull_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1666,6 +2122,7 @@ async def get_pull_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1673,9 +2130,9 @@ async def get_pull_request_async( return json.loads(response.text) - async def update_pull_request_async( + async def update_pull_request( self, - input: PullRequestUpdateRequest, + input: PullRequestUpdateRequest | Mapping[str, Any], repository_owner: str, repository_name: str, pull_number: int, @@ -1693,6 +2150,25 @@ async def update_pull_request_async( access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + + Swagger operation ID: `UpdatePullRequest`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + pull_number: Pull Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1703,7 +2179,7 @@ async def update_pull_request_async( f"/{quote(str(pull_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1717,6 +2193,7 @@ async def update_pull_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1724,7 +2201,7 @@ async def update_pull_request_async( return json.loads(response.text) - async def get_pull_request_files_async( + def list_pull_request_files( self, repository_owner: str, repository_name: str, @@ -1734,12 +2211,32 @@ async def get_pull_request_files_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get the list of files from a pull request This operation is used to get the list of files from a pull request for the repository. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetPullRequestFiles`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + pull_number: Pull Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1750,31 +2247,52 @@ async def get_pull_request_files_async( f"/{quote(str(pull_number), safe='')}" f"/files" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def request_reviewers_pull_request_async( + return AsyncItemPaged(get_next, extract_data) + + async def request_reviewers_pull_request( self, - input: RequestReviewersBody, + input: RequestReviewersBody | Mapping[str, Any], repository_owner: str, repository_name: str, pull_number: int, @@ -1789,6 +2307,25 @@ async def request_reviewers_pull_request_async( Requests reviews for a pull request from a given set of users and/or teams. + + Swagger operation ID: `RequestReviewersPullRequest`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + pull_number: Pull Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1800,7 +2337,7 @@ async def request_reviewers_pull_request_async( f"/requested_reviewers" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1814,11 +2351,12 @@ async def request_reviewers_pull_request_async( request_url, response.status, response.text, + response=response, ) - async def remove_reviewers_pull_request_async( + async def remove_reviewers_pull_request( self, - input: RequestReviewersBody, + input: RequestReviewersBody | Mapping[str, Any], repository_owner: str, repository_name: str, pull_number: int, @@ -1833,6 +2371,25 @@ async def remove_reviewers_pull_request_async( Remove requested reviewers from a pull request from a given set of users and/or teams. + + Swagger operation ID: `RemoveReviewersPullRequest`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + pull_number: Pull Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1844,7 +2401,7 @@ async def remove_reviewers_pull_request_async( f"/requested_reviewers" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=input, timeout=timeout, headers=headers, @@ -1858,11 +2415,12 @@ async def remove_reviewers_pull_request_async( request_url, response.status, response.text, + response=response, ) - async def create_pull_request_async( + async def create_pull_request( self, - input: PullRequestCreateRequest, + input: PullRequestCreateRequest | Mapping[str, Any], repository_owner: str, repository_name: str, *, @@ -1879,6 +2437,24 @@ async def create_pull_request_async( access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to create a pull request. + + Swagger operation ID: `CreatePullRequest`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1888,7 +2464,7 @@ async def create_pull_request_async( f"/pulls" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1902,6 +2478,7 @@ async def create_pull_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1909,10 +2486,11 @@ async def create_pull_request_async( return json.loads(response.text) - async def get_pull_requests_async( + def list_pull_requests( self, repository_owner: str, repository_name: str, + *, state: Optional[str] = None, head: Optional[str] = None, base: Optional[str] = None, @@ -1920,16 +2498,41 @@ async def get_pull_requests_async( direction: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all Pull Requests of A Repository Get all Pull Requests of A Repository. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetPullRequests`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + state: Filter by state. + head: Filter by head user or organization. + base: Filter by base branch name. + sort: What to sort the results by. + direction: Direction of sort. + per_page: Number of results per page. + page: Page number to display. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1976,31 +2579,52 @@ async def get_pull_requests_async( query_params.append(f"page={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def create_repository_dispatch_event_async( + async def create_repository_dispatch_event( self, - input: RepositoryDispatchEvent, + input: RepositoryDispatchEvent | Mapping[str, Any], repository_owner: str, repository_name: str, *, @@ -2017,6 +2641,24 @@ async def create_repository_dispatch_event_async( GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. + + Swagger operation ID: `CreateRepositoryDispatchEvent`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2026,7 +2668,7 @@ async def create_repository_dispatch_event_async( f"/dispatches" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2040,9 +2682,10 @@ async def create_repository_dispatch_event_async( request_url, response.status, response.text, + response=response, ) - async def compare_repository_commits_async( + async def compare_repository_commits( self, repository_owner: str, repository_name: str, @@ -2062,6 +2705,24 @@ async def compare_repository_commits_async( `repositoryName`, use the format `:branch`. The response is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. + + Swagger operation ID: `CompareRepositoryCommits`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + base: base parameter. + head: head parameter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2072,7 +2733,7 @@ async def compare_repository_commits_async( f"/{quote(str(base), safe='')}...{quote(str(head), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2086,6 +2747,7 @@ async def compare_repository_commits_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2093,7 +2755,7 @@ async def compare_repository_commits_async( return json.loads(response.text) - async def add_selected_repo_to_org_secret_async( + async def add_selected_repo_to_org_secret( self, repository_owner: str, repository_id: int, @@ -2114,6 +2776,23 @@ async def add_selected_repo_to_org_secret_async( You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + + Swagger operation ID: `AddSelectedRepoToOrgSecret`. + + Args: + repository_owner: Name of the repository owner. + repository_id: Unique Identifier of the repository. + secret_name: Name of the secret. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2126,7 +2805,7 @@ async def add_selected_repo_to_org_secret_async( f"/{quote(str(repository_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2140,9 +2819,10 @@ async def add_selected_repo_to_org_secret_async( request_url, response.status, response.text, + response=response, ) - async def remove_selected_repo_from_org_secret_async( + async def remove_selected_repo_from_org_secret( self, repository_owner: str, repository_id: int, @@ -2163,6 +2843,23 @@ async def remove_selected_repo_from_org_secret_async( You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + + Swagger operation ID: `RemoveSelectedRepoFromOrgSecret`. + + Args: + repository_owner: Name of the repository owner. + repository_id: Unique Identifier of the repository. + secret_name: Name of the secret. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2175,7 +2872,7 @@ async def remove_selected_repo_from_org_secret_async( f"/{quote(str(repository_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2189,9 +2886,10 @@ async def remove_selected_repo_from_org_secret_async( request_url, response.status, response.text, + response=response, ) - async def delete_webhook_trigger_async( + async def delete_webhook_trigger( self, repository_owner: str, repository_name: str, @@ -2206,6 +2904,23 @@ async def delete_webhook_trigger_async( Deletes a GitHub Webhook Deletes a GitHub Webhook + + Swagger operation ID: `DeleteWebhookTrigger`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + webhook_id: ID of the GitHub Webhook. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2216,7 +2931,7 @@ async def delete_webhook_trigger_async( f"/{quote(str(webhook_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2230,9 +2945,10 @@ async def delete_webhook_trigger_async( request_url, response.status, response.text, + response=response, ) - async def get_issue_num_async( + async def get_issue_num( self, repository_owner: str, repository_name: str, @@ -2247,6 +2963,23 @@ async def get_issue_num_async( Get a particular issue of a repository Get a particular issue of a repository. + + Swagger operation ID: `GetIssueNum`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + issue_number: Issue Number for a given issue. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2257,7 +2990,7 @@ async def get_issue_num_async( f"/{quote(str(issue_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2271,6 +3004,7 @@ async def get_issue_num_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2278,9 +3012,9 @@ async def get_issue_num_async( return json.loads(response.text) - async def update_issue_num_async( + async def update_issue_num( self, - input: IssueUpdateModel, + input: IssueUpdateModel | Mapping[str, Any], repository_owner: str, repository_name: str, issue_number: int, @@ -2294,6 +3028,25 @@ async def update_issue_num_async( Update an Issue Update an existing issue given the issue number. + + Swagger operation ID: `UpdateIssueNum`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + issue_number: Issue Number for a given issue. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2304,7 +3057,7 @@ async def update_issue_num_async( f"/{quote(str(issue_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -2318,6 +3071,7 @@ async def update_issue_num_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2325,9 +3079,9 @@ async def update_issue_num_async( return json.loads(response.text) - async def update_milestone_async( + async def update_milestone( self, - input: MilestoneUpdateModel, + input: MilestoneUpdateModel | Mapping[str, Any], repository_owner: str, repository_name: str, milestone_number: int, @@ -2341,6 +3095,25 @@ async def update_milestone_async( Update a milestone Update an existing milestone. + + Swagger operation ID: `UpdateMilestone`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + milestone_number: Milestone number for a given milestone. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2351,7 +3124,7 @@ async def update_milestone_async( f"/{quote(str(milestone_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -2365,6 +3138,7 @@ async def update_milestone_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2372,7 +3146,7 @@ async def update_milestone_async( return json.loads(response.text) - async def get_user_async( + async def get_user( self, *, timeout: Optional[float] = None, @@ -2384,10 +3158,24 @@ async def get_user_async( Get the authenticated user Get the authenticated user. + + Swagger operation ID: `GetUser`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/user" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2401,6 +3189,7 @@ async def get_user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2408,9 +3197,9 @@ async def get_user_async( return json.loads(response.text) - async def search_github_with_query_async( + async def search_github_with_query( self, - input: GraphQlQuery, + input: GraphQlQuery | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -2421,10 +3210,26 @@ async def search_github_with_query_async( Search Github using Query Search Github using Query + + Swagger operation ID: `SearchGithubWithQuery`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/graphql" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2438,24 +3243,46 @@ async def search_github_with_query_async( request_url, response.status, response.text, + response=response, ) - async def get_assignees_async( + def list_assignees( self, repository_owner: str, repository_name: str, + *, per_page: Optional[int] = None, page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists the available assignees for issues in a repository Lists the available assignees for issues in a repository. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAssignees`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + per_page: Number of results per page. + page: Page number to display. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2477,44 +3304,86 @@ async def get_assignees_async( query_params.append(f"page={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_collaborators_async( + def list_collaborators( self, repository_owner: str, repository_name: str, + *, per_page: Optional[int] = None, page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List repository collaborators List repository collaborators. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListCollaborators`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + per_page: Number of results per page. + page: Page number to display. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2536,29 +3405,50 @@ async def list_collaborators_async( query_params.append(f"page={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def check_collaborator_async( + return AsyncItemPaged(get_next, extract_data) + + async def check_collaborator( self, repository_owner: str, repository_name: str, @@ -2573,6 +3463,23 @@ async def check_collaborator_async( Check if a user is a repository collaborator Check if a user is a repository collaborator. + + Swagger operation ID: `checkCollaborator`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + user_name: The handle for the GitHub user account. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2583,7 +3490,7 @@ async def check_collaborator_async( f"/{quote(str(user_name), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2597,6 +3504,7 @@ async def check_collaborator_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2604,25 +3512,49 @@ async def check_collaborator_async( return json.loads(response.text) - async def get_milestones_async( + def list_milestones( self, repository_owner: str, repository_name: str, + *, state: Optional[str] = None, sort: Optional[str] = None, direction: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists all milestones of a repository Lists all milestones of a repository. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMilestones`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + state: State of the milestone. + sort: What to sort the results by. + direction: Direction of sort. + per_page: Number of results per page. + page: Page number to display. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2659,44 +3591,86 @@ async def get_milestones_async( query_params.append(f"page={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def get_labels_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_labels( self, repository_owner: str, repository_name: str, + *, per_page: Optional[int] = None, page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists all labels for a repository Lists all labels for a repository. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetLabels`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + per_page: Number of results per page. + page: Page number to display. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2718,45 +3692,88 @@ async def get_labels_async( query_params.append(f"page={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_issue_labels_async( + def list_issue_labels( self, repository_owner: str, repository_name: str, issue_number: int, + *, per_page: Optional[int] = None, page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists all labels for an issue Lists all labels for an issue. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetIssueLabels`. + + Args: + repository_owner: Name of the repository owner. + repository_name: Name of the repository. + issue_number: Issue Number for a given issue. + per_page: Number of results per page. + page: Page number to display. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2780,46 +3797,90 @@ async def get_issue_labels_async( query_params.append(f"page={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_repos_async( + return AsyncItemPaged(get_next, extract_data) + + def list_repos( self, repository_owner: str, + *, type_: Optional[str] = None, sort: Optional[str] = None, direction: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists all public repositories for a user Lists all public repositories for a user. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetRepos`. + + Args: + repository_owner: Name of the repository owner. + type_: Limit results to repositories of the specified type. + sort: The property to sort the results by. + direction: Direction of sort. + per_page: Number of results per page. + page: Page number to fetch. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2853,46 +3914,90 @@ async def get_repos_async( query_params.append(f"page={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_org_repos_async( + return AsyncItemPaged(get_next, extract_data) + + def list_org_repos( self, repository_owner: str, + *, type_: Optional[str] = None, sort: Optional[str] = None, direction: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists all public repositories for an organization Lists all public repositories for an organization. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetOrgRepos`. + + Args: + repository_owner: Name of the repository owner. + type_: Limit results to repositories of the specified type. + sort: The property to sort the results by. + direction: Direction of sort. + per_page: Number of results per page. + page: Page number to fetch. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2926,30 +4031,52 @@ async def get_org_repos_async( query_params.append(f"page={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_user_repos_async( + def list_user_repos( self, + *, visibility: Optional[str] = None, affiliation: Optional[str] = None, since: Optional[str] = None, @@ -2959,17 +4086,43 @@ async def get_user_repos_async( direction: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists all repositories for the authenticated user Lists all repositories (both public and private) for the authenticated user. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetUserRepos`. + + Args: + visibility: Limit results to repositories of the specified + visibility(public/private/all). + affiliation: Limit results based on affiliation. + since: Limit results to repositories updated after a given time. + before: Limit results to repositories updated before a given time. + type_: Limit results to repositories of the specified type. + sort: The property to sort the results by. + direction: Direction of sort. + per_page: Number of results per page. + page: Page number to fetch. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/user/repos" query_params = [] @@ -3020,45 +4173,88 @@ async def get_user_repos_async( query_params.append(f"page={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def search_issues_async( + return AsyncItemPaged(get_next, extract_data) + + def list_search_issues( self, q: str, + *, sort: Optional[str] = None, order: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Find issues by state and keyword Find issues by state and keyword. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SearchIssues`. + + Args: + q: Search keywords and qualifiers. + sort: The property to sort the results by. + order: Direction of sort. + per_page: Number of results per page. + page: Page number to fetch. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/search/issues" query_params = [] @@ -3088,31 +4284,52 @@ async def search_issues_async( query_params.append(f"page={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("body", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def invoke_mcp_server_async( + async def invoke_mcp_server( self, - input: QueryRequest, + input: QueryRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -3123,10 +4340,26 @@ async def invoke_mcp_server_async( Github MCP Server Github MCP Server + + Swagger operation ID: `InvokeMCPServer`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/mcp" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3140,6 +4373,7 @@ async def invoke_mcp_server_async( request_url, response.status, response.text, + response=response, ) diff --git a/src/azure/connectors/googlecalendar.py b/src/azure/connectors/googlecalendar.py index 424473da..c5468177 100644 --- a/src/azure/connectors/googlecalendar.py +++ b/src/azure/connectors/googlecalendar.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,23 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "GooglecalendarClient", + "CalendarEventChangedList", + "CalendarEventList", + "CalendarList", + "CalendarListEntry", + "ObjectEntity", + "PatchEvent", + "RequestEvent", + "ResponseEvent", + "ResponseEventWithActionType", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +45,12 @@ class CalendarList: Response for List calendars """ - items: Optional[List[CalendarListEntry]] = None + items: Optional[ + List[CalendarListEntry | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Calendars in the list.""" @@ -39,7 +60,12 @@ class CalendarEventList: Response for List the events on a calendar """ - items: Optional[List[ResponseEvent]] = None + items: Optional[ + List[ResponseEvent | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Events in the calendar.""" @@ -49,40 +75,42 @@ class ResponseEvent: Response for Create an event """ - summary: Optional[str] = None + summary: Optional[str] = dataclass_field(default=None, kw_only=True) """A summary of the event.""" - start: Optional[str] = None + start: Optional[str] = dataclass_field(default=None, kw_only=True) """The (inclusive) start time of the event.""" - end: Optional[str] = None + end: Optional[str] = dataclass_field(default=None, kw_only=True) """The (exclusive) end time of the event.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the event.""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """Geographic location of the event as free-form text.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Status of the event. Possible values are \"confirmed\", \"tentative\", or \"cancelled\". """ - html_link: Optional[str] = field( + html_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "htmlLink"}, ) """Unique ID of the list.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Opaque identifier of the event.""" - attendees: Optional[str] = None + attendees: Optional[str] = dataclass_field(default=None, kw_only=True) """The event's attendees.""" - creator: Optional[str] = None + creator: Optional[str] = dataclass_field(default=None, kw_only=True) """The creator of the event.""" - organizer: Optional[str] = None + organizer: Optional[str] = dataclass_field(default=None, kw_only=True) """The organizer of the event.""" - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """Creation time of the event.""" - updated: Optional[str] = None + updated: Optional[str] = dataclass_field(default=None, kw_only=True) """Last modification time of the event.""" - end_time_unspecified: Optional[bool] = field( + end_time_unspecified: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endTimeUnspecified"}, ) """ @@ -97,7 +125,7 @@ class ObjectEntity: Response for Delete an event """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -110,7 +138,12 @@ class CalendarEventChangedList: Response for When an event is added, updated or deleted from a calendar """ - items: Optional[List[ResponseEventWithActionType]] = None + items: Optional[ + List[ResponseEventWithActionType | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Changed events in the calendar.""" @@ -120,16 +153,17 @@ class CalendarListEntry: Definition: CalendarListEntry """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Identifier of the calendar.""" - summary: Optional[str] = None + summary: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the calendar.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the calendar.""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """Geographic location of the calendar as free-form text.""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timeZone"}, ) """The time zone of the calendar.""" @@ -141,25 +175,26 @@ class RequestEvent: Definition: RequestEvent """ - summary: Optional[str] = None + summary: Optional[str] = dataclass_field(default=None, kw_only=True) """A summary of the event.""" - start: Optional[str] = None + start: str """The (inclusive) start time of the event.""" - end: Optional[str] = None + end: str """The (exclusive) end time of the event.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the event.""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """Geographic location of the event as free-form text.""" - attendees: Optional[str] = None + attendees: Optional[str] = dataclass_field(default=None, kw_only=True) """Enter a comma-separated list of attendee emails.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Status of the event. Possible values are \"confirmed\", \"tentative\", or \"cancelled\". """ - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAllDay"}, ) """Is all-day event?""" @@ -171,25 +206,26 @@ class PatchEvent: Definition: PatchEvent """ - summary: Optional[str] = None + summary: Optional[str] = dataclass_field(default=None, kw_only=True) """A summary of the event.""" - start: Optional[str] = None + start: Optional[str] = dataclass_field(default=None, kw_only=True) """The (inclusive) start time of the event.""" - end: Optional[str] = None + end: Optional[str] = dataclass_field(default=None, kw_only=True) """The (exclusive) end time of the event.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the event.""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """Geographic location of the event as free-form text.""" - attendees: Optional[str] = None + attendees: Optional[str] = dataclass_field(default=None, kw_only=True) """Enter a comma-separated list of attendee emails.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Status of the event. Possible values are \"confirmed\", \"tentative\", or \"cancelled. """ - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAllDay"}, ) """Is all-day event?""" @@ -201,45 +237,48 @@ class ResponseEventWithActionType: Definition: ResponseEventWithActionType """ - action_type: Optional[str] = field( + action_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actionType"}, ) """Type of action which changed the event in change trigger.""" - summary: Optional[str] = None + summary: Optional[str] = dataclass_field(default=None, kw_only=True) """A summary of the event.""" - start: Optional[str] = None + start: Optional[str] = dataclass_field(default=None, kw_only=True) """The (inclusive) start time of the event.""" - end: Optional[str] = None + end: Optional[str] = dataclass_field(default=None, kw_only=True) """The (exclusive) end time of the event.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the event.""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """Geographic location of the event as free-form text.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Status of the event. Possible values are \"confirmed\", \"tentative\", or \"cancelled\". """ - html_link: Optional[str] = field( + html_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "htmlLink"}, ) """Unique ID of the list.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Opaque identifier of the event.""" - attendees: Optional[str] = None + attendees: Optional[str] = dataclass_field(default=None, kw_only=True) """The event's attendees.""" - creator: Optional[str] = None + creator: Optional[str] = dataclass_field(default=None, kw_only=True) """The creator of the event.""" - organizer: Optional[str] = None + organizer: Optional[str] = dataclass_field(default=None, kw_only=True) """The organizer of the event.""" - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """Creation time of the event.""" - updated: Optional[str] = None + updated: Optional[str] = dataclass_field(default=None, kw_only=True) """Last modification time of the event.""" - end_time_unspecified: Optional[bool] = field( + end_time_unspecified: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endTimeUnspecified"}, ) """ @@ -259,7 +298,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -276,8 +315,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -298,7 +337,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -313,19 +352,115 @@ def __init__( def connector_name(self) -> str: return "googlecalendar" - async def list_calendars_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_calendars( self, - min_access_role: Optional[str] = None, *, + min_access_role: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List calendars This operation is used to list all calendars in your Google account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListCalendars`. + + Args: + min_access_role: The minimum access role users must have to view + calendars. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/users/me/calendarList" query_params = [] @@ -336,45 +471,90 @@ async def list_calendars_async( query_params.append(f"minAccessRole={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_events_async( + def list_events( self, calendar_id: str, + *, time_min: Optional[str] = None, time_max: Optional[str] = None, q: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List the events on a calendar This operation is used to return the first page of arbitrarily ordered events on the selected calendar. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListEvents`. + + Args: + calendar_id: Unique ID of the calendar to fetch events from. + time_min: Time format: yyyy-MM-ddTHH:mm:ss.fffZ + (2016-07-20T08:00:00.000Z). + time_max: Time format: yyyy-MM-ddTHH:mm:ss.fffZ + (2016-07-20T09:00:59.000Z). + q: Text search terms to find events that match these terms in any + fields. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -398,31 +578,52 @@ async def list_events_async( query_params.append(f"q={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def create_event_async( + async def create_event( self, - input: RequestEvent, + input: RequestEvent | Mapping[str, Any], calendar_id: str, *, timeout: Optional[float] = None, @@ -434,13 +635,30 @@ async def create_event_async( Create an event This operation is used to create an event on a specific calendar. + + Swagger operation ID: `CreateEvent`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + calendar_id: Unique ID of the calendar to fetch events from. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/calendars/{quote(str(calendar_id), safe='')}/events" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -454,6 +672,7 @@ async def create_event_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -461,7 +680,7 @@ async def create_event_async( return json.loads(response.text) - async def get_event_async( + async def get_event( self, calendar_id: str, event_id: str, @@ -476,6 +695,22 @@ async def get_event_async( This operation is used to get the details of a specific event from a calendar. + + Swagger operation ID: `GetEvent`. + + Args: + calendar_id: Unique ID of the calendar to fetch events from. + event_id: Unique ID of the event to get. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -485,7 +720,7 @@ async def get_event_async( f"/{quote(str(event_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -499,6 +734,7 @@ async def get_event_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -506,7 +742,7 @@ async def get_event_async( return json.loads(response.text) - async def delete_event_async( + async def delete_event( self, calendar_id: str, event_id: str, @@ -520,6 +756,22 @@ async def delete_event_async( Delete an event This operation is used to delete an event from a calendar. + + Swagger operation ID: `DeleteEvent`. + + Args: + calendar_id: Unique ID of the calendar to fetch events from. + event_id: Unique ID of the event to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -529,7 +781,7 @@ async def delete_event_async( f"/{quote(str(event_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -543,6 +795,7 @@ async def delete_event_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -550,9 +803,9 @@ async def delete_event_async( return json.loads(response.text) - async def update_event_async( + async def update_event( self, - input: PatchEvent, + input: PatchEvent | Mapping[str, Any], calendar_id: str, event_id: str, *, @@ -565,6 +818,24 @@ async def update_event_async( Update an event This operation is used to update an existing event on a calendar. + + Swagger operation ID: `UpdateEvent`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + calendar_id: Unique ID of the calendar to fetch events from. + event_id: Unique ID of the event to get. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -574,7 +845,7 @@ async def update_event_async( f"/{quote(str(event_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -588,6 +859,7 @@ async def update_event_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -595,46 +867,84 @@ async def update_event_async( return json.loads(response.text) - async def list_writable_calendars_async( + def list_writable_calendars( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List writable calendars This operation is used to list all calendars in your Google account that you can write to. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListWritableCalendars`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/users/me/calendarList/1" query_params = [] query_params.append("minAccessRole=" + quote("writer", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/googledrive.py b/src/azure/connectors/googledrive.py index 37a99dfc..2eac943d 100644 --- a/src/azure/connectors/googledrive.py +++ b/src/azure/connectors/googledrive.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,31 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "GoogledriveClient", + "BlobDataSetsMetadata", + "BlobMetadata", + "DataSet", + "DataSetsList", + "DataSetsMetadata", + "Item", + "ItemsList", + "ObjectEntity", + "PassThroughNativeQuery", + "Procedure", + "Table", + "TableCapabilitiesMetadata", + "TableFilterRestrictionsMetadata", + "TableMetadata", + "TableSelectRestrictionsMetadata", + "TableSortRestrictionsMetadata", + "TablesList", + "TabularDataSetsMetadata", +] + # Type Definitions @@ -29,56 +53,84 @@ class BlobMetadata: Response for Get file metadata using id """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - folder_id: Optional[str] = field( + folder_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FolderId"}, ) """The unique id of the parent folder of the file or folder.""" - folder_path: Optional[str] = field( + folder_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FolderPath"}, ) """The current path of the parent folder of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" - last_modified_by: Optional[str] = field( + last_modified_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModifiedBy"}, ) """The user who last modified the file or folder.""" @@ -90,8 +142,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -100,25 +162,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -130,15 +196,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -150,7 +218,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -163,26 +231,30 @@ class TableMetadata: Definition: TableMetadata """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Table name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Table title""" - x_ms_permission: Optional[str] = field( + x_ms_permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-permission"}, ) """Table permission""" - x_ms_capabilities: Optional[TableCapabilitiesMetadata] = field( + x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-capabilities"}, ) - schema: Optional[ObjectEntity] = None - referenced_entities: Optional[ObjectEntity] = field( + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referencedEntities"}, ) - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """Url link""" @@ -194,30 +266,42 @@ class TableCapabilitiesMetadata: Definition: TableCapabilitiesMetadata """ - sort_restrictions: Optional[TableSortRestrictionsMetadata] = field( + sort_restrictions: Optional[ + TableSortRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortRestrictions"}, ) - filter_restrictions: Optional[TableFilterRestrictionsMetadata] = field( + filter_restrictions: Optional[ + TableFilterRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterRestrictions"}, ) - select_restrictions: Optional[TableSelectRestrictionsMetadata] = field( + select_restrictions: Optional[ + TableSelectRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectRestrictions"}, ) - is_only_server_pagable: Optional[bool] = field( + is_only_server_pagable: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOnlyServerPagable"}, ) """Server paging restrictions""" - filter_function_support: Optional[List[str]] = field( + filter_function_support: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterFunctionSupport"}, ) """List of supported filter capabilities""" - server_paging_options: Optional[List[str]] = field( + server_paging_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serverPagingOptions"}, ) """List of supported server-driven paging capabilities""" @@ -229,15 +313,17 @@ class TableSortRestrictionsMetadata: Definition: TableSortRestrictionsMetadata """ - sortable: Optional[bool] = None + sortable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has sortable columns""" - unsortable_properties: Optional[List[str]] = field( + unsortable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unsortableProperties"}, ) """List of unsortable properties""" - ascending_only_properties: Optional[List[str]] = field( + ascending_only_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ascendingOnlyProperties"}, ) """List of properties which support ascending order only""" @@ -249,15 +335,17 @@ class TableFilterRestrictionsMetadata: Definition: TableFilterRestrictionsMetadata """ - filterable: Optional[bool] = None + filterable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has filterable columns""" - non_filterable_properties: Optional[List[str]] = field( + non_filterable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nonFilterableProperties"}, ) """List of non filterable properties""" - required_properties: Optional[List[str]] = field( + required_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredProperties"}, ) """List of required properties""" @@ -269,7 +357,7 @@ class TableSelectRestrictionsMetadata: Definition: TableSelectRestrictionsMetadata """ - selectable: Optional[bool] = None + selectable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has selectable columns""" @@ -279,7 +367,12 @@ class TablesList: Definition: TablesList """ - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Tables""" @@ -289,15 +382,21 @@ class Table: Definition: Table """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the table. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the table.""" - dynamic_properties: Optional[Dict[str, str]] = field( + dynamic_properties: Optional[Dict[str, str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """Additional table properties provided by the connector to the clients.""" @@ -309,8 +408,9 @@ class Item: Definition: Item """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -321,7 +421,12 @@ class ItemsList: Definition: ItemsList """ - value: Optional[List[Item]] = None + value: Optional[ + List[Item | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items""" @@ -331,7 +436,12 @@ class DataSetsList: Definition: DataSetsList """ - value: Optional[List[DataSet]] = None + value: Optional[ + List[DataSet | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of datasets""" @@ -341,14 +451,24 @@ class DataSet: Definition: DataSet """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Dataset name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Dataset display name""" - query: Optional[List[PassThroughNativeQuery]] = None + query: Optional[ + List[PassThroughNativeQuery | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Pass-through Native Queries""" @@ -358,10 +478,15 @@ class Procedure: Definition: Procedure """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Procedure name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Procedure display name""" @@ -373,8 +498,9 @@ class PassThroughNativeQuery: Definition: PassThroughNativeQuery """ - language: Optional[str] = field( + language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Language"}, ) """Query language""" @@ -391,7 +517,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -408,8 +534,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -430,7 +556,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -445,7 +571,84 @@ def __init__( def connector_name(self) -> str: return "googledrive" - async def get_file_metadata_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def get_file_metadata( self, id: str, *, @@ -458,6 +661,21 @@ async def get_file_metadata_async( Get file metadata using id Retrieves file metadata from Google Drive using id + + Swagger operation ID: `GetFileMetadata`. + + Args: + id: Specify the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -467,7 +685,7 @@ async def get_file_metadata_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -481,6 +699,7 @@ async def get_file_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -488,7 +707,7 @@ async def get_file_metadata_async( return json.loads(response.text) - async def update_file_async( + async def update_file( self, input: bytes, id: str, @@ -502,6 +721,22 @@ async def update_file_async( Update file Updates a file in Google Drive + + Swagger operation ID: `UpdateFile`. + + Args: + input: The binary request body. + id: Specify the file to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -511,7 +746,7 @@ async def update_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, @@ -528,6 +763,7 @@ async def update_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -535,7 +771,7 @@ async def update_file_async( return json.loads(response.text) - async def delete_file_async( + async def delete_file( self, id: str, *, @@ -548,6 +784,21 @@ async def delete_file_async( Delete file Deletes a file from Google Drive + + Swagger operation ID: `DeleteFile`. + + Args: + id: Specify the file to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -557,7 +808,7 @@ async def delete_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -571,9 +822,10 @@ async def delete_file_async( request_url, response.status, response.text, + response=response, ) - async def get_file_metadata_by_path_async( + async def get_file_metadata_by_path( self, path: str, *, @@ -586,6 +838,21 @@ async def get_file_metadata_by_path_async( Get file metadata using path Retrieves file metadata from Google Drive using path + + Swagger operation ID: `GetFileMetadataByPath`. + + Args: + path: Path of the file in Google Drive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/GetFileByPath" @@ -599,7 +866,7 @@ async def get_file_metadata_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -613,6 +880,7 @@ async def get_file_metadata_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -620,11 +888,11 @@ async def get_file_metadata_by_path_async( return json.loads(response.text) - async def get_file_content_by_path_async( + async def get_file_content_by_path( self, path: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -634,6 +902,22 @@ async def get_file_content_by_path_async( Get file content using path Retrieves file content from Google Drive using path + + Swagger operation ID: `GetFileContentByPath`. + + Args: + path: Path of the file in Google Drive. + infer_content_type: Infer content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -653,7 +937,7 @@ async def get_file_content_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -667,15 +951,16 @@ async def get_file_content_by_path_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_file_content_async( + async def get_file_content( self, id: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -685,6 +970,22 @@ async def get_file_content_async( Get file content using id Retrieves file content from Google Drive using id + + Swagger operation ID: `GetFileContent`. + + Args: + id: Unique identifier of the file to retrieve in Google Drive. + infer_content_type: Infer content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -703,7 +1004,7 @@ async def get_file_content_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -717,16 +1018,17 @@ async def get_file_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def copy_file_async( + async def copy_file( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -736,6 +1038,24 @@ async def copy_file_async( Copy file Copies a file on Google Drive + + Swagger operation ID: `CopyFile`. + + Args: + source: Url to source file. + destination: Destination file path in Google Drive, including + target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/copyFile" @@ -758,7 +1078,7 @@ async def copy_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -772,6 +1092,7 @@ async def copy_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -779,7 +1100,7 @@ async def copy_file_async( return json.loads(response.text) - async def list_folder_async( + def list_folder( self, id: str, *, @@ -787,11 +1108,29 @@ async def list_folder_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files in folder List files in a Google Drive folder + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListFolder`. + + Args: + id: Specify the folder in Google Drive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -800,67 +1139,126 @@ async def list_folder_async( f"/folders" f"/{quote(quote(str(id), safe=''), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def list_root_folder_async( + return AsyncItemPaged(get_next, extract_data) + + def list_root_folder( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files in root folder Lists files in the Google Drive root folder + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRootFolder`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/folders" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def create_file_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_file( self, input: bytes, folder_id: str, @@ -875,6 +1273,23 @@ async def create_file_async( Create file Uploads a file to a Google Drive folder selected by its identifier + + Swagger operation ID: `CreateFileV2`. + + Args: + input: The binary request body. + folder_id: Folder to upload the file to Google Drive. + name: Name of the file to create in Google Drive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/v2/files" @@ -892,7 +1307,7 @@ async def create_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -909,6 +1324,7 @@ async def create_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -916,12 +1332,12 @@ async def create_file_async( return json.loads(response.text) - async def extract_folder_async( + async def extract_folder( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -931,6 +1347,23 @@ async def extract_folder_async( Extract archive to folder Extracts an archive file into a folder in Google Drive (example: .zip) + + Swagger operation ID: `ExtractFolderV2`. + + Args: + source: Path to the archive file. + destination: Path in Google Drive to extract the archive contents. + overwrite: Overwrites the destination files if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/extractFolderV2" @@ -953,7 +1386,7 @@ async def extract_folder_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -967,6 +1400,7 @@ async def extract_folder_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/googletasks.py b/src/azure/connectors/googletasks.py index 9037a955..02d346a8 100644 --- a/src/azure/connectors/googletasks.py +++ b/src/azure/connectors/googletasks.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,20 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "GoogletasksClient", + "TaskCreate", + "TaskList", + "TaskListCreate", + "TaskListEntry", + "TaskListList", + "TaskObject", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +42,12 @@ class TaskListList: Response for List task lists """ - items: Optional[List[TaskListEntry]] = None + items: Optional[ + List[TaskListEntry | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Task lists in the lists.""" @@ -39,16 +57,17 @@ class TaskListEntry: Response for Create a task list """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier of the task list.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the task list.""" - self_link: Optional[str] = field( + self_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selfLink"}, ) """A link to this task list.""" - updated: Optional[str] = None + updated: Optional[str] = dataclass_field(default=None, kw_only=True) """The time the task list was last updated.""" @@ -58,7 +77,12 @@ class TaskList: Response for Lists the tasks for a task list """ - items: Optional[List[TaskObject]] = None + items: Optional[ + List[TaskObject | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The tasks in the list.""" @@ -68,28 +92,29 @@ class TaskObject: Response for Create a task in a task list """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier of the task.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the task.""" - updated: Optional[str] = None + updated: Optional[str] = dataclass_field(default=None, kw_only=True) """The last time the task was updated.""" - self_link: Optional[str] = field( + self_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selfLink"}, ) """A link to the task.""" - parent: Optional[str] = None + parent: Optional[str] = dataclass_field(default=None, kw_only=True) """The parent of the task.""" - position: Optional[str] = None + position: Optional[str] = dataclass_field(default=None, kw_only=True) """The position of the task.""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """The notes for the task.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status of the task.""" - due: Optional[str] = None + due: Optional[str] = dataclass_field(default=None, kw_only=True) """The datetime the task is due.""" - completed: Optional[str] = None + completed: Optional[str] = dataclass_field(default=None, kw_only=True) """The datetime the task was completed.""" @@ -99,7 +124,7 @@ class TaskListCreate: Definition: TaskListCreate """ - title: Optional[str] = None + title: str """The title of the task list.""" @@ -109,11 +134,11 @@ class TaskCreate: Definition: TaskCreate """ - title: Optional[str] = None + title: str """The title of the task.""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """The notes for the task.""" - due: Optional[str] = None + due: Optional[str] = dataclass_field(default=None, kw_only=True) """The datetime the task is due.""" @@ -128,7 +153,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -145,8 +170,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -167,7 +192,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -182,45 +207,160 @@ def __init__( def connector_name(self) -> str: return "googletasks" - async def list_task_lists_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_task_lists( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List task lists List all task lists. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListTaskLists`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/users/@me/lists" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item - async def create_task_list_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_task_list( self, - input: TaskListCreate, + input: TaskListCreate | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -231,10 +371,26 @@ async def create_task_list_async( Create a task list Creates a new task list. + + Swagger operation ID: `CreateTaskList`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/users/@me/lists" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -248,6 +404,7 @@ async def create_task_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -255,7 +412,7 @@ async def create_task_list_async( return json.loads(response.text) - async def list_tasks_async( + def list_tasks( self, task_list_id: str, *, @@ -263,41 +420,80 @@ async def list_tasks_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists the tasks for a task list Lists the tasks for a specific task list. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListTasks`. + + Args: + task_list_id: The id of the task list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/lists/{quote(str(task_list_id), safe='')}/tasks" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item - async def create_task_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_task( self, - input: TaskCreate, + input: TaskCreate | Mapping[str, Any], task_list_id: str, *, timeout: Optional[float] = None, @@ -309,13 +505,30 @@ async def create_task_async( Create a task in a task list Create a task in a specific task list. + + Swagger operation ID: `CreateTask`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + task_list_id: The id of the task list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/lists/{quote(str(task_list_id), safe='')}/tasks" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -329,6 +542,7 @@ async def create_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -336,7 +550,7 @@ async def create_task_async( return json.loads(response.text) - async def list_task_async( + async def list_task( self, task_list_id: str, task_id: str, @@ -350,6 +564,22 @@ async def list_task_async( Get a task from a task list Get specific task from the specified task list. + + Swagger operation ID: `ListTask`. + + Args: + task_list_id: The id of the task list. + task_id: The id of the task. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -359,7 +589,7 @@ async def list_task_async( f"/{quote(str(task_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -373,6 +603,7 @@ async def list_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/impexium.py b/src/azure/connectors/impexium.py index c0fafcac..0aa82986 100644 --- a/src/azure/connectors/impexium.py +++ b/src/azure/connectors/impexium.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,167 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "ImpexiumClient", + "AbandonedCheckoutData", + "ActivityData", + "AddActivityInput", + "AddCategoriesForAnIndividualInput", + "AddCategoriesForAnOrganizationInput", + "AddEmailToIndividualInput", + "AddExamScoresInput", + "AddIndividualInput", + "AddOrUpdateAListOfCustomFieldsPerIndividualInput", + "AddOrUpdateAListOfCustomFieldsPerOrganizationInput", + "AddOrganizationInput", + "AddRelationshipToIndividualInput", + "AddToCommitteeResponse", + "AddWebLinkForIndividualInput", + "AddWebLinkForOrganizationInput", + "AddressSaveData", + "AwardData", + "AwardNominationData", + "AwardRecipientIndividualData", + "AwardRecipientOrganizationData", + "AwardsGetIndividualAwardRecipientsResponse", + "AwardsGetOrganizationAwardRecipientsResponse", + "BaseNoteData", + "CertificationData", + "CommitteeData", + "CommitteeMemberCreateData", + "CommitteeMemberData", + "CommitteeMemberPayload", + "CommitteeMemberUpdateData", + "CommitteeNomineeData", + "CommitteeNomineeSaveData", + "CommitteePositionData", + "ContactData", + "CountryData", + "CourseAttendeeData", + "CustomFieldData", + "CustomFieldResultData", + "CustomFieldValueData", + "CustomerAddressUpdatedPayload", + "CustomerCustomFieldValuePayload", + "CustomerMergedPayload", + "CustomerPhoneUpdatedPayload", + "CustomerRelationshipUpdatedPayload", + "CustomerRequestPayload", + "DeleteAnIndividualWebLinkInput", + "DeleteAnOrganizationWebLinkInput", + "EducationCreditData", + "EmailData", + "EmailPayload", + "EventData", + "EventRegistrationSubstitutedPayload", + "ExamData", + "ExamScoreData", + "ExamScoreResultData", + "ExhibitData", + "ExhibitorData", + "FindCustomerPhoneResponse", + "FindIndividualIdOrEmailResponse", + "FindMembersByNameResponse", + "FindMembersOrIndividualsByFirstAndLastNameResponse", + "FindMembersOrIndividualsByNameResponse", + "GetAListOfAllServicesOfAnOrganizationResponse", + "GetAListOfLicensesResponse", + "GetAbandonedCheckoutsResponse", + "GetAllCommitteesResponse", + "GetAllEventRegistrationsInformationForAnIndividualResponse", + "GetAllEventsResponse", + "GetAllOpenOrdersForAnIndividualResponse", + "GetAllStatesByCountryResponse", + "GetCommitteeInformationForAnIndividualResponse", + "GetCourseAttendeesResponse", + "GetIndividualsActiveSubscriptionsResponse", + "GetIndividualsRelationshipsResponse", + "GetListOfActiveCertificationsForAnIndividualResponse", + "GetListOfActiveCertificationsForAnOrganizationResponse", + "GetNomineesByCommitteeResponse", + "GetOrganizationsActiveSubscriptionsResponse", + "GetOrganizationsRelationshipsResponse", + "GetPositionsByCommitteeResponse", + "GetPurchasesForAnIndividualResponse", + "GetSubCommitteesResponse", + "GetUpcomingEventsResponse", + "IndividualData", + "IndividualLookupBasicData", + "IndividualPayload", + "IndividualRequestToBeForgottenPayload", + "IndividualsLookupByNameResponse", + "LicenseData", + "ListAllAwardsResponse", + "ListAllCountriesResponse", + "ListAllEventCancellationsByEventResponse", + "ListAllExhibitorsResponse", + "ListAllExhibitsResponse", + "ListAllIndividualsResponse", + "ListAllOpenCustomerRequestResponse", + "ListCompletedUserTasksByUserIdOrEmailResponse", + "ListOfAllIndividualMembersResponse", + "ListOfAllOrganizationMembersResponse", + "ListOfCustomerRelationshipsResponse", + "ListOfExamsResponse", + "ListPendingUserTasksByUserIdOrEmailResponse", + "ListRegistrantsResponse", + "MarkRegistrantAttendedInput", + "MembershipData", + "MembershipTypeTerminatedPayload", + "NoteData", + "NotificationData", + "OrganizationData", + "OrganizationLookupBasicData", + "OrganizationLookupByNameResponse", + "PayableOrderData", + "PhoneDataSet", + "PhoneSaveData", + "ProductPurchasePayload", + "PurchaseCancelledPayload", + "PurchasedItemData", + "RegisterAnIndividualForAFreeSessionInput", + "RegistrantCancellationData", + "RegistrantData", + "RegistrationData", + "RelationshipData", + "RelationshipTypeData", + "RequestData", + "RequestSaveData", + "RequestUpdateData", + "SaveCategoryBasicData", + "SaveRelationshipForOrganizationInput", + "ServiceData", + "SessionRegistrationData", + "StateProvinceData", + "SubscriptionData", + "TaskData", + "TaskSaveData", + "UpdateAnIndividualEmailInput", + "UpdateAwardNominationData", + "UpdateOrganizationInput", + "UserTaskData", + "WhenCommitteeMemberUpdatedInput", + "WhenCustomerAddressUpdatedInput", + "WhenCustomerCustomFieldValueUpdatedInput", + "WhenCustomerIsMergedInput", + "WhenCustomerPhoneUpdatedInput", + "WhenCustomerRelationshipUpdatedInput", + "WhenEmailUpdatedInput", + "WhenEventRegistrationSubstitutedInput", + "WhenIndividualCreatedInput", + "WhenIndividualDeletedInput", + "WhenIndividualRequestForgottenInput", + "WhenMembershipTerminatedInput", + "WhenProductPurchasedInput", + "WhenPurchaseCancelledInput", + "WhenPurchasePaidInput", + "WhenRequestUpdatedInput", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,13 +189,15 @@ class GetAbandonedCheckoutsResponse: Response for Get Abandoned Checkouts """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number""" - data_list: Optional[List[AbandonedCheckoutData]] = field( + data_list: Optional[List[AbandonedCheckoutData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -47,13 +209,15 @@ class ListAllExhibitorsResponse: Response for List All Exhibitors """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number""" - data_list: Optional[List[ExhibitorData]] = field( + data_list: Optional[List[ExhibitorData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -65,13 +229,15 @@ class ListOfExamsResponse: Response for List of Exams """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number""" - data_list: Optional[List[ExamData]] = field( + data_list: Optional[List[ExamData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -83,13 +249,15 @@ class ListRegistrantsResponse: Response for List Registrants """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[RegistrantData]] = field( + data_list: Optional[List[RegistrantData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -101,19 +269,21 @@ class GetCourseAttendeesResponse: Response for Get Course Attendees """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[CourseAttendeeData]] = field( + data_list: Optional[List[CourseAttendeeData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" -AddExamScoresInput = List["ExamScoreData"] +AddExamScoresInput = List["ExamScoreData | Mapping[str, Any]"] @dataclass @@ -122,14 +292,15 @@ class ExamScoreResultData: Response for Add Exam Scores """ - individual_record_number: Optional[str] = field( + individual_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "individualRecordNumber"}, ) """Individual Record Number.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status.""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """Message.""" @@ -139,13 +310,15 @@ class FindMembersByNameResponse: Response for Find Members by Name """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[ContactData]] = field( + data_list: Optional[List[ContactData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -157,19 +330,23 @@ class GetPurchasesForAnIndividualResponse: Response for Get Purchases for an Individual """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[PurchasedItemData]] = field( + data_list: Optional[List[PurchasedItemData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" -AddOrUpdateAListOfCustomFieldsPerOrganizationInput = List["CustomFieldValueData"] +AddOrUpdateAListOfCustomFieldsPerOrganizationInput = List[ + "CustomFieldValueData | Mapping[str, Any]" +] @dataclass @@ -178,12 +355,13 @@ class CustomFieldResultData: Response for Add or Update a List of Custom Fields Per Organization """ - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status.""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """Message.""" - custom_field_name: Optional[str] = field( + custom_field_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customFieldName"}, ) """Custom Field Name.""" @@ -195,11 +373,11 @@ class CustomFieldData: Response for Get Individual Custom Field Values """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - caption: Optional[str] = None + caption: Optional[str] = dataclass_field(default=None, kw_only=True) """Caption.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Custom Field Value. For multi-selects, use \"|\" as delimiter.""" @@ -209,13 +387,17 @@ class ListAllEventCancellationsByEventResponse: Response for List All Event Cancellations by Event """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[RegistrantCancellationData]] = field( + data_list: Optional[ + List[RegistrantCancellationData | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -227,13 +409,15 @@ class GetAllOpenOrdersForAnIndividualResponse: Response for Get All Open Orders for an Individual """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number""" - data_list: Optional[List[PayableOrderData]] = field( + data_list: Optional[List[PayableOrderData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -245,13 +429,15 @@ class ListCompletedUserTasksByUserIdOrEmailResponse: Response for List Completed User Tasks by User ID or Email """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[UserTaskData]] = field( + data_list: Optional[List[UserTaskData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -263,13 +449,15 @@ class ListPendingUserTasksByUserIdOrEmailResponse: Response for List Pending User Tasks by User ID or Email """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[UserTaskData]] = field( + data_list: Optional[List[UserTaskData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -281,24 +469,27 @@ class TaskData: Response for Update Task by Task Number """ - task_number: Optional[str] = field( + task_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "taskNumber"}, ) """Task Number.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - category: Optional[str] = None + category: Optional[str] = dataclass_field(default=None, kw_only=True) """Category.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - due_date: Optional[str] = field( + due_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDate"}, ) """Due Date.""" @@ -310,13 +501,15 @@ class ListAllCountriesResponse: Response for List All Countries """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number""" - data_list: Optional[List[CountryData]] = field( + data_list: Optional[List[CountryData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -328,13 +521,15 @@ class GetAllStatesByCountryResponse: Response for Get All States by Country """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number""" - data_list: Optional[List[StateProvinceData]] = field( + data_list: Optional[List[StateProvinceData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -346,13 +541,15 @@ class ListAllExhibitsResponse: Response for List All Exhibits """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number""" - data_list: Optional[List[ExhibitData]] = field( + data_list: Optional[List[ExhibitData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -364,19 +561,21 @@ class RequestUpdateData: Response for Update Customer Request """ - request_number: Optional[str] = field( + request_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requestNumber"}, ) """Request Number.""" - closed_date: Optional[str] = field( + closed_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "closedDate"}, ) """Closed Date.""" -AddCategoriesForAnOrganizationInput = List["SaveCategoryBasicData"] +AddCategoriesForAnOrganizationInput = List["SaveCategoryBasicData | Mapping[str, Any]"] @dataclass @@ -385,13 +584,15 @@ class ListOfCustomerRelationshipsResponse: Response for List of Customer Relationships """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[RelationshipTypeData]] = field( + data_list: Optional[List[RelationshipTypeData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -403,13 +604,15 @@ class ListAllOpenCustomerRequestResponse: Response for List All Open Customer Request """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[RequestData]] = field( + data_list: Optional[List[RequestData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -421,60 +624,71 @@ class MembershipData: Response for Get Organization Inactive Memberships """ - membership_type: Optional[str] = field( + membership_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "membershipType"}, ) """Membership Type.""" - membership_type_id: Optional[str] = field( + membership_type_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "membershipTypeId"}, ) """Membership Type ID.""" - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - expire_date: Optional[str] = field( + expire_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "expireDate"}, ) """Expire Date.""" - grace_expire_date: Optional[str] = field( + grace_expire_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "graceExpireDate"}, ) """Grace Expire Date.""" - inherited_membership_benefits: Optional[bool] = field( + inherited_membership_benefits: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "inheritedMembershipBenefits"}, ) """Inherited Membership Benefits.""" - renewal_url: Optional[str] = field( + renewal_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "renewalUrl"}, ) """Renewal URL.""" - join_date: Optional[str] = field( + join_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "joinDate"}, ) """Join Date.""" - terminate_date: Optional[str] = field( + terminate_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "terminateDate"}, ) """Terminate Date.""" - effective_date: Optional[str] = field( + effective_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "effectiveDate"}, ) """Effective Date.""" - membership_unique_id: Optional[str] = field( + membership_unique_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "membershipUniqueId"}, ) """Membership Unique ID.""" - terms_list: Optional[List[Dict[str, Any]]] = field( + terms_list: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "termsList"}, ) """Terms List""" @@ -486,36 +700,41 @@ class UserTaskData: Response for Update User Task Progress or Mark as Completed """ - task_number: Optional[str] = field( + task_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "taskNumber"}, ) """Task Number.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - category: Optional[str] = None + category: Optional[str] = dataclass_field(default=None, kw_only=True) """Category.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description.""" - assigned_by: Optional[str] = field( + assigned_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedBy"}, ) """Assigned By.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - due_date: Optional[str] = field( + due_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDate"}, ) """Due Date.""" - progress: Optional[str] = None + progress: Optional[str] = dataclass_field(default=None, kw_only=True) """Progress.""" - completed_date: Optional[str] = field( + completed_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completedDate"}, ) """Completed Date.""" @@ -527,135 +746,158 @@ class IndividualData: Response for Find Members (Individuals) by First Name """ - first_name: Optional[str] = field( + first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstName"}, ) """First Name.""" - last_name: Optional[str] = field( + last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastName"}, ) """Last Name.""" - middle_name: Optional[str] = field( + middle_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "middleName"}, ) """Middle Name.""" - preferred_first_name: Optional[str] = field( + preferred_first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredFirstName"}, ) """Preferred First Name.""" - second_last_name: Optional[str] = field( + second_last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "secondLastName"}, ) """Second Last Name.""" - prefix: Optional[str] = None + prefix: Optional[str] = dataclass_field(default=None, kw_only=True) """Prefix.""" - suffix: Optional[str] = None + suffix: Optional[str] = dataclass_field(default=None, kw_only=True) """Suffix.""" - gender: Optional[str] = None + gender: Optional[str] = dataclass_field(default=None, kw_only=True) """Gender.""" - primary_organization: Optional[Dict[str, Any]] = field( + primary_organization: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "primaryOrganization"}, ) - committees: Optional[List[Dict[str, Any]]] = None + committees: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Committees.""" - security_roles: Optional[List[Dict[str, Any]]] = field( + security_roles: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "securityRoles"}, ) """Security Roles.""" - user: Optional[Dict[str, Any]] = None - designation_data: Optional[List[Dict[str, Any]]] = field( + user: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + designation_data: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "designationData"}, ) """Designations.""" - relationships: Optional[List[Dict[str, Any]]] = None + relationships: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Relationships.""" - job_roles: Optional[List[Dict[str, Any]]] = field( + job_roles: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobRoles"}, ) """Job Roles.""" - tags: Optional[List[str]] = None + tags: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Tags.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Individual Id.""" - customer_type: Optional[str] = field( + customer_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customerType"}, ) """Customer Type.""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - addresses: Optional[List[Dict[str, Any]]] = None + addresses: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Addresses.""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email.""" - image_uri: Optional[str] = field( + image_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "imageUri"}, ) """Image URI.""" - twitter: Optional[str] = None + twitter: Optional[str] = dataclass_field(default=None, kw_only=True) """Twitter.""" - linked_in: Optional[str] = field( + linked_in: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "linkedIn"}, ) """LinkedIn.""" - emails: Optional[List[Dict[str, Any]]] = None + emails: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Emails.""" - phones: Optional[List[Dict[str, Any]]] = None + phones: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Phones.""" - web_site: Optional[str] = field( + web_site: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webSite"}, ) """Website.""" - memberships: Optional[List[Dict[str, Any]]] = None + memberships: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Memberships.""" - category: Optional[str] = None + category: Optional[str] = dataclass_field(default=None, kw_only=True) """Category.""" - categories: Optional[List[Dict[str, Any]]] = None + categories: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Categories.""" - custom_fields: Optional[List[Dict[str, Any]]] = field( + custom_fields: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customFields"}, ) """Custom Fields.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - links: Optional[List[Dict[str, Any]]] = None + links: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Links.""" - old_id: Optional[str] = field( + old_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldId"}, ) """Old Id.""" - is_deceased: Optional[bool] = field( + is_deceased: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isDeceased"}, ) """Is Deceased.""" -AddCategoriesForAnIndividualInput = List["SaveCategoryBasicData"] +AddCategoriesForAnIndividualInput = List["SaveCategoryBasicData | Mapping[str, Any]"] @dataclass @@ -664,13 +906,15 @@ class ListOfAllOrganizationMembersResponse: Response for List of All Organization Members """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[OrganizationData]] = field( + data_list: Optional[List[OrganizationData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -682,13 +926,15 @@ class ListOfAllIndividualMembersResponse: Response for List of All Individual Members """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[IndividualData]] = field( + data_list: Optional[List[IndividualData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -700,13 +946,15 @@ class GetListOfActiveCertificationsForAnOrganizationResponse: Response for Get List of Active Certifications for an Organization """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[CertificationData]] = field( + data_list: Optional[List[CertificationData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -718,19 +966,21 @@ class GetListOfActiveCertificationsForAnIndividualResponse: Response for Get List of Active Certifications for an Individual """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[CertificationData]] = field( + data_list: Optional[List[CertificationData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" -RegisterAnIndividualForAFreeSessionInput = List["SessionRegistrationData"] +RegisterAnIndividualForAFreeSessionInput = List["SessionRegistrationData | Mapping[str, Any]"] @dataclass @@ -739,13 +989,15 @@ class GetAListOfLicensesResponse: Response for Get a List of Licenses """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[LicenseData]] = field( + data_list: Optional[List[LicenseData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -757,13 +1009,15 @@ class ListAllAwardsResponse: Response for List All Awards """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[AwardData]] = field( + data_list: Optional[List[AwardData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -775,13 +1029,15 @@ class FindMembersOrIndividualsByNameResponse: Response for Find Members (Individuals) by Name """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[IndividualData]] = field( + data_list: Optional[List[IndividualData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -793,13 +1049,15 @@ class GetAListOfAllServicesOfAnOrganizationResponse: Response for Get a List of All Services of an Organization """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[ServiceData]] = field( + data_list: Optional[List[ServiceData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -811,9 +1069,9 @@ class ServiceData: Response for Add a Service to an Organization """ - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" @@ -823,24 +1081,30 @@ class PhoneDataSet: Response for Update Phone for an Individual """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - primary: Optional[bool] = None + primary: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is Primary.""" - type_: Optional[int] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type.""" - country: Optional[Dict[str, Any]] = None - show_in_directory: Optional[bool] = field( + country: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - number: Optional[str] = None + number: Optional[str] = dataclass_field(default=None, kw_only=True) """Number.""" - extension: Optional[str] = None + extension: Optional[str] = dataclass_field(default=None, kw_only=True) """Extension.""" - type_name: Optional[str] = field( + type_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "typeName"}, ) """Type Name.""" @@ -852,9 +1116,13 @@ class DeleteAnIndividualWebLinkInput: Delete an Individual Web Link """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Url.""" @@ -864,9 +1132,13 @@ class AddWebLinkForIndividualInput: Add Web Link for Individual """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Url.""" @@ -876,13 +1148,15 @@ class GetNomineesByCommitteeResponse: Response for Get Nominees by Committee """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[CommitteeNomineeData]] = field( + data_list: Optional[List[CommitteeNomineeData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """Data List""" @@ -894,13 +1168,15 @@ class GetOrganizationsActiveSubscriptionsResponse: Response for Get Organization's Active Subscriptions """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[SubscriptionData]] = field( + data_list: Optional[List[SubscriptionData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -912,9 +1188,9 @@ class DeleteAnOrganizationWebLinkInput: Delete an Organization Web Link """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Type.""" - url: Optional[str] = None + url: str """Url.""" @@ -924,9 +1200,9 @@ class AddWebLinkForOrganizationInput: Add Web Link for Organization """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Type.""" - url: Optional[str] = None + url: str """Url.""" @@ -936,13 +1212,15 @@ class GetOrganizationsRelationshipsResponse: Response for Get Organization's Relationships """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[RelationshipData]] = field( + data_list: Optional[List[RelationshipData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """DataList""" @@ -954,43 +1232,51 @@ class AddressSaveData: Response for Add or Update Address to Organization """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - primary: Optional[bool] = None + primary: Optional[bool] = dataclass_field(default=None, kw_only=True) """Primary.""" - line1: Optional[str] = None + line1: Optional[str] = dataclass_field(default=None, kw_only=True) """Line 1.""" - line2: Optional[str] = None + line2: Optional[str] = dataclass_field(default=None, kw_only=True) """Line 2.""" - line3: Optional[str] = None + line3: Optional[str] = dataclass_field(default=None, kw_only=True) """Line 3.""" - city: Optional[str] = None + city: Optional[str] = dataclass_field(default=None, kw_only=True) """City.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """State.""" - zipcode: Optional[str] = None + zipcode: Optional[str] = dataclass_field(default=None, kw_only=True) """Zipcode.""" - country: Optional[str] = None + country: Optional[str] = dataclass_field(default=None, kw_only=True) """Country.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - is_preferred_shipping: Optional[bool] = field( + is_preferred_shipping: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isPreferredShipping"}, ) """Is Preferred Shipping.""" - is_preferred_billing: Optional[bool] = field( + is_preferred_billing: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isPreferredBilling"}, ) """Is Preferred Billing.""" - is_bad_address: Optional[bool] = field( + is_bad_address: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isBadAddress"}, ) """Is Bad Address.""" @@ -1005,13 +1291,15 @@ class GetUpcomingEventsResponse: Response for Get Upcoming Events """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[EventData]] = field( + data_list: Optional[List[EventData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """DataList""" @@ -1023,13 +1311,15 @@ class GetCommitteeInformationForAnIndividualResponse: Response for Get Committee Information for an Individual """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number""" - data_list: Optional[List[CommitteeMemberData]] = field( + data_list: Optional[List[CommitteeMemberData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """Data List.""" @@ -1041,13 +1331,15 @@ class GetAllEventsResponse: Response for Get All Events """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[EventData]] = field( + data_list: Optional[List[EventData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """DataList""" @@ -1059,13 +1351,15 @@ class GetAllEventRegistrationsInformationForAnIndividualResponse: Response for Get All Event Registrations Information for an Individual """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[RegistrationData]] = field( + data_list: Optional[List[RegistrationData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -1077,13 +1371,15 @@ class GetIndividualsRelationshipsResponse: Response for Get Individual's Relationships """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[RelationshipData]] = field( + data_list: Optional[List[RelationshipData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """Data List.""" @@ -1095,14 +1391,19 @@ class UpdateAnIndividualEmailInput: Update an Individual Email """ - primary: Optional[bool] = None + primary: Optional[bool] = dataclass_field(default=None, kw_only=True) """Primary.""" - address: Optional[str] = None + address: Optional[str] = dataclass_field(default=None, kw_only=True) """Address.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory""" @@ -1114,42 +1415,43 @@ class SaveRelationshipForOrganizationInput: Save Relationship for Organization """ - relationship_name: Optional[str] = field( - default=None, + relationship_name: str = dataclass_field( metadata={"wire_name": "relationshipName"}, ) """Relationship Name.""" - related_to_customer_record_number: Optional[str] = field( - default=None, + related_to_customer_record_number: str = dataclass_field( metadata={"wire_name": "relatedToCustomerRecordNumber"}, ) """Related To Customer Record Number.""" - reciprocal_relationship_name: Optional[str] = field( - default=None, + reciprocal_relationship_name: str = dataclass_field( metadata={"wire_name": "reciprocalRelationshipName"}, ) """Reciprocal Relationship Name.""" - is_primary: Optional[bool] = field( + is_primary: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isPrimary"}, ) """Is Primary.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDate"}, ) """End Date.""" - is_reciprocal_primary: Optional[bool] = field( + is_reciprocal_primary: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReciprocalPrimary"}, ) """Is Reciprocal Primary.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" @@ -1159,20 +1461,15 @@ class AddIndividualInput: Add Individual """ - first_name: Optional[str] = field( - default=None, - metadata={"wire_name": "firstName"}, - ) + first_name: str = dataclass_field(metadata={"wire_name": "firstName"}) """First Name.""" - last_name: Optional[str] = field( - default=None, - metadata={"wire_name": "lastName"}, - ) + last_name: str = dataclass_field(metadata={"wire_name": "lastName"}) """Last Name.""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email Address.""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" @@ -1184,14 +1481,19 @@ class AddEmailToIndividualInput: Add Email to Individual """ - primary: Optional[bool] = None + primary: Optional[bool] = dataclass_field(default=None, kw_only=True) """Primary""" - address: Optional[str] = None + address: Optional[str] = dataclass_field(default=None, kw_only=True) """Address.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory""" @@ -1203,14 +1505,19 @@ class EmailData: Response for Add Email to Individual """ - primary: Optional[bool] = None + primary: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is Primary Email.""" - address: Optional[str] = None + address: Optional[str] = dataclass_field(default=None, kw_only=True) """Address.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" @@ -1222,13 +1529,15 @@ class FindMembersOrIndividualsByFirstAndLastNameResponse: Response for Find Members (Individuals) by First Name and Last Name """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[IndividualData]] = field( + data_list: Optional[List[IndividualData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -1240,14 +1549,15 @@ class AddActivityInput: Add Activity """ - category: Optional[str] = None + category: str """Category.""" - text: Optional[str] = None + text: str """Text.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """URL.""" - activity_date: Optional[str] = field( + activity_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "activityDate"}, ) """Activity Date.""" @@ -1259,13 +1569,15 @@ class FindIndividualIdOrEmailResponse: Response for Find Individual by Id or Email or Record Number """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[IndividualData]] = field( + data_list: Optional[List[IndividualData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """Data List.""" @@ -1277,38 +1589,39 @@ class AddRelationshipToIndividualInput: Add Relationship to Individual """ - relationship_name: Optional[str] = field( - default=None, + relationship_name: str = dataclass_field( metadata={"wire_name": "relationshipName"}, ) """Relationship Name.""" - related_to_customer_record_number: Optional[str] = field( - default=None, + related_to_customer_record_number: str = dataclass_field( metadata={"wire_name": "relatedToCustomerRecordNumber"}, ) """Related To Customer Record Number.""" - reciprocal_relationship_name: Optional[str] = field( - default=None, + reciprocal_relationship_name: str = dataclass_field( metadata={"wire_name": "reciprocalRelationshipName"}, ) """Reciprocal Relationship Name.""" - is_primary: Optional[bool] = field( + is_primary: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isPrimary"}, ) """Is Primary.""" - is_reciprocal_primary: Optional[bool] = field( + is_reciprocal_primary: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReciprocalPrimary"}, ) """Is Reciprocal Primary.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDate"}, ) """End Date.""" @@ -1320,13 +1633,17 @@ class IndividualsLookupByNameResponse: Response for Lookup Individuals """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[IndividualLookupBasicData]] = field( + data_list: Optional[ + List[IndividualLookupBasicData | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """Data List.""" @@ -1338,58 +1655,67 @@ class AddToCommitteeResponse: Response for Add Individual to Committee """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Member Id.""" - first_name: Optional[str] = field( + first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstName"}, ) """First Name.""" - last_name: Optional[str] = field( + last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastName"}, ) """Last Name.""" - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - position: Optional[str] = None + position: Optional[str] = dataclass_field(default=None, kw_only=True) """Position.""" - position_code: Optional[str] = field( + position_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "positionCode"}, ) """Position Code.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDate"}, ) """End Date.""" - primary_organization: Optional[Dict[str, Any]] = field( + primary_organization: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "primaryOrganization"}, ) - organization_representing: Optional[Dict[str, Any]] = field( + organization_representing: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "organizationRepresenting"}, ) - nominated_by_customer: Optional[Dict[str, Any]] = field( + nominated_by_customer: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nominatedByCustomer"}, ) - addresses: Optional[List[Dict[str, Any]]] = None - phones: Optional[List[Dict[str, Any]]] = None - emails: Optional[List[Dict[str, Any]]] = None - rank: Optional[int] = None + addresses: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + phones: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + emails: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + rank: Optional[int] = dataclass_field(default=None, kw_only=True) """Rank.""" @@ -1399,21 +1725,21 @@ class AddOrganizationInput: Add Organization """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id.""" - name: Optional[str] = None + name: str """Name.""" - show_in_directory: Optional[bool] = field( - default=None, + show_in_directory: bool = dataclass_field( metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - branch_name: Optional[str] = field( + branch_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "branchName"}, ) """Branch Name.""" - website: Optional[str] = None + website: Optional[str] = dataclass_field(default=None, kw_only=True) """Website.""" @@ -1423,86 +1749,97 @@ class OrganizationData: Response for Add Organization """ - contact_ids: Optional[List[str]] = field( + contact_ids: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contactIds"}, ) """Contact Ids.""" - parent_company_id: Optional[str] = field( + parent_company_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentCompanyId"}, ) """Parent Company Id.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description.""" - branch_name: Optional[str] = field( + branch_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "branchName"}, ) """Branch Name.""" - tags: Optional[List[str]] = None + tags: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Tags.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Organization Id.""" - customer_type: Optional[str] = field( + customer_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customerType"}, ) """Customer Type.""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Organization Name.""" - addresses: Optional[List[Dict[str, Any]]] = None + addresses: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Addresses.""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email.""" - image_uri: Optional[str] = field( + image_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "imageUri"}, ) """Image URI.""" - twitter: Optional[str] = None + twitter: Optional[str] = dataclass_field(default=None, kw_only=True) """Twitter.""" - linked_in: Optional[str] = field( + linked_in: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "linkedIn"}, ) """LinkedIn.""" - emails: Optional[List[Dict[str, Any]]] = None + emails: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Emails.""" - phones: Optional[List[Dict[str, Any]]] = None + phones: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Phones.""" - web_site: Optional[str] = field( + web_site: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webSite"}, ) """Website.""" - memberships: Optional[List[Dict[str, Any]]] = None + memberships: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Memberships.""" - category: Optional[str] = None + category: Optional[str] = dataclass_field(default=None, kw_only=True) """Category.""" - categories: Optional[List[Dict[str, Any]]] = None + categories: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Categories.""" - custom_fields: Optional[List[Dict[str, Any]]] = field( + custom_fields: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customFields"}, ) """Custom Fields.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - links: Optional[List[Dict[str, Any]]] = None + links: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Links.""" - old_id: Optional[str] = field( + old_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldId"}, ) """Old Id.""" @@ -1514,21 +1851,23 @@ class UpdateOrganizationInput: Update Organization """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - branch_name: Optional[str] = field( + branch_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "branchName"}, ) """Branch Name.""" - website: Optional[str] = None + website: Optional[str] = dataclass_field(default=None, kw_only=True) """Website.""" @@ -1538,13 +1877,17 @@ class OrganizationLookupByNameResponse: Response for Lookup Organizations """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[OrganizationLookupBasicData]] = field( + data_list: Optional[ + List[OrganizationLookupBasicData | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """Data List.""" @@ -1556,13 +1899,15 @@ class GetAllCommitteesResponse: Response for Get All Committees """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[CommitteeData]] = field( + data_list: Optional[List[CommitteeData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -1574,13 +1919,15 @@ class GetPositionsByCommitteeResponse: Response for Get Positions by Committee """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[CommitteePositionData]] = field( + data_list: Optional[List[CommitteePositionData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -1592,13 +1939,15 @@ class GetSubCommitteesResponse: Response for Get Sub-Committees """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """pageNumber""" - data_list: Optional[List[CommitteeData]] = field( + data_list: Optional[List[CommitteeData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -1610,13 +1959,15 @@ class GetIndividualsActiveSubscriptionsResponse: Response for Get Individual's Active Subscriptions """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[SubscriptionData]] = field( + data_list: Optional[List[SubscriptionData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """dataList""" @@ -1628,13 +1979,15 @@ class ListAllIndividualsResponse: Response for List all Individuals """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[IndividualData]] = field( + data_list: Optional[List[IndividualData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) @@ -1645,13 +1998,15 @@ class FindCustomerPhoneResponse: Response for Find Customer by Phone Number """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[Dict[str, Any]]] = field( + data_list: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) @@ -1665,13 +2020,17 @@ class AwardsGetIndividualAwardRecipientsResponse: Response for List Award Individual Recipients """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[AwardRecipientIndividualData]] = field( + data_list: Optional[ + List[AwardRecipientIndividualData | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """Data List.""" @@ -1683,13 +2042,17 @@ class AwardsGetOrganizationAwardRecipientsResponse: Response for List Award Organization Recipients """ - page_number: Optional[int] = field( + page_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageNumber"}, ) """Page Number.""" - data_list: Optional[List[AwardRecipientOrganizationData]] = field( + data_list: Optional[ + List[AwardRecipientOrganizationData | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dataList"}, ) """Data List.""" @@ -1701,19 +2064,13 @@ class WhenIndividualCreatedInput: When an individual is created """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1723,19 +2080,13 @@ class WhenIndividualDeletedInput: When an individual is deleted """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1745,19 +2096,13 @@ class WhenIndividualRequestForgottenInput: When an individual requests to be forgotten """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1767,23 +2112,17 @@ class WhenProductPurchasedInput: When a product is purchased """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id.""" - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - filters: Optional[List[str]] = None + filters: List[str] """Filters.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1793,19 +2132,13 @@ class WhenCommitteeMemberUpdatedInput: When a committee member is updated """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1815,23 +2148,17 @@ class WhenPurchaseCancelledInput: When a purchase is canceled """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id.""" - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - filters: Optional[List[str]] = None + filters: List[str] """Filters.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1841,19 +2168,13 @@ class WhenRequestUpdatedInput: When a customer request is updated """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1863,19 +2184,13 @@ class WhenEmailUpdatedInput: When a customer email is updated """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1885,21 +2200,15 @@ class WhenCustomerCustomFieldValueUpdatedInput: When a customer custom field value is updated """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - filters: Optional[List[str]] = None + filters: List[str] """Filters.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1909,19 +2218,13 @@ class WhenCustomerIsMergedInput: When a customer is merged """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1931,19 +2234,13 @@ class WhenCustomerRelationshipUpdatedInput: When a customer relationship is updated """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1953,19 +2250,13 @@ class WhenCustomerPhoneUpdatedInput: When a customer phone is updated """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1975,19 +2266,13 @@ class WhenCustomerAddressUpdatedInput: When a customer address is updated """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -1997,21 +2282,15 @@ class WhenEventRegistrationSubstitutedInput: When an event registration is substituted """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - filters: Optional[List[str]] = None + filters: List[str] """Filters.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -2021,21 +2300,15 @@ class WhenPurchasePaidInput: When a purchase is paid """ - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - filters: Optional[List[str]] = None + filters: List[str] """Filters.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -2045,21 +2318,15 @@ class WhenMembershipTerminatedInput: When a membership is terminated """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id.""" - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" - secret: Optional[str] = None + secret: str """Secret.""" - call_back_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callBackUrl"}, - ) + call_back_url: str = dataclass_field(metadata={"wire_name": "callBackUrl"}) """Callback URL.""" - description: Optional[str] = None + description: str """Description.""" @@ -2069,21 +2336,24 @@ class AbandonedCheckoutData: Definition: AbandonedCheckoutData """ - created_on: Optional[str] = field( + created_on: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdOn"}, ) """Created On""" - created_by_email_address: Optional[str] = field( + created_by_email_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdByEmailAddress"}, ) """Created By Email Address""" - currency: Optional[str] = None + currency: Optional[str] = dataclass_field(default=None, kw_only=True) """Currency""" - customer: Optional[Dict[str, Any]] = None - line_items: Optional[List[Dict[str, Any]]] = field( + customer: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + line_items: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineItems"}, ) """Line Items""" @@ -2095,9 +2365,9 @@ class ExhibitorData: Definition: ExhibitorData """ - organization: Optional[Dict[str, Any]] = None + organization: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Organization""" - booths: Optional[List[Dict[str, Any]]] = None + booths: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Booths""" @@ -2107,77 +2377,93 @@ class ExamData: Definition: ExamData """ - exam_start_date: Optional[str] = field( + exam_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "examStartDate"}, ) """Exam Start Date""" - exam_end_date: Optional[str] = field( + exam_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "examEndDate"}, ) """Exam End Date""" - exam_number: Optional[str] = field( + exam_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "examNumber"}, ) """Exam Number""" - education_credits: Optional[List[Dict[str, Any]]] = field( + education_credits: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "educationCredits"}, ) """Education Credits""" - categories: Optional[List[Dict[str, Any]]] = None + categories: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """categories""" - active_prices: Optional[List[Dict[str, Any]]] = field( + active_prices: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "activePrices"}, ) """Active Prices""" - related_products: Optional[List[Dict[str, Any]]] = field( + related_products: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "relatedProducts"}, ) """Related Products""" - tags: Optional[List[str]] = None + tags: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Tags.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - short_description: Optional[str] = field( + short_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortDescription"}, ) """Short Description.""" - long_description: Optional[str] = field( + long_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "longDescription"}, ) """Long Description.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Url.""" - image_url: Optional[List[str]] = field( + image_url: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "imageUrl"}, ) """Image Url.""" - is_public: Optional[bool] = field( + is_public: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isPublic"}, ) """Is Public.""" - available_from: Optional[str] = field( + available_from: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "availableFrom"}, ) """Available From.""" - available_until: Optional[str] = field( + available_until: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "availableUntil"}, ) """Available Until.""" @@ -2189,118 +2475,138 @@ class RegistrantData: Definition: RegistrantData """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - badge_name: Optional[str] = field( + badge_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "badgeName"}, ) """Badge Name""" - badge_organization: Optional[str] = field( + badge_organization: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "badgeOrganization"}, ) """Badge Organization.""" - badge_city: Optional[str] = field( + badge_city: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "badgeCity"}, ) """Badge City.""" - badge_state: Optional[str] = field( + badge_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "badgeState"}, ) """Badge State.""" - attended_date: Optional[str] = field( + attended_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "attendedDate"}, ) """Attended Date.""" - sessions: Optional[List[Dict[str, Any]]] = None - itemized_custom_fields: Optional[List[Dict[str, Any]]] = field( + sessions: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + itemized_custom_fields: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "itemizedCustomFields"}, ) """Itemized Custom Fields""" - guest_of_record_number: Optional[str] = field( + guest_of_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "guestOfRecordNumber"}, ) """Guest Of Record Number.""" - registrant_type_code: Optional[str] = field( + registrant_type_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "registrantTypeCode"}, ) """Registrant Type Code.""" - registrant_type_name: Optional[str] = field( + registrant_type_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "registrantTypeName"}, ) """Registrant Type Name.""" - registration_number: Optional[str] = field( + registration_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "registrationNumber"}, ) """Registration Number.""" - bought_together_with: Optional[List[Dict[str, Any]]] = field( + bought_together_with: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "boughtTogetherWith"}, ) - first_name: Optional[str] = field( + first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstName"}, ) """First Name.""" - last_name: Optional[str] = field( + last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastName"}, ) """Last Name.""" - middle_name: Optional[str] = field( + middle_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "middleName"}, ) """Middle Name.""" - preferred_first_name: Optional[str] = field( + preferred_first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredFirstName"}, ) """Preferred First Name.""" - second_last_name: Optional[str] = field( + second_last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "secondLastName"}, ) """Second Last Name.""" - prefix: Optional[str] = None + prefix: Optional[str] = dataclass_field(default=None, kw_only=True) """Prefix.""" - suffix: Optional[str] = None + suffix: Optional[str] = dataclass_field(default=None, kw_only=True) """Suffix.""" - gender: Optional[str] = None + gender: Optional[str] = dataclass_field(default=None, kw_only=True) """Gender.""" - primary_organization: Optional[Dict[str, Any]] = field( + primary_organization: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "primaryOrganization"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - customer_type: Optional[str] = field( + customer_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customerType"}, ) """Customer Type""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - addresses: Optional[List[Dict[str, Any]]] = None - phones: Optional[List[Dict[str, Any]]] = None - emails: Optional[List[Dict[str, Any]]] = None + addresses: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + phones: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + emails: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -2309,80 +2615,92 @@ class CourseAttendeeData: Definition: CourseAttendeeData """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - registered_date: Optional[str] = field( + registered_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "registeredDate"}, ) """Registered Date.""" - attended_date: Optional[str] = field( + attended_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "attendedDate"}, ) """Attended Date.""" - itemized_custom_fields: Optional[List[Dict[str, Any]]] = field( + itemized_custom_fields: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "itemizedCustomFields"}, ) """Itemized Custom Fields""" - first_name: Optional[str] = field( + first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstName"}, ) """First Name.""" - last_name: Optional[str] = field( + last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastName"}, ) """Last Name.""" - middle_name: Optional[str] = field( + middle_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "middleName"}, ) """Middle Name.""" - preferred_first_name: Optional[str] = field( + preferred_first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredFirstName"}, ) """Preferred First Name.""" - second_last_name: Optional[str] = field( + second_last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "secondLastName"}, ) """Second Last Name.""" - prefix: Optional[str] = None + prefix: Optional[str] = dataclass_field(default=None, kw_only=True) """Prefix.""" - suffix: Optional[str] = None + suffix: Optional[str] = dataclass_field(default=None, kw_only=True) """Suffix""" - gender: Optional[str] = None + gender: Optional[str] = dataclass_field(default=None, kw_only=True) """Gender.""" - primary_organization: Optional[Dict[str, Any]] = field( + primary_organization: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "primaryOrganization"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - customer_type: Optional[str] = field( + customer_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customerType"}, ) """Customer Type.""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - addresses: Optional[List[Dict[str, Any]]] = None + addresses: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Addresses.""" - emails: Optional[List[Dict[str, Any]]] = None + emails: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Emails.""" - phones: Optional[List[Dict[str, Any]]] = None + phones: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Phones.""" @@ -2392,12 +2710,13 @@ class ExamScoreData: Definition: ExamScoreData """ - individual_record_number: Optional[str] = field( + individual_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "individualRecordNumber"}, ) """Individual Record Number.""" - score: Optional[str] = None + score: Optional[str] = dataclass_field(default=None, kw_only=True) """Score.""" @@ -2407,63 +2726,71 @@ class ContactData: Definition: ContactData """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - customer_type: Optional[str] = field( + customer_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customerType"}, ) """Customer Type.""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - addresses: Optional[List[Dict[str, Any]]] = None - image_uri: Optional[str] = field( + addresses: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + image_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "imageUri"}, ) """Image Uri.""" - twitter: Optional[str] = None + twitter: Optional[str] = dataclass_field(default=None, kw_only=True) """Twitter.""" - linked_in: Optional[str] = field( + linked_in: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "linkedIn"}, ) """LinkedIn.""" - emails: Optional[List[Dict[str, Any]]] = None + emails: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """emails""" - phones: Optional[List[Dict[str, Any]]] = None - web_site: Optional[str] = field( + phones: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + web_site: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webSite"}, ) """Website.""" - memberships: Optional[List[Dict[str, Any]]] = None + memberships: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Memberships.""" - category: Optional[str] = None + category: Optional[str] = dataclass_field(default=None, kw_only=True) """Category.""" - categories: Optional[List[Dict[str, Any]]] = None + categories: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Categories""" - custom_fields: Optional[List[Dict[str, Any]]] = field( + custom_fields: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customFields"}, ) """Custom Fields""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - links: Optional[List[Dict[str, Any]]] = None + links: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Links""" - old_id: Optional[str] = field( + old_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldId"}, ) """Old ID.""" @@ -2475,45 +2802,53 @@ class PurchasedItemData: Definition: PurchasedItemData """ - order_number: Optional[str] = field( + order_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "orderNumber"}, ) """Order Number.""" - product_code: Optional[str] = field( + product_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "productCode"}, ) """Product Code.""" - product_name: Optional[str] = field( + product_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "productName"}, ) """Product Name.""" - product_type: Optional[str] = field( + product_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "productType"}, ) """Product Type.""" - purchase_date: Optional[str] = field( + purchase_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "purchaseDate"}, ) """Purchase Date.""" - additional_info: Optional[str] = field( + additional_info: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "additionalInfo"}, ) """Additional Info.""" - quantity: Optional[int] = None + quantity: Optional[int] = dataclass_field(default=None, kw_only=True) """Quantity.""" - itemized_custom_fields: Optional[List[Dict[str, Any]]] = field( + itemized_custom_fields: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "itemizedCustomFields"}, ) """Itemized Custom Fields""" - product_categories: Optional[List[Dict[str, Any]]] = field( + product_categories: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "productCategories"}, ) """Product Categories""" @@ -2525,9 +2860,9 @@ class CustomFieldValueData: Definition: CustomFieldValueData """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value.""" @@ -2537,41 +2872,47 @@ class CommitteeNomineeSaveData: Definition: CommitteeNomineeSaveData """ - nominee_record_number: Optional[str] = field( + nominee_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nomineeRecordNumber"}, ) """Nominee Record Number.""" - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - position_code: Optional[str] = field( + position_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "positionCode"}, ) """Position Code.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status.""" - representing_organization_record_number: Optional[str] = field( + representing_organization_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "representingOrganizationRecordNumber"}, ) """Representing Organization Record Number.""" - representing_organization_relationship_name: Optional[str] = field( + representing_organization_relationship_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "representingOrganizationRelationshipName"}, ) """Representing Organization Relationship Name.""" - nominated_by_customer_record_number: Optional[str] = field( + nominated_by_customer_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nominatedByCustomerRecordNumber"}, ) """Nominated By Customer Record Number.""" - committee_term: Optional[int] = field( + committee_term: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "committeeTerm"}, ) """Committee Term.""" - rank: Optional[int] = None + rank: Optional[int] = dataclass_field(default=None, kw_only=True) """Rank.""" @@ -2581,86 +2922,99 @@ class RegistrantCancellationData: Definition: RegistrantCancellationData """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - registration_number: Optional[str] = field( + registration_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "registrationNumber"}, ) """Registration Number.""" - event_cancellation_date: Optional[str] = field( + event_cancellation_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventCancellationDate"}, ) """Event Cancellation Date.""" - guest_of_record_number: Optional[str] = field( + guest_of_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "guestOfRecordNumber"}, ) """Guest Of Record Number.""" - cancelled_sessions: Optional[List[Dict[str, Any]]] = field( + cancelled_sessions: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "cancelledSessions"}, ) """Cancelled Sessions.""" - first_name: Optional[str] = field( + first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstName"}, ) """First Name.""" - last_name: Optional[str] = field( + last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastName"}, ) """Last Name.""" - middle_name: Optional[str] = field( + middle_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "middleName"}, ) """Middle Name.""" - preferred_first_name: Optional[str] = field( + preferred_first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredFirstName"}, ) """Preferred First Name.""" - second_last_name: Optional[str] = field( + second_last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "secondLastName"}, ) """Second Last Name.""" - prefix: Optional[str] = None + prefix: Optional[str] = dataclass_field(default=None, kw_only=True) """Prefix.""" - suffix: Optional[str] = None + suffix: Optional[str] = dataclass_field(default=None, kw_only=True) """Suffix.""" - gender: Optional[str] = None + gender: Optional[str] = dataclass_field(default=None, kw_only=True) """Gender.""" - primary_organization: Optional[Dict[str, Any]] = field( + primary_organization: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "primaryOrganization"}, ) """primaryOrganization""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - customer_type: Optional[str] = field( + customer_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customerType"}, ) """Customer Type.""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - addresses: Optional[List[Dict[str, Any]]] = None + addresses: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Addresses.""" - emails: Optional[List[Dict[str, Any]]] = None + emails: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Emails""" - phones: Optional[List[Dict[str, Any]]] = None + phones: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Phones.""" @@ -2670,32 +3024,39 @@ class PayableOrderData: Definition: PayableOrderData """ - number: Optional[str] = None + number: Optional[str] = dataclass_field(default=None, kw_only=True) """Number.""" - date: Optional[str] = None + date: Optional[str] = dataclass_field(default=None, kw_only=True) """Date.""" - balance: Optional[float] = None + balance: Optional[float] = dataclass_field(default=None, kw_only=True) """Balance.""" - line_items: Optional[List[Dict[str, Any]]] = field( + line_items: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineItems"}, ) """lineItems""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - customer_id: Optional[str] = field( + customer_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customerId"}, ) """Customer Id.""" - total_amount: Optional[float] = field( + total_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "totalAmount"}, ) """Total Amount.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" @@ -2705,18 +3066,21 @@ class BaseNoteData: Definition: BaseNoteData """ - content: Optional[str] = field( + content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Content"}, ) """Content.""" - category: Optional[str] = field( + category: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Category"}, ) """Category.""" - is_internal: Optional[bool] = field( + is_internal: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isInternal"}, ) """Is Internal.""" @@ -2728,19 +3092,21 @@ class TaskSaveData: Definition: TaskSaveData """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - category: Optional[str] = None + category: Optional[str] = dataclass_field(default=None, kw_only=True) """Category.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - due_date: Optional[str] = field( + due_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDate"}, ) """Due Date.""" @@ -2752,21 +3118,23 @@ class CountryData: Definition: CountryData """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - two_letter_iso_code: Optional[str] = field( + two_letter_iso_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "twoLetterIsoCode"}, ) """Two Letter Iso Code.""" - three_letter_iso_code: Optional[str] = field( + three_letter_iso_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "threeLetterIsoCode"}, ) """Three Letter Iso Code.""" - code: Optional[int] = None + code: Optional[int] = dataclass_field(default=None, kw_only=True) """Code.""" @@ -2776,14 +3144,15 @@ class StateProvinceData: Definition: StateProvinceData """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - abbreviation: Optional[str] = None + abbreviation: Optional[str] = dataclass_field(default=None, kw_only=True) """Abbreviation.""" - iso_code: Optional[str] = field( + iso_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isoCode"}, ) """Iso Code.""" @@ -2795,44 +3164,51 @@ class ExhibitData: Definition: ExhibitData """ - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - start_time: Optional[str] = field( + start_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startTime"}, ) """Start Time.""" - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDate"}, ) """End Date.""" - end_time: Optional[str] = field( + end_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endTime"}, ) """End Time.""" - categories: Optional[List[Dict[str, Any]]] = None + categories: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Categories""" - short_description: Optional[str] = field( + short_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortDescription"}, ) """Short Description.""" - long_description: Optional[str] = field( + long_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "longDescription"}, ) """Long Description.""" - featured_listing: Optional[Dict[str, Any]] = field( + featured_listing: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "featuredListing"}, ) @@ -2843,19 +3219,21 @@ class RequestSaveData: Definition: RequestSaveData """ - requested_by_customer_record_number: Optional[str] = field( + requested_by_customer_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requestedByCustomerRecordNumber"}, ) """Requested By Customer Record Number.""" - request_type: Optional[str] = field( + request_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requestType"}, ) """Request Type.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description.""" - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Source.""" @@ -2865,35 +3243,41 @@ class RelationshipTypeData: Definition: RelationshipTypeData """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - reciprocal_relationship_name: Optional[str] = field( + reciprocal_relationship_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reciprocalRelationshipName"}, ) """Reciprocal Relationship Name.""" - relationship_type: Optional[str] = field( + relationship_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "relationshipType"}, ) """Relationship Type.""" - allow_primary: Optional[bool] = field( + allow_primary: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowPrimary"}, ) """Allow Primary.""" - can_purchase_for_organization: Optional[bool] = field( + can_purchase_for_organization: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "canPurchaseForOrganization"}, ) """Can Purchase For Organization.""" - can_manage_p_a_c: Optional[bool] = field( + can_manage_p_a_c: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "canManagePAC"}, ) """Can Manage PAC.""" - can_manage_organization: Optional[bool] = field( + can_manage_organization: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "canManageOrganization"}, ) """Can Manage Organization.""" @@ -2905,32 +3289,37 @@ class RequestData: Definition: RequestData """ - request_number: Optional[str] = field( + request_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requestNumber"}, ) """Request Number.""" - request_date: Optional[str] = field( + request_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requestDate"}, ) """Request Date.""" - requested_by_customer_record_number: Optional[str] = field( + requested_by_customer_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requestedByCustomerRecordNumber"}, ) """Requested By Customer Record Number.""" - request_type: Optional[str] = field( + request_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requestType"}, ) """Request Type.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description.""" - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Source.""" - closed_date: Optional[str] = field( + closed_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "closedDate"}, ) """Closed Date.""" @@ -2942,16 +3331,17 @@ class NotificationData: Definition: NotificationData """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """Message.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Url.""" - date: Optional[str] = None + date: Optional[str] = dataclass_field(default=None, kw_only=True) """Date.""" - is_read: Optional[bool] = field( + is_read: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isRead"}, ) """Is Read.""" @@ -2963,10 +3353,11 @@ class SaveCategoryBasicData: Definition: SaveCategoryBasicData """ - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - is_primary: Optional[bool] = field( + is_primary: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isPrimary"}, ) """Is Primary.""" @@ -2978,12 +3369,13 @@ class CertificationData: Definition: CertificationData """ - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - expire_date: Optional[str] = field( + expire_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "expireDate"}, ) """Expire Date.""" @@ -2995,14 +3387,15 @@ class ActivityData: Definition: ActivityData """ - category: Optional[str] = None + category: Optional[str] = dataclass_field(default=None, kw_only=True) """Category.""" - text: Optional[str] = None + text: Optional[str] = dataclass_field(default=None, kw_only=True) """Text.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Url.""" - activity_date: Optional[str] = field( + activity_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "activityDate"}, ) """Activity Date.""" @@ -3014,8 +3407,9 @@ class SessionRegistrationData: Definition: SessionRegistrationData """ - session_code: Optional[str] = field( + session_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sessionCode"}, ) """Session Code.""" @@ -3027,31 +3421,35 @@ class AwardData: Definition: AwardData """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description.""" - year: Optional[int] = None + year: Optional[int] = dataclass_field(default=None, kw_only=True) """Year.""" - customer_type: Optional[str] = field( + customer_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customerType"}, ) """Customer Type.""" - allow_public_nomination: Optional[bool] = field( + allow_public_nomination: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowPublicNomination"}, ) """Allow Public Nomination.""" - nomination_start_date: Optional[str] = field( + nomination_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nominationStartDate"}, ) """Nomination Start Date.""" - nomination_end_date: Optional[str] = field( + nomination_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nominationEndDate"}, ) """Nomination End Date.""" @@ -3063,26 +3461,29 @@ class LicenseData: Definition: LicenseData """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - license_type: Optional[str] = field( + license_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "licenseType"}, ) """License Type.""" - number: Optional[str] = None + number: Optional[str] = dataclass_field(default=None, kw_only=True) """Number.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """State.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - expiration_date: Optional[str] = field( + expiration_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "expirationDate"}, ) """Experation Date.""" @@ -3094,53 +3495,61 @@ class CommitteeNomineeData: Definition: CommitteeNomineeData """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID.""" - first_name: Optional[str] = field( + first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstName"}, ) """First Name.""" - last_name: Optional[str] = field( + last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastName"}, ) """Last Name.""" - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - position: Optional[str] = None + position: Optional[str] = dataclass_field(default=None, kw_only=True) """Position.""" - position_code: Optional[str] = field( + position_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "positionCode"}, ) """Position Code.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDate"}, ) """End Date.""" - primary_organization: Optional[Dict[str, Any]] = field( + primary_organization: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "primaryOrganization"}, ) - organization_representing: Optional[Dict[str, Any]] = field( + organization_representing: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "organizationRepresenting"}, ) - nominated_by_customer: Optional[Dict[str, Any]] = field( + nominated_by_customer: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nominatedByCustomer"}, ) - addresses: Optional[List[Dict[str, Any]]] = None - phones: Optional[List[Dict[str, Any]]] = None - emails: Optional[List[Dict[str, Any]]] = None - rank: Optional[int] = None + addresses: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + phones: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + emails: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + rank: Optional[int] = dataclass_field(default=None, kw_only=True) """Rank.""" @@ -3150,33 +3559,39 @@ class RelationshipData: Definition: RelationshipData """ - relationship_name: Optional[str] = field( + relationship_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "relationshipName"}, ) """Relationship Name.""" - related_to_customer: Optional[Dict[str, Any]] = field( + related_to_customer: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "relatedToCustomer"}, ) """Related To Customer.""" - reciprocal_relationship_name: Optional[str] = field( + reciprocal_relationship_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reciprocalRelationshipName"}, ) """Reciprocal Relationship Name.""" - is_primary: Optional[bool] = field( + is_primary: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isPrimary"}, ) """Is Primary.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDate"}, ) """End Date.""" @@ -3188,51 +3603,60 @@ class RegistrationData: Definition: RegistrationData """ - individual_id: Optional[str] = field( + individual_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "individualId"}, ) """Individual ID.""" - event: Optional[Dict[str, Any]] = None + event: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Event.""" - sessions: Optional[List[Dict[str, Any]]] = None + sessions: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Sessions.""" - badge_name: Optional[str] = field( + badge_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "badgeName"}, ) """Badge Name.""" - badge_organization: Optional[str] = field( + badge_organization: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "badgeOrganization"}, ) """Badge Organization.""" - badge_city: Optional[str] = field( + badge_city: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "badgeCity"}, ) """Badge City.""" - badge_state: Optional[str] = field( + badge_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "badgeState"}, ) """Badge State.""" - bought_together_with: Optional[List[Dict[str, Any]]] = field( + bought_together_with: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "boughtTogetherWith"}, ) - registrant_type_code: Optional[str] = field( + registrant_type_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "registrantTypeCode"}, ) """Registrant Type Code.""" - registrant_type_name: Optional[str] = field( + registrant_type_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "registrantTypeName"}, ) """Registrant Type Name.""" - registration_number: Optional[str] = field( + registration_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "registrationNumber"}, ) """Registration Number.""" @@ -3244,23 +3668,26 @@ class CommitteeMemberData: Definition: CommitteeMemberData """ - committee: Optional[Dict[str, Any]] = None - position: Optional[str] = None + committee: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + position: Optional[str] = dataclass_field(default=None, kw_only=True) """Position.""" - position_code: Optional[str] = field( + position_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "positionCode"}, ) """Position Code.""" - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDate"}, ) """End Date.""" @@ -3272,99 +3699,117 @@ class EventData: Definition: EventData """ - event_id: Optional[str] = field( + event_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventId"}, ) """Event ID.""" - event_code: Optional[str] = field( + event_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventCode"}, ) """Event Code.""" - event_name: Optional[str] = field( + event_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventName"}, ) """Event Name.""" - event_start_date: Optional[str] = field( + event_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventStartDate"}, ) """Event Start Date.""" - event_start_time: Optional[str] = field( + event_start_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventStartTime"}, ) """Event Start Time.""" - event_end_date: Optional[str] = field( + event_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventEndDate"}, ) """Event End Date.""" - event_end_time: Optional[str] = field( + event_end_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventEndTime"}, ) """Event End Time.""" - event_timezone: Optional[str] = field( + event_timezone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventTimezone"}, ) """Event Time Zone.""" - event_description: Optional[str] = field( + event_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventDescription"}, ) """Event Description.""" - short_description: Optional[str] = field( + short_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortDescription"}, ) """Short Description.""" - public_event: Optional[bool] = field( + public_event: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "publicEvent"}, ) """Public Event.""" - image_url: Optional[List[str]] = field( + image_url: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "imageUrl"}, ) """Image Url.""" - external_url: Optional[str] = field( + external_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "externalUrl"}, ) """External Url.""" - external_code: Optional[str] = field( + external_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "externalCode"}, ) """External Code.""" - event_locations: Optional[List[Dict[str, Any]]] = field( + event_locations: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventLocations"}, ) """Event Locations.""" - categories: Optional[List[Dict[str, Any]]] = None + categories: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Event Locations - Categories.""" - education_credits: Optional[List[Dict[str, Any]]] = field( + education_credits: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "educationCredits"}, ) """Event Locations - Education Credits.""" - uploads_data: Optional[List[Dict[str, Any]]] = field( + uploads_data: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "uploadsData"}, ) """Event Locations - Uploads Data""" - related_products: Optional[List[Dict[str, Any]]] = field( + related_products: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "relatedProducts"}, ) """Event Locations - Related Products.""" - tags: Optional[List[str]] = None + tags: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Event Locations - Tags""" @@ -3374,26 +3819,21 @@ class PhoneSaveData: Definition: PhoneSaveData """ - country_name: Optional[str] = field( - default=None, - metadata={"wire_name": "countryName"}, - ) + country_name: str = dataclass_field(metadata={"wire_name": "countryName"}) """Country Name.""" - primary: Optional[bool] = None + primary: Optional[bool] = dataclass_field(default=None, kw_only=True) """Primary.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show in Directory.""" - number: Optional[str] = None + number: str """Number.""" - extension: Optional[str] = None + extension: Optional[str] = dataclass_field(default=None, kw_only=True) """Extension.""" - type_name: Optional[str] = field( - default=None, - metadata={"wire_name": "typeName"}, - ) + type_name: str = dataclass_field(metadata={"wire_name": "typeName"}) """Type Name.""" @@ -3403,18 +3843,21 @@ class IndividualPayload: Definition: IndividualPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) """Notifications.""" @@ -3426,18 +3869,21 @@ class CommitteeMemberPayload: Definition: CommitteeMemberPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) """Notifications.""" @@ -3449,18 +3895,21 @@ class PurchaseCancelledPayload: Definition: PurchaseCancelledPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) """Notifications.""" @@ -3472,18 +3921,21 @@ class CustomerRequestPayload: Definition: CustomerRequestPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id,.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) """Notifications.""" @@ -3495,18 +3947,21 @@ class EmailPayload: Definition: EmailPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) """Notifications.""" @@ -3518,49 +3973,49 @@ class CommitteeMemberCreateData: Definition: CommitteeMemberCreateData """ - record_number: Optional[str] = field( - default=None, + record_number: str = dataclass_field( metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Member Code.""" - position_code: Optional[str] = field( - default=None, + position_code: str = dataclass_field( metadata={"wire_name": "positionCode"}, ) """Position Code.""" - start_date: Optional[str] = field( - default=None, - metadata={"wire_name": "startDate"}, - ) + start_date: str = dataclass_field(metadata={"wire_name": "startDate"}) """Start Date.""" - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDate"}, ) """End Date.""" - representing_organization_record_number: Optional[str] = field( + representing_organization_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "representingOrganizationRecordNumber"}, ) """Representing Organization - Record Number.""" - representing_organization_relationship_name: Optional[str] = field( + representing_organization_relationship_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "representingOrganizationRelationshipName"}, ) """Representing Organization - Relationship Name.""" - nominated_by_customer_record_number: Optional[str] = field( + nominated_by_customer_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nominatedByCustomerRecordNumber"}, ) """Nominated By - Record Number""" - committee_term: Optional[int] = field( + committee_term: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "committeeTerm"}, ) """Committee Term.""" - rank: Optional[int] = None + rank: Optional[int] = dataclass_field(default=None, kw_only=True) """Rank.""" @@ -3570,16 +4025,17 @@ class SubscriptionData: Definition: SubscriptionData """ - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - expire_date: Optional[str] = field( + expire_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "expireDate"}, ) """Expire Date.""" - quantity: Optional[int] = None + quantity: Optional[int] = dataclass_field(default=None, kw_only=True) """Quantity.""" @@ -3589,16 +4045,17 @@ class CommitteePositionData: Definition: CommitteePositionData """ - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - term: Optional[int] = None + term: Optional[int] = dataclass_field(default=None, kw_only=True) """Term.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description.""" - is_admin: Optional[bool] = field( + is_admin: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAdmin"}, ) """Is Admin.""" @@ -3610,49 +4067,55 @@ class CommitteeData: Definition: CommitteeData """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name.""" - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Code.""" - website: Optional[str] = None + website: Optional[str] = dataclass_field(default=None, kw_only=True) """Website.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id.""" - parent_committee_id: Optional[str] = field( + parent_committee_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentCommitteeId"}, ) """Parent Committee Id.""" - category_name: Optional[str] = field( + category_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "categoryName"}, ) """Category Name.""" - category_code: Optional[str] = field( + category_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "categoryCode"}, ) """Category Code.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDate"}, ) """End Date.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - term: Optional[Dict[str, Any]] = None + term: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Term.""" - tags: Optional[List[str]] = None + tags: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Tags.""" @@ -3662,49 +4125,57 @@ class CommitteeMemberUpdateData: Definition: CommitteeMemberUpdateData """ - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """Member Code.""" - position_code: Optional[str] = field( + position_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "positionCode"}, ) """New Position Code.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """Start Date.""" - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDate"}, ) """End Date.""" - representing_organization_record_number: Optional[str] = field( + representing_organization_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "representingOrganizationRecordNumber"}, ) """Representing Organization - Record Number.""" - representing_organization_relationship_name: Optional[str] = field( + representing_organization_relationship_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "representingOrganizationRelationshipName"}, ) """Representing Organization - Relationship Name.""" - nominated_by_customer_record_number: Optional[str] = field( + nominated_by_customer_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nominatedByCustomerRecordNumber"}, ) """Nominated By - Record Number""" - committee_term: Optional[int] = field( + committee_term: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "committeeTerm"}, ) """Committee Term.""" - rank: Optional[int] = None + rank: Optional[int] = dataclass_field(default=None, kw_only=True) """Rank.""" @@ -3714,34 +4185,33 @@ class EducationCreditData: Definition: EducationCreditData """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Education Credit Type.""" - description: Optional[str] = None + description: str """Description.""" - number_of_credits: Optional[float] = field( - default=None, + number_of_credits: float = dataclass_field( metadata={"wire_name": "numberOfCredits"}, ) """Number of Credits Earned.""" - date_earned: Optional[str] = field( - default=None, - metadata={"wire_name": "dateEarned"}, - ) + date_earned: str = dataclass_field(metadata={"wire_name": "dateEarned"}) """Earned Date.""" - provider_name: Optional[str] = field( + provider_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "providerName"}, ) """Provider Name.""" - state_name: Optional[str] = field( + state_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "stateName"}, ) """State or Province Name.""" - reference: Optional[str] = None + reference: Optional[str] = dataclass_field(default=None, kw_only=True) """Reference.""" - is_self_reported: Optional[bool] = field( + is_self_reported: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isSelfReported"}, ) """Is Self Reported.""" @@ -3753,24 +4223,27 @@ class NoteData: Definition: NoteData """ - is_alert: Optional[bool] = field( + is_alert: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAlert"}, ) """Is Alert.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - follow_up_date: Optional[str] = field( + follow_up_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "followUpDate"}, ) """Follow Up Date.""" - content: Optional[str] = None + content: str """Content.""" - category: Optional[str] = None + category: Optional[str] = dataclass_field(default=None, kw_only=True) """Category.""" - is_internal: Optional[bool] = field( + is_internal: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isInternal"}, ) """Is Internal.""" @@ -3782,29 +4255,27 @@ class AwardNominationData: Definition: AwardNominationData """ - nominee_record_number: Optional[str] = field( - default=None, + nominee_record_number: str = dataclass_field( metadata={"wire_name": "nomineeRecordNumber"}, ) """Nominee Record Number.""" - nominated_by_customer_record_number: Optional[str] = field( - default=None, + nominated_by_customer_record_number: str = dataclass_field( metadata={"wire_name": "nominatedByCustomerRecordNumber"}, ) """Nominated By Record Number.""" - nomination_date: Optional[str] = field( - default=None, + nomination_date: str = dataclass_field( metadata={"wire_name": "nominationDate"}, ) """Nomination Date.""" - awarded_date: Optional[str] = field( + awarded_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "awardedDate"}, ) """Awarded Date.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """An explanation why the nominee should be considered for the award.""" @@ -3814,29 +4285,29 @@ class UpdateAwardNominationData: Definition: UpdateAwardNominationData """ - nominee_record_number: Optional[str] = field( + nominee_record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nomineeRecordNumber"}, ) """Nominee Record Number.""" - nominated_by_customer_record_number: Optional[str] = field( - default=None, + nominated_by_customer_record_number: str = dataclass_field( metadata={"wire_name": "nominatedByCustomerRecordNumber"}, ) """Nominated By Record Number.""" - nomination_date: Optional[str] = field( - default=None, + nomination_date: str = dataclass_field( metadata={"wire_name": "nominationDate"}, ) """Nomination Date.""" - awarded_date: Optional[str] = field( + awarded_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "awardedDate"}, ) """Awarded Date.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """An explanation why the nominee should be considered for the award.""" @@ -3846,68 +4317,78 @@ class AwardRecipientIndividualData: Definition: AwardRecipientIndividualData """ - awarded_date: Optional[str] = field( + awarded_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "awardedDate"}, ) """Awarded Date.""" - first_name: Optional[str] = field( + first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstName"}, ) """First Name.""" - last_name: Optional[str] = field( + last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastName"}, ) """Last Name.""" - middle_name: Optional[str] = field( + middle_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "middleName"}, ) """Middle Name.""" - preferred_first_name: Optional[str] = field( + preferred_first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredFirstName"}, ) """Preferred First Name.""" - second_last_name: Optional[str] = field( + second_last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "secondLastName"}, ) """Second Last Name.""" - prefix: Optional[str] = None + prefix: Optional[str] = dataclass_field(default=None, kw_only=True) """Prefix.""" - suffix: Optional[str] = None + suffix: Optional[str] = dataclass_field(default=None, kw_only=True) """Suffix.""" - gender: Optional[str] = None + gender: Optional[str] = dataclass_field(default=None, kw_only=True) """Gender.""" - primary_organization: Optional[Dict[str, Any]] = field( + primary_organization: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "primaryOrganization"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Individual Id.""" - customer_type: Optional[str] = field( + customer_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customerType"}, ) """Customer Type.""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - addresses: Optional[List[Dict[str, Any]]] = None + addresses: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Addresses.""" - emails: Optional[List[Dict[str, Any]]] = None + emails: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Emails.""" - phones: Optional[List[Dict[str, Any]]] = None + phones: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Phones.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" @@ -3919,52 +4400,59 @@ class AwardRecipientOrganizationData: Definition: AwardRecipientOrganizationData """ - awarded_date: Optional[str] = field( + awarded_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "awardedDate"}, ) """Awarded Date.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Organization Name.""" - acronym: Optional[str] = None + acronym: Optional[str] = dataclass_field(default=None, kw_only=True) """Acronym.""" - branch_name: Optional[str] = field( + branch_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "branchName"}, ) """Branch Name.""" - annual_sales: Optional[float] = field( + annual_sales: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "annualSales"}, ) """Annual Sales.""" - employee_range_id: Optional[str] = field( + employee_range_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "employeeRangeId"}, ) """Employee Range Id.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Organization Id.""" - customer_type: Optional[str] = field( + customer_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customerType"}, ) """Customer Type.""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - show_in_directory: Optional[bool] = field( + show_in_directory: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInDirectory"}, ) """Show In Directory.""" - addresses: Optional[List[Dict[str, Any]]] = None + addresses: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Addresses.""" - emails: Optional[List[Dict[str, Any]]] = None + emails: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Emails.""" - phones: Optional[List[Dict[str, Any]]] = None + phones: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Phones.""" @@ -3974,28 +4462,31 @@ class OrganizationLookupBasicData: Definition: OrganizationLookupBasicData """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Organization Name.""" - acronym: Optional[str] = None + acronym: Optional[str] = dataclass_field(default=None, kw_only=True) """Acronym.""" - branch_name: Optional[str] = field( + branch_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "branchName"}, ) """Branch Name.""" - employee_range_id: Optional[str] = field( + employee_range_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "employeeRangeId"}, ) """Employee Range Id.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Organization Id.""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" - addresses: Optional[List[Dict[str, Any]]] = None + addresses: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Addresses.""" @@ -4005,47 +4496,54 @@ class IndividualLookupBasicData: Definition: IndividualLookupBasicData """ - first_name: Optional[str] = field( + first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstName"}, ) """First Name.""" - last_name: Optional[str] = field( + last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastName"}, ) """Last Name.""" - middle_name: Optional[str] = field( + middle_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "middleName"}, ) """Middle Name.""" - preferred_first_name: Optional[str] = field( + preferred_first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredFirstName"}, ) """Preferred First Name.""" - second_last_name: Optional[str] = field( + second_last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "secondLastName"}, ) """Second Last Name.""" - prefix: Optional[str] = None + prefix: Optional[str] = dataclass_field(default=None, kw_only=True) """Prefix.""" - suffix: Optional[str] = None + suffix: Optional[str] = dataclass_field(default=None, kw_only=True) """Suffix.""" - gender: Optional[str] = None + gender: Optional[str] = dataclass_field(default=None, kw_only=True) """Gender.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title.""" - primary_organization: Optional[Dict[str, Any]] = field( + primary_organization: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "primaryOrganization"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Individual Id.""" - record_number: Optional[str] = field( + record_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordNumber"}, ) """Record Number.""" @@ -4057,18 +4555,21 @@ class CustomerCustomFieldValuePayload: Definition: CustomerCustomFieldValuePayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) @@ -4079,18 +4580,21 @@ class CustomerMergedPayload: Definition: CustomerMergedPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) @@ -4101,18 +4605,21 @@ class CustomerRelationshipUpdatedPayload: Definition: CustomerRelationshipUpdatedPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) @@ -4123,18 +4630,21 @@ class CustomerPhoneUpdatedPayload: Definition: CustomerPhoneUpdatedPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) @@ -4145,18 +4655,21 @@ class CustomerAddressUpdatedPayload: Definition: CustomerAddressUpdatedPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) @@ -4167,18 +4680,21 @@ class EventRegistrationSubstitutedPayload: Definition: EventRegistrationSubstitutedPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) @@ -4189,18 +4705,21 @@ class IndividualRequestToBeForgottenPayload: Definition: IndividualRequestToBeForgottenPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) @@ -4211,18 +4730,21 @@ class ProductPurchasePayload: Definition: ProductPurchasePayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) @@ -4233,18 +4755,21 @@ class MembershipTypeTerminatedPayload: Definition: MembershipTypeTerminatedPayload """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebhookId"}, ) """Webhook Id.""" - properties: Optional[Dict[str, Any]] = field( + properties: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Properties.""" - notifications: Optional[List[Dict[str, Any]]] = field( + notifications: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Notifications"}, ) @@ -4260,7 +4785,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -4277,8 +4802,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -4299,7 +4824,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -4314,13 +4839,90 @@ def __init__( def connector_name(self) -> str: return "impexium" - async def get_abandoned_checkouts_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def get_abandoned_checkouts( self, page_number: int, abandoned_from: str, + *, product_code: Optional[str] = None, customer_record_number: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4330,6 +4932,24 @@ async def get_abandoned_checkouts_async( Get Abandoned Checkouts Get Abandoned Checkouts + + Swagger operation ID: `GetAbandonedCheckouts`. + + Args: + page_number: Page Number. + abandoned_from: Abandoned From. + product_code: Product Code. + customer_record_number: Customer Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4357,7 +4977,7 @@ async def get_abandoned_checkouts_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4371,6 +4991,7 @@ async def get_abandoned_checkouts_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4378,7 +4999,7 @@ async def get_abandoned_checkouts_async( return json.loads(response.text) - async def list_all_exhibitors_async( + def list_all_exhibitors( self, exhibit_code: str, page_number: int, @@ -4387,11 +5008,30 @@ async def list_all_exhibitors_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List All Exhibitors List All Exhibitors + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-All-Exhibitors`. + + Args: + exhibit_code: Exhibit Code. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4402,47 +5042,96 @@ async def list_all_exhibitors_async( f"/Exhibitors" f"/{quote(str(page_number), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item + + return None, items() - async def list_of_exams_async( + return AsyncItemPaged(get_next, extract_data) + + def list_of_exams( self, page_number: int, + *, code: Optional[str] = None, category_name: Optional[str] = None, is_public: Optional[bool] = None, changed_since: Optional[str] = None, tag: Optional[str] = None, include_prices: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List of Exams List of Exams + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-of-Exams`. + + Args: + page_number: The page number of the result set. + code: A specific Exam code. + category_name: A specific Exam Category name. + is_public: When set to true, only public Exams will be displayed; + If it's not specified will display all. + changed_since: When a date (yyyy-MM-ddTHH:mm:ss (UTC)) is + specified, only Exams modified after this date will be + displayed. + tag: Tag. + include_prices: When set to true, add the active price list for + every product. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4481,45 +5170,88 @@ async def list_of_exams_async( query_params.append(f"includePrices={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item + + return None, items() - async def list_registrants_async( + return AsyncItemPaged(get_next, extract_data) + + def list_registrants( self, event_code: str, page_number: int, + *, session_code: Optional[str] = None, include_details: Optional[bool] = None, registered_since: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Registrants List Registrants + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-Registrants`. + + Args: + event_code: Event Code. + page_number: Page Number. + session_code: Session Code. + include_details: Include Details. + registered_since: Registered Since. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4548,29 +5280,50 @@ async def list_registrants_async( query_params.append(f"registeredSince={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item + + return None, items() - async def get_course_attendees_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_course_attendees( self, code: str, page_number: int, @@ -4584,6 +5337,22 @@ async def get_course_attendees_async( Get Course Attendees Get Course Attendees + + Swagger operation ID: `Get-Course-Attendees`. + + Args: + code: Course Code. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4595,7 +5364,7 @@ async def get_course_attendees_async( f"/{quote(str(page_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4609,6 +5378,7 @@ async def get_course_attendees_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4616,7 +5386,7 @@ async def get_course_attendees_async( return json.loads(response.text) - async def add_exam_scores_async( + async def add_exam_scores( self, input: AddExamScoresInput, exam_code: str, @@ -4630,13 +5400,29 @@ async def add_exam_scores_async( Add Exam Scores Add Exam Scores + + Swagger operation ID: `Add-Exam-Scores`. + + Args: + input: The request body. + exam_code: Exam Code. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Exams/{quote(str(exam_code), safe='')}/Scores" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4650,6 +5436,7 @@ async def add_exam_scores_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4657,7 +5444,7 @@ async def add_exam_scores_async( return json.loads(response.text) - async def find_members_by_name_async( + async def find_members_by_name( self, name: str, page_number: int, @@ -4671,6 +5458,22 @@ async def find_members_by_name_async( Find Members by Name Find Members by Name + + Swagger operation ID: `Find-Members-by-Name`. + + Args: + name: Individual or Organization name. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4683,7 +5486,7 @@ async def find_members_by_name_async( f"/{quote(str(page_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4697,6 +5500,7 @@ async def find_members_by_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4704,14 +5508,14 @@ async def find_members_by_name_async( return json.loads(response.text) - async def get_purchases_for_an_individual_async( + async def get_purchases_for_an_individual( self, id_or_record_number: str, page_number: int, + *, product_code: Optional[str] = None, purchased_since: Optional[str] = None, product_category_code: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4721,6 +5525,25 @@ async def get_purchases_for_an_individual_async( Get Purchases for an Individual Get Purchases for an Individual + + Swagger operation ID: `Get-Purchases-for-an-Individual`. + + Args: + id_or_record_number: Individual ID or Record Number. + page_number: Page Number. + product_code: Product Code. + purchased_since: yyyy-MM-ddTHH:mm:ss. + product_category_code: Product Category Code. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4750,7 +5573,7 @@ async def get_purchases_for_an_individual_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4764,6 +5587,7 @@ async def get_purchases_for_an_individual_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4771,7 +5595,7 @@ async def get_purchases_for_an_individual_async( return json.loads(response.text) - async def add_or_update_a_list_of_custom_fields_per_organization_async( + async def add_or_update_a_list_of_custom_fields_per_organization( self, input: AddOrUpdateAListOfCustomFieldsPerOrganizationInput, id_or_record_number: str, @@ -4785,6 +5609,23 @@ async def add_or_update_a_list_of_custom_fields_per_organization_async( Add or Update a List of Custom Fields Per Organization Add or Update a List of Custom Fields Per Organization + + Swagger operation ID: + `Add-or-Update-a-List-of-Custom-Fields-Per-Organization`. + + Args: + input: The request body. + id_or_record_number: Organization ID or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4795,7 +5636,7 @@ async def add_or_update_a_list_of_custom_fields_per_organization_async( f"/CustomFieldsList" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4809,6 +5650,7 @@ async def add_or_update_a_list_of_custom_fields_per_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4816,9 +5658,9 @@ async def add_or_update_a_list_of_custom_fields_per_organization_async( return json.loads(response.text) - async def add_nominee_async( + async def add_nominee( self, - input: CommitteeNomineeSaveData, + input: CommitteeNomineeSaveData | Mapping[str, Any], code: str, *, timeout: Optional[float] = None, @@ -4830,13 +5672,30 @@ async def add_nominee_async( Add Nominee Add Nominee + + Swagger operation ID: `Add-Nominee`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + code: Committee Code. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Committees/{quote(str(code), safe='')}/Nominations" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4850,9 +5709,10 @@ async def add_nominee_async( request_url, response.status, response.text, + response=response, ) - async def get_individual_custom_field_values_async( + def list_individual_custom_field_values( self, id: str, *, @@ -4860,41 +5720,80 @@ async def get_individual_custom_field_values_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Individual Custom Field Values Get Individual Custom Field Values - """ - request_url = ( + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Get-Individual-Custom-Field-Values`. + + Args: + id: Individual ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. + """ + request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Individuals/{quote(str(id), safe='')}/CustomFields" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def update_custom_field_value_async( + return AsyncItemPaged(get_next, extract_data) + + async def update_custom_field_value( self, - input: CustomFieldData, + input: CustomFieldData | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -4906,13 +5805,30 @@ async def update_custom_field_value_async( Update Individual Custom Field Values Update Individual Custom Field Values. + + Swagger operation ID: `Update-custom-field-value`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Customer ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Individuals/{quote(str(id), safe='')}/CustomFields" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4926,24 +5842,48 @@ async def update_custom_field_value_async( request_url, response.status, response.text, + response=response, ) - async def list_all_event_cancellations_by_event_async( + def list_all_event_cancellations_by_event( self, event_code: str, page_number: int, + *, include_details: Optional[bool] = None, cancelled_since: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List All Event Cancellations by Event List All Event Cancellations by Event + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-All-Event-Cancellations-by-Event`. + + Args: + event_code: A valid Event Code. + page_number: Page Number. + include_details: Indicates if additional information should be + returned. + cancelled_since: The initial date to search cancellations + (yyyy-MM-ddTHH:mm:ss). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4967,36 +5907,57 @@ async def list_all_event_cancellations_by_event_async( query_params.append(f"cancelledSince={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item - async def get_all_open_orders_for_an_individual_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_all_open_orders_for_an_individual( self, id_or_record_number: str, page_number: int, + *, include_line_items: Optional[bool] = None, from_date: Optional[str] = None, to_date: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5006,6 +5967,25 @@ async def get_all_open_orders_for_an_individual_async( Get All Open Orders for an Individual Get All Open Orders for an Individual + + Swagger operation ID: `Get-All-Open-Orders-for-an-Individual`. + + Args: + id_or_record_number: Individual ID or Record Number. + page_number: Page Number. + include_line_items: Include Line Items. + from_date: From Date. + to_date: To Date. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5036,7 +6016,7 @@ async def get_all_open_orders_for_an_individual_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5050,6 +6030,7 @@ async def get_all_open_orders_for_an_individual_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5057,7 +6038,7 @@ async def get_all_open_orders_for_an_individual_async( return json.loads(response.text) - async def list_completed_user_tasks_by_user_id_or_email_async( + def list_completed_user_tasks_by_user_id_or_email( self, user_id_or_email: str, page_number: int, @@ -5066,11 +6047,30 @@ async def list_completed_user_tasks_by_user_id_or_email_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Completed User Tasks by User ID or Email List Completed User Tasks by User ID or Email + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-Completed-User-Tasks-by-User-ID-or-Email`. + + Args: + user_id_or_email: A valid User ID or Email. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5082,29 +6082,50 @@ async def list_completed_user_tasks_by_user_id_or_email_async( f"/Completed" f"/{quote(str(page_number), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_pending_user_tasks_by_user_id_or_email_async( + def list_pending_user_tasks_by_user_id_or_email( self, user_id_or_email: str, page_number: int, @@ -5113,11 +6134,30 @@ async def list_pending_user_tasks_by_user_id_or_email_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Pending User Tasks by User ID or Email List Pending User Tasks by User ID or Email + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-Pending-User-Tasks-by-User-ID-or-Email`. + + Args: + user_id_or_email: A valid User ID or Email. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5129,31 +6169,52 @@ async def list_pending_user_tasks_by_user_id_or_email_async( f"/Pending" f"/{quote(str(page_number), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item + + return None, items() - async def add_note_to_sales_opportunity_async( + return AsyncItemPaged(get_next, extract_data) + + async def add_note_to_sales_opportunity( self, - input: BaseNoteData, + input: BaseNoteData | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -5165,13 +6226,30 @@ async def add_note_to_sales_opportunity_async( Add Note to Sales Opportunity Add Note to Sales Opportunity + + Swagger operation ID: `Add-Note-to-Sales-Opportunity`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Sales opportunity ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Sales/Opportunities/{quote(str(id), safe='')}/Notes" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5185,11 +6263,12 @@ async def add_note_to_sales_opportunity_async( request_url, response.status, response.text, + response=response, ) - async def add_activity_to_sales_opportunity_async( + async def add_activity_to_sales_opportunity( self, - input: ActivityData, + input: ActivityData | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -5201,13 +6280,30 @@ async def add_activity_to_sales_opportunity_async( Add Activity to Sales Opportunity Add Activity to Sales Opportunity + + Swagger operation ID: `Add-Activity-to-Sales-Opportunity`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Opportunity ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Sales/Opportunities/{quote(str(id), safe='')}/Activities" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5221,11 +6317,12 @@ async def add_activity_to_sales_opportunity_async( request_url, response.status, response.text, + response=response, ) - async def update_task_by_task_number_async( + async def update_task_by_task_number( self, - input: TaskSaveData, + input: TaskSaveData | Mapping[str, Any], task_number: str, *, timeout: Optional[float] = None, @@ -5237,13 +6334,30 @@ async def update_task_by_task_number_async( Update Task by Task Number Update Task by Task Number + + Swagger operation ID: `Update-Task-by-Task-Number`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + task_number: A valid Task Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/tasks/{quote(str(task_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5257,6 +6371,7 @@ async def update_task_by_task_number_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5264,7 +6379,7 @@ async def update_task_by_task_number_async( return json.loads(response.text) - async def list_all_countries_async( + def list_all_countries( self, page_number: int, *, @@ -5272,39 +6387,78 @@ async def list_all_countries_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List All Countries List All Countries + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-All-Countries`. + + Args: + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Countries/All/{quote(str(page_number), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item + + return None, items() - async def get_all_states_by_country_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_all_states_by_country( self, country_id: str, page_number: int, @@ -5318,6 +6472,22 @@ async def get_all_states_by_country_async( Get All States by Country Get All States by Country + + Swagger operation ID: `Get-All-States-by-Country`. + + Args: + country_id: Country ID. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5330,7 +6500,7 @@ async def get_all_states_by_country_async( f"/{quote(str(page_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5344,6 +6514,7 @@ async def get_all_states_by_country_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5351,7 +6522,7 @@ async def get_all_states_by_country_async( return json.loads(response.text) - async def list_all_exhibits_async( + def list_all_exhibits( self, page_number: int, *, @@ -5359,39 +6530,78 @@ async def list_all_exhibits_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List All Exhibits List All Exhibits + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-All-Exhibits`. + + Args: + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Exhibits/{quote(str(page_number), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def delete_a_category_for_an_organization_async( + async def delete_a_category_for_an_organization( self, record_number: str, category_code: str, @@ -5405,6 +6615,22 @@ async def delete_a_category_for_an_organization_async( Delete a Category for an Organization Delete a Category for an Organization + + Swagger operation ID: `Delete-a-Category-for-an-Organization`. + + Args: + record_number: Record Number. + category_code: Category Code. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5416,7 +6642,7 @@ async def delete_a_category_for_an_organization_async( f"/{quote(str(category_code), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5430,11 +6656,12 @@ async def delete_a_category_for_an_organization_async( request_url, response.status, response.text, + response=response, ) - async def add_customer_request_async( + async def add_customer_request( self, - input: RequestSaveData, + input: RequestSaveData | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5445,10 +6672,26 @@ async def add_customer_request_async( Add Customer Request Add Customer Request + + Swagger operation ID: `Add-Customer-Request`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v1/Requests" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5462,11 +6705,12 @@ async def add_customer_request_async( request_url, response.status, response.text, + response=response, ) - async def update_customer_request_async( + async def update_customer_request( self, - input: RequestUpdateData, + input: RequestUpdateData | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5477,10 +6721,26 @@ async def update_customer_request_async( Update Customer Request Update Customer Request + + Swagger operation ID: `Update-Customer-Request`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v1/Requests" - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5494,6 +6754,7 @@ async def update_customer_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5501,7 +6762,7 @@ async def update_customer_request_async( return json.loads(response.text) - async def add_categories_for_an_organization_async( + async def add_categories_for_an_organization( self, input: AddCategoriesForAnOrganizationInput, record_number: str, @@ -5515,6 +6776,22 @@ async def add_categories_for_an_organization_async( Add Categories for an Organization Add Categories for an Organization + + Swagger operation ID: `Add-Categories-for-an-Organization`. + + Args: + input: The request body. + record_number: Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5525,7 +6802,7 @@ async def add_categories_for_an_organization_async( f"/Categories" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5539,9 +6816,10 @@ async def add_categories_for_an_organization_async( request_url, response.status, response.text, + response=response, ) - async def list_of_customer_relationships_async( + def list_of_customer_relationships( self, page_number: int, *, @@ -5549,11 +6827,29 @@ async def list_of_customer_relationships_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List of Customer Relationships List of Customer Relationships + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-of-Customer-Relationships`. + + Args: + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5563,29 +6859,50 @@ async def list_of_customer_relationships_async( f"/RelationshipTypes" f"/{quote(str(page_number), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_all_open_customer_request_async( + def list_all_open_customer_request( self, page_number: int, *, @@ -5593,39 +6910,78 @@ async def list_all_open_customer_request_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List All Open Customer Request List All Open Customer Request + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-All-Open-Customer-Request`. + + Args: + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Requests/Open/{quote(str(page_number), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item - async def get_organization_inactive_memberships_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_organization_inactive_memberships( self, id: str, *, @@ -5638,6 +6994,21 @@ async def get_organization_inactive_memberships_async( Get Organization Inactive Memberships Get Organization Inactive Memberships + + Swagger operation ID: `Get-Organization-Inactive-Memberships`. + + Args: + id: Organization ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5649,7 +7020,7 @@ async def get_organization_inactive_memberships_async( f"/Inactive" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5663,6 +7034,7 @@ async def get_organization_inactive_memberships_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5670,7 +7042,7 @@ async def get_organization_inactive_memberships_async( return json.loads(response.text) - async def delete_record_from_custom_data_table_async( + async def delete_record_from_custom_data_table( self, table_name: str, id: str, @@ -5684,6 +7056,22 @@ async def delete_record_from_custom_data_table_async( Delete Record From Custom Data Table Delete Record From Custom Data Table + + Swagger operation ID: `Delete-Record-From-Custom-Data-Table`. + + Args: + table_name: Custom table name. + id: ID of the record to be deleted. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5694,7 +7082,7 @@ async def delete_record_from_custom_data_table_async( f"/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5708,11 +7096,12 @@ async def delete_record_from_custom_data_table_async( request_url, response.status, response.text, + response=response, ) - async def update_user_task_progress_or_mark_as_completed_async( + async def update_user_task_progress_or_mark_as_completed( self, - input: UserTaskData, + input: UserTaskData | Mapping[str, Any], user_id_or_email: str, *, timeout: Optional[float] = None, @@ -5724,13 +7113,30 @@ async def update_user_task_progress_or_mark_as_completed_async( Update User Task Progress or Mark as Completed Update User Task Progress or Mark as Completed + + Swagger operation ID: `Update-User-Task-Progress-or-Mark-as-Completed`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + user_id_or_email: A valid User Id or Email. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/tasks/Users/{quote(str(user_id_or_email), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5744,6 +7150,7 @@ async def update_user_task_progress_or_mark_as_completed_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5751,12 +7158,12 @@ async def update_user_task_progress_or_mark_as_completed_async( return json.loads(response.text) - async def find_members_or_individuals_by_first_name_async( + async def find_members_or_individuals_by_first_name( self, first_name: str, page_number: int, - include_email: Optional[bool] = None, *, + include_email: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5766,6 +7173,23 @@ async def find_members_or_individuals_by_first_name_async( Find Members (Individuals) by First Name Find Members (Individuals) by First Name + + Swagger operation ID: `Find-Members-or-Individuals-by-First-Name`. + + Args: + first_name: First Name. + page_number: Page Number. + include_email: Include Email Data. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5786,7 +7210,7 @@ async def find_members_or_individuals_by_first_name_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5800,6 +7224,7 @@ async def find_members_or_individuals_by_first_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5807,12 +7232,12 @@ async def find_members_or_individuals_by_first_name_async( return json.loads(response.text) - async def find_members_or_individuals_by_last_name_async( + async def find_members_or_individuals_by_last_name( self, last_name: str, page_number: int, - include_email: Optional[bool] = None, *, + include_email: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5822,6 +7247,23 @@ async def find_members_or_individuals_by_last_name_async( Find Members (Individuals) by Last Name Find Members (Individuals) by Last Name + + Swagger operation ID: `Find-Members-or-Individuals-by-Last-Name`. + + Args: + last_name: Last Name. + page_number: Page Number. + include_email: Include Email Data. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5842,7 +7284,7 @@ async def find_members_or_individuals_by_last_name_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5856,6 +7298,7 @@ async def find_members_or_individuals_by_last_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5863,9 +7306,9 @@ async def find_members_or_individuals_by_last_name_async( return json.loads(response.text) - async def assign_task_to_a_user_async( + async def assign_task_to_a_user( self, - input: UserTaskData, + input: UserTaskData | Mapping[str, Any], user_id_or_email: str, *, timeout: Optional[float] = None, @@ -5877,13 +7320,30 @@ async def assign_task_to_a_user_async( Create a new task or Assign Task to a User Create a new task or Assign Task to a User + + Swagger operation ID: `Assign-Task-to-a-User`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + user_id_or_email: A valid User Id or Email. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/tasks/Users/{quote(str(user_id_or_email), safe='')}/Task" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5897,9 +7357,10 @@ async def assign_task_to_a_user_async( request_url, response.status, response.text, + response=response, ) - async def delete_a_category_for_an_individual_async( + async def delete_a_category_for_an_individual( self, record_number: str, category_code: str, @@ -5913,6 +7374,22 @@ async def delete_a_category_for_an_individual_async( Delete a Category for an Individual Delete a Category for an Individual + + Swagger operation ID: `Delete-a-Category-for-an-Individual`. + + Args: + record_number: Record Number. + category_code: Category Code. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5924,7 +7401,7 @@ async def delete_a_category_for_an_individual_async( f"/{quote(str(category_code), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5938,11 +7415,12 @@ async def delete_a_category_for_an_individual_async( request_url, response.status, response.text, + response=response, ) - async def add_notification_to_individual_async( + async def add_notification_to_individual( self, - input: NotificationData, + input: NotificationData | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -5954,13 +7432,30 @@ async def add_notification_to_individual_async( Add Notification to Individual Add Notification to Individual + + Swagger operation ID: `Add-Notification-to-Individual`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Individual ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Individuals/{quote(str(id), safe='')}/Notifications" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5974,9 +7469,10 @@ async def add_notification_to_individual_async( request_url, response.status, response.text, + response=response, ) - async def add_categories_for_an_individual_async( + async def add_categories_for_an_individual( self, input: AddCategoriesForAnIndividualInput, record_number: str, @@ -5990,6 +7486,22 @@ async def add_categories_for_an_individual_async( Add Categories for an Individual Add Categories for an Individual + + Swagger operation ID: `Add-Categories-for-an-Individual`. + + Args: + input: The request body. + record_number: Individual Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6000,7 +7512,7 @@ async def add_categories_for_an_individual_async( f"/Categories" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6014,11 +7526,12 @@ async def add_categories_for_an_individual_async( request_url, response.status, response.text, + response=response, ) - async def add_a_new_task_async( + async def add_a_new_task( self, - input: TaskSaveData, + input: TaskSaveData | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6029,10 +7542,26 @@ async def add_a_new_task_async( Add a New Task Add a New Task + + Swagger operation ID: `Add-a-New-Task`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v1/tasks" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6046,6 +7575,7 @@ async def add_a_new_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6053,9 +7583,10 @@ async def add_a_new_task_async( return json.loads(response.text) - async def list_of_all_organization_members_async( + def list_of_all_organization_members( self, page_number: int, + *, zip_code: Optional[str] = None, radius: Optional[float] = None, state_abbreviation: Optional[str] = None, @@ -6075,16 +7606,52 @@ async def list_of_all_organization_members_async( include_custom_fields: Optional[bool] = None, expiring_from: Optional[str] = None, expiring_to: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List of All Organization Members List of All Organization Members + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-of-All-Organization-Members`. + + Args: + page_number: Page Number. + zip_code: Zip Code. + radius: Radius in Miles. + state_abbreviation: State Abbreviation. + congressional_district: Congressional District. + membership_type_code: A valid code for a Membership Type. + membership_type_category: A valid Membership Type Category name. + city: City. + name: Name. + tag: Tag. + latitude: Latitude. + longitude: Longitude. + domain: Domain. + include_membership: Include Membership Data. + include_address: Include Address Data. + include_phone: Include Phone Data. + include_email: Include Email Data. + include_custom_fields: Include Custom Field Data. + expiring_from: Expire Date - From. + expiring_to: Expire Date - To. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6193,31 +7760,53 @@ async def list_of_all_organization_members_async( query_params.append(f"expiringTo={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item - async def list_of_all_individual_members_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_of_all_individual_members( self, page_number: int, + *, zip_code: Optional[str] = None, radius: Optional[float] = None, membership_type_code: Optional[str] = None, @@ -6233,16 +7822,48 @@ async def list_of_all_individual_members_async( include_membership_renewal_url: Optional[bool] = None, expiring_from: Optional[str] = None, expiring_to: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List of All Individual Members List of All Individual Members + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-of-All-Individual-Members`. + + Args: + page_number: Page Number. + zip_code: Zip Code. + radius: Radius in Miles. + membership_type_code: A valid code for a Membership Type. + membership_type_category: A valid Membership Type Category name. + tag: Tag. + include_membership: Include Membership Data. + include_address: Include Address Data. + include_phone: Include Phone Data. + include_email: Include Email Data. + include_link: Include Link Data. + include_custom_fields: Include Custom Field Data. + include_categories: Include Categories Data. + include_membership_renewal_url: Include Membership Renewal URLs. + expiring_from: Expire Date - From. + expiring_to: Expire Date - To. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6331,29 +7952,50 @@ async def list_of_all_individual_members_async( query_params.append(f"expiringTo={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_list_of_active_certifications_for_an_organization_async( + async def get_list_of_active_certifications_for_an_organization( self, id_or_record_number: str, page_number: int, @@ -6367,6 +8009,23 @@ async def get_list_of_active_certifications_for_an_organization_async( Get List of Active Certifications for an Organization Get List of Active Certifications for an Organization + + Swagger operation ID: + `Get-List-of-Active-Certifications-for-an-Organization`. + + Args: + id_or_record_number: Organization ID or Record Number. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6378,7 +8037,7 @@ async def get_list_of_active_certifications_for_an_organization_async( f"/{quote(str(page_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6392,6 +8051,7 @@ async def get_list_of_active_certifications_for_an_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6399,7 +8059,7 @@ async def get_list_of_active_certifications_for_an_organization_async( return json.loads(response.text) - async def get_list_of_active_certifications_for_an_individual_async( + async def get_list_of_active_certifications_for_an_individual( self, id_or_record_number: str, page_number: int, @@ -6413,6 +8073,23 @@ async def get_list_of_active_certifications_for_an_individual_async( Get List of Active Certifications for an Individual Get List of Active Certifications for an Individual + + Swagger operation ID: + `Get-List-of-Active-Certifications-for-an-Individual`. + + Args: + id_or_record_number: Individual ID or Record Number. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6424,7 +8101,7 @@ async def get_list_of_active_certifications_for_an_individual_async( f"/{quote(str(page_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6438,6 +8115,7 @@ async def get_list_of_active_certifications_for_an_individual_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6445,7 +8123,7 @@ async def get_list_of_active_certifications_for_an_individual_async( return json.loads(response.text) - async def get_individual_inactive_memberships_async( + async def get_individual_inactive_memberships( self, id: str, *, @@ -6458,6 +8136,21 @@ async def get_individual_inactive_memberships_async( Get Individual Inactive Memberships Get Individual Inactive Memberships + + Swagger operation ID: `Get-Individual-Inactive-Memberships`. + + Args: + id: Individual ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6469,7 +8162,7 @@ async def get_individual_inactive_memberships_async( f"/Inactive" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6483,6 +8176,7 @@ async def get_individual_inactive_memberships_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6490,9 +8184,9 @@ async def get_individual_inactive_memberships_async( return json.loads(response.text) - async def add_activity_to_organization_async( + async def add_activity_to_organization( self, - input: ActivityData, + input: ActivityData | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -6504,13 +8198,30 @@ async def add_activity_to_organization_async( Add Activity to Organization Add Activity to Organization + + Swagger operation ID: `Add-Activity-to-Organization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Organization ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Organizations/{quote(str(id), safe='')}/Activities" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6524,15 +8235,16 @@ async def add_activity_to_organization_async( request_url, response.status, response.text, + response=response, ) - async def register_an_individual_for_a_free_session_async( + async def register_an_individual_for_a_free_session( self, input: RegisterAnIndividualForAFreeSessionInput, event_code: str, customer_id_or_record_number: str, - registration_number: Optional[str] = None, *, + registration_number: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -6542,6 +8254,25 @@ async def register_an_individual_for_a_free_session_async( Register an Individual for a Free Session Register an Individual for a Free Session + + Swagger operation ID: `Register-an-Individual-for-a-Free-Session`. + + Args: + input: The request body. + event_code: A Valid Event Code. + customer_id_or_record_number: A Valid Individual ID or Record + Number. + registration_number: A Valid Registration Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6562,7 +8293,7 @@ async def register_an_individual_for_a_free_session_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6576,9 +8307,10 @@ async def register_an_individual_for_a_free_session_async( request_url, response.status, response.text, + response=response, ) - async def get_a_list_of_licenses_async( + async def get_a_list_of_licenses( self, id: str, page_number: int, @@ -6592,6 +8324,22 @@ async def get_a_list_of_licenses_async( Get a List of Licenses Get a List of Licenses + + Swagger operation ID: `Get-a-List-of-Licenses`. + + Args: + id: Individual ID. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6603,7 +8351,7 @@ async def get_a_list_of_licenses_async( f"/{quote(str(page_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6617,6 +8365,7 @@ async def get_a_list_of_licenses_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6624,20 +8373,39 @@ async def get_a_list_of_licenses_async( return json.loads(response.text) - async def list_all_awards_async( + def list_all_awards( self, page_number: int, - year: Optional[int] = None, *, + year: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List All Awards List All Awards + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-All-Awards`. + + Args: + page_number: Page Number. + year: Year. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6651,34 +8419,55 @@ async def list_all_awards_async( query_params.append(f"Year={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item - async def find_members_or_individuals_by_name_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def find_members_or_individuals_by_name( self, name: str, page_number: int, - include_email: Optional[bool] = None, *, + include_email: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -6688,6 +8477,23 @@ async def find_members_or_individuals_by_name_async( Find Members (Individuals) by Name Find Members (Individuals) by Name + + Swagger operation ID: `Find-Members-or-Individuals-by-Name`. + + Args: + name: Individual Name. + page_number: Page Number. + include_email: Include Email Data. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6708,7 +8514,7 @@ async def find_members_or_individuals_by_name_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6722,6 +8528,7 @@ async def find_members_or_individuals_by_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6729,7 +8536,7 @@ async def find_members_or_individuals_by_name_async( return json.loads(response.text) - async def get_a_list_of_all_services_of_an_organization_async( + async def get_a_list_of_all_services_of_an_organization( self, id: str, *, @@ -6742,13 +8549,28 @@ async def get_a_list_of_all_services_of_an_organization_async( Get a List of All Services of an Organization Get a List of All Services of an Organization + + Swagger operation ID: `Get-a-List-of-All-Services-of-an-Organization`. + + Args: + id: Organization ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Organizations/{quote(str(id), safe='')}/Services" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6762,6 +8584,7 @@ async def get_a_list_of_all_services_of_an_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6769,9 +8592,9 @@ async def get_a_list_of_all_services_of_an_organization_async( return json.loads(response.text) - async def add_a_service_to_an_organization_async( + async def add_a_service_to_an_organization( self, - input: ServiceData, + input: ServiceData | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -6783,13 +8606,30 @@ async def add_a_service_to_an_organization_async( Add a Service to an Organization Add a Service to an Organization + + Swagger operation ID: `Add-a-Service-to-an-Organization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Organization ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Organizations/{quote(str(id), safe='')}/Services" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6803,6 +8643,7 @@ async def add_a_service_to_an_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6810,9 +8651,9 @@ async def add_a_service_to_an_organization_async( return json.loads(response.text) - async def update_phone_for_an_individual_async( + async def update_phone_for_an_individual( self, - input: PhoneSaveData, + input: PhoneSaveData | Mapping[str, Any], id_or_record_number: str, id: str, *, @@ -6825,6 +8666,24 @@ async def update_phone_for_an_individual_async( Update Phone for an Individual Update Phone for an Individual + + Swagger operation ID: `Update-Phone-for-an-Individual`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: Individual ID or Record Number. + id: Phone ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6836,7 +8695,7 @@ async def update_phone_for_an_individual_async( f"/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -6850,6 +8709,7 @@ async def update_phone_for_an_individual_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6857,9 +8717,9 @@ async def update_phone_for_an_individual_async( return json.loads(response.text) - async def update_phone_for_an_organization_async( + async def update_phone_for_an_organization( self, - input: PhoneSaveData, + input: PhoneSaveData | Mapping[str, Any], id_or_record_number: str, id: str, *, @@ -6872,6 +8732,24 @@ async def update_phone_for_an_organization_async( Update Phone for an Organization Update Phone for an Organization + + Swagger operation ID: `Update-Phone-for-an-Organization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: Organization ID or Record Number. + id: Phone ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6883,7 +8761,7 @@ async def update_phone_for_an_organization_async( f"/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -6897,6 +8775,7 @@ async def update_phone_for_an_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6904,9 +8783,9 @@ async def update_phone_for_an_organization_async( return json.loads(response.text) - async def delete_an_individual_web_link_async( + async def delete_an_individual_web_link( self, - input: DeleteAnIndividualWebLinkInput, + input: DeleteAnIndividualWebLinkInput | Mapping[str, Any], id_or_record_number: str, *, timeout: Optional[float] = None, @@ -6918,6 +8797,23 @@ async def delete_an_individual_web_link_async( Delete an Individual Web Link Delete an Individual Web Link + + Swagger operation ID: `Delete-an-Individual-Web-Link`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: A valid Individual ID or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6928,7 +8824,7 @@ async def delete_an_individual_web_link_async( f"/Links" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=input, timeout=timeout, headers=headers, @@ -6942,11 +8838,12 @@ async def delete_an_individual_web_link_async( request_url, response.status, response.text, + response=response, ) - async def add_web_link_for_individual_async( + async def add_web_link_for_individual( self, - input: AddWebLinkForIndividualInput, + input: AddWebLinkForIndividualInput | Mapping[str, Any], id_or_record_number: str, *, timeout: Optional[float] = None, @@ -6958,6 +8855,23 @@ async def add_web_link_for_individual_async( Add Web Link for Individual Add Web Link for Individual + + Swagger operation ID: `Add-Web-Link-for-Individual`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: A valid Individual Id or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6968,7 +8882,7 @@ async def add_web_link_for_individual_async( f"/Links" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6982,11 +8896,12 @@ async def add_web_link_for_individual_async( request_url, response.status, response.text, + response=response, ) - async def add_phone_to_organization_async( + async def add_phone_to_organization( self, - input: PhoneSaveData, + input: PhoneSaveData | Mapping[str, Any], id_or_record_number: str, *, timeout: Optional[float] = None, @@ -6998,6 +8913,23 @@ async def add_phone_to_organization_async( Add Phone to Organization Add Phone to Organization + + Swagger operation ID: `Add-Phone-to-Organization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: Organization ID or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7008,7 +8940,7 @@ async def add_phone_to_organization_async( f"/Phones" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7022,6 +8954,7 @@ async def add_phone_to_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7029,12 +8962,12 @@ async def add_phone_to_organization_async( return json.loads(response.text) - async def get_nominees_by_committee_async( + async def get_nominees_by_committee( self, code: str, page_number: int, - term: Optional[str] = None, *, + term: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -7044,6 +8977,23 @@ async def get_nominees_by_committee_async( Get Nominees by Committee Get Nominees by Committee + + Swagger operation ID: `Get-Nominees-by-Committee`. + + Args: + code: Committee Code. + page_number: Page Number. + term: Term. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7063,7 +9013,7 @@ async def get_nominees_by_committee_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7077,6 +9027,7 @@ async def get_nominees_by_committee_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7084,7 +9035,7 @@ async def get_nominees_by_committee_async( return json.loads(response.text) - async def get_organizations_active_subscriptions_async( + async def get_organizations_active_subscriptions( self, id: str, page_number: int, @@ -7098,6 +9049,22 @@ async def get_organizations_active_subscriptions_async( Get Organization's Active Subscriptions Get Organization's Active Subscriptions + + Swagger operation ID: `Get-Organizations-Active-Subscriptions`. + + Args: + id: Organization ID. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7109,7 +9076,7 @@ async def get_organizations_active_subscriptions_async( f"/{quote(str(page_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7123,6 +9090,7 @@ async def get_organizations_active_subscriptions_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7130,9 +9098,9 @@ async def get_organizations_active_subscriptions_async( return json.loads(response.text) - async def delete_an_organization_web_link_async( + async def delete_an_organization_web_link( self, - input: DeleteAnOrganizationWebLinkInput, + input: DeleteAnOrganizationWebLinkInput | Mapping[str, Any], id_or_record_number: str, *, timeout: Optional[float] = None, @@ -7144,6 +9112,23 @@ async def delete_an_organization_web_link_async( Delete an Organization Web Link Delete an Organization Web Link + + Swagger operation ID: `Delete-an-Organization-Web-Link`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: Organization ID or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7154,7 +9139,7 @@ async def delete_an_organization_web_link_async( f"/Links" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=input, timeout=timeout, headers=headers, @@ -7168,11 +9153,12 @@ async def delete_an_organization_web_link_async( request_url, response.status, response.text, + response=response, ) - async def add_web_link_for_organization_async( + async def add_web_link_for_organization( self, - input: AddWebLinkForOrganizationInput, + input: AddWebLinkForOrganizationInput | Mapping[str, Any], id_or_record_number: str, *, timeout: Optional[float] = None, @@ -7184,6 +9170,23 @@ async def add_web_link_for_organization_async( Add Web Link for Organization Add Web Link for Organization + + Swagger operation ID: `Add-Web-Link-for-Organization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: Organization ID or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7194,7 +9197,7 @@ async def add_web_link_for_organization_async( f"/Links" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7208,11 +9211,12 @@ async def add_web_link_for_organization_async( request_url, response.status, response.text, + response=response, ) - async def add_email_to_organization_async( + async def add_email_to_organization( self, - input: EmailData, + input: EmailData | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -7224,13 +9228,30 @@ async def add_email_to_organization_async( Add Email to Organization Add Email to Organization + + Swagger operation ID: `Add-Email-to-Organization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Organization ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Organizations/{quote(str(id), safe='')}/Emails" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7244,15 +9265,16 @@ async def add_email_to_organization_async( request_url, response.status, response.text, + response=response, ) - async def get_organizations_relationships_async( + async def get_organizations_relationships( self, id: str, page_number: int, + *, relationship_name: Optional[str] = None, includes_details: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -7262,6 +9284,24 @@ async def get_organizations_relationships_async( Get Organization's Relationships Get Organization's Relationships + + Swagger operation ID: `Get-Organizations-Relationships`. + + Args: + id: Organization ID. + page_number: Page Number. + relationship_name: Name of the Relationship. + includes_details: Includes Details. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7286,7 +9326,7 @@ async def get_organizations_relationships_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7300,6 +9340,7 @@ async def get_organizations_relationships_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7307,9 +9348,9 @@ async def get_organizations_relationships_async( return json.loads(response.text) - async def add_or_update_address_to_organization_async( + async def add_or_update_address_to_organization( self, - input: AddressSaveData, + input: AddressSaveData | Mapping[str, Any], id_or_record_number: str, *, timeout: Optional[float] = None, @@ -7321,6 +9362,23 @@ async def add_or_update_address_to_organization_async( Add or Update Address to Organization Add or Update Address to Organization + + Swagger operation ID: `Add-or-Update-Address-to-Organization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: Organization ID or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7331,7 +9389,7 @@ async def add_or_update_address_to_organization_async( f"/Addresses" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7345,6 +9403,7 @@ async def add_or_update_address_to_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7352,7 +9411,7 @@ async def add_or_update_address_to_organization_async( return json.loads(response.text) - async def add_or_update_a_list_of_custom_fields_per_individual_async( + async def add_or_update_a_list_of_custom_fields_per_individual( self, input: AddOrUpdateAListOfCustomFieldsPerIndividualInput, id_or_record_number: str, @@ -7366,6 +9425,23 @@ async def add_or_update_a_list_of_custom_fields_per_individual_async( Add or Update a List of Custom Fields Per Individual Add or Update a List of Custom Fields Per Individual + + Swagger operation ID: + `Add-or-Update-a-List-of-Custom-Fields-Per-Individual`. + + Args: + input: The request body. + id_or_record_number: Individual ID or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7376,7 +9452,7 @@ async def add_or_update_a_list_of_custom_fields_per_individual_async( f"/CustomFieldsList" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7390,6 +9466,7 @@ async def add_or_update_a_list_of_custom_fields_per_individual_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7397,7 +9474,7 @@ async def add_or_update_a_list_of_custom_fields_per_individual_async( return json.loads(response.text) - async def get_upcoming_events_async( + async def get_upcoming_events( self, page_number: int, *, @@ -7410,13 +9487,28 @@ async def get_upcoming_events_async( Get Upcoming Events Get Upcoming Events + + Swagger operation ID: `Get-Upcoming-Events`. + + Args: + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Events/Upcoming/{quote(str(page_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7430,6 +9522,7 @@ async def get_upcoming_events_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7437,9 +9530,9 @@ async def get_upcoming_events_async( return json.loads(response.text) - async def add_phone_to_individual_async( + async def add_phone_to_individual( self, - input: PhoneSaveData, + input: PhoneSaveData | Mapping[str, Any], id_or_record_number: str, *, timeout: Optional[float] = None, @@ -7451,6 +9544,23 @@ async def add_phone_to_individual_async( Add Phone to Individual Add Phone to Individual + + Swagger operation ID: `Add-Phone-to-Individual`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: Individual ID or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7461,7 +9571,7 @@ async def add_phone_to_individual_async( f"/Phones" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7475,6 +9585,7 @@ async def add_phone_to_individual_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7482,12 +9593,12 @@ async def add_phone_to_individual_async( return json.loads(response.text) - async def get_committee_information_for_an_individual_async( + async def get_committee_information_for_an_individual( self, id: str, page_number: int, - include_inactive: Optional[bool] = None, *, + include_inactive: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -7497,6 +9608,23 @@ async def get_committee_information_for_an_individual_async( Get Committee Information for an Individual Get Committee Information for an Individual + + Swagger operation ID: `Get-Committee-Information-for-an-Individual`. + + Args: + id: Individual ID. + page_number: Page Number. + include_inactive: Include Inactive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7516,7 +9644,7 @@ async def get_committee_information_for_an_individual_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7530,6 +9658,7 @@ async def get_committee_information_for_an_individual_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7537,7 +9666,7 @@ async def get_committee_information_for_an_individual_async( return json.loads(response.text) - async def get_organization_custom_field_values_async( + def list_organization_custom_field_values( self, id: str, *, @@ -7545,39 +9674,78 @@ async def get_organization_custom_field_values_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Organization Custom Field Values Get Organization Custom Field Values + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Get-Organization-Custom-Field-Values`. + + Args: + id: Organization ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Organizations/{quote(str(id), safe='')}/CustomFields" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - if not response.text: - return None + return None, items() - return json.loads(response.text) + return AsyncItemPaged(get_next, extract_data) - async def get_organization_active_memberships_async( + def list_organization_active_memberships( self, id: str, *, @@ -7585,11 +9753,29 @@ async def get_organization_active_memberships_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Organization Active Memberships Get Organization Active Memberships + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Get-Organization-Active-Memberships`. + + Args: + id: Organization ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7600,35 +9786,56 @@ async def get_organization_active_memberships_async( f"/Memberships" f"/Active" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_all_events_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_all_events( self, page_number: int, + *, code: Optional[str] = None, name: Optional[str] = None, tag: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -7638,6 +9845,24 @@ async def get_all_events_async( Get All Events Get All Events + + Swagger operation ID: `Get-All-Events`. + + Args: + page_number: Page Number. + code: Code. + name: Name. + tag: Tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7662,7 +9887,7 @@ async def get_all_events_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7676,6 +9901,7 @@ async def get_all_events_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7683,7 +9909,7 @@ async def get_all_events_async( return json.loads(response.text) - async def get_individual_active_memberships_async( + def list_individual_active_memberships( self, id: str, *, @@ -7691,44 +9917,83 @@ async def get_individual_active_memberships_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Individual Active Memberships Get Individual Active Memberships + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Get-Individual-Active-Memberships`. + + Args: + id: Individual ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Individuals/{quote(str(id), safe='')}/Memberships/Active" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def get_all_event_registrations_information_for_an_individual_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_all_event_registrations_information_for_an_individual( self, id_or_record_number: str, page_number: int, - event_code: Optional[str] = None, *, + event_code: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -7738,6 +10003,24 @@ async def get_all_event_registrations_information_for_an_individual_async( Get All Event Registrations Information for an Individual Get All Event Registrations Information for an Individual + + Swagger operation ID: + `Get-All-Event-Registrations-Information-for-an-Individual`. + + Args: + id_or_record_number: Individual ID or Record Number. + page_number: Page Number. + event_code: Event Code. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7757,7 +10040,7 @@ async def get_all_event_registrations_information_for_an_individual_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7771,6 +10054,7 @@ async def get_all_event_registrations_information_for_an_individual_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7778,13 +10062,13 @@ async def get_all_event_registrations_information_for_an_individual_async( return json.loads(response.text) - async def get_individuals_relationships_async( + async def get_individuals_relationships( self, id: str, page_number: int, + *, relationship_name: Optional[str] = None, include_details: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -7794,6 +10078,24 @@ async def get_individuals_relationships_async( Get Individual's Relationships Get Individual's Relationships + + Swagger operation ID: `Get-Individuals-Relationships`. + + Args: + id: Individual ID. + page_number: Page Number. + relationship_name: Name of the Relationship. + include_details: Include Details. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7818,7 +10120,7 @@ async def get_individuals_relationships_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7832,6 +10134,7 @@ async def get_individuals_relationships_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7839,9 +10142,9 @@ async def get_individuals_relationships_async( return json.loads(response.text) - async def update_an_individual_email_async( + async def update_an_individual_email( self, - input: UpdateAnIndividualEmailInput, + input: UpdateAnIndividualEmailInput | Mapping[str, Any], id_or_record_number: str, current_email_address: str, *, @@ -7854,6 +10157,24 @@ async def update_an_individual_email_async( Update an Individual Email Update an Individual Email + + Swagger operation ID: `Update-an-Individual-Email`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: Individual ID or Record Number. + current_email_address: Email Address to Update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7865,7 +10186,7 @@ async def update_an_individual_email_async( f"/{quote(str(current_email_address), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -7879,11 +10200,12 @@ async def update_an_individual_email_async( request_url, response.status, response.text, + response=response, ) - async def save_relationship_for_organization_async( + async def save_relationship_for_organization( self, - input: SaveRelationshipForOrganizationInput, + input: SaveRelationshipForOrganizationInput | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -7895,13 +10217,30 @@ async def save_relationship_for_organization_async( Save Relationship for Organization Save Relationship for Organization + + Swagger operation ID: `Save-Relationship-for-Organization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Organization ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Organizations/{quote(str(id), safe='')}/Relationships" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7915,13 +10254,14 @@ async def save_relationship_for_organization_async( request_url, response.status, response.text, + response=response, ) - async def add_individual_async( + async def add_individual( self, - input: AddIndividualInput, - create_user: Optional[bool] = None, + input: AddIndividualInput | Mapping[str, Any], *, + create_user: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -7931,6 +10271,24 @@ async def add_individual_async( Add Individual Adds an Individual. + + Swagger operation ID: `Add-Individual`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + create_user: Choose True if a user account should be created when + the individual is created. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v1/Individuals" query_params = [] @@ -7942,7 +10300,7 @@ async def add_individual_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7956,6 +10314,7 @@ async def add_individual_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7963,9 +10322,9 @@ async def add_individual_async( return json.loads(response.text) - async def add_email_to_individual_async( + async def add_email_to_individual( self, - input: AddEmailToIndividualInput, + input: AddEmailToIndividualInput | Mapping[str, Any], id_or_record_number: str, *, timeout: Optional[float] = None, @@ -7977,6 +10336,23 @@ async def add_email_to_individual_async( Add Email to Individual Add Email to Individual + + Swagger operation ID: `Add-Email-to-Individual`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: Individual ID Or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7987,7 +10363,7 @@ async def add_email_to_individual_async( f"/Emails" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8001,6 +10377,7 @@ async def add_email_to_individual_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8008,9 +10385,9 @@ async def add_email_to_individual_async( return json.loads(response.text) - async def add_or_update_address_to_individual_async( + async def add_or_update_address_to_individual( self, - input: AddressSaveData, + input: AddressSaveData | Mapping[str, Any], id_or_record_number: str, *, timeout: Optional[float] = None, @@ -8022,6 +10399,23 @@ async def add_or_update_address_to_individual_async( Add or Update Address to Individual Add or Update Address to Individual + + Swagger operation ID: `Add-or-Update-Address-to-Individual`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: Individual ID or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8032,7 +10426,7 @@ async def add_or_update_address_to_individual_async( f"/Addresses" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8046,6 +10440,7 @@ async def add_or_update_address_to_individual_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8053,13 +10448,13 @@ async def add_or_update_address_to_individual_async( return json.loads(response.text) - async def find_members_or_individuals_by_first_and_last_name_async( + async def find_members_or_individuals_by_first_and_last_name( self, first_name: str, last_name: str, page_number: int, - include_email: Optional[bool] = None, *, + include_email: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -8069,6 +10464,25 @@ async def find_members_or_individuals_by_first_and_last_name_async( Find Members (Individuals) by First Name and Last Name Find Members (Individuals) by First Name and Last Name + + Swagger operation ID: + `Find-members-or-individuals-by-first-and-last-name`. + + Args: + first_name: First Name. + last_name: Last Name. + page_number: Page Number. + include_email: Include Email Data. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8090,7 +10504,7 @@ async def find_members_or_individuals_by_first_and_last_name_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8104,6 +10518,7 @@ async def find_members_or_individuals_by_first_and_last_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8111,13 +10526,13 @@ async def find_members_or_individuals_by_first_and_last_name_async( return json.loads(response.text) - async def get_committee_members_by_committee_id_or_code_async( + async def get_committee_members_by_committee_id_or_code( self, id_or_code: str, page_number: int, + *, term: Optional[int] = None, position_codes: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -8127,6 +10542,24 @@ async def get_committee_members_by_committee_id_or_code_async( Get Committee Members by committee ID or code Get Committee Members by Committee ID or Code + + Swagger operation ID: `Get-Committee-Members-by-committee-ID-or-code`. + + Args: + id_or_code: Committee ID or Code. + page_number: Page Number. + term: Term. + position_codes: Position Codes. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8151,7 +10584,7 @@ async def get_committee_members_by_committee_id_or_code_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8165,11 +10598,12 @@ async def get_committee_members_by_committee_id_or_code_async( request_url, response.status, response.text, + response=response, ) - async def add_activity_async( + async def add_activity( self, - input: AddActivityInput, + input: AddActivityInput | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -8181,13 +10615,30 @@ async def add_activity_async( Add Activity Add Activity. + + Swagger operation ID: `Add-Activity`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Individual Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Individuals/{quote(str(id), safe='')}/Activities" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8201,9 +10652,10 @@ async def add_activity_async( request_url, response.status, response.text, + response=response, ) - async def find_individual_id_or_email_async( + async def find_individual_id_or_email( self, id_or_record_number_or_email: str, page_number: int, @@ -8217,6 +10669,22 @@ async def find_individual_id_or_email_async( Find Individual by Id or Email or Record Number Find Individual by Id or Email. + + Swagger operation ID: `Find-Individual-IDOrEmail`. + + Args: + id_or_record_number_or_email: Id or Record Number or Email. + page_number: pageNumber. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8232,7 +10700,7 @@ async def find_individual_id_or_email_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8246,6 +10714,7 @@ async def find_individual_id_or_email_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8253,9 +10722,9 @@ async def find_individual_id_or_email_async( return json.loads(response.text) - async def add_relationship_to_individual_async( + async def add_relationship_to_individual( self, - input: AddRelationshipToIndividualInput, + input: AddRelationshipToIndividualInput | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -8267,13 +10736,30 @@ async def add_relationship_to_individual_async( Add Relationship to Individual Add Relationship to Individual. + + Swagger operation ID: `Add-relationship-to-individual`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Individual Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Individuals/{quote(str(id), safe='')}/Relationships" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8287,11 +10773,12 @@ async def add_relationship_to_individual_async( request_url, response.status, response.text, + response=response, ) - async def individual_add_education_credit_async( + async def individual_add_education_credit( self, - input: EducationCreditData, + input: EducationCreditData | Mapping[str, Any], id_or_record_number: str, *, timeout: Optional[float] = None, @@ -8303,6 +10790,23 @@ async def individual_add_education_credit_async( Add Education Credits to Individual Add a new Education Credit to an Individual. + + Swagger operation ID: `Individual-Add-Education-Credit`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id_or_record_number: Individual Id or Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8313,7 +10817,7 @@ async def individual_add_education_credit_async( f"/EducationCredits" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8327,11 +10831,12 @@ async def individual_add_education_credit_async( request_url, response.status, response.text, + response=response, ) - async def individual_add_note_async( + async def individual_add_note( self, - input: NoteData, + input: NoteData | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -8343,13 +10848,30 @@ async def individual_add_note_async( Add Note to Individual Add a Note to an Individual. + + Swagger operation ID: `Individual-AddNote`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Individual Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Individuals/{quote(str(id), safe='')}/Notes" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8363,9 +10885,10 @@ async def individual_add_note_async( request_url, response.status, response.text, + response=response, ) - async def individuals_lookup_by_name_async( + async def individuals_lookup_by_name( self, page_number: int, name: str, @@ -8379,6 +10902,22 @@ async def individuals_lookup_by_name_async( Lookup Individuals Lookup Individuals by Name + + Swagger operation ID: `Individuals-LookupByName`. + + Args: + page_number: pageNumber. + name: Individual Name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8393,7 +10932,7 @@ async def individuals_lookup_by_name_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8407,6 +10946,7 @@ async def individuals_lookup_by_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8414,9 +10954,9 @@ async def individuals_lookup_by_name_async( return json.loads(response.text) - async def add_to_committee_async( + async def add_to_committee( self, - input: CommitteeMemberCreateData, + input: CommitteeMemberCreateData | Mapping[str, Any], code: str, *, timeout: Optional[float] = None, @@ -8428,13 +10968,30 @@ async def add_to_committee_async( Add Individual to Committee Add Individual to Committee. + + Swagger operation ID: `Add-To-Committee`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + code: Committee Code. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Committees/{quote(str(code), safe='')}/Members" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8448,6 +11005,7 @@ async def add_to_committee_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8455,9 +11013,9 @@ async def add_to_committee_async( return json.loads(response.text) - async def update_committee_member_async( + async def update_committee_member( self, - input: CommitteeMemberUpdateData, + input: CommitteeMemberUpdateData | Mapping[str, Any], code: str, member_record_number: str, current_position_code: str, @@ -8471,6 +11029,25 @@ async def update_committee_member_async( Update Committee Member Update Committee Member. + + Swagger operation ID: `Update-Committee-Member`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + code: Committee Code. + member_record_number: Member Record Number. + current_position_code: Current Position Code. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8483,7 +11060,7 @@ async def update_committee_member_async( f"/{quote(str(current_position_code), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -8497,11 +11074,12 @@ async def update_committee_member_async( request_url, response.status, response.text, + response=response, ) - async def add_organization_async( + async def add_organization( self, - input: AddOrganizationInput, + input: AddOrganizationInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -8512,10 +11090,26 @@ async def add_organization_async( Add Organization Add Organization. + + Swagger operation ID: `Add-Organization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v1/Organizations" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8529,6 +11123,7 @@ async def add_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8536,9 +11131,9 @@ async def add_organization_async( return json.loads(response.text) - async def update_organization_async( + async def update_organization( self, - input: UpdateOrganizationInput, + input: UpdateOrganizationInput | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -8550,13 +11145,30 @@ async def update_organization_async( Update Organization Update Organization. + + Swagger operation ID: `Update-Organization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Organization Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Organizations/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -8570,6 +11182,7 @@ async def update_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8577,7 +11190,7 @@ async def update_organization_async( return json.loads(response.text) - async def organization_get_profile_async( + async def organization_get_profile( self, id_or_recordnumber: str, page_number: int, @@ -8591,6 +11204,22 @@ async def organization_get_profile_async( Find Organization by Id or Record Number Get organization's profile information by ID or Record Number + + Swagger operation ID: `Organization-Get-Profile`. + + Args: + id_or_recordnumber: Organization Id or Record Number. + page_number: pageNumber. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8606,7 +11235,7 @@ async def organization_get_profile_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8620,6 +11249,7 @@ async def organization_get_profile_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8627,9 +11257,9 @@ async def organization_get_profile_async( return json.loads(response.text) - async def organization_add_note_async( + async def organization_add_note( self, - input: NoteData, + input: NoteData | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -8641,13 +11271,30 @@ async def organization_add_note_async( Add Note to Organization Add a Note to an Organization. + + Swagger operation ID: `Organization-AddNote`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Organization Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Organizations/{quote(str(id), safe='')}/Notes" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8661,9 +11308,10 @@ async def organization_add_note_async( request_url, response.status, response.text, + response=response, ) - async def organization_lookup_by_name_async( + async def organization_lookup_by_name( self, page_number: int, name: str, @@ -8677,6 +11325,22 @@ async def organization_lookup_by_name_async( Lookup Organizations Lookup Organizations by Name or Acronym + + Swagger operation ID: `Organization-LookupByName`. + + Args: + page_number: pageNumber. + name: Name or Acronym. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8691,7 +11355,7 @@ async def organization_lookup_by_name_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8705,6 +11369,7 @@ async def organization_lookup_by_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8712,14 +11377,14 @@ async def organization_lookup_by_name_async( return json.loads(response.text) - async def get_all_committees_async( + async def get_all_committees( self, page_number: int, + *, code: Optional[str] = None, name: Optional[str] = None, term: Optional[int] = None, active_only: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -8729,6 +11394,25 @@ async def get_all_committees_async( Get All Committees Get All Committees + + Swagger operation ID: `Get-All-Committees`. + + Args: + page_number: Page Number. + code: Committee Code. + name: Committee Name. + term: Term. + active_only: Active Only. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8758,7 +11442,7 @@ async def get_all_committees_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8772,6 +11456,7 @@ async def get_all_committees_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8779,7 +11464,7 @@ async def get_all_committees_async( return json.loads(response.text) - async def get_positions_by_committee_async( + async def get_positions_by_committee( self, code: str, *, @@ -8792,13 +11477,28 @@ async def get_positions_by_committee_async( Get Positions by Committee Get Positions by Committee + + Swagger operation ID: `Get-Positions-by-Committee`. + + Args: + code: Committee Code. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Committees/{quote(str(code), safe='')}/Positions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8812,6 +11512,7 @@ async def get_positions_by_committee_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8819,7 +11520,7 @@ async def get_positions_by_committee_async( return json.loads(response.text) - async def get_sub_committees_async( + async def get_sub_committees( self, code: str, page_number: int, @@ -8833,6 +11534,22 @@ async def get_sub_committees_async( Get Sub-Committees Get Sub-Committees + + Swagger operation ID: `Get-Sub-Committees`. + + Args: + code: Code. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8844,7 +11561,7 @@ async def get_sub_committees_async( f"/{quote(str(page_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8858,6 +11575,7 @@ async def get_sub_committees_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8865,7 +11583,7 @@ async def get_sub_committees_async( return json.loads(response.text) - async def get_individuals_active_subscriptions_async( + async def get_individuals_active_subscriptions( self, id: str, page_number: int, @@ -8879,6 +11597,22 @@ async def get_individuals_active_subscriptions_async( Get Individual's Active Subscriptions Get Individual's Active Subscriptions + + Swagger operation ID: `Get-Individuals-Active-Subscriptions`. + + Args: + id: Individual. + page_number: Page Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8891,7 +11625,7 @@ async def get_individuals_active_subscriptions_async( f"/{quote(str(page_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8905,6 +11639,7 @@ async def get_individuals_active_subscriptions_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8912,22 +11647,43 @@ async def get_individuals_active_subscriptions_async( return json.loads(response.text) - async def list_all_individuals_async( + def list_all_individuals( self, page_number: int, + *, name: Optional[str] = None, include_details: Optional[bool] = None, old_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Individuals List all Individuals + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `List-all-Individuals`. + + Args: + page_number: Page Number. + name: Individual Name. + include_details: Include Details. + old_id: Individual Old ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8951,29 +11707,50 @@ async def list_all_individuals_async( query_params.append(f"oldID={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("dataList", []): + yield item - async def find_customer_phone_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def find_customer_phone( self, page_number: str, phone_number: str, @@ -8987,6 +11764,22 @@ async def find_customer_phone_async( Find Customer by Phone Number Find Customer by Phone Number. + + Swagger operation ID: `Find-Customer-Phone`. + + Args: + page_number: pageNumber. + phone_number: Phone Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -9003,7 +11796,7 @@ async def find_customer_phone_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -9017,6 +11810,7 @@ async def find_customer_phone_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -9024,7 +11818,7 @@ async def find_customer_phone_async( return json.loads(response.text) - async def mark_registrant_attended_async( + async def mark_registrant_attended( self, input: MarkRegistrantAttendedInput, record_number: str, @@ -9038,6 +11832,22 @@ async def mark_registrant_attended_async( Mark Registrant as Attended Mark the Registrant as Attended for the specified Events. + + Swagger operation ID: `Mark-Registrant-Attended`. + + Args: + input: The request body. + record_number: Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -9049,7 +11859,7 @@ async def mark_registrant_attended_async( f"/Attended" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -9063,11 +11873,12 @@ async def mark_registrant_attended_async( request_url, response.status, response.text, + response=response, ) - async def awards_add_award_nomination_async( + async def awards_add_award_nomination( self, - input: AwardNominationData, + input: AwardNominationData | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -9079,13 +11890,30 @@ async def awards_add_award_nomination_async( Add Award Nomination Add a new Award Nomination. + + Swagger operation ID: `Awards-AddAwardNomination`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Award Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v1/Awards/{quote(str(id), safe='')}/Nominations" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -9099,11 +11927,12 @@ async def awards_add_award_nomination_async( request_url, response.status, response.text, + response=response, ) - async def awards_update_award_nomination_async( + async def awards_update_award_nomination( self, - input: UpdateAwardNominationData, + input: UpdateAwardNominationData | Mapping[str, Any], id: str, nominee_record_number: str, *, @@ -9116,6 +11945,24 @@ async def awards_update_award_nomination_async( Update Award Nomination Update an existing Award Nomination. + + Swagger operation ID: `Awards-UpdateAwardNomination`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Award Id. + nominee_record_number: Nominee Record Number. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -9127,7 +11974,7 @@ async def awards_update_award_nomination_async( f"/{quote(str(nominee_record_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -9141,9 +11988,10 @@ async def awards_update_award_nomination_async( request_url, response.status, response.text, + response=response, ) - async def awards_get_individual_award_recipients_async( + async def awards_get_individual_award_recipients( self, page_number: int, id: str, @@ -9157,6 +12005,22 @@ async def awards_get_individual_award_recipients_async( List Award Individual Recipients List all Individuals that are Award Recipients. + + Swagger operation ID: `Awards-GetIndividualAwardRecipients`. + + Args: + page_number: pageNumber. + id: Award Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -9173,7 +12037,7 @@ async def awards_get_individual_award_recipients_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -9187,6 +12051,7 @@ async def awards_get_individual_award_recipients_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -9194,7 +12059,7 @@ async def awards_get_individual_award_recipients_async( return json.loads(response.text) - async def awards_get_organization_award_recipients_async( + async def awards_get_organization_award_recipients( self, page_number: int, id: str, @@ -9208,6 +12073,22 @@ async def awards_get_organization_award_recipients_async( List Award Organization Recipients List all Organizations that are Award Recipients. + + Swagger operation ID: `Awards-GetOrganizationAwardRecipients`. + + Args: + page_number: pageNumber. + id: Award Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -9224,7 +12105,7 @@ async def awards_get_organization_award_recipients_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -9238,6 +12119,7 @@ async def awards_get_organization_award_recipients_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/infusionsoft.py b/src/azure/connectors/infusionsoft.py index eac62651..c596426b 100644 --- a/src/azure/connectors/infusionsoft.py +++ b/src/azure/connectors/infusionsoft.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,19 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "InfusionsoftClient", + "CreateTaskRequest", + "ListOrdersResponse", + "ListTasksResponse", + "OnNewTaskResponse", + "TaskResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,28 +41,32 @@ class TaskResponse: Response for Create a task """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """An integer that uniquely identifies this task.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The actual task name (Do this thing).""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """A description of the task defined by the user.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ A string representing the type of Task as defined by the user from a list of types editable in the Infusionsoft application. """ - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """The priority of the task.""" - completed: Optional[bool] = None + completed: Optional[bool] = dataclass_field(default=None, kw_only=True) """A boolean indicating the completed status of the task.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The link to the task.""" - due_date: Optional[str] = None + due_date: Optional[str] = dataclass_field(default=None, kw_only=True) """The datetime the task is due, given as GMT in ISO 8601 format.""" -OnNewTaskResponse = List["TaskResponse"] +OnNewTaskResponse = List["TaskResponse | Mapping[str, Any]"] ListOrdersResponse = List[Dict[str, Any]] @@ -62,7 +78,7 @@ class ListTasksResponse: Response for List tasks """ - tasks: Optional[List[Dict[str, Any]]] = None + tasks: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Collection of tasks.""" @@ -72,15 +88,19 @@ class CreateTaskRequest: Definition: CreateTask_Request """ - title: Optional[str] = None + title: str """The title of the task.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """A description of the task title.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type of the task.""" - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """Priority of the task (1, 2, 3, etc.)""" - due_date: Optional[str] = None + due_date: Optional[str] = dataclass_field(default=None, kw_only=True) """Due date of the task (Ex. 2014-06-17T17:12:52.000Z""" @@ -95,7 +115,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -112,8 +132,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -134,7 +154,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -149,9 +169,86 @@ def __init__( def connector_name(self) -> str: return "infusionsoft" - async def create_task_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def create_task( self, - input: CreateTaskRequest, + input: CreateTaskRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -162,10 +259,26 @@ async def create_task_async( Create a task Create a new task. + + Swagger operation ID: `CreateTask`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/crm/rest/v1/tasks/" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -179,6 +292,7 @@ async def create_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -186,9 +300,9 @@ async def create_task_async( return json.loads(response.text) - async def update_task_async( + async def update_task( self, - input: CreateTaskRequest, + input: CreateTaskRequest | Mapping[str, Any], id: int, *, timeout: Optional[float] = None, @@ -200,13 +314,30 @@ async def update_task_async( Update a task Update an existing task. + + Swagger operation ID: `UpdateTask`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Id of the task. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/crm/rest/v1/tasks/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -220,6 +351,7 @@ async def update_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -227,18 +359,35 @@ async def update_task_async( return json.loads(response.text) - async def list_tasks_async( + def list_tasks( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List tasks Retrieve a page of tasks ordered by due date. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListTasks`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/crm/rest/v1/tasks/search" @@ -247,27 +396,48 @@ async def list_tasks_async( query_params.append("order=" + quote("-due_date", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("tasks", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/insightly.py b/src/azure/connectors/insightly.py index 2a09aa70..df0269dc 100644 --- a/src/azure/connectors/insightly.py +++ b/src/azure/connectors/insightly.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,36 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "InsightlyClient", + "Address", + "Contact", + "ContactInfo", + "ContactRequest", + "Event", + "Lead", + "LeadRequest", + "ListContactsResponse", + "ListEventsResponse", + "ListLeadsResponse", + "ListProjectsResponse", + "ListTasksResponse", + "ListUsersResponse", + "ObjectEntity", + "Organization", + "OrganizationRequest", + "Project", + "ProjectRequest", + "Tag", + "TaskObject", + "TaskRequest", + "User", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +58,12 @@ class ListTasksResponse: Response for List tasks """ - tasks: Optional[List[TaskObject]] = None + tasks: Optional[ + List[TaskObject | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A collection of tasks""" @@ -39,162 +73,193 @@ class TaskObject: Response for Update task """ - t_a_s_k_id: Optional[int] = field( + t_a_s_k_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TASK_ID"}, ) """The unique identifier of the task.""" - t_i_t_l_e: Optional[str] = field( + t_i_t_l_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TITLE"}, ) """The title of the task.""" - d_u_e_d_a_t_e: Optional[str] = field( + d_u_e_d_a_t_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DUE_DATE"}, ) """yyyy-MM-dd HH:mm:ss""" - c_a_t_e_g_o_r_y_id: Optional[int] = field( + c_a_t_e_g_o_r_y_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CATEGORY_ID"}, ) """The unique identifier of the category.""" - c_o_m_p_l_e_t_e_d_d_a_t_e_u_t_c: Optional[str] = field( + c_o_m_p_l_e_t_e_d_d_a_t_e_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "COMPLETED_DATE_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - c_o_m_p_l_e_t_e_d: Optional[bool] = field( + c_o_m_p_l_e_t_e_d: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "COMPLETED"}, ) """A boolean value determining whether or not the task is completed.""" - d_e_t_a_i_l_s: Optional[str] = field( + d_e_t_a_i_l_s: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DETAILS"}, ) """The details of the task.""" - s_t_a_t_u_s: Optional[str] = field( + s_t_a_t_u_s: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "STATUS"}, ) """The status of the task.""" - p_r_i_o_r_i_t_y: Optional[int] = field( + p_r_i_o_r_i_t_y: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PRIORITY"}, ) """The priority of the task.""" - s_t_a_r_t_d_a_t_e: Optional[str] = field( + s_t_a_r_t_d_a_t_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "START_DATE"}, ) """yyyy-MM-dd HH:mm:ss""" - p_r_o_j_e_c_t_id: Optional[int] = field( + p_r_o_j_e_c_t_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PROJECT_ID"}, ) """The unique identifier of the project.""" - o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = field( + o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OPPORTUNITY_ID"}, ) """The unique identifier of the opportunity.""" - m_i_l_e_s_t_o_n_e_id: Optional[int] = field( + m_i_l_e_s_t_o_n_e_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MILESTONE_ID"}, ) """The unique identifier of the milestone.""" - p_i_p_e_l_i_n_e_id: Optional[int] = field( + p_i_p_e_l_i_n_e_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PIPELINE_ID"}, ) """The unique identifier of the pipeline.""" - s_t_a_g_e_id: Optional[int] = field( + s_t_a_g_e_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "STAGE_ID"}, ) """The unique identifier of the stage.""" - p_e_r_c_e_n_t_c_o_m_p_l_e_t_e: Optional[int] = field( + p_e_r_c_e_n_t_c_o_m_p_l_e_t_e: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PERCENT_COMPLETE"}, ) """The task completed value in percent.""" - o_w_n_e_r_u_s_e_r_id: Optional[int] = field( + o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OWNER_USER_ID"}, ) """The unique identifier of the task owner.""" - r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = field( + r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RESPONSIBLE_USER_ID"}, ) """The unique identifier of the user assigned to the task.""" - p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: Optional[bool] = field( + p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PUBLICLY_VISIBLE"}, ) """ A boolean value determining whether or not the task is publicly visible. """ - d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_CREATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_UPDATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - a_s_s_i_g_n_e_d_b_y_u_s_e_r_id: Optional[int] = field( + a_s_s_i_g_n_e_d_b_y_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ASSIGNED_BY_USER_ID"}, ) """The unique identifier of the assigned by user.""" - p_a_r_e_n_t_t_a_s_k_id: Optional[int] = field( + p_a_r_e_n_t_t_a_s_k_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PARENT_TASK_ID"}, ) """The unique identifier of the parent task.""" - o_w_n_e_r_v_i_s_i_b_l_e: Optional[bool] = field( + o_w_n_e_r_v_i_s_i_b_l_e: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OWNER_VISIBLE"}, ) """ A boolean value determining whether or not the owner is publicly visible. """ - a_s_s_i_g_n_e_d_t_e_a_m_id: Optional[int] = field( + a_s_s_i_g_n_e_d_t_e_a_m_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ASSIGNED_TEAM_ID"}, ) """The unique identifier of the assigned team.""" - a_s_s_i_g_n_e_d_d_a_t_e_u_t_c: Optional[str] = field( + a_s_s_i_g_n_e_d_d_a_t_e_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ASSIGNED_DATE_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - r_e_m_i_n_d_e_r_d_a_t_e_u_t_c: Optional[str] = field( + r_e_m_i_n_d_e_r_d_a_t_e_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "REMINDER_DATE_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - r_e_m_i_n_d_e_r_s_e_n_t: Optional[bool] = field( + r_e_m_i_n_d_e_r_s_e_n_t: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "REMINDER_SENT"}, ) """A boolean value determining whether or not a reminder is set.""" - r_e_c_u_r_r_e_n_c_e: Optional[str] = field( + r_e_c_u_r_r_e_n_c_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RECURRENCE"}, ) """Recurrence""" - c_a_n_e_d_i_t: Optional[bool] = field( + c_a_n_e_d_i_t: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CAN_EDIT"}, ) """Can edit.""" - c_a_n_d_e_l_e_t_e: Optional[bool] = field( + c_a_n_d_e_l_e_t_e: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CAN_DELETE"}, ) """Can delete""" @@ -206,8 +271,19 @@ class ListProjectsResponse: Response for List projects """ - projects: Optional[List[Project]] = None + projects: Optional[ + List[Project | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A collection of projects""" + next_link: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "nextLink"}, + ) + """The URL to retrieve the next page.""" @dataclass @@ -216,103 +292,123 @@ class Project: Response for Update project """ - p_r_o_j_e_c_t_id: Optional[int] = field( + p_r_o_j_e_c_t_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PROJECT_ID"}, ) """The unique identifier of the project.""" - p_r_o_j_e_c_t_n_a_m_e: Optional[str] = field( + p_r_o_j_e_c_t_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PROJECT_NAME"}, ) """The name of the project.""" - s_t_a_t_u_s: Optional[str] = field( + s_t_a_t_u_s: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "STATUS"}, ) """The status of the project.""" - p_r_o_j_e_c_t_d_e_t_a_i_l_s: Optional[str] = field( + p_r_o_j_e_c_t_d_e_t_a_i_l_s: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PROJECT_DETAILS"}, ) """The details of the project.""" - i_m_a_g_e_u_r_l: Optional[str] = field( + i_m_a_g_e_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IMAGE_URL"}, ) """The image URL of the project.""" - d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_CREATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - v_i_s_i_b_l_e_t_o: Optional[str] = field( + v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TO"}, ) """Project Visibility.""" - d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_UPDATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - s_t_a_r_t_e_d_d_a_t_e: Optional[str] = field( + s_t_a_r_t_e_d_d_a_t_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "STARTED_DATE"}, ) """yyyy-MM-dd HH:mm:ss""" - c_o_m_p_l_e_t_e_d_d_a_t_e: Optional[str] = field( + c_o_m_p_l_e_t_e_d_d_a_t_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "COMPLETED_DATE"}, ) """yyyy-MM-dd HH:mm:ss""" - o_w_n_e_r_u_s_e_r_id: Optional[int] = field( + o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OWNER_USER_ID"}, ) """The unique identifier of the project owner.""" - r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = field( + r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RESPONSIBLE_USER_ID"}, ) """The unique identifier of the assigned user.""" - o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = field( + o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OPPORTUNITY_ID"}, ) """The unique identifier of the opportunity.""" - p_i_p_e_l_i_n_e_id: Optional[int] = field( + p_i_p_e_l_i_n_e_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PIPELINE_ID"}, ) """The unique identifier of the pipeline.""" - s_t_a_g_e_id: Optional[int] = field( + s_t_a_g_e_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "STAGE_ID"}, ) """The unique identifier of the stage.""" - c_a_t_e_g_o_r_y_id: Optional[int] = field( + c_a_t_e_g_o_r_y_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CATEGORY_ID"}, ) """The unique identifier of the category.""" - v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = field( + v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TEAM_ID"}, ) """The unique identifier of the team.""" - v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = field( + v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_USER_IDS"}, ) """The unique identifiers of the users.""" - c_a_n_e_d_i_t: Optional[bool] = field( + c_a_n_e_d_i_t: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CAN_EDIT"}, ) """Can edit""" - c_a_n_d_e_l_e_t_e: Optional[bool] = field( + c_a_n_d_e_l_e_t_e: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CAN_DELETE"}, ) """Can delete""" @@ -324,7 +420,12 @@ class ListLeadsResponse: Response for List leads """ - leads: Optional[List[Lead]] = None + leads: Optional[ + List[Lead | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A collection of leads""" @@ -334,188 +435,225 @@ class Lead: Response for Update lead """ - l_e_a_d_id: Optional[int] = field( + l_e_a_d_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LEAD_ID"}, ) """The unique identifier of the lead.""" - s_a_l_u_t_a_t_i_o_n: Optional[str] = field( + s_a_l_u_t_a_t_i_o_n: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SALUTATION"}, ) """The salutation of the lead.""" - t_i_t_l_e: Optional[str] = field( + t_i_t_l_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TITLE"}, ) """The title of the lead.""" - f_i_r_s_t_n_a_m_e: Optional[str] = field( + f_i_r_s_t_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FIRST_NAME"}, ) """First name of the lead.""" - l_a_s_t_n_a_m_e: Optional[str] = field( + l_a_s_t_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LAST_NAME"}, ) """Last name of the lead.""" - l_e_a_d_d_e_s_c_r_i_p_t_i_o_n: Optional[str] = field( + l_e_a_d_d_e_s_c_r_i_p_t_i_o_n: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LEAD_DESCRIPTION"}, ) """A brief description of the lead.""" - d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_CREATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_UPDATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - c_o_n_v_e_r_t_e_d_d_a_t_e_u_t_c: Optional[str] = field( + c_o_n_v_e_r_t_e_d_d_a_t_e_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONVERTED_DATE_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - l_e_a_d_s_t_a_t_u_s_id: Optional[int] = field( + l_e_a_d_s_t_a_t_u_s_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LEAD_STATUS_ID"}, ) """The status Id of the lead.""" - v_i_s_i_b_l_e_t_o: Optional[str] = field( + v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TO"}, ) """Lead visibility.""" - o_r_g_a_n_i_z_a_t_i_o_n_n_a_m_e: Optional[str] = field( + o_r_g_a_n_i_z_a_t_i_o_n_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ORGANIZATION_NAME"}, ) """The name of the organization.""" - p_h_o_n_e_n_u_m_b_e_r: Optional[str] = field( + p_h_o_n_e_n_u_m_b_e_r: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PHONE_NUMBER"}, ) """Lead phone number.""" - m_o_b_i_l_e_p_h_o_n_e_n_u_m_b_e_r: Optional[str] = field( + m_o_b_i_l_e_p_h_o_n_e_n_u_m_b_e_r: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MOBILE_PHONE_NUMBER"}, ) """Lead mobile phone number.""" - e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = field( + e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EMAIL_ADDRESS"}, ) """Lead email address.""" - c_o_n_v_e_r_t_e_d: Optional[bool] = field( + c_o_n_v_e_r_t_e_d: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONVERTED"}, ) """A boolean value determining whether or not the lead is converted.""" - w_e_b_s_i_t_e_u_r_l: Optional[str] = field( + w_e_b_s_i_t_e_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WEBSITE_URL"}, ) """Lead website URL""" - o_w_n_e_r_u_s_e_r_id: Optional[int] = field( + o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OWNER_USER_ID"}, ) """The unique identifier of the lead owner.""" - r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = field( + r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RESPONSIBLE_USER_ID"}, ) """The unique identifier of the responsible user.""" - e_m_p_l_o_y_e_e_c_o_u_n_t: Optional[int] = field( + e_m_p_l_o_y_e_e_c_o_u_n_t: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EMPLOYEE_COUNT"}, ) """The employee count of the lead.""" - l_e_a_d_r_a_t_i_n_g: Optional[int] = field( + l_e_a_d_r_a_t_i_n_g: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LEAD_RATING"}, ) """The rating of the lead.""" - i_n_d_u_s_t_r_y: Optional[str] = field( + i_n_d_u_s_t_r_y: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "INDUSTRY"}, ) """The industry of the lead.""" - a_d_d_r_e_s_s_s_t_r_e_e_t: Optional[str] = field( + a_d_d_r_e_s_s_s_t_r_e_e_t: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_STREET"}, ) """Address street.""" - a_d_d_r_e_s_s_c_i_t_y: Optional[str] = field( + a_d_d_r_e_s_s_c_i_t_y: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_CITY"}, ) """Address city.""" - a_d_d_r_e_s_s_s_t_a_t_e: Optional[str] = field( + a_d_d_r_e_s_s_s_t_a_t_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_STATE"}, ) """Address state.""" - a_d_d_r_e_s_s_p_o_s_t_c_o_d_e: Optional[str] = field( + a_d_d_r_e_s_s_p_o_s_t_c_o_d_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_POSTCODE"}, ) """Address postcode.""" - a_d_d_r_e_s_s_c_o_u_n_t_r_y: Optional[str] = field( + a_d_d_r_e_s_s_c_o_u_n_t_r_y: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_COUNTRY"}, ) """Address country.""" - f_a_x_n_u_m_b_e_r: Optional[str] = field( + f_a_x_n_u_m_b_e_r: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FAX_NUMBER"}, ) """Lead fax number.""" - c_o_n_v_e_r_t_e_d_c_o_n_t_a_c_t_id: Optional[int] = field( + c_o_n_v_e_r_t_e_d_c_o_n_t_a_c_t_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONVERTED_CONTACT_ID"}, ) """The unique identifier of the converted contact.""" - c_o_n_v_e_r_t_e_d_o_r_g_a_n_i_z_a_t_i_o_n_id: Optional[int] = field( + c_o_n_v_e_r_t_e_d_o_r_g_a_n_i_z_a_t_i_o_n_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONVERTED_ORGANIZATION_ID"}, ) """The unique identifier of the converted organization.""" - c_o_n_v_e_r_t_e_d_o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = field( + c_o_n_v_e_r_t_e_d_o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONVERTED_OPPORTUNITY_ID"}, ) """The unique identifier of the opportunity.""" - l_e_a_d_s_o_u_r_c_e_id: Optional[int] = field( + l_e_a_d_s_o_u_r_c_e_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LEAD_SOURCE_ID"}, ) """The unique identifier of the lead source.""" - v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = field( + v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TEAM_ID"}, ) """The unique identifier of the team.""" - v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = field( + v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_USER_IDS"}, ) """The unique identifiers of the users.""" - i_m_a_g_e_u_r_l: Optional[str] = field( + i_m_a_g_e_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IMAGE_URL"}, ) """Lead Image URL""" - c_a_n_e_d_i_t: Optional[bool] = field( + c_a_n_e_d_i_t: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CAN_EDIT"}, ) """Can edit""" - c_a_n_d_e_l_e_t_e: Optional[bool] = field( + c_a_n_d_e_l_e_t_e: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CAN_DELETE"}, ) """Can delete""" @@ -527,7 +665,12 @@ class ListContactsResponse: Response for List contacts """ - contacts: Optional[List[Contact]] = None + contacts: Optional[ + List[Contact | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A collection of contacts""" @@ -537,153 +680,184 @@ class Contact: Response for Update contact """ - a_d_d_r_e_s_s_w_o_r_k: Optional[Dict[str, Any]] = field( + a_d_d_r_e_s_s_w_o_r_k: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_WORK"}, ) - a_d_d_r_e_s_s_h_o_m_e: Optional[Dict[str, Any]] = field( + a_d_d_r_e_s_s_h_o_m_e: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_HOME"}, ) - a_d_d_r_e_s_s_p_o_s_t_a_l: Optional[Dict[str, Any]] = field( + a_d_d_r_e_s_s_p_o_s_t_a_l: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_POSTAL"}, ) - a_d_d_r_e_s_s_p_r_i_m_a_r_y: Optional[Dict[str, Any]] = field( + a_d_d_r_e_s_s_p_r_i_m_a_r_y: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_PRIMARY"}, ) - a_d_d_r_e_s_s_o_t_h_e_r: Optional[Dict[str, Any]] = field( + a_d_d_r_e_s_s_o_t_h_e_r: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_OTHER"}, ) - e_m_a_i_l_w_o_r_k: Optional[str] = field( + e_m_a_i_l_w_o_r_k: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EMAIL_WORK"}, ) """The work email of the contact.""" - e_m_a_i_l_h_o_m_e: Optional[str] = field( + e_m_a_i_l_h_o_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EMAIL_HOME"}, ) """The home email of the contact.""" - e_m_a_i_l_p_e_r_s_o_n_a_l: Optional[str] = field( + e_m_a_i_l_p_e_r_s_o_n_a_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EMAIL_PERSONAL"}, ) """The personal email of the contact.""" - e_m_a_i_l_o_t_h_e_r: Optional[str] = field( + e_m_a_i_l_o_t_h_e_r: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EMAIL_OTHER"}, ) """The other email of the contact.""" - p_h_o_n_e_w_o_r_k: Optional[str] = field( + p_h_o_n_e_w_o_r_k: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PHONE_WORK"}, ) """The work phone number of the contact.""" - p_h_o_n_e_h_o_m_e: Optional[str] = field( + p_h_o_n_e_h_o_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PHONE_HOME"}, ) """The home phone number of the contact.""" - p_h_o_n_e_m_o_b_i_l_e: Optional[str] = field( + p_h_o_n_e_m_o_b_i_l_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PHONE_MOBILE"}, ) """The mobile phone number of the contact.""" - p_h_o_n_e_o_t_h_e_r: Optional[str] = field( + p_h_o_n_e_o_t_h_e_r: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PHONE_OTHER"}, ) """The other phone number of the contact.""" - c_o_n_t_a_c_t_id: Optional[int] = field( + c_o_n_t_a_c_t_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONTACT_ID"}, ) """The unique identifier of the contact.""" - s_a_l_u_t_a_t_i_o_n: Optional[str] = field( + s_a_l_u_t_a_t_i_o_n: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SALUTATION"}, ) """The salutation of the contact.""" - f_i_r_s_t_n_a_m_e: Optional[str] = field( + f_i_r_s_t_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FIRST_NAME"}, ) """First name of the contact.""" - l_a_s_t_n_a_m_e: Optional[str] = field( + l_a_s_t_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LAST_NAME"}, ) """Last name of the contact.""" - i_m_a_g_e_u_r_l: Optional[str] = field( + i_m_a_g_e_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IMAGE_URL"}, ) """Contact image URL.""" - d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_CREATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - v_i_s_i_b_l_e_t_o: Optional[str] = field( + v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TO"}, ) """Contact visibility.""" - b_a_c_k_g_r_o_u_n_d: Optional[str] = field( + b_a_c_k_g_r_o_u_n_d: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BACKGROUND"}, ) """Background""" - d_e_f_a_u_l_t_l_i_n_k_e_d_o_r_g_a_n_i_s_a_t_i_o_n: Optional[int] = field( + d_e_f_a_u_l_t_l_i_n_k_e_d_o_r_g_a_n_i_s_a_t_i_o_n: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DEFAULT_LINKED_ORGANISATION"}, ) """Default linked organization.""" - o_w_n_e_r_u_s_e_r_id: Optional[int] = field( + o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OWNER_USER_ID"}, ) """The unique identifier of the owner.""" - d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_UPDATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = field( + v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TEAM_ID"}, ) """The unique identifier of the team.""" - v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = field( + v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_USER_IDS"}, ) """The unique identifiers of the users.""" - c_a_n_e_d_i_t: Optional[bool] = field( + c_a_n_e_d_i_t: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CAN_EDIT"}, ) """Can edit""" - c_a_n_d_e_l_e_t_e: Optional[bool] = field( + c_a_n_d_e_l_e_t_e: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CAN_DELETE"}, ) """Can delete""" - s_o_c_i_a_l_l_i_n_k_e_d_i_n: Optional[str] = field( + s_o_c_i_a_l_l_i_n_k_e_d_i_n: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SOCIAL_LINKEDIN"}, ) """Social LinkedIn.""" - s_o_c_i_a_l_f_a_c_e_b_o_o_k: Optional[str] = field( + s_o_c_i_a_l_f_a_c_e_b_o_o_k: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SOCIAL_FACEBOOK"}, ) """Social Facebook.""" - s_o_c_i_a_l_t_w_i_t_t_e_r: Optional[str] = field( + s_o_c_i_a_l_t_w_i_t_t_e_r: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SOCIAL_TWITTER"}, ) """Social Twitter.""" @@ -695,7 +869,12 @@ class ListUsersResponse: Response for List users """ - users: Optional[List[User]] = None + users: Optional[ + List[User | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A collection of users""" @@ -705,7 +884,7 @@ class ObjectEntity: Response for Delete task """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -718,7 +897,12 @@ class ListEventsResponse: Response for When an event is created """ - events: Optional[List[Event]] = None + events: Optional[ + List[Event | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A collection of events""" @@ -728,68 +912,83 @@ class Organization: Response for Add organization """ - o_r_g_a_n_i_s_a_t_i_o_n_id: Optional[int] = field( + o_r_g_a_n_i_s_a_t_i_o_n_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ORGANISATION_ID"}, ) """The unique identifier of the organization.""" - o_r_g_a_n_i_s_a_t_i_o_n_b_a_c_k_g_r_o_u_n_d: Optional[str] = field( + o_r_g_a_n_i_s_a_t_i_o_n_b_a_c_k_g_r_o_u_n_d: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ORGANISATION_BACKGROUND"}, ) """The background of the organization.""" - o_r_g_a_n_i_s_a_t_i_o_n_n_a_m_e: Optional[str] = field( + o_r_g_a_n_i_s_a_t_i_o_n_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ORGANISATION_NAME"}, ) """The name of the organization.""" - d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_CREATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_UPDATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - o_w_n_e_r_u_s_e_r_id: Optional[int] = field( + o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OWNER_USER_ID"}, ) """The unique identifier of the owner.""" - v_i_s_i_b_l_e_t_o: Optional[str] = field( + v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TO"}, ) """Organization visibility.""" - a_d_d_r_e_s_s_e_s: Optional[List[Address]] = field( + a_d_d_r_e_s_s_e_s: Optional[List[Address | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESSES"}, ) """Organization Addresses""" - c_o_n_t_a_c_t_i_n_f_o_s: Optional[List[ContactInfo]] = field( + c_o_n_t_a_c_t_i_n_f_o_s: Optional[ + List[ContactInfo | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONTACTINFOS"}, ) """Contact Information""" - b_a_c_k_g_r_o_u_n_d: Optional[str] = field( + b_a_c_k_g_r_o_u_n_d: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BACKGROUND"}, ) """The background of the organization.""" - i_m_a_g_e_u_r_l: Optional[str] = field( + i_m_a_g_e_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IMAGE_URL"}, ) """Organization image URL.""" - v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = field( + v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TEAM_ID"}, ) """The unique identifier of the team.""" - v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = field( + v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_USER_IDS"}, ) """The unique identifiers of the users.""" @@ -801,38 +1000,33 @@ class TaskRequest: Definition: TaskRequest """ - t_i_t_l_e: Optional[str] = field( - default=None, - metadata={"wire_name": "TITLE"}, - ) + t_i_t_l_e: str = dataclass_field(metadata={"wire_name": "TITLE"}) """The title of the task.""" - d_u_e_d_a_t_e: Optional[str] = field( + d_u_e_d_a_t_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DUE_DATE"}, ) """yyyy-MM-dd HH:mm:ss""" - c_o_m_p_l_e_t_e_d: Optional[bool] = field( - default=None, + c_o_m_p_l_e_t_e_d: bool = dataclass_field( metadata={"wire_name": "COMPLETED"}, ) """A boolean value determining whether or not the task is completed.""" - d_e_t_a_i_l_s: Optional[str] = field( + d_e_t_a_i_l_s: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DETAILS"}, ) """The details of the task.""" - s_t_a_t_u_s: Optional[str] = field( - default=None, - metadata={"wire_name": "STATUS"}, - ) + s_t_a_t_u_s: str = dataclass_field(metadata={"wire_name": "STATUS"}) """The status of the task.""" - p_r_i_o_r_i_t_y: Optional[int] = field( + p_r_i_o_r_i_t_y: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PRIORITY"}, ) """The priority of the task.""" - p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: Optional[bool] = field( - default=None, + p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: bool = dataclass_field( metadata={"wire_name": "PUBLICLY_VISIBLE"}, ) """ @@ -846,8 +1040,9 @@ class Tag: Definition: Tag """ - t_a_g_n_a_m_e: Optional[str] = field( + t_a_g_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TAG_NAME"}, ) """The name of the tag.""" @@ -859,60 +1054,65 @@ class ProjectRequest: Definition: ProjectRequest """ - p_r_o_j_e_c_t_n_a_m_e: Optional[str] = field( - default=None, + p_r_o_j_e_c_t_n_a_m_e: str = dataclass_field( metadata={"wire_name": "PROJECT_NAME"}, ) """The name of the project.""" - p_r_o_j_e_c_t_d_e_t_a_i_l_s: Optional[str] = field( + p_r_o_j_e_c_t_d_e_t_a_i_l_s: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PROJECT_DETAILS"}, ) """The details of the project.""" - s_t_a_t_u_s: Optional[str] = field( - default=None, - metadata={"wire_name": "STATUS"}, - ) + s_t_a_t_u_s: str = dataclass_field(metadata={"wire_name": "STATUS"}) """The status of the project.""" - i_m_a_g_e_u_r_l: Optional[str] = field( + i_m_a_g_e_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IMAGE_URL"}, ) """The image URL of the project.""" - v_i_s_i_b_l_e_t_o: Optional[str] = field( + v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TO"}, ) """Project Visibility.""" - v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = field( + v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TEAM_ID"}, ) """Visible Team Id (Required when team visibility state is selected)""" - v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = field( + v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_USER_IDS"}, ) """ Visible User IDs (Required when individuals visibility state is selected) """ - o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = field( + o_p_p_o_r_t_u_n_i_t_y_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OPPORTUNITY_ID"}, ) """The unique identifier of the opportunity.""" - p_i_p_e_l_i_n_e_id: Optional[int] = field( + p_i_p_e_l_i_n_e_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PIPELINE_ID"}, ) """The unique identifier of the pipeline.""" - s_t_a_g_e_id: Optional[int] = field( + s_t_a_g_e_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "STAGE_ID"}, ) """The unique identifier of the stage.""" - t_a_g_s: Optional[List[Tag]] = field( + t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TAGS"}, ) """Tags""" @@ -924,105 +1124,121 @@ class LeadRequest: Definition: LeadRequest """ - t_i_t_l_e: Optional[str] = field( + t_i_t_l_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TITLE"}, ) """The title of the lead.""" - f_i_r_s_t_n_a_m_e: Optional[str] = field( + f_i_r_s_t_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FIRST_NAME"}, ) """First name of the lead.""" - l_a_s_t_n_a_m_e: Optional[str] = field( - default=None, - metadata={"wire_name": "LAST_NAME"}, - ) + l_a_s_t_n_a_m_e: str = dataclass_field(metadata={"wire_name": "LAST_NAME"}) """Last name of the lead.""" - l_e_a_d_d_e_s_c_r_i_p_t_i_o_n: Optional[str] = field( + l_e_a_d_d_e_s_c_r_i_p_t_i_o_n: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LEAD_DESCRIPTION"}, ) """A brief description of the lead.""" - c_o_n_v_e_r_t_e_d_d_a_t_e_u_t_c: Optional[str] = field( + c_o_n_v_e_r_t_e_d_d_a_t_e_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONVERTED_DATE_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - v_i_s_i_b_l_e_t_o: Optional[str] = field( + v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TO"}, ) """Lead Visibility""" - v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = field( + v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TEAM_ID"}, ) """Visible Team Id (Required when team visibility state is selected)""" - v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = field( + v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_USER_IDS"}, ) """ Visible User IDs (Required when individuals visibility state is selected) """ - o_r_g_a_n_i_z_a_t_i_o_n_n_a_m_e: Optional[str] = field( + o_r_g_a_n_i_z_a_t_i_o_n_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ORGANIZATION_NAME"}, ) """The name of the organization.""" - p_h_o_n_e_n_u_m_b_e_r: Optional[str] = field( + p_h_o_n_e_n_u_m_b_e_r: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PHONE_NUMBER"}, ) """Lead phone number.""" - m_o_b_i_l_e_p_h_o_n_e_n_u_m_b_e_r: Optional[str] = field( + m_o_b_i_l_e_p_h_o_n_e_n_u_m_b_e_r: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MOBILE_PHONE_NUMBER"}, ) """Lead mobile phone number.""" - e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = field( + e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EMAIL_ADDRESS"}, ) """Lead email address.""" - c_o_n_v_e_r_t_e_d: Optional[bool] = field( + c_o_n_v_e_r_t_e_d: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONVERTED"}, ) """A boolean value determining whether or not the lead is converted.""" - w_e_b_s_i_t_e_u_r_l: Optional[str] = field( + w_e_b_s_i_t_e_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WEBSITE_URL"}, ) """Lead website URL""" - o_w_n_e_r_u_s_e_r_id: Optional[int] = field( + o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OWNER_USER_ID"}, ) """The unique identifier of the lead owner.""" - r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = field( + r_e_s_p_o_n_s_i_b_l_e_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RESPONSIBLE_USER_ID"}, ) """The unique identifier of the responsible user.""" - e_m_p_l_o_y_e_e_c_o_u_n_t: Optional[int] = field( + e_m_p_l_o_y_e_e_c_o_u_n_t: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EMPLOYEE_COUNT"}, ) """The employee count of the lead.""" - l_e_a_d_r_a_t_i_n_g: Optional[int] = field( + l_e_a_d_r_a_t_i_n_g: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LEAD_RATING"}, ) """The rating of the lead.""" - i_n_d_u_s_t_r_y: Optional[str] = field( + i_n_d_u_s_t_r_y: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "INDUSTRY"}, ) """The industry of the lead.""" - t_a_g_s: Optional[List[Tag]] = field( + t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TAGS"}, ) """Tag""" @@ -1034,38 +1250,45 @@ class Address: Definition: Address """ - a_d_d_r_e_s_s_id: Optional[int] = field( + a_d_d_r_e_s_s_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_ID"}, ) """The unique identifier of the address.""" - a_d_d_r_e_s_s_t_y_p_e: Optional[str] = field( + a_d_d_r_e_s_s_t_y_p_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESS_TYPE"}, ) """Address type.""" - s_t_r_e_e_t: Optional[str] = field( + s_t_r_e_e_t: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "STREET"}, ) """Address street.""" - c_i_t_y: Optional[str] = field( + c_i_t_y: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CITY"}, ) """Address city.""" - s_t_a_t_e: Optional[str] = field( + s_t_a_t_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "STATE"}, ) """Address state.""" - p_o_s_t_c_o_d_e: Optional[str] = field( + p_o_s_t_c_o_d_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "POSTCODE"}, ) """Address postcode.""" - c_o_u_n_t_r_y: Optional[str] = field( + c_o_u_n_t_r_y: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "COUNTRY"}, ) """Address country.""" @@ -1077,28 +1300,33 @@ class ContactInfo: Definition: ContactInfo """ - c_o_n_t_a_c_t_i_n_f_o_id: Optional[int] = field( + c_o_n_t_a_c_t_i_n_f_o_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONTACT_INFO_ID"}, ) """The unique identifier of the contact info.""" - t_y_p_e: Optional[str] = field( + t_y_p_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TYPE"}, ) """Contact info type.""" - s_u_b_t_y_p_e: Optional[str] = field( + s_u_b_t_y_p_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SUBTYPE"}, ) """Contact info sub-type.""" - l_a_b_e_l: Optional[str] = field( + l_a_b_e_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LABEL"}, ) """Contact info label.""" - d_e_t_a_i_l: Optional[str] = field( + d_e_t_a_i_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DETAIL"}, ) """Contact info detail.""" @@ -1110,50 +1338,55 @@ class ContactRequest: Definition: ContactRequest """ - s_a_l_u_t_a_t_i_o_n: Optional[str] = field( + s_a_l_u_t_a_t_i_o_n: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SALUTATION"}, ) """The salutation of the contact.""" - f_i_r_s_t_n_a_m_e: Optional[str] = field( - default=None, + f_i_r_s_t_n_a_m_e: str = dataclass_field( metadata={"wire_name": "FIRST_NAME"}, ) """First name of the contact.""" - l_a_s_t_n_a_m_e: Optional[str] = field( - default=None, - metadata={"wire_name": "LAST_NAME"}, - ) + l_a_s_t_n_a_m_e: str = dataclass_field(metadata={"wire_name": "LAST_NAME"}) """Last name of the lead.""" - b_a_c_k_g_r_o_u_n_d: Optional[str] = field( + b_a_c_k_g_r_o_u_n_d: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BACKGROUND"}, ) """Background""" - v_i_s_i_b_l_e_t_o: Optional[str] = field( + v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TO"}, ) """Contact Visibility""" - v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = field( + v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TEAM_ID"}, ) """Visible Team Id (Required when team visibility state is selected)""" - v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = field( + v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_USER_IDS"}, ) """ Visible User IDs (Required when individuals visibility state is selected) """ - c_o_n_t_a_c_t_i_n_f_o_s: Optional[List[ContactInfo]] = field( + c_o_n_t_a_c_t_i_n_f_o_s: Optional[ + List[ContactInfo | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONTACTINFOS"}, ) """Contact Information""" - t_a_g_s: Optional[List[Tag]] = field( + t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TAGS"}, ) """Tag""" @@ -1165,97 +1398,115 @@ class User: Definition: User """ - u_s_e_r_id: Optional[int] = field( + u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "USER_ID"}, ) """The unique identifier of the user.""" - c_o_n_t_a_c_t_id: Optional[int] = field( + c_o_n_t_a_c_t_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONTACT_ID"}, ) """The unique identifier of the contact.""" - f_i_r_s_t_n_a_m_e: Optional[str] = field( + f_i_r_s_t_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FIRST_NAME"}, ) """First name of the user.""" - l_a_s_t_n_a_m_e: Optional[str] = field( + l_a_s_t_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LAST_NAME"}, ) """Last name of the user.""" - e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = field( + e_m_a_i_l_a_d_d_r_e_s_s: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EMAIL_ADDRESS"}, ) """User email address.""" - t_i_m_e_z_o_n_e_id: Optional[str] = field( + t_i_m_e_z_o_n_e_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TIMEZONE_ID"}, ) """The unique identifier of the timezone.""" - e_m_a_i_l_d_r_o_p_b_o_x_id_e_n_t_i_f_i_e_r: Optional[str] = field( + e_m_a_i_l_d_r_o_p_b_o_x_id_e_n_t_i_f_i_e_r: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EMAIL_DROPBOX_IDENTIFIER"}, ) """The unique identifier of the email dropbox.""" - e_m_a_i_l_d_r_o_p_b_o_x_a_d_d_r_e_s_s: Optional[str] = field( + e_m_a_i_l_d_r_o_p_b_o_x_a_d_d_r_e_s_s: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EMAIL_DROPBOX_ADDRESS"}, ) """Email dropbox address""" - a_d_m_i_n_i_s_t_r_a_t_o_r: Optional[bool] = field( + a_d_m_i_n_i_s_t_r_a_t_o_r: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADMINISTRATOR"}, ) """ A boolean value determining whether or not the user is an administrator. """ - a_c_c_o_u_n_t_o_w_n_e_r: Optional[bool] = field( + a_c_c_o_u_n_t_o_w_n_e_r: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ACCOUNT_OWNER"}, ) """ A boolean value determining whether or not the user is the account owner. """ - a_c_t_i_v_e: Optional[bool] = field( + a_c_t_i_v_e: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ACTIVE"}, ) """A boolean value determining whether or not the user is active.""" - d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_CREATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_UPDATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - u_s_e_r_c_u_r_r_e_n_c_y: Optional[str] = field( + u_s_e_r_c_u_r_r_e_n_c_y: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "USER_CURRENCY"}, ) """User currency.""" - c_o_n_t_a_c_t_d_i_s_p_l_a_y: Optional[str] = field( + c_o_n_t_a_c_t_d_i_s_p_l_a_y: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONTACT_DISPLAY"}, ) """Contact display.""" - c_o_n_t_a_c_t_o_r_d_e_r: Optional[str] = field( + c_o_n_t_a_c_t_o_r_d_e_r: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONTACT_ORDER"}, ) """Contact order.""" - t_a_s_k_w_e_e_k_s_t_a_r_t: Optional[int] = field( + t_a_s_k_w_e_e_k_s_t_a_r_t: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TASK_WEEK_START"}, ) """Task week start.""" - i_n_s_t_a_n_c_e_id: Optional[int] = field( + i_n_s_t_a_n_c_e_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "INSTANCE_ID"}, ) """The unique identifier of the instance.""" @@ -1267,65 +1518,77 @@ class Event: Definition: Event """ - e_v_e_n_t_id: Optional[int] = field( + e_v_e_n_t_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EVENT_ID"}, ) """The unique identifier of the event.""" - t_i_t_l_e: Optional[str] = field( + t_i_t_l_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TITLE"}, ) """The title of the event.""" - s_t_a_r_t_d_a_t_e_u_t_c: Optional[str] = field( + s_t_a_r_t_d_a_t_e_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "START_DATE_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - e_n_d_d_a_t_e_u_t_c: Optional[str] = field( + e_n_d_d_a_t_e_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "END_DATE_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_c_r_e_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_CREATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = field( + d_a_t_e_u_p_d_a_t_e_d_u_t_c: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DATE_UPDATED_UTC"}, ) """yyyy-MM-dd HH:mm:ss""" - o_w_n_e_r_u_s_e_r_id: Optional[int] = field( + o_w_n_e_r_u_s_e_r_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OWNER_USER_ID"}, ) """The unique identifier of the owner.""" - r_e_m_i_n_d_e_r_s_e_n_t: Optional[bool] = field( + r_e_m_i_n_d_e_r_s_e_n_t: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "REMINDER_SENT"}, ) """A boolean value determining whether or not the reminder was sent.""" - a_l_l_d_a_y: Optional[bool] = field( + a_l_l_d_a_y: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ALL_DAY"}, ) """A boolean value determining whether or not the event is all day.""" - p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: Optional[bool] = field( + p_u_b_l_i_c_l_y_v_i_s_i_b_l_e: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PUBLICLY_VISIBLE"}, ) """ A boolean value determining whether or not the event is publicly visible. """ - c_a_n_e_d_i_t: Optional[bool] = field( + c_a_n_e_d_i_t: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CAN_EDIT"}, ) """Can edit""" - c_a_n_d_e_l_e_t_e: Optional[bool] = field( + c_a_n_d_e_l_e_t_e: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CAN_DELETE"}, ) """Can delete""" @@ -1337,45 +1600,53 @@ class OrganizationRequest: Definition: OrganizationRequest """ - o_r_g_a_n_i_s_a_t_i_o_n_n_a_m_e: Optional[str] = field( - default=None, + o_r_g_a_n_i_s_a_t_i_o_n_n_a_m_e: str = dataclass_field( metadata={"wire_name": "ORGANISATION_NAME"}, ) """The name of the organization.""" - o_r_g_a_n_i_s_a_t_i_o_n_b_a_c_k_g_r_o_u_n_d: Optional[str] = field( + o_r_g_a_n_i_s_a_t_i_o_n_b_a_c_k_g_r_o_u_n_d: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ORGANISATION_BACKGROUND"}, ) """The background of the organization.""" - v_i_s_i_b_l_e_t_o: Optional[str] = field( + v_i_s_i_b_l_e_t_o: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TO"}, ) """Organization visibility.""" - v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = field( + v_i_s_i_b_l_e_t_e_a_m_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_TEAM_ID"}, ) """Visible Team Id (Required when team visibility state is selected)""" - v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = field( + v_i_s_i_b_l_e_u_s_e_r_id_s: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VISIBLE_USER_IDS"}, ) """ Visible User IDs (Required when individuals visibility state is selected) """ - a_d_d_r_e_s_s_e_s: Optional[List[Address]] = field( + a_d_d_r_e_s_s_e_s: Optional[List[Address | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ADDRESSES"}, ) """Organization Addresses""" - c_o_n_t_a_c_t_i_n_f_o_s: Optional[List[ContactInfo]] = field( + c_o_n_t_a_c_t_i_n_f_o_s: Optional[ + List[ContactInfo | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CONTACTINFOS"}, ) """Contact Information""" - t_a_g_s: Optional[List[Tag]] = field( + t_a_g_s: Optional[List[Tag | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TAGS"}, ) """Tags""" @@ -1392,7 +1663,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1409,8 +1680,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1431,7 +1702,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1446,45 +1717,160 @@ def __init__( def connector_name(self) -> str: return "insightly" - async def list_tasks_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_tasks( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List tasks List tasks + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListTasks`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Tasks" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("tasks", []): + yield item + + return None, items() - async def update_task_async( + return AsyncItemPaged(get_next, extract_data) + + async def update_task( self, - input: TaskRequest, + input: TaskRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -1496,6 +1882,23 @@ async def update_task_async( Update task Update task + + Swagger operation ID: `UpdateTask`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Unique Id of the task to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Tasks" query_params = [] @@ -1506,7 +1909,7 @@ async def update_task_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1520,6 +1923,7 @@ async def update_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1527,9 +1931,9 @@ async def update_task_async( return json.loads(response.text) - async def add_task_async( + async def add_task( self, - input: TaskRequest, + input: TaskRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1540,10 +1944,26 @@ async def add_task_async( Add task Add task + + Swagger operation ID: `AddTask`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Tasks" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1557,6 +1977,7 @@ async def add_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1564,45 +1985,90 @@ async def add_task_async( return json.loads(response.text) - async def list_projects_async( + def list_projects( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List projects List projects + + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListProjects`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Projects" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) + + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + next_link = page.get("nextLink") + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None ) - if not response.text: - return None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("projects", []): + yield item - return json.loads(response.text) + return continuation_token, items() - async def update_project_async( + return AsyncItemPaged(get_next, extract_data) + + async def update_project( self, - input: ProjectRequest, + input: ProjectRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -1614,6 +2080,23 @@ async def update_project_async( Update project Update project + + Swagger operation ID: `UpdateProject`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Unique Id of the project to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Projects" query_params = [] @@ -1624,7 +2107,7 @@ async def update_project_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1638,6 +2121,7 @@ async def update_project_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1645,9 +2129,9 @@ async def update_project_async( return json.loads(response.text) - async def add_project_async( + async def add_project( self, - input: ProjectRequest, + input: ProjectRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1658,10 +2142,26 @@ async def add_project_async( Add project Add project + + Swagger operation ID: `AddProject`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Projects" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1675,6 +2175,7 @@ async def add_project_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1682,45 +2183,83 @@ async def add_project_async( return json.loads(response.text) - async def list_leads_async( + def list_leads( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List leads List leads + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListLeads`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Leads" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("leads", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def update_lead_async( + async def update_lead( self, - input: LeadRequest, + input: LeadRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -1732,6 +2271,23 @@ async def update_lead_async( Update lead Update lead + + Swagger operation ID: `UpdateLead`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Unique Id of the lead to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Leads" query_params = [] @@ -1742,7 +2298,7 @@ async def update_lead_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1756,6 +2312,7 @@ async def update_lead_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1763,9 +2320,9 @@ async def update_lead_async( return json.loads(response.text) - async def add_lead_async( + async def add_lead( self, - input: LeadRequest, + input: LeadRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1776,10 +2333,26 @@ async def add_lead_async( Add lead Add lead + + Swagger operation ID: `AddLead`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Leads" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1793,6 +2366,7 @@ async def add_lead_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1800,45 +2374,83 @@ async def add_lead_async( return json.loads(response.text) - async def list_contacts_async( + def list_contacts( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List contacts List contacts + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListContacts`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Contacts" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("contacts", []): + yield item + + return None, items() - async def update_contact_async( + return AsyncItemPaged(get_next, extract_data) + + async def update_contact( self, - input: ContactRequest, + input: ContactRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -1850,6 +2462,23 @@ async def update_contact_async( Update contact Update contact + + Swagger operation ID: `UpdateContact`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Unique Id of the contact to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Contacts" query_params = [] @@ -1860,7 +2489,7 @@ async def update_contact_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1874,6 +2503,7 @@ async def update_contact_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1881,9 +2511,9 @@ async def update_contact_async( return json.loads(response.text) - async def add_contact_async( + async def add_contact( self, - input: ContactRequest, + input: ContactRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1894,10 +2524,26 @@ async def add_contact_async( Add contact Add contact + + Swagger operation ID: `AddContact`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Contacts" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1911,6 +2557,7 @@ async def add_contact_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1918,43 +2565,81 @@ async def add_contact_async( return json.loads(response.text) - async def list_users_async( + def list_users( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List users List users + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListUsers`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Users" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("users", []): + yield item + + return None, items() - async def delete_task_async( + return AsyncItemPaged(get_next, extract_data) + + async def delete_task( self, task_id: int, *, @@ -1967,13 +2652,28 @@ async def delete_task_async( Delete task Delete task + + Swagger operation ID: `DeleteTask`. + + Args: + task_id: Task Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Tasks/{quote(str(task_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1987,6 +2687,7 @@ async def delete_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1994,7 +2695,7 @@ async def delete_task_async( return json.loads(response.text) - async def follow_task_async( + async def follow_task( self, task_id: int, *, @@ -2007,13 +2708,28 @@ async def follow_task_async( Follow a task Follow a task + + Swagger operation ID: `FollowTask`. + + Args: + task_id: Task Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Tasks/{quote(str(task_id), safe='')}/Follow" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2027,6 +2743,7 @@ async def follow_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2034,7 +2751,7 @@ async def follow_task_async( return json.loads(response.text) - async def delete_project_async( + async def delete_project( self, project_id: int, *, @@ -2047,13 +2764,28 @@ async def delete_project_async( Delete project Delete project + + Swagger operation ID: `DeleteProject`. + + Args: + project_id: Project Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Projects/{quote(str(project_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2067,6 +2799,7 @@ async def delete_project_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2074,7 +2807,7 @@ async def delete_project_async( return json.loads(response.text) - async def delete_lead_async( + async def delete_lead( self, lead_id: int, *, @@ -2087,13 +2820,28 @@ async def delete_lead_async( Delete lead Delete lead + + Swagger operation ID: `DeleteLead`. + + Args: + lead_id: Lead Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Leads/{quote(str(lead_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2107,6 +2855,7 @@ async def delete_lead_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2114,7 +2863,7 @@ async def delete_lead_async( return json.loads(response.text) - async def delete_contact_async( + async def delete_contact( self, contact_id: int, *, @@ -2127,13 +2876,28 @@ async def delete_contact_async( Delete contact Delete contact + + Swagger operation ID: `DeleteContact`. + + Args: + contact_id: Contact Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Contacts/{quote(str(contact_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2147,6 +2911,7 @@ async def delete_contact_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2154,9 +2919,9 @@ async def delete_contact_async( return json.loads(response.text) - async def add_organization_async( + async def add_organization( self, - input: OrganizationRequest, + input: OrganizationRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -2167,10 +2932,26 @@ async def add_organization_async( Add organization Add organization + + Swagger operation ID: `AddOrganization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Organisations" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2184,6 +2965,7 @@ async def add_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/jedoxodatahub.py b/src/azure/connectors/jedoxodatahub.py index 24f32daf..2d52c294 100644 --- a/src/azure/connectors/jedoxodatahub.py +++ b/src/azure/connectors/jedoxodatahub.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,58 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "JedoxodatahubClient", + "Cell", + "CellArray", + "Cube", + "CubeArray", + "CubeCellsResponse", + "CubesResponse", + "Database", + "DatabaseArray", + "DatabasesResponse", + "Dimension", + "DimensionArray", + "DimensionsResponse", + "Element", + "ElementArray", + "ElementsResponse", + "Error", + "ExtractRowsResponse", + "ExtractsResponse", + "GetCubeCellResultSchemaResponse", + "GetExtractRowsResultSchemaResponse", + "GetTransformRowsResultSchemaResponse", + "GetViewCellResultSchemaResponse", + "IntegratorComponent", + "IntegratorComponentArray", + "IntegratorExtractComponentRow", + "IntegratorExtractComponentRowArray", + "IntegratorProject", + "IntegratorProjectArray", + "IntegratorProjectGroup", + "IntegratorProjectGroupArray", + "IntegratorProjectGroupsResponse", + "IntegratorProjectsResponse", + "IntegratorRunResult", + "IntegratorTransformComponentRow", + "IntegratorTransformComponentRowArray", + "JobsResponse", + "LoadsResponse", + "TransformRowsResponse", + "TransformsResponse", + "View", + "ViewArray", + "ViewCell", + "ViewCellArray", + "ViewCellsResponse", + "ViewsResponse", +] + # Type Definitions @@ -29,7 +80,7 @@ class DatabasesResponse: Response for Get databases """ - value: Optional[DatabaseArray] = None + value: Optional[DatabaseArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -38,17 +89,31 @@ class Database: Response for Get database by id """ - cube_count: Optional[int] = field( + cube_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CubeCount"}, ) - dimension_count: Optional[int] = field( + dimension_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DimensionCount"}, ) - id: Optional[int] = field(default=None, metadata={"wire_name": "Id"}) - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) + id: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) @dataclass @@ -57,7 +122,7 @@ class CubesResponse: Response for Get cubes """ - value: Optional[CubeArray] = None + value: Optional[CubeArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -66,13 +131,26 @@ class Cube: Response for Get cube by ID """ - filled_cell_count: Optional[int] = field( + filled_cell_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FilledCellCount"}, ) - id: Optional[int] = field(default=None, metadata={"wire_name": "Id"}) - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) + id: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) @dataclass @@ -81,7 +159,7 @@ class CubeCellsResponse: Response for Get cube cells """ - value: Optional[CellArray] = None + value: Optional[CellArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -90,7 +168,7 @@ class DimensionsResponse: Response for Get dimensions """ - value: Optional[DimensionArray] = None + value: Optional[DimensionArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -99,13 +177,26 @@ class Dimension: Response for Get dimension by ID """ - element_count: Optional[int] = field( + element_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ElementCount"}, ) - id: Optional[int] = field(default=None, metadata={"wire_name": "Id"}) - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) + id: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) @dataclass @@ -114,7 +205,7 @@ class ElementsResponse: Response for Get elements """ - value: Optional[ElementArray] = None + value: Optional[ElementArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -123,15 +214,29 @@ class Element: Response for Get element by ID """ - id: Optional[int] = field(default=None, metadata={"wire_name": "Id"}) - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) - position: Optional[int] = field( + id: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) + position: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Position"}, ) - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) - weight: Optional[float] = field( + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) + weight: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Weight"}, ) @@ -142,7 +247,7 @@ class ViewsResponse: Response for Get stored views """ - value: Optional[ViewArray] = None + value: Optional[ViewArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -151,33 +256,44 @@ class View: Response for Get stored view by ID """ - creation_date: Optional[str] = field( + creation_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreationDate"}, ) - cube_id: Optional[int] = field( + cube_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CubeId"}, ) - cube_name: Optional[str] = field( + cube_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CubeName"}, ) - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) - friendly_name: Optional[str] = field( + friendly_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FriendlyName"}, ) - global_: Optional[bool] = field( + global_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Global"}, ) - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) - user_name: Optional[str] = field( + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) + user_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserName"}, ) @@ -188,7 +304,7 @@ class ViewCellsResponse: Response for Get stored view cells """ - value: Optional[ViewCellArray] = None + value: Optional[ViewCellArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -197,7 +313,7 @@ class IntegratorProjectGroupsResponse: Response for Get Integrator project groups """ - value: Optional[IntegratorProjectGroupArray] = None + value: Optional[IntegratorProjectGroupArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -206,26 +322,39 @@ class IntegratorProjectGroup: Response for Get Integrator project group by identifier """ - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) - developer: Optional[str] = field( + developer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Developer"}, ) - friendly_name: Optional[str] = field( + friendly_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FriendlyName"}, ) - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) - namespace: Optional[str] = field( + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) + namespace: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Namespace"}, ) - version: Optional[str] = field( + version: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Version"}, ) @@ -236,7 +365,7 @@ class IntegratorProjectsResponse: Response for Get Integrator projects """ - value: Optional[IntegratorProjectArray] = None + value: Optional[IntegratorProjectArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -245,17 +374,24 @@ class IntegratorProject: Response for Get Integrator project by name """ - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) - modification_date: Optional[str] = field( + modification_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ModificationDate"}, ) - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) - version: Optional[str] = field( + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) + version: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Version"}, ) @@ -266,7 +402,7 @@ class ExtractsResponse: Response for Get extracts """ - value: Optional[IntegratorComponentArray] = None + value: Optional[IntegratorComponentArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -275,16 +411,26 @@ class IntegratorComponent: Response for Get extract by Name """ - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) - modification_date: Optional[str] = field( + modification_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ModificationDate"}, ) - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) @dataclass @@ -293,7 +439,12 @@ class ExtractRowsResponse: Response for Get extract rows """ - value: Optional[IntegratorExtractComponentRowArray] = None + value: Optional[ + IntegratorExtractComponentRowArray + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -302,7 +453,7 @@ class JobsResponse: Response for Get jobs """ - value: Optional[IntegratorComponentArray] = None + value: Optional[IntegratorComponentArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -311,22 +462,25 @@ class IntegratorRunResult: Response for Run job """ - errors: Optional[int] = None - execution_type: Optional[str] = field( + errors: Optional[int] = dataclass_field(default=None, kw_only=True) + execution_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "executionType"}, ) - id: Optional[int] = None - start_date: Optional[str] = field( + id: Optional[int] = dataclass_field(default=None, kw_only=True) + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) - status: Optional[str] = None - trace_available: Optional[bool] = field( + status: Optional[str] = dataclass_field(default=None, kw_only=True) + trace_available: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "traceAvailable"}, ) - warnings: Optional[int] = None + warnings: Optional[int] = dataclass_field(default=None, kw_only=True) @dataclass @@ -335,7 +489,7 @@ class LoadsResponse: Response for Get loads """ - value: Optional[IntegratorComponentArray] = None + value: Optional[IntegratorComponentArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -344,7 +498,7 @@ class TransformsResponse: Response for Get transforms """ - value: Optional[IntegratorComponentArray] = None + value: Optional[IntegratorComponentArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -353,7 +507,12 @@ class TransformRowsResponse: Response for Get transform Rows """ - value: Optional[IntegratorTransformComponentRowArray] = None + value: Optional[ + IntegratorTransformComponentRowArray + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -362,7 +521,7 @@ class GetCubeCellResultSchemaResponse: Response for Get Cube Cell Result Schema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -375,7 +534,7 @@ class GetExtractRowsResultSchemaResponse: Response for Get Extract Rows Result Schema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -388,7 +547,7 @@ class GetTransformRowsResultSchemaResponse: Response for Get Transform Rows Result Schema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -401,7 +560,7 @@ class GetViewCellResultSchemaResponse: Response for Get View Cell Result Schema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -414,26 +573,26 @@ class Cell: Definition: Cell """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) """ -CellArray = List["Cell"] +CellArray = List["Cell | Mapping[str, Any]"] -CubeArray = List["Cube"] +CubeArray = List["Cube | Mapping[str, Any]"] -DatabaseArray = List["Database"] +DatabaseArray = List["Database | Mapping[str, Any]"] -DimensionArray = List["Dimension"] +DimensionArray = List["Dimension | Mapping[str, Any]"] -ElementArray = List["Element"] +ElementArray = List["Element | Mapping[str, Any]"] @dataclass @@ -442,10 +601,10 @@ class Error: Definition: Error """ - error: Optional[str] = None + error: Optional[str] = dataclass_field(default=None, kw_only=True) -IntegratorComponentArray = List["IntegratorComponent"] +IntegratorComponentArray = List["IntegratorComponent | Mapping[str, Any]"] @dataclass @@ -454,20 +613,20 @@ class IntegratorExtractComponentRow: Definition: IntegratorExtractComponentRow """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) """ -IntegratorExtractComponentRowArray = List["IntegratorExtractComponentRow"] +IntegratorExtractComponentRowArray = List["IntegratorExtractComponentRow | Mapping[str, Any]"] -IntegratorProjectArray = List["IntegratorProject"] +IntegratorProjectArray = List["IntegratorProject | Mapping[str, Any]"] -IntegratorProjectGroupArray = List["IntegratorProjectGroup"] +IntegratorProjectGroupArray = List["IntegratorProjectGroup | Mapping[str, Any]"] @dataclass @@ -476,17 +635,19 @@ class IntegratorTransformComponentRow: Definition: IntegratorTransformComponentRow """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) """ -IntegratorTransformComponentRowArray = List["IntegratorTransformComponentRow"] +IntegratorTransformComponentRowArray = List[ + "IntegratorTransformComponentRow | Mapping[str, Any]" +] -ViewArray = List["View"] +ViewArray = List["View | Mapping[str, Any]"] @dataclass @@ -495,14 +656,14 @@ class ViewCell: Definition: ViewCell """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) """ -ViewCellArray = List["ViewCell"] +ViewCellArray = List["ViewCell | Mapping[str, Any]"] # Client Class @@ -516,7 +677,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -533,8 +694,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -555,7 +716,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -570,23 +731,126 @@ def __init__( def connector_name(self) -> str: return "jedoxodatahub" - async def databases_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_databases( self, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get databases Get a list of databases found in the server. System and config databases are excluded from the list, but can be requested by providing the ID. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Databases`. + + Args: + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Databases" query_params = [] @@ -607,29 +871,50 @@ async def databases_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def database_by_id_async( + return AsyncItemPaged(get_next, extract_data) + + async def database_by_id( self, database_id: int, *, @@ -642,13 +927,28 @@ async def database_by_id_async( Get database by id Get the database with the given ID. + + Swagger operation ID: `DatabaseById`. + + Args: + database_id: Numeric ID of the database. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Databases({quote(str(database_id), safe='')})" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -662,6 +962,7 @@ async def database_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -669,24 +970,51 @@ async def database_by_id_async( return json.loads(response.text) - async def cubes_async( + def list_cubes( self, database_id: int, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get cubes Get a list of cubes in the given database. To prevent issues with the URL encodings, Attribute cubes will be renamed, e.g. \\#_Years to ATT_Years. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Cubes`. + + Args: + database_id: Numeric ID of the database. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -710,29 +1038,50 @@ async def cubes_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def cube_by_id_async( + async def cube_by_id( self, database_id: int, cube_id: int, @@ -748,6 +1097,22 @@ async def cube_by_id_async( Get the cube with the given ID in the given database. To prevent issues with the URL encodings, Attribute cubes will be renamed, e.g. \\#_Years to ATT_Years. + + Swagger operation ID: `CubeById`. + + Args: + database_id: Numeric ID of the database. + cube_id: Numeric ID of the cube. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -755,7 +1120,7 @@ async def cube_by_id_async( f"/Cubes({quote(str(cube_id), safe='')})" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -769,6 +1134,7 @@ async def cube_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -776,10 +1142,11 @@ async def cube_by_id_async( return json.loads(response.text) - async def cube_cells_async( + def list_cube_cells( self, database_id: int, cube_id: int, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, @@ -787,18 +1154,59 @@ async def cube_cells_async( userules: Optional[bool] = None, zerosupression: Optional[bool] = None, disablepaging: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get cube cells Get the cells from a cube. This returns the cells' values and element names. If the cell has a string value, the value is instead stored in the stringValue field. Element names are stored in dynamic properties. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `CubeCells`. + + Args: + database_id: Numeric ID of the database. + cube_id: Numeric ID of the cube. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + > Currently the /Cells functions only support basic operations. + Complex formulas might return an invalid result. For complex + filtering, please use Views. + baseonly: If set to true, the result will only contain base + elements. If set to false, it will also contain consolidated + elements. + userules: If set to true, rules will be applied to the resulting + cells. + zerosupression: If set to true, numeric cells with a value of 0 and + empty string cells will be removed from the result. + disablepaging: If set to true, the service will return the entire + result instead of a single page. With this option set to true, + the response might take multiple minutes depending on the + cube's size. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -844,44 +1252,92 @@ async def cube_cells_async( query_params.append(f"disablepaging={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def dimensions_async( + return AsyncItemPaged(get_next, extract_data) + + def list_dimensions( self, database_id: int, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get dimensions Get a list of dimensions in the given database. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Dimensions`. + + Args: + database_id: Numeric ID of the database. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -905,29 +1361,50 @@ async def dimensions_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def dimension_by_id_async( + return AsyncItemPaged(get_next, extract_data) + + async def dimension_by_id( self, database_id: int, dimension_id: int, @@ -941,6 +1418,22 @@ async def dimension_by_id_async( Get dimension by ID Get the dimension with the given ID in the given database. + + Swagger operation ID: `DimensionById`. + + Args: + database_id: Numeric ID of the database. + dimension_id: Numeric ID of the dimension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -948,7 +1441,7 @@ async def dimension_by_id_async( f"/Dimensions({quote(str(dimension_id), safe='')})" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -962,6 +1455,7 @@ async def dimension_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -969,23 +1463,51 @@ async def dimension_by_id_async( return json.loads(response.text) - async def elements_async( + def list_elements( self, database_id: int, dimension_id: int, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get elements Get a list of elements in the given dimension. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Elements`. + + Args: + database_id: Numeric ID of the database. + dimension_id: Numeric ID of the dimension. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1011,29 +1533,50 @@ async def elements_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def element_by_id_async( + async def element_by_id( self, database_id: int, dimension_id: int, @@ -1048,6 +1591,23 @@ async def element_by_id_async( Get element by ID Returns the element with the given ID in the given dimension. + + Swagger operation ID: `ElementById`. + + Args: + database_id: Numeric ID of the database. + dimension_id: Numeric ID of the dimension. + element_id: Numeric ID of the element. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1056,7 +1616,7 @@ async def element_by_id_async( f"/Elements({quote(str(element_id), safe='')})" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1070,6 +1630,7 @@ async def element_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1077,22 +1638,49 @@ async def element_by_id_async( return json.loads(response.text) - async def views_async( + def list_views( self, database_id: int, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get stored views Get a list of stored views in the given database. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Views`. + + Args: + database_id: Numeric ID of the database. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1116,29 +1704,50 @@ async def views_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def view_by_id_async( + return AsyncItemPaged(get_next, extract_data) + + async def view_by_id( self, database_id: int, view_id: str, @@ -1152,6 +1761,22 @@ async def view_by_id_async( Get stored view by ID Get the view with the given ID in the given database. + + Swagger operation ID: `ViewById`. + + Args: + database_id: Numeric ID of the database. + view_id: UUID of the view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1159,7 +1784,7 @@ async def view_by_id_async( f"/Views({quote(str(view_id), safe='')})" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1173,6 +1798,7 @@ async def view_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1180,10 +1806,11 @@ async def view_by_id_async( return json.loads(response.text) - async def view_cells_async( + def list_view_cells( self, database_id: int, view_id: str, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, @@ -1191,18 +1818,58 @@ async def view_cells_async( userules: Optional[bool] = None, zerosupression: Optional[bool] = None, disablepaging: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get stored view cells Get all cells from a view. This returns the cells' values and element names. If the cell has a string value, the value is instead stored in the stringValue field. Element names are stored in dynamic properties. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ViewCells`. + + Args: + database_id: Numeric ID of the database. + view_id: UUID of the view. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + > Currently the /Cells functions only support basic operations. + Complex formulas might return an invalid result. + baseonly: If set to true, the result will only contain base + elements. If set to false, it will also contain consolidated + elements. + userules: If set to true, rules will be applied to the resulting + cells. + zerosupression: If set to true, numeric cells with a value of 0 and + empty string cells will be removed from the result. + disablepaging: If set to true, the service will return the entire + result instead of a single page. With this option set to true, + the response might take multiple minutes depending on the + view's size. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1248,43 +1915,90 @@ async def view_cells_async( query_params.append(f"disablepaging={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def integrator_project_groups_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_integrator_project_groups( self, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Integrator project groups Get a list of integrator project groups found in the server. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `IntegratorProjectGroups`. + + Args: + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Integrator" query_params = [] @@ -1305,29 +2019,50 @@ async def integrator_project_groups_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def integrator_projects_by_id_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def integrator_projects_by_id( self, group_identifier: str, *, @@ -1340,13 +2075,28 @@ async def integrator_projects_by_id_async( Get Integrator project group by identifier Get the project group with the given ID. + + Swagger operation ID: `IntegratorProjectsById`. + + Args: + group_identifier: The identifier of the Integrator project group. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Integrator('{quote(str(group_identifier), safe='')}')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1360,6 +2110,7 @@ async def integrator_projects_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1367,22 +2118,49 @@ async def integrator_projects_by_id_async( return json.loads(response.text) - async def integrator_projects_async( + def list_integrator_projects( self, group_identifier: str, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Integrator projects Get a list of integrator projects found in the server. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `IntegratorProjects`. + + Args: + group_identifier: The identifier of the Integrator project group. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1406,29 +2184,50 @@ async def integrator_projects_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def integrator_projects_by_name_async( + return AsyncItemPaged(get_next, extract_data) + + async def integrator_projects_by_name( self, group_identifier: str, project_name: str, @@ -1442,6 +2241,22 @@ async def integrator_projects_by_name_async( Get Integrator project by name Get the integrator project with the given name. + + Swagger operation ID: `IntegratorProjectsByName`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1449,7 +2264,7 @@ async def integrator_projects_by_name_async( f"/Projects('{quote(str(project_name), safe='')}')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1463,6 +2278,7 @@ async def integrator_projects_by_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1470,23 +2286,51 @@ async def integrator_projects_by_name_async( return json.loads(response.text) - async def extracts_async( + def list_extracts( self, group_identifier: str, project_name: str, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get extracts Get a list of extracts in the given integrator project. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Extracts`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1512,29 +2356,50 @@ async def extracts_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def extract_by_name_async( + return AsyncItemPaged(get_next, extract_data) + + async def extract_by_name( self, group_identifier: str, project_name: str, @@ -1549,6 +2414,23 @@ async def extract_by_name_async( Get extract by Name Get the extract with the given name in the given integrator project. + + Swagger operation ID: `ExtractByName`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + extract_name: The name of the extract. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1557,7 +2439,7 @@ async def extract_by_name_async( f"/Extracts('{quote(str(extract_name), safe='')}')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1571,6 +2453,7 @@ async def extract_by_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1578,25 +2461,54 @@ async def extract_by_name_async( return json.loads(response.text) - async def extract_rows_async( + def list_extract_rows( self, group_identifier: str, project_name: str, extract_name: str, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get extract rows Stream the rows of the extract with the given name in the given integrator project. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ExtractRows`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + extract_name: The name of the extract. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1623,45 +2535,94 @@ async def extract_rows_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def jobs_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_jobs( self, group_identifier: str, project_name: str, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get jobs Get a list of jobs in the given integrator project. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Jobs`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1687,29 +2648,50 @@ async def jobs_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def job_by_name_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def job_by_name( self, group_identifier: str, project_name: str, @@ -1724,6 +2706,23 @@ async def job_by_name_async( Get job by name Get the jobs with the given name in the given integrator project. + + Swagger operation ID: `JobByName`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + job_name: The name of the job. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1732,7 +2731,7 @@ async def job_by_name_async( f"/Jobs('{quote(str(job_name), safe='')}')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1746,6 +2745,7 @@ async def job_by_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1753,7 +2753,7 @@ async def job_by_name_async( return json.loads(response.text) - async def run_job_async( + async def run_job( self, group_identifier: str, project_name: str, @@ -1769,6 +2769,23 @@ async def run_job_async( Run the job with the given name in the given integrator project. The execution will be added to the queue. + + Swagger operation ID: `RunJob`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + job_name: The name of the job. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1778,7 +2795,7 @@ async def run_job_async( f"/Run" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1792,6 +2809,7 @@ async def run_job_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1799,7 +2817,7 @@ async def run_job_async( return json.loads(response.text) - async def run_job_with_variables_async( + async def run_job_with_variables( self, group_identifier: str, project_name: str, @@ -1816,6 +2834,27 @@ async def run_job_with_variables_async( Run the job with the given name in the given integrator project. The execution will be added to the queue. + + Swagger operation ID: `RunJobWithVariables`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + job_name: The name of the job. + variables: Variable names and values separated by an equal sign. If + a variable is omitted, the default value will be used. Multiple + variables must be separated by commas. Example: + Variables='SourceDB=Demo,TargetDB=Biker'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1827,7 +2866,7 @@ async def run_job_with_variables_async( f"')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1841,6 +2880,7 @@ async def run_job_with_variables_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1848,23 +2888,51 @@ async def run_job_with_variables_async( return json.loads(response.text) - async def loads_async( + def list_loads( self, group_identifier: str, project_name: str, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get loads Get a list of loads in the given integrator project. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Loads`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1890,29 +2958,50 @@ async def loads_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def load_by_name_async( + return AsyncItemPaged(get_next, extract_data) + + async def load_by_name( self, group_identifier: str, project_name: str, @@ -1927,6 +3016,23 @@ async def load_by_name_async( Get load by name Get the transform with the given name in the given integrator project. + + Swagger operation ID: `LoadByName`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + load_name: The name of the load. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1935,7 +3041,7 @@ async def load_by_name_async( f"/Loads('{quote(str(load_name), safe='')}')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1949,6 +3055,7 @@ async def load_by_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1956,7 +3063,7 @@ async def load_by_name_async( return json.loads(response.text) - async def run_load_async( + async def run_load( self, group_identifier: str, project_name: str, @@ -1972,6 +3079,23 @@ async def run_load_async( Run the load with the given name in the given integrator project. The execution will be added to the queue. + + Swagger operation ID: `RunLoad`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + load_name: The name of the load. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1981,7 +3105,7 @@ async def run_load_async( f"/Run()" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1995,6 +3119,7 @@ async def run_load_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2002,7 +3127,7 @@ async def run_load_async( return json.loads(response.text) - async def run_load_with_variables_async( + async def run_load_with_variables( self, group_identifier: str, project_name: str, @@ -2019,6 +3144,27 @@ async def run_load_with_variables_async( Run the load with the given name in the given integrator project. The execution will be added to the queue. + + Swagger operation ID: `RunLoadWithVariables`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + load_name: The name of the load. + variables: Variable names and values separated by an equal sign. If + a variable is omitted, the default value will be used. Multiple + variables must be separated by commas. Example: + Variables='SourceDB=Demo,TargetDB=Biker'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2030,7 +3176,7 @@ async def run_load_with_variables_async( f"')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2044,6 +3190,7 @@ async def run_load_with_variables_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2051,23 +3198,51 @@ async def run_load_with_variables_async( return json.loads(response.text) - async def transforms_async( + def list_transforms( self, group_identifier: str, project_name: str, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get transforms Get a list of transforms in the given integrator project. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Transforms`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2093,29 +3268,50 @@ async def transforms_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def transform_by_name_async( + async def transform_by_name( self, group_identifier: str, project_name: str, @@ -2130,6 +3326,23 @@ async def transform_by_name_async( Get transform by name Get the transform with the given name in the given integrator project. + + Swagger operation ID: `TransformByName`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + transform_name: The name of the transform. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2138,7 +3351,7 @@ async def transform_by_name_async( f"/Transforms('{quote(str(transform_name), safe='')}')" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2152,6 +3365,7 @@ async def transform_by_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2159,25 +3373,54 @@ async def transform_by_name_async( return json.loads(response.text) - async def transform_rows_async( + def list_transform_rows( self, group_identifier: str, project_name: str, transform_name: str, + *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get transform Rows Stream the rows of the transform with the given name in the given integrator project. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `TransformRows`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the Integrator project. + transform_name: The name of the transform. + top: Limits the number of items returned by the given number. The + service returns the number of available items up to but not + greater than the specified value n. + skip: Excludes the first n items of the queried collection from the + result. The service returns items starting at position n+1. + filter: The $filter system query option restricts the set of items + returned. For a list of available operations and functions see + the [OData + Documentation](http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Ref356810738). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2204,29 +3447,50 @@ async def transform_rows_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_cube_cell_result_schema_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_cube_cell_result_schema( self, database_id: int, cube_id: int, @@ -2241,6 +3505,22 @@ async def get_cube_cell_result_schema_async( Service request for getting the schema used for the result of cube cells. + + Swagger operation ID: `GetCubeCellResultSchema`. + + Args: + database_id: The identifier of the Olap database. + cube_id: The identifier of the Olap cube. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2254,7 +3534,7 @@ async def get_cube_cell_result_schema_async( f"/cells" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2268,6 +3548,7 @@ async def get_cube_cell_result_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2275,7 +3556,7 @@ async def get_cube_cell_result_schema_async( return json.loads(response.text) - async def get_extract_rows_result_schema_async( + async def get_extract_rows_result_schema( self, group_identifier: str, project_name: str, @@ -2291,6 +3572,23 @@ async def get_extract_rows_result_schema_async( Service request for getting the schema used for the result of extract rows. + + Swagger operation ID: `GetExtractRowsResultSchema`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the project. + extract_name: The name of the extract. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2305,7 +3603,7 @@ async def get_extract_rows_result_schema_async( f"/rows" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2319,6 +3617,7 @@ async def get_extract_rows_result_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2326,7 +3625,7 @@ async def get_extract_rows_result_schema_async( return json.loads(response.text) - async def get_transform_rows_result_schema_async( + async def get_transform_rows_result_schema( self, group_identifier: str, project_name: str, @@ -2342,6 +3641,23 @@ async def get_transform_rows_result_schema_async( Service request for getting the schema used for the result of transform rows. + + Swagger operation ID: `GetTransformRowsResultSchema`. + + Args: + group_identifier: The identifier of the Integrator project group. + project_name: The name of the project. + transform_name: The name of the transform. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2356,7 +3672,7 @@ async def get_transform_rows_result_schema_async( f"/rows" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2370,6 +3686,7 @@ async def get_transform_rows_result_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2377,7 +3694,7 @@ async def get_transform_rows_result_schema_async( return json.loads(response.text) - async def get_view_cell_result_schema_async( + async def get_view_cell_result_schema( self, database_id: int, view_id: str, @@ -2392,6 +3709,22 @@ async def get_view_cell_result_schema_async( Service request for getting the schema used for the result of view cells. + + Swagger operation ID: `GetViewCellResultSchema`. + + Args: + database_id: The identifier of the Olap database. + view_id: The identifier of the stored view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2405,7 +3738,7 @@ async def get_view_cell_result_schema_async( f"/cells" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2419,6 +3752,7 @@ async def get_view_cell_result_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/jira.py b/src/azure/connectors/jira.py index 2ee35e1c..39d0703c 100644 --- a/src/azure/connectors/jira.py +++ b/src/azure/connectors/jira.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,57 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "JiraClient", + "Assignee", + "CancelTaskResponse", + "Comment", + "CommentResponse", + "CreateIssueInput", + "CreateIssueRequest", + "CreateIssueResponse", + "CreateProjectCategoryInput", + "CreateProjectCategoryResponse", + "CreateProjectInput", + "CreateProjectResponse", + "Creator", + "EditIssueInput", + "EditIssueResponse", + "FilterArray", + "FullIssue", + "GetCurrentUserResponse", + "GetTaskResponse", + "GetUserResponse", + "IssueTypes", + "ListFiltersResponse", + "ListIssuesResponse", + "ListIssuesResponseDatacenter", + "ListProjectsResponse", + "ListTransitionsResponse", + "MCPQueryRequest", + "MCPQueryResponse", + "PartialIssue", + "PriorityList", + "Project", + "ProjectArray", + "Reporter", + "Sites", + "StatusList", + "Transition", + "TransitionInput", + "TransitionStatus", + "UpdateIssueRequest", + "UpdateProjectInput", + "UpdateProjectResponse", + "UpdateTransitionResponse", + "User", + "UserList", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -32,8 +82,9 @@ class ListIssuesResponse: Response for Get list of issues """ - next_page_token: Optional[str] = field( + next_page_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextPageToken"}, ) """ @@ -41,12 +92,18 @@ class ListIssuesResponse: the 'Next page token' input of a subsequent call to fetch the next page. Absent on the last page. """ - is_last: Optional[bool] = field( + is_last: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isLast"}, ) """Indicates whether this is the last page of results.""" - issues: Optional[List[FullIssue]] = None + issues: Optional[ + List[FullIssue | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -55,17 +112,24 @@ class ListIssuesResponseDatacenter: Response for Get list of issues (Datacenter) """ - start_at: Optional[int] = field( + start_at: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startAt"}, ) """The index of the first item to return in a page of results""" - max_results: Optional[int] = field( + max_results: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "maxResults"}, ) """The maximum number of items to return per page""" - issues: Optional[List[FullIssue]] = None + issues: Optional[ + List[FullIssue | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -74,7 +138,12 @@ class ListTransitionsResponse: Response for Get list of Transitions """ - transitions: Optional[List[Transition]] = None + transitions: Optional[ + List[Transition | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -83,7 +152,7 @@ class UpdateTransitionResponse: Response for Performs an issue transition """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -96,7 +165,7 @@ class GetCurrentUserResponse: Response for Get current user """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -109,13 +178,13 @@ class FullIssue: Response for When a new issue is created (Datacenter) """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique id of the issue.""" - key: Optional[str] = None + key: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique key of the issue.""" - self: Optional[str] = None + self: Optional[str] = dataclass_field(default=None, kw_only=True) """Browse to the issue using this URL.""" - fields: Optional[Dict[str, Any]] = None + fields: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -124,12 +193,12 @@ class MCPQueryResponse: Response for Jira MCP Server """ - jsonrpc: Optional[str] = None - id: Optional[str] = None - method: Optional[str] = None - params: Optional[Dict[str, Any]] = None - result: Optional[Dict[str, Any]] = None - error: Optional[Dict[str, Any]] = None + jsonrpc: Optional[str] = dataclass_field(default=None, kw_only=True) + id: Optional[str] = dataclass_field(default=None, kw_only=True) + method: Optional[str] = dataclass_field(default=None, kw_only=True) + params: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + result: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + error: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -138,11 +207,11 @@ class CommentResponse: Response for Add comment """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique id of the comment.""" - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """Body of the comment.""" - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" @@ -152,7 +221,7 @@ class CancelTaskResponse: Response for Cancel Task """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -165,7 +234,7 @@ class CreateIssueInput: Create a new issue """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -178,9 +247,9 @@ class CreateIssueResponse: Response for Create a new issue """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the issue.""" - key: Optional[str] = None + key: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique key of the issue.""" @@ -190,21 +259,19 @@ class CreateProjectInput: Create a new project """ - key: Optional[str] = None + key: str """The unique key, starts with a capital letter.""" - name: Optional[str] = None + name: str """Title of the project.""" - project_type_key: Optional[str] = field( - default=None, + project_type_key: str = dataclass_field( metadata={"wire_name": "projectTypeKey"}, ) """Project type key.""" - lead_account_id: Optional[str] = field( - default=None, + lead_account_id: str = dataclass_field( metadata={"wire_name": "leadAccountId"}, ) """Id of Project lead.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Verbose description of the project.""" @@ -214,9 +281,9 @@ class CreateProjectResponse: Response for Create a new project """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique id of the project.""" - key: Optional[str] = None + key: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique key of the project.""" @@ -226,9 +293,9 @@ class CreateProjectCategoryInput: Create Project Category """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description""" @@ -238,7 +305,7 @@ class CreateProjectCategoryResponse: Response for Create Project Category """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -251,27 +318,28 @@ class EditIssueInput: Edit Issue """ - transition: Optional[Dict[str, Any]] = None + transition: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Transition""" - fields: Optional[Dict[str, Any]] = None + fields: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update. """ - update: Optional[Dict[str, Any]] = None + update: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields. """ - history_metadata: Optional[Dict[str, Any]] = field( + history_metadata: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "historyMetadata"}, ) """History meta data""" - properties: Optional[List[Dict[str, Any]]] = None + properties: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Properties""" @@ -281,7 +349,7 @@ class EditIssueResponse: Response for Edit Issue """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -294,7 +362,7 @@ class GetTaskResponse: Response for Get Task """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -307,7 +375,7 @@ class GetUserResponse: Response for Get User """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -320,12 +388,13 @@ class ListFiltersResponse: Response for Get list of Filters """ - next_page: Optional[str] = field( + next_page: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextPage"}, ) """Next page of filters""" - values: Optional[FilterArray] = None + values: Optional[FilterArray] = dataclass_field(default=None, kw_only=True) @dataclass @@ -334,12 +403,13 @@ class ListProjectsResponse: Response for Get projects """ - next_page: Optional[str] = field( + next_page: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextPage"}, ) """Next page of projects""" - values: Optional[ProjectArray] = None + values: Optional[ProjectArray] = dataclass_field(default=None, kw_only=True) UserList = List[Dict[str, Any]] @@ -351,58 +421,67 @@ class UpdateProjectInput: Update Project """ - key: Optional[str] = None + key: Optional[str] = dataclass_field(default=None, kw_only=True) """Key""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name""" - project_type_key: Optional[str] = field( + project_type_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectTypeKey"}, ) """Project Type Key""" - project_template_key: Optional[str] = field( + project_template_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectTemplateKey"}, ) """Project Template Key""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description""" - lead: Optional[str] = None + lead: Optional[str] = dataclass_field(default=None, kw_only=True) """Lead""" - lead_account_id: Optional[str] = field( + lead_account_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "leadAccountId"}, ) """Lead Account ID""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """URL""" - assignee_type: Optional[str] = field( + assignee_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assigneeType"}, ) """Assignee Type""" - avatar_id: Optional[str] = field( + avatar_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "avatarId"}, ) """Avatar ID""" - issue_security_scheme: Optional[str] = field( + issue_security_scheme: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "issueSecurityScheme"}, ) """Issue Security Scheme""" - permission_scheme: Optional[str] = field( + permission_scheme: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "permissionScheme"}, ) """Permission Scheme""" - notification_scheme: Optional[str] = field( + notification_scheme: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationScheme"}, ) """Notification Scheme""" - category_id: Optional[str] = field( + category_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "categoryId"}, ) """Category ID""" @@ -414,7 +493,7 @@ class UpdateProjectResponse: Response for Update Project """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -430,14 +509,15 @@ class Project: Definition: Project """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique Id of the project.""" - key: Optional[str] = None + key: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique key of the project.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the project.""" - project_type_key: Optional[str] = field( + project_type_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectTypeKey"}, ) """The unique key of the project type.""" @@ -452,11 +532,11 @@ class PartialIssue: Definition: PartialIssue """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique Id of the Issue.""" - key: Optional[str] = None + key: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique key of the issue.""" - fields: Optional[Dict[str, Any]] = None + fields: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -465,20 +545,23 @@ class Creator: Definition: Creator """ - account_id: Optional[str] = field( + account_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "accountId"}, ) """Person who created the issue.""" - key: Optional[str] = None + key: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique key of the person who created the issue.""" - email_address: Optional[str] = field( + email_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "emailAddress"}, ) """Email of the person who created the issue.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the person who created the issue.""" @@ -490,20 +573,23 @@ class Assignee: Definition: Assignee """ - account_id: Optional[str] = field( + account_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "accountId"}, ) """Person whom the issue is assigned to.""" - key: Optional[str] = None + key: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique key of the person whom the issue is assigned to.""" - email_address: Optional[str] = field( + email_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "emailAddress"}, ) """Email of the person whom the issue is assigned to.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the person whom the issue is assigned to.""" @@ -515,20 +601,23 @@ class User: Definition: User """ - account_id: Optional[str] = field( + account_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "accountId"}, ) """Id of the Jira user.""" - key: Optional[str] = None + key: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique key of the Jira user.""" - email_address: Optional[str] = field( + email_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "emailAddress"}, ) """Email of the Jira user.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the Jira user.""" @@ -540,20 +629,23 @@ class Reporter: Definition: Reporter """ - account_id: Optional[str] = field( + account_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountId"}, ) """Person who reported the issue.""" - key: Optional[str] = None + key: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique key of the person who reported the issue.""" - email_address: Optional[str] = field( + email_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "emailAddress"}, ) """Email of the person who reported the issue.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the person who reported the issue.""" @@ -568,7 +660,7 @@ class CreateIssueRequest: Definition: CreateIssueRequest """ - fields: Optional[Dict[str, Any]] = None + fields: Dict[str, Any] @dataclass @@ -577,7 +669,7 @@ class UpdateIssueRequest: Definition: UpdateIssueRequest """ - fields: Optional[Dict[str, Any]] = None + fields: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) StatusList = List[Dict[str, Any]] @@ -592,7 +684,7 @@ class Comment: Definition: Comment """ - body: Optional[str] = None + body: str """Body of the comment.""" @@ -602,12 +694,12 @@ class Transition: Definition: Transition """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID of the transition""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the transition""" - to: Optional[TransitionStatus] = None - fields: Optional[Dict[str, Any]] = None + to: Optional[TransitionStatus | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + fields: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Fields required for this transition""" @@ -617,9 +709,9 @@ class TransitionStatus: Definition: TransitionStatus """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID of the status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the status""" @@ -629,13 +721,14 @@ class TransitionInput: Definition: TransitionInput """ - fields: Optional[Dict[str, Any]] = None - history_metadata: Optional[Dict[str, Any]] = field( + fields: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + history_metadata: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "historyMetadata"}, ) - transition: Optional[Dict[str, Any]] = None - update: Optional[Dict[str, Any]] = None + transition: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + update: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -644,14 +737,15 @@ class MCPQueryRequest: Definition: MCPQueryRequest """ - jsonrpc: Optional[str] = None - id: Optional[str] = None - method: Optional[str] = None - params: Optional[Dict[str, Any]] = None - result: Optional[Dict[str, Any]] = None - error: Optional[Dict[str, Any]] = None - callback_endpoint: Optional[str] = field( + jsonrpc: Optional[str] = dataclass_field(default=None, kw_only=True) + id: Optional[str] = dataclass_field(default=None, kw_only=True) + method: Optional[str] = dataclass_field(default=None, kw_only=True) + params: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + result: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + error: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + callback_endpoint: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callbackEndpoint"}, ) @@ -667,7 +761,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -684,8 +778,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -706,7 +800,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -721,59 +815,198 @@ def __init__( def connector_name(self) -> str: return "jira" - async def list_resources_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_resources( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get list of Resources This operation returns a list of resources accessible to user. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListResources`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/oauth/token/accessible-resources" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def list_issues_async( + return AsyncItemPaged(get_next, extract_data) + + def list_issues( self, + *, jql: Optional[str] = None, fields: Optional[str] = None, - next_page_token: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get list of issues This operation returns a list of issues using JQL. + + Returns an Azure Core pager that follows opaque continuation tokens. + Resume with by_page(continuation_token=...). + + Swagger operation ID: `ListIssues`. + + Args: + jql: The JQL query used to search for issues. If left blank, + returns all issues created in the last 10 years. + fields: Optional comma-separated list of Jira field IDs or keys to + return, for example summary,status,attachment. For custom + fields, use the field ID, such as customfield_10042. Also + supports *all, *navigable, and exclusions such as + *all,-attachment. If omitted, all fields are returned. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/2/search" query_params = [] @@ -788,72 +1021,133 @@ async def list_issues_async( if isinstance(fields, bool): value = value.lower() query_params.append(f"fields={quote(value, safe='')}") - if next_page_token is not None: - value = str(next_page_token) - if isinstance(next_page_token, bool): - value = value.lower() - query_params.append(f"nextPageToken={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + separator = '&' if '?' in request_url else '?' + request_url += ( + separator + "nextPageToken=" + + quote(continuation_token, safe='') + ) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + continuation_token = page.get("nextPageToken") or None + if page.get("isLast") is True: + continuation_token = None - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("issues", []): + yield item + + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_issues_datacenter_async( + def list_issues_datacenter( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get list of issues (Datacenter) This operation returns a list of issues using JQL. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListIssues_Datacenter`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/datacenter/search" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("issues", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_transitions_async( + def list_transitions( self, issue_id_or_key: str, *, @@ -861,42 +1155,82 @@ async def list_transitions_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get list of Transitions Returns a list of the transitions possible for this issue by the current user + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListTransitions`. + + Args: + issue_id_or_key: ID or key of the issue to retrieve transitions + for. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/3/issue/{quote(str(issue_id_or_key), safe='')}/transitions" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("transitions", []): + yield item + + return None, items() - async def update_transition_async( + return AsyncItemPaged(get_next, extract_data) + + async def update_transition( self, - input: TransitionInput, + input: TransitionInput | Mapping[str, Any], issue_id_or_key: str, *, timeout: Optional[float] = None, @@ -908,13 +1242,30 @@ async def update_transition_async( Performs an issue transition Transitions an issue to a new status. + + Swagger operation ID: `UpdateTransition`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + issue_id_or_key: ID or key of the issue to be transitioned. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/3/issue/{quote(str(issue_id_or_key), safe='')}/transitions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -928,6 +1279,7 @@ async def update_transition_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -935,10 +1287,10 @@ async def update_transition_async( return json.loads(response.text) - async def get_current_user_async( + async def get_current_user( self, - expand: Optional[str] = None, *, + expand: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -948,6 +1300,26 @@ async def get_current_user_async( Get current user This operation returns details for the current user + + Swagger operation ID: `GetCurrentUser`. + + Args: + expand: Use expand to include additional information about users in + the response. This parameter accepts a comma-separated list. + Expand options include: * `groups` includes all groups and + nested groups to which the user belongs. * `applicationRoles` + includes details of all the applications to which the user has + access. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/3/myself" query_params = [] @@ -959,7 +1331,7 @@ async def get_current_user_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -973,6 +1345,7 @@ async def get_current_user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -980,11 +1353,11 @@ async def get_current_user_async( return json.loads(response.text) - async def mcp_jira_issue_management_async( + async def mcp_jira_issue_management( self, - input: MCPQueryRequest, - session_id: Optional[str] = None, + input: MCPQueryRequest | Mapping[str, Any], *, + session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -994,6 +1367,23 @@ async def mcp_jira_issue_management_async( Jira MCP Server Jira MCP Server + + Swagger operation ID: `mcp_JiraIssueManagement`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + session_id: sessionId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/mcp/JiraIssueManagement" query_params = [] @@ -1005,7 +1395,7 @@ async def mcp_jira_issue_management_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1019,6 +1409,7 @@ async def mcp_jira_issue_management_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1026,9 +1417,9 @@ async def mcp_jira_issue_management_async( return json.loads(response.text) - async def add_comment_async( + async def add_comment( self, - input: Comment, + input: Comment | Mapping[str, Any], issue_key: str, *, timeout: Optional[float] = None, @@ -1040,13 +1431,30 @@ async def add_comment_async( Add comment This operation is used to add a comment to an existing Jira issue. + + Swagger operation ID: `AddComment_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + issue_key: Unique Key of the issue to add a comment to. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/issue/{quote(str(issue_key), safe='')}/comment" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1060,6 +1468,7 @@ async def add_comment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1067,7 +1476,7 @@ async def add_comment_async( return json.loads(response.text) - async def cancel_task_async( + async def cancel_task( self, task_id: str, *, @@ -1081,13 +1490,28 @@ async def cancel_task_async( Cancels a task. Permissions required: either of: Administer Jira or Creator of the task. + + Swagger operation ID: `CancelTask_V2`. + + Args: + task_id: The ID of the task. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/task/{quote(str(task_id), safe='')}/cancel" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1101,6 +1525,7 @@ async def cancel_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1108,9 +1533,9 @@ async def cancel_task_async( return json.loads(response.text) - async def create_issue_async( + async def create_issue( self, - input: CreateIssueInput, + input: CreateIssueInput | Mapping[str, Any], project_key: str, issue_type_ids: str, *, @@ -1123,6 +1548,24 @@ async def create_issue_async( Create a new issue This operation is used to create a new issue. + + Swagger operation ID: `CreateIssue_V3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + project_key: Pick a project to create the issue in. + issue_type_ids: Pick an issue type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v3/issue" query_params = [] @@ -1137,7 +1580,7 @@ async def create_issue_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1151,6 +1594,7 @@ async def create_issue_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1158,9 +1602,9 @@ async def create_issue_async( return json.loads(response.text) - async def create_project_async( + async def create_project( self, - input: CreateProjectInput, + input: CreateProjectInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1171,10 +1615,26 @@ async def create_project_async( Create a new project This operation is used to create a new Jira project. + + Swagger operation ID: `CreateProject_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/project" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1188,6 +1648,7 @@ async def create_project_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1195,9 +1656,9 @@ async def create_project_async( return json.loads(response.text) - async def create_project_category_async( + async def create_project_category( self, - input: CreateProjectCategoryInput, + input: CreateProjectCategoryInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1209,10 +1670,26 @@ async def create_project_category_async( Creates a project category. Permissions required: Administer Jira (global permissions) + + Swagger operation ID: `CreateProjectCategory_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/projectCategory" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1226,6 +1703,7 @@ async def create_project_category_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1233,11 +1711,11 @@ async def create_project_category_async( return json.loads(response.text) - async def delete_project_async( + async def delete_project( self, project_id_or_key: str, - enable_undo: Optional[bool] = None, *, + enable_undo: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1248,6 +1726,23 @@ async def delete_project_async( Deletes a project. Permissions required: Administer Jira (global permissions) + + Swagger operation ID: `DeleteProject_V2`. + + Args: + project_id_or_key: The project ID or project key (case sensitive). + enable_undo: Whether this project is placed in the Jira recycle bin + where it will be available for restoration. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1262,7 +1757,7 @@ async def delete_project_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1276,16 +1771,17 @@ async def delete_project_async( request_url, response.status, response.text, + response=response, ) - async def edit_issue_async( + async def edit_issue( self, - input: EditIssueInput, + input: EditIssueInput | Mapping[str, Any], issue_id_or_key: str, + *, notify_users: Optional[bool] = None, override_screen_security: Optional[bool] = None, override_editable_flag: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1297,6 +1793,28 @@ async def edit_issue_async( Edits an issue. A transition may be applied and issue properties updated as part of the edit. The edits to the issue's fields are defined using update and fields. + + Swagger operation ID: `EditIssue_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + issue_id_or_key: Provide the Issue ID or Key for the issue you wish + to edit. + notify_users: Do you want to notify users? + override_screen_security: Do you want to override the screen + security? + override_editable_flag: Do you want to override the editable flag? + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1321,7 +1839,7 @@ async def edit_issue_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1335,6 +1853,7 @@ async def edit_issue_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1342,43 +1861,81 @@ async def edit_issue_async( return json.loads(response.text) - async def get_all_project_categories_async( + def list_all_project_categories( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get All Project Categories Returns all project categories. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllProjectCategories_V2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/projectCategory" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_issue_async( + async def get_issue( self, issue_key: str, *, @@ -1392,13 +1949,28 @@ async def get_issue_async( This operation is used to retrieve the issue object for a given issue Key. + + Swagger operation ID: `GetIssue_V2`. + + Args: + issue_key: Unique Key of the issue. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/issue/{quote(str(issue_key), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1412,6 +1984,7 @@ async def get_issue_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1419,7 +1992,7 @@ async def get_issue_async( return json.loads(response.text) - async def get_task_async( + async def get_task( self, task_id: str, *, @@ -1433,13 +2006,28 @@ async def get_task_async( Returns the status of a long-running asynchronous task. When a task has finished, this operation returns the JSON blob applicable to the task. + + Swagger operation ID: `GetTask_V2`. + + Args: + task_id: The ID of the task. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/task/{quote(str(task_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1453,6 +2041,7 @@ async def get_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1460,11 +2049,11 @@ async def get_task_async( return json.loads(response.text) - async def get_user_async( + async def get_user( self, account_id: str, - expand: Optional[str] = None, *, + expand: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1474,6 +2063,29 @@ async def get_user_async( Get User Returns a user. Permissions required: Browse users and groups. + + Swagger operation ID: `GetUser_V2`. + + Args: + account_id: The account ID of the user, which uniquely identifies + the user across all Atlassian products. For example, + *5b10ac8d82e05b22cc7d4ef5*. Required. + expand: Use expand to include additional information about users in + the response. This parameter accepts a comma-separated list. + Expand options include: * `groups` includes all groups and + nested groups to which the user belongs. * `applicationRoles` + includes details of all the applications to which the user has + access. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/user" query_params = [] @@ -1489,7 +2101,7 @@ async def get_user_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1503,6 +2115,7 @@ async def get_user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1510,80 +2123,170 @@ async def get_user_async( return json.loads(response.text) - async def list_filters_async( + def list_filters( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get list of Filters This operation returns a list of Filters accessible to user. + + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListFilters_V2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/filter/search" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) + + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + next_link = page.get("nextPage") + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None ) - if not response.text: - return None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("values", []): + yield item - return json.loads(response.text) + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_projects_async( + def list_projects( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get projects This operation is used to retrieve a list of projects for your Jira instance. + + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListProjects_V3`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/project/search" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) + + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + next_link = page.get("nextPage") + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None ) - if not response.text: - return None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("values", []): + yield item - return json.loads(response.text) + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_project_users_async( + def list_project_users( self, project_key: str, *, @@ -1591,12 +2294,30 @@ async def list_project_users_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List users by project This operation is used to retrieve a list of all users associated with a project. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListProjectUsers_V2`. + + Args: + project_key: Unique key of the project. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v2/user/permission/search" @@ -1608,29 +2329,50 @@ async def list_project_users_async( query_params.append(f"projectKey={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def remove_project_category_async( + async def remove_project_category( self, id: int, *, @@ -1644,13 +2386,28 @@ async def remove_project_category_async( Deletes a project category. Permissions required: Administer Jira (global permissions) + + Swagger operation ID: `RemoveProjectCategory_V2`. + + Args: + id: ID of the project category to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/projectCategory/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1664,11 +2421,12 @@ async def remove_project_category_async( request_url, response.status, response.text, + response=response, ) - async def update_project_async( + async def update_project( self, - input: UpdateProjectInput, + input: UpdateProjectInput | Mapping[str, Any], project_id_or_key: str, *, timeout: Optional[float] = None, @@ -1680,13 +2438,31 @@ async def update_project_async( Update Project Updates the project details of a project. + + Swagger operation ID: `UpdateProject_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + project_id_or_key: Provide the project ID or Key you want to + update1. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/project/{quote(str(project_id_or_key), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1700,6 +2476,7 @@ async def update_project_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1707,7 +2484,7 @@ async def update_project_async( return json.loads(response.text) - async def list_issue_types_async( + def list_issue_types( self, project_key: str, *, @@ -1715,12 +2492,30 @@ async def list_issue_types_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get issue types This operation is used to retrieve a list of issue types for a given project. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListIssueTypes_V2`. + + Args: + project_key: Project. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v2/types/issue/createmeta" @@ -1732,29 +2527,50 @@ async def list_issue_types_async( query_params.append(f"projectKey={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def list_issue_types_fields_async( + return AsyncItemPaged(get_next, extract_data) + + def list_issue_types_fields( self, project_key: str, issuetype_ids: str, @@ -1763,12 +2579,31 @@ async def list_issue_types_fields_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get issue types fields This operation is used to retrieve a list of fields for a specific issue type. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListIssueTypesFields_V2`. + + Args: + project_key: Project. + issuetype_ids: Issue Types. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v3/issue/createmeta" query_params = [] @@ -1782,27 +2617,48 @@ async def list_issue_types_fields_async( query_params.append(f"issuetypeIds={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/keyvault.py b/src/azure/connectors/keyvault.py index 9744abdd..19bab92f 100644 --- a/src/azure/connectors/keyvault.py +++ b/src/azure/connectors/keyvault.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,22 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "KeyvaultClient", + "KeyDecryptInput", + "KeyDecryptOutput", + "KeyEncryptInput", + "KeyEncryptOutput", + "KeyMetadata", + "KeyMetadataCollection", + "Secret", + "SecretMetadata", + "SecretMetadataCollection", +] + # Type Definitions @@ -29,10 +44,16 @@ class KeyMetadataCollection: Response for List keys """ - value: Optional[List[KeyMetadata]] = None + value: Optional[ + List[KeyMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The keys""" - continuation_token: Optional[str] = field( + continuation_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "continuationToken"}, ) """Continuation token""" @@ -44,42 +65,49 @@ class KeyMetadata: Response for Get key metadata """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the key""" - version: Optional[str] = None + version: Optional[str] = dataclass_field(default=None, kw_only=True) """Version of the key""" - is_enabled: Optional[bool] = field( + is_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEnabled"}, ) """A flag indicating whether the key is enabled""" - created_time: Optional[str] = field( + created_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdTime"}, ) """Time when the key was created""" - last_updated_time: Optional[str] = field( + last_updated_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastUpdatedTime"}, ) """Time when the key was last updated""" - validity_start_time: Optional[str] = field( + validity_start_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "validityStartTime"}, ) """Time when the key validity starts.""" - validity_end_time: Optional[str] = field( + validity_end_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "validityEndTime"}, ) """Time when the key validity ends.""" - allowed_operations: Optional[List[str]] = field( + allowed_operations: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowedOperations"}, ) """Operations allowed using the key""" - key_type: Optional[str] = field( + key_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "keyType"}, ) """Type of the key""" @@ -91,8 +119,9 @@ class KeyEncryptOutput: Response for Encrypt data with key """ - encrypted_data: Optional[str] = field( + encrypted_data: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "encryptedData"}, ) """Encrypted data""" @@ -104,8 +133,9 @@ class KeyDecryptOutput: Response for Decrypt data with key """ - raw_data: Optional[str] = field( + raw_data: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "rawData"}, ) """Raw data""" @@ -117,10 +147,16 @@ class SecretMetadataCollection: Response for List secrets """ - value: Optional[List[SecretMetadata]] = None + value: Optional[ + List[SecretMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The secrets""" - continuation_token: Optional[str] = field( + continuation_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "continuationToken"}, ) """Continuation token""" @@ -132,37 +168,43 @@ class SecretMetadata: Response for Get secret metadata """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the secret""" - version: Optional[str] = None + version: Optional[str] = dataclass_field(default=None, kw_only=True) """Version of the secret""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """Content type of the secret""" - is_enabled: Optional[bool] = field( + is_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEnabled"}, ) """A flag indicating whether the secret is enabled""" - created_time: Optional[str] = field( + created_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdTime"}, ) """Time when the secret was created""" - last_updated_time: Optional[str] = field( + last_updated_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastUpdatedTime"}, ) """Time when the secret was last updated""" - validity_start_time: Optional[str] = field( + validity_start_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "validityStartTime"}, ) """Time when the secret validity starts.""" - validity_end_time: Optional[str] = field( + validity_end_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "validityEndTime"}, ) """Time when the secret validity ends.""" @@ -174,39 +216,45 @@ class Secret: Response for Get secret """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value of the secret""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the secret""" - version: Optional[str] = None + version: Optional[str] = dataclass_field(default=None, kw_only=True) """Version of the secret""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """Content type of the secret""" - is_enabled: Optional[bool] = field( + is_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEnabled"}, ) """A flag indicating whether the secret is enabled""" - created_time: Optional[str] = field( + created_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdTime"}, ) """Time when the secret was created""" - last_updated_time: Optional[str] = field( + last_updated_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastUpdatedTime"}, ) """Time when the secret was last updated""" - validity_start_time: Optional[str] = field( + validity_start_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "validityStartTime"}, ) """Time when the secret validity starts.""" - validity_end_time: Optional[str] = field( + validity_end_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "validityEndTime"}, ) """Time when the secret validity ends.""" @@ -218,12 +266,9 @@ class KeyEncryptInput: Definition: KeyEncryptInput """ - algorithm: Optional[str] = None + algorithm: str """Algorithm to use for encrypting the data""" - raw_data: Optional[str] = field( - default=None, - metadata={"wire_name": "rawData"}, - ) + raw_data: str = dataclass_field(metadata={"wire_name": "rawData"}) """Data to encrypt""" @@ -233,10 +278,9 @@ class KeyDecryptInput: Definition: KeyDecryptInput """ - algorithm: Optional[str] = None + algorithm: str """Algorithm to use for decrypting the data""" - encrypted_data: Optional[str] = field( - default=None, + encrypted_data: str = dataclass_field( metadata={"wire_name": "encryptedData"}, ) """Data to decrypt""" @@ -253,7 +297,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -270,8 +314,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -292,7 +336,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -307,43 +351,158 @@ def __init__( def connector_name(self) -> str: return "keyvault" - async def list_keys_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_keys( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List keys List keys. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListKeys`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/keys" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_key_versions_async( + def list_key_versions( self, key_name: str, *, @@ -351,39 +510,78 @@ async def list_key_versions_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List key versions List versions of a key. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListKeyVersions`. + + Args: + key_name: Name of the key. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/keys/{quote(str(key_name), safe='')}/versions" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_key_metadata_async( + async def get_key_metadata( self, key_name: str, *, @@ -396,13 +594,28 @@ async def get_key_metadata_async( Get key metadata Gets metadata of a key. + + Swagger operation ID: `GetKeyMetadata`. + + Args: + key_name: Name of the key. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/keys/{quote(str(key_name), safe='')}/metadata" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -416,6 +629,7 @@ async def get_key_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -423,7 +637,7 @@ async def get_key_metadata_async( return json.loads(response.text) - async def get_key_version_metadata_async( + async def get_key_version_metadata( self, key_name: str, key_version: str, @@ -437,6 +651,22 @@ async def get_key_version_metadata_async( Get key version metadata Gets metadata of a version of a key. + + Swagger operation ID: `GetKeyVersionMetadata`. + + Args: + key_name: Name of the key. + key_version: Version of the key. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -447,7 +677,7 @@ async def get_key_version_metadata_async( f"/metadata" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -461,6 +691,7 @@ async def get_key_version_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -468,9 +699,9 @@ async def get_key_version_metadata_async( return json.loads(response.text) - async def encrypt_data_async( + async def encrypt_data( self, - input: KeyEncryptInput, + input: KeyEncryptInput | Mapping[str, Any], key_name: str, *, timeout: Optional[float] = None, @@ -482,13 +713,30 @@ async def encrypt_data_async( Encrypt data with key Encrypt data using the latest version of a key. + + Swagger operation ID: `EncryptData`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + key_name: Name of the key. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/keys/{quote(str(key_name), safe='')}/encrypt" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -502,6 +750,7 @@ async def encrypt_data_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -509,9 +758,9 @@ async def encrypt_data_async( return json.loads(response.text) - async def encrypt_data_with_version_async( + async def encrypt_data_with_version( self, - input: KeyEncryptInput, + input: KeyEncryptInput | Mapping[str, Any], key_name: str, key_version: str, *, @@ -524,6 +773,24 @@ async def encrypt_data_with_version_async( Encrypt data with key version Encrypt data using a specific version of a key. + + Swagger operation ID: `EncryptDataWithVersion`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + key_name: Name of the key. + key_version: Version of the key. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -534,7 +801,7 @@ async def encrypt_data_with_version_async( f"/encrypt" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -548,6 +815,7 @@ async def encrypt_data_with_version_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -555,9 +823,9 @@ async def encrypt_data_with_version_async( return json.loads(response.text) - async def decrypt_data_async( + async def decrypt_data( self, - input: KeyDecryptInput, + input: KeyDecryptInput | Mapping[str, Any], key_name: str, *, timeout: Optional[float] = None, @@ -571,13 +839,30 @@ async def decrypt_data_async( Decrypt data using the latest version of a key. Output of this operation is typically classified as secret and can be visible in the run history. + + Swagger operation ID: `DecryptData`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + key_name: Name of the key. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/keys/{quote(str(key_name), safe='')}/decrypt" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -591,6 +876,7 @@ async def decrypt_data_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -598,9 +884,9 @@ async def decrypt_data_async( return json.loads(response.text) - async def decrypt_data_with_version_async( + async def decrypt_data_with_version( self, - input: KeyDecryptInput, + input: KeyDecryptInput | Mapping[str, Any], key_name: str, key_version: str, *, @@ -615,6 +901,24 @@ async def decrypt_data_with_version_async( Decrypt data using a specific version of a key. Output of this operation is typically classified as secret and can be visible in the run history. + + Swagger operation ID: `DecryptDataWithVersion`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + key_name: Name of the key. + key_version: Version of the key. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -625,7 +929,7 @@ async def decrypt_data_with_version_async( f"/decrypt" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -639,6 +943,7 @@ async def decrypt_data_with_version_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -646,43 +951,81 @@ async def decrypt_data_with_version_async( return json.loads(response.text) - async def list_secrets_async( + def list_secrets( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List secrets List secrets. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListSecrets`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/secrets" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def list_secret_versions_async( + return AsyncItemPaged(get_next, extract_data) + + def list_secret_versions( self, secret_name: str, *, @@ -690,39 +1033,78 @@ async def list_secret_versions_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List secret versions List versions of a secret. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListSecretVersions`. + + Args: + secret_name: Name of the secret. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/secrets/{quote(str(secret_name), safe='')}/versions" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_secret_metadata_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_secret_metadata( self, secret_name: str, *, @@ -735,13 +1117,28 @@ async def get_secret_metadata_async( Get secret metadata Gets metadata of a secret. + + Swagger operation ID: `GetSecretMetadata`. + + Args: + secret_name: Name of the secret. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/secrets/{quote(str(secret_name), safe='')}/metadata" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -755,6 +1152,7 @@ async def get_secret_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -762,7 +1160,7 @@ async def get_secret_metadata_async( return json.loads(response.text) - async def get_secret_version_metadata_async( + async def get_secret_version_metadata( self, secret_name: str, secret_version: str, @@ -776,6 +1174,22 @@ async def get_secret_version_metadata_async( Get secret version metadata Gets metadata of a version of a secret. + + Swagger operation ID: `GetSecretVersionMetadata`. + + Args: + secret_name: Name of the secret. + secret_version: Version of the secret. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -786,7 +1200,7 @@ async def get_secret_version_metadata_async( f"/metadata" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -800,6 +1214,7 @@ async def get_secret_version_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -807,7 +1222,7 @@ async def get_secret_version_metadata_async( return json.loads(response.text) - async def get_secret_async( + async def get_secret( self, secret_name: str, *, @@ -821,13 +1236,28 @@ async def get_secret_async( Gets a secret. Output of this operation is typically classified as secret and can be visible in the run history. + + Swagger operation ID: `GetSecret`. + + Args: + secret_name: Name of the secret. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/secrets/{quote(str(secret_name), safe='')}/value" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -841,6 +1271,7 @@ async def get_secret_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -848,7 +1279,7 @@ async def get_secret_async( return json.loads(response.text) - async def get_secret_version_async( + async def get_secret_version( self, secret_name: str, secret_version: str, @@ -863,6 +1294,22 @@ async def get_secret_version_async( Gets a version of a secret. Output of this operation is typically classified as secret and can be visible in the run history. + + Swagger operation ID: `GetSecretVersion`. + + Args: + secret_name: Name of the secret. + secret_version: Version of the secret. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -873,7 +1320,7 @@ async def get_secret_version_async( f"/value" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -887,6 +1334,7 @@ async def get_secret_version_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/kusto.py b/src/azure/connectors/kusto.py index d3017d65..14b58764 100644 --- a/src/azure/connectors/kusto.py +++ b/src/azure/connectors/kusto.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Literal, Any, Mapping from urllib.parse import quote import json +from azure.core.polling import AsyncLROPoller from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,28 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorPollingMethod, ) +__all__ = [ + "KustoClient", + "AsyncCommandResult", + "ChartType", + "ClusterName", + "CommandAndVisualizeSchema", + "ControlCommandAndListSchema", + "DatabaseName", + "MCPQueryRequest", + "MCPQueryResponse", + "ObjectEntity", + "Query", + "QueryAndListSchema", + "QueryAndVisualizeSchema", + "Row", + "Table", + "VisualizeResults", +] + # Type Definitions @@ -29,7 +50,12 @@ class Table: Response for Run KQL query """ - value: Optional[List[Row]] = None + value: Optional[ + List[Row | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -38,25 +64,29 @@ class VisualizeResults: Response for Run KQL query and render a chart """ - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """The body of the result in base64 encoding.""" - body_html: Optional[str] = field( + body_html: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "bodyHtml"}, ) """The body of the result in html encoding.""" - attachment_content: Optional[str] = field( + attachment_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "attachmentContent"}, ) """The content of the attachment.""" - attachment_name: Optional[str] = field( + attachment_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "attachmentName"}, ) """The name of the attachment file.""" - kusto_deep_link: Optional[str] = field( + kusto_deep_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "kustoDeepLink"}, ) """Links to run the query in Kusto tools, for instance in KustoExplorer.""" @@ -68,12 +98,13 @@ class AsyncCommandResult: Response for Run async control command """ - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The state of the command.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status of the command.""" - operation_id: Optional[str] = field( + operation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "operationId"}, ) """The operation ID of the control command""" @@ -85,12 +116,12 @@ class MCPQueryResponse: Response for Kusto Query MCP Server """ - jsonrpc: Optional[str] = None - id: Optional[str] = None - method: Optional[str] = None - params: Optional[Dict[str, Any]] = None - result: Optional[Dict[str, Any]] = None - error: Optional[Dict[str, Any]] = None + jsonrpc: Optional[str] = dataclass_field(default=None, kw_only=True) + id: Optional[str] = dataclass_field(default=None, kw_only=True) + method: Optional[str] = dataclass_field(default=None, kw_only=True) + params: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + result: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + error: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -99,7 +130,7 @@ class ObjectEntity: Response for Query schema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -112,7 +143,7 @@ class Row: Definition: Row """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -125,11 +156,10 @@ class QueryAndVisualizeSchema: Definition: QueryAndVisualizeSchema """ - cluster: Optional[ClusterName] = None - db: Optional[DatabaseName] = None - csl: Optional[Query] = None - chart_type: Optional[ChartType] = field( - default=None, + cluster: ClusterName + db: DatabaseName + csl: Query + chart_type: ChartType = dataclass_field( metadata={"wire_name": "chartType"}, ) @@ -140,12 +170,11 @@ class CommandAndVisualizeSchema: Definition: CommandAndVisualizeSchema """ - cluster: Optional[ClusterName] = None - db: Optional[DatabaseName] = None - csl: Optional[str] = None + cluster: ClusterName + db: DatabaseName + csl: str """Specify the control command you would like to run""" - chart_type: Optional[ChartType] = field( - default=None, + chart_type: ChartType = dataclass_field( metadata={"wire_name": "chartType"}, ) @@ -156,9 +185,9 @@ class QueryAndListSchema: Definition: QueryAndListSchema """ - cluster: Optional[ClusterName] = None - db: Optional[DatabaseName] = None - csl: Optional[Query] = None + cluster: ClusterName + db: DatabaseName + csl: Query @dataclass @@ -167,9 +196,9 @@ class ControlCommandAndListSchema: Definition: ControlCommandAndListSchema """ - cluster: Optional[ClusterName] = None - db: Optional[DatabaseName] = None - csl: Optional[str] = None + cluster: ClusterName + db: DatabaseName + csl: str """Specify the show control command you would like to run""" @@ -191,14 +220,15 @@ class MCPQueryRequest: Definition: MCPQueryRequest """ - jsonrpc: Optional[str] = None - id: Optional[str] = None - method: Optional[str] = None - params: Optional[Dict[str, Any]] = None - result: Optional[Dict[str, Any]] = None - error: Optional[Dict[str, Any]] = None - callback_endpoint: Optional[str] = field( + jsonrpc: Optional[str] = dataclass_field(default=None, kw_only=True) + id: Optional[str] = dataclass_field(default=None, kw_only=True) + method: Optional[str] = dataclass_field(default=None, kw_only=True) + params: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + result: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + error: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + callback_endpoint: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callbackEndpoint"}, ) @@ -214,7 +244,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -231,8 +261,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -253,7 +283,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -268,24 +298,43 @@ def __init__( def connector_name(self) -> str: return "kusto" - async def list_kusto_results_async( + async def begin_list_kusto_results( self, - input: QueryAndListSchema, + input: QueryAndListSchema | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Run KQL query Runs the KQL query and returns the result as a set of rows which can be iterated over in the following connectors e.g TableName | take 10. + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `listKustoResultsPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/ListKustoResults/false" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -299,34 +348,68 @@ async def list_kusto_results_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def list_kusto_show_command_results_async( + async def begin_list_kusto_show_command_results( self, - input: ControlCommandAndListSchema, + input: ControlCommandAndListSchema | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Run show control command Runs the show control command and returns the result as a set of rows which can be iterated over in the following connectors e.g .show table TableName policy caching. + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `listKustoShowCommandResultsPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/ListKustoShowCommandResults" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -340,33 +423,67 @@ async def list_kusto_show_command_results_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def run_kusto_query_and_visualize_results_async( + async def begin_run_kusto_query_and_visualize_results( self, - input: QueryAndVisualizeSchema, + input: QueryAndVisualizeSchema | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Run KQL query and render a chart Runs the KQL query and returns result as a chart of your choice e.g TableName | where Timestamp > ago(1h) | project timestamp, value. + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `runKustoQueryAndVisualizeResultsPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/RunKustoAndVisualizeResults/false" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -380,33 +497,67 @@ async def run_kusto_query_and_visualize_results_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def run_kusto_command_and_visualize_results_async( + async def begin_run_kusto_command_and_visualize_results( self, - input: CommandAndVisualizeSchema, + input: CommandAndVisualizeSchema | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Run control command and render a chart Runs the control command and returns the result as a chart of your choice e.g .clear table TableName data. + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `runKustoCommandAndVisualizeResultsPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/RunKustoAndVisualizeResults/true" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -420,34 +571,68 @@ async def run_kusto_command_and_visualize_results_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def run_async_control_command_and_wait_async( + async def begin_run_async_control_command_and_wait( self, - input: ControlCommandAndListSchema, + input: ControlCommandAndListSchema | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Run async control command Runs control command in async mode and returns its ID, state and status on completion. Command can run for maximum 1 hour. The 'async' keyword is mandatory e.g .set-or-append async TargetTable <| SourceTable. + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `runAsyncControlCommandAndWait`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/RunAsyncControlCommandAndWait" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -461,18 +646,33 @@ async def run_async_control_command_and_wait_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def mcp_kusto_query_management_async( + async def mcp_kusto_query_management( self, - input: MCPQueryRequest, - session_id: Optional[str] = None, + input: MCPQueryRequest | Mapping[str, Any], *, + session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -482,6 +682,23 @@ async def mcp_kusto_query_management_async( Kusto Query MCP Server This MCP server runs Kusto queries and manages the results. + + Swagger operation ID: `mcp_KustoQueryManagement`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + session_id: sessionId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/mcp/KustoQueryManagement" @@ -495,7 +712,7 @@ async def mcp_kusto_query_management_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -509,6 +726,7 @@ async def mcp_kusto_query_management_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -516,9 +734,9 @@ async def mcp_kusto_query_management_async( return json.loads(response.text) - async def list_kusto_results_schema_async( + async def list_kusto_results_schema( self, - input: QueryAndListSchema, + input: QueryAndListSchema | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -529,10 +747,26 @@ async def list_kusto_results_schema_async( Query schema Gets the schema for a query + + Swagger operation ID: `listKustoResultsSchemaPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/ListKustoResultsSchema" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -546,6 +780,7 @@ async def list_kusto_results_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/mailchimp.py b/src/azure/connectors/mailchimp.py index f0b93108..337d70a8 100644 --- a/src/azure/connectors/mailchimp.py +++ b/src/azure/connectors/mailchimp.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,51 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "MailchimpClient", + "ABSplitOpts", + "AddUserResponseModel", + "CampaignDefaults", + "CampaignResponseModel", + "Capsule", + "Contact", + "CreateNewListResponseModel", + "DailySend", + "DeliveryStatus", + "FirstAndLastName", + "GetAddMembersBatchResponseModel", + "GetAllMembersResponseModel", + "GetCampaignsResponse", + "GetListsResponseModel", + "GetMembersResponseModel", + "Highrise", + "LastNote", + "Link", + "Location", + "MemberResponseModel", + "NewCampaignRequest", + "NewListRequest", + "NewMemberInListRequest", + "NewMembersInListRequest", + "ObjectEntity", + "RSSOpts", + "Recipient", + "ReportSummary", + "Salesforce", + "Schedule", + "SegmentOpts", + "Settings", + "SocialCard", + "Stats", + "Tracking", + "UpdateMemberInListRequest", + "VariateSettings", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +73,12 @@ class GetCampaignsResponse: Response for List campaigns """ - campaigns: Optional[List[CampaignResponseModel]] = None + campaigns: Optional[ + List[CampaignResponseModel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """An array of objects, each representing a campaign""" @@ -39,9 +88,14 @@ class GetListsResponseModel: Response for Get all the lists """ - lists: Optional[List[CreateNewListResponseModel]] = None + lists: Optional[ + List[CreateNewListResponseModel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """An array of objects, each representing a list""" - total_items: Optional[int] = None + total_items: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of items matching the query regardless of pagination""" @@ -51,46 +105,47 @@ class CreateNewListResponseModel: Response for New List """ - id: Optional[str] = None + id: str """A string that uniquely identifies this list""" - name: Optional[str] = None + name: str """The name of the list""" - contact: Optional[Contact] = None - permission_reminder: Optional[str] = None + contact: Contact | Mapping[str, Any] + permission_reminder: str """The permission reminder for the list""" - use_archive_bar: Optional[bool] = None + use_archive_bar: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether campaigns for this list use the Archive Bar in archives by default """ - campaign_defaults: Optional[CampaignDefaults] = None - notify_on_subscribe: Optional[str] = None + campaign_defaults: CampaignDefaults | Mapping[str, Any] + notify_on_subscribe: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address to send subscribe notifications to""" - notify_on_unsubscribe: Optional[str] = None + notify_on_unsubscribe: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address to send unsubscribe notifications to""" - date_created: Optional[str] = None + date_created: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time that this list was created""" - list_rating: Optional[int] = None + list_rating: Optional[int] = dataclass_field(default=None, kw_only=True) """An auto-generated activity score for the list (0-5)""" - email_type_option: Optional[bool] = None + email_type_option: bool """ Whether the list supports multiple formats for emails.When set to true, subscribers can choose whether they want to receive HTML or plain-text emails.When set to false, subscribers will receive HTML emails, with a plain-text alternative backup """ - subscribe_url_short: Optional[str] = None + subscribe_url_short: Optional[str] = dataclass_field(default=None, kw_only=True) """Our EepURL shortened version of this list's subscribe form""" - subscribe_url_long: Optional[str] = None + subscribe_url_long: Optional[str] = dataclass_field(default=None, kw_only=True) """The full version of this list's subscribe form (host will vary)""" - beamer_address: Optional[str] = None + beamer_address: Optional[str] = dataclass_field(default=None, kw_only=True) """The list's Email Beamer address""" - visibility: Optional[str] = None + visibility: Optional[str] = dataclass_field(default=None, kw_only=True) """Whether this list is public or private""" - modules: Optional[List[str]] = None + modules: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Any list-specific modules installed for this list""" - stats: Optional[Stats] = None - links: Optional[List[Link]] = field( + stats: Optional[Stats | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + links: Optional[List[Link | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) """A list of link types and descriptions for the API schema documents""" @@ -102,14 +157,14 @@ class GetAddMembersBatchResponseModel: Response for Subscribe or unsubscribe list members """ - total_created: Optional[int] = None + total_created: Optional[int] = dataclass_field(default=None, kw_only=True) """Total number of members that were added to the list""" - total_updated: Optional[int] = None + total_updated: Optional[int] = dataclass_field(default=None, kw_only=True) """ The total number of an existing list members whose subscription status was updated """ - error_count: Optional[int] = None + error_count: Optional[int] = dataclass_field(default=None, kw_only=True) """ The number email addresses that could not be added to the list or updated """ @@ -121,11 +176,16 @@ class GetAllMembersResponseModel: Response for Show list members """ - members: Optional[List[MemberResponseModel]] = None + members: Optional[ + List[MemberResponseModel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """An array of objects, each representing a specific list member""" - list_id: Optional[str] = None + list_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The list id""" - total_items: Optional[int] = None + total_items: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of items matching the query regardless of pagination""" @@ -135,47 +195,53 @@ class MemberResponseModel: Response for Add member to list """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The MD5 hash of the lowercase version of the list member's email address """ - email_address: Optional[str] = None + email_address: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address for a subscriber""" - unique_email_id: Optional[str] = None + unique_email_id: Optional[str] = dataclass_field(default=None, kw_only=True) """An identifier for the address across all of MailChimp""" - email_type: Optional[str] = None + email_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of email this member asked to get ('html' or 'text').""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Subscriber's current status. Possible Values: subscribed, unsubscribed, cleaned, pending """ - merge_fields: Optional[FirstAndLastName] = None - stats: Optional[Stats] = None - ip_signup: Optional[str] = None + merge_fields: Optional[ + FirstAndLastName | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + stats: Optional[Stats | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + ip_signup: Optional[str] = dataclass_field(default=None, kw_only=True) """IP address the subscriber signed up from""" - timestamp_signup: Optional[str] = None + timestamp_signup: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time the subscriber signed up for the list""" - ip_opt: Optional[str] = None + ip_opt: Optional[str] = dataclass_field(default=None, kw_only=True) """The IP address the subscriber used to confirm their opt-in status""" - timestamp_opt: Optional[str] = None + timestamp_opt: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time the subscribe confirmed their opt-in status""" - member_rating: Optional[int] = None + member_rating: Optional[int] = dataclass_field(default=None, kw_only=True) """Star rating for this member, between 1 and 5""" - last_changed: Optional[str] = None + last_changed: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time the member's info was last changed""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """If set/detected, the subscriber's language""" - vip: Optional[bool] = None + vip: Optional[bool] = dataclass_field(default=None, kw_only=True) """VIP status for subscriber""" - email_client: Optional[str] = None + email_client: Optional[str] = dataclass_field(default=None, kw_only=True) """The list member's email client""" - location: Optional[Location] = None - last_note: Optional[LastNote] = None - list_id: Optional[str] = None + location: Optional[Location | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + last_note: Optional[LastNote | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + list_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The list id""" - links: Optional[List[Link]] = field( + links: Optional[List[Link | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) """A list of link types and descriptions for the API schema documents""" @@ -187,11 +253,16 @@ class GetMembersResponseModel: Response for When a Member has been added to a list """ - members: Optional[List[AddUserResponseModel]] = None + members: Optional[ + List[AddUserResponseModel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """An array of objects, each representing a specific list member""" - list_id: Optional[str] = None + list_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The list id""" - total_items: Optional[int] = None + total_items: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of items matching the query regardless of pagination""" @@ -201,40 +272,75 @@ class CampaignResponseModel: Response for New Campaign """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """A string that uniquely identifies this campaign""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ There are four types of campaigns you can create in MailChimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead """ - create_time: Optional[str] = None + create_time: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time the campaign was created""" - archive_url: Optional[str] = None + archive_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The link to the campaign's archive version""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The current status of the campaign.""" - emails_sent: Optional[int] = None + emails_sent: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of emails sent for this campaign""" - send_time: Optional[str] = None + send_time: Optional[str] = dataclass_field(default=None, kw_only=True) """The time and date a campaign was sent""" - content_type: Optional[str] = None + content_type: Optional[str] = dataclass_field(default=None, kw_only=True) """ How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url') """ - recipient: Optional[List[Recipient]] = None + recipient: Optional[ + List[Recipient | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List settings for the campaign""" - settings: Optional[Settings] = None - variate_settings: Optional[VariateSettings] = None - tracking: Optional[Tracking] = None - rss_opts: Optional[RSSOpts] = None - ab_split_opts: Optional[ABSplitOpts] = None - social_card: Optional[SocialCard] = None - report_summary: Optional[ReportSummary] = None - delivery_status: Optional[DeliveryStatus] = None - links: Optional[List[Link]] = field( + settings: Optional[Settings | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + variate_settings: Optional[ + VariateSettings | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + tracking: Optional[Tracking | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + rss_opts: Optional[RSSOpts | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + ab_split_opts: Optional[ + ABSplitOpts | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + social_card: Optional[ + SocialCard | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + report_summary: Optional[ + ReportSummary | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, + ) + delivery_status: Optional[ + DeliveryStatus | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + links: Optional[List[Link | Mapping[str, Any]]] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) """A list of link types and descriptions for the API schema documents""" @@ -246,9 +352,14 @@ class Recipient: Definition: Recipient """ - list_id: Optional[str] = None + list_id: str """The unique list id""" - segment_opts: Optional[SegmentOpts] = None + segment_opts: Optional[ + SegmentOpts | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -257,7 +368,7 @@ class VariateSettings: Definition: Variate_Settings """ - winner_criteria: Optional[str] = None + winner_criteria: Optional[str] = dataclass_field(default=None, kw_only=True) """ The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue-or you may choose @@ -266,35 +377,35 @@ class VariateSettings: Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the MailChimp web application """ - wait_time: Optional[int] = None + wait_time: Optional[int] = dataclass_field(default=None, kw_only=True) """ The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes """ - test_size: Optional[int] = None + test_size: Optional[int] = dataclass_field(default=None, kw_only=True) """ The percentage of recipients to send the test combinations to, must be a value between 10 and 100 """ - subject_lines: Optional[List[str]] = None + subject_lines: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used """ - send_times: Optional[List[str]] = None + send_times: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored """ - from_names: Optional[List[str]] = None + from_names: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used """ - reply_to_addresses: Optional[List[str]] = None + reply_to_addresses: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, @@ -308,32 +419,37 @@ class Tracking: Definition: Tracking """ - opens: Optional[bool] = None + opens: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns """ - html_clicks: Optional[bool] = None + html_clicks: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns """ - text_clicks: Optional[bool] = None + text_clicks: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns """ - goal_tracking: Optional[bool] = None + goal_tracking: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to enable Goal tracking""" - ecomm360: Optional[bool] = None + ecomm360: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to enable eCommerce360 tracking""" - google_analytics: Optional[str] = None + google_analytics: Optional[str] = dataclass_field(default=None, kw_only=True) """The custom slug for Google Analytics tracking (max of 50 bytes)""" - clicktale: Optional[str] = None + clicktale: Optional[str] = dataclass_field(default=None, kw_only=True) """The custom slug for ClickTale tracking (max of 50 bytes)""" - salesforce: Optional[Salesforce] = None - highrise: Optional[Highrise] = None - capsule: Optional[Capsule] = None + salesforce: Optional[ + Salesforce | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + highrise: Optional[Highrise | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + capsule: Optional[Capsule | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -342,16 +458,16 @@ class RSSOpts: Definition: RSS_Opts """ - feed_url: Optional[str] = None + feed_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The URL for the RSS feed""" - frequency: Optional[str] = None + frequency: Optional[str] = dataclass_field(default=None, kw_only=True) """The frequency of the RSS Campaign""" - constrain_rss_img: Optional[str] = None + constrain_rss_img: Optional[str] = dataclass_field(default=None, kw_only=True) """ Whether to add CSS to images in the RSS feed to constrain their width in campaigns """ - schedule: Optional[Schedule] = None + schedule: Optional[Schedule | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -360,11 +476,11 @@ class SocialCard: Definition: Social_Card """ - image_url: Optional[str] = None + image_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The url for the header image for the card""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """A short summary of the campaign to display""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title for the card. Typically the subject line of the campaign""" @@ -374,10 +490,11 @@ class SegmentOpts: Definition: Segment_Opts """ - saved_segment_id: Optional[int] = None + saved_segment_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The id for an existing saved segment""" - match_: Optional[str] = field( + match_: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "match"}, ) """Segment match type: Possible Values: any, all""" @@ -389,9 +506,9 @@ class Salesforce: Definition: Salesforce """ - campaign: Optional[bool] = None + campaign: Optional[bool] = dataclass_field(default=None, kw_only=True) """Create a campaign in a connected Salesforce account""" - notes: Optional[bool] = None + notes: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Update contact notes for a campaign based on subscriber email addresses """ @@ -403,9 +520,9 @@ class Highrise: Definition: Highrise """ - campaign: Optional[bool] = None + campaign: Optional[bool] = dataclass_field(default=None, kw_only=True) """Create a campaign in a connected Highrise account""" - notes: Optional[bool] = None + notes: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Update contact notes for a campaign based on subscriber email addresses """ @@ -417,7 +534,7 @@ class Capsule: Definition: Capsule """ - notes: Optional[bool] = None + notes: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Update contact notes for a campaign based on subscriber email addresses """ @@ -429,15 +546,20 @@ class Schedule: Definition: Schedule """ - hour: Optional[int] = None + hour: Optional[int] = dataclass_field(default=None, kw_only=True) """ The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in your account's default time zone """ - daily_send: Optional[DailySend] = None - weekly_send_day: Optional[str] = None + daily_send: Optional[ + DailySend | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + weekly_send_day: Optional[str] = dataclass_field(default=None, kw_only=True) """The day of the week to send a weekly RSS Campaign""" - monthly_send_date: Optional[float] = None + monthly_send_date: Optional[float] = dataclass_field(default=None, kw_only=True) """ The day of the month to send a monthly RSS Campaign. Acceptable days are 1-32, where '0' is always the last day of a month. Months with fewer than @@ -453,19 +575,19 @@ class DailySend: Definition: Daily_Send """ - sunday: Optional[bool] = None + sunday: Optional[bool] = dataclass_field(default=None, kw_only=True) """Sends the daily RSS Campaign on Sundays""" - monday: Optional[bool] = None + monday: Optional[bool] = dataclass_field(default=None, kw_only=True) """Sends the daily RSS Campaign on Mondays""" - tuesday: Optional[bool] = None + tuesday: Optional[bool] = dataclass_field(default=None, kw_only=True) """Sends the daily RSS Campaign on Tuesdays""" - wednesday: Optional[bool] = None + wednesday: Optional[bool] = dataclass_field(default=None, kw_only=True) """Sends the daily RSS Campaign on Wednesdays""" - thursday: Optional[bool] = None + thursday: Optional[bool] = dataclass_field(default=None, kw_only=True) """Sends the daily RSS Campaign on Thursdays""" - friday: Optional[bool] = None + friday: Optional[bool] = dataclass_field(default=None, kw_only=True) """Sends the daily RSS Campaign on Fridays""" - saturday: Optional[bool] = None + saturday: Optional[bool] = dataclass_field(default=None, kw_only=True) """Sends the daily RSS Campaign on Saturdays""" @@ -475,34 +597,34 @@ class Settings: Definition: Settings """ - subject_line: Optional[str] = None + subject_line: str """The subject line for the campaign""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the campaign""" - from_name: Optional[str] = None + from_name: str """The 'from' name on the campaign (not an email address)""" - reply_to: Optional[str] = None + reply_to: str """The reply-to email address for the campaign""" - use_conversation: Optional[bool] = None + use_conversation: Optional[bool] = dataclass_field(default=None, kw_only=True) """Use MailChimp Conversation feature to manage out-of-office replies""" - to_name: Optional[str] = None + to_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The campaign's custom 'To' name. Typically the first name merge field""" - folder_id: Optional[str] = None + folder_id: Optional[str] = dataclass_field(default=None, kw_only=True) """If the campaign is listed in a folder, the id for that folder""" - authenticate: Optional[bool] = None + authenticate: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether MailChimp authenticated the campaign. Defaults to true""" - auto_footer: Optional[bool] = None + auto_footer: Optional[bool] = dataclass_field(default=None, kw_only=True) """Automatically append MailChimp's default footer to the campaign""" - inline_css: Optional[bool] = None + inline_css: Optional[bool] = dataclass_field(default=None, kw_only=True) """Automatically inline the CSS included with the campaign content""" - auto_tweet: Optional[bool] = None + auto_tweet: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Automatically tweet a link to the campaign archive page when the campaign is sent """ - auto_fb_post: Optional[List[int]] = None + auto_fb_post: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """An array of Facebook page ids to auto-post to""" - fb_comments: Optional[bool] = None + fb_comments: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true @@ -515,44 +637,44 @@ class ABSplitOpts: Definition: AB_Split_Opts """ - split_test: Optional[str] = None + split_test: Optional[str] = dataclass_field(default=None, kw_only=True) """The type of AB split to run""" - pick_winner: Optional[str] = None + pick_winner: Optional[str] = dataclass_field(default=None, kw_only=True) """ How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual' """ - wait_units: Optional[str] = None + wait_units: Optional[str] = dataclass_field(default=None, kw_only=True) """ How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent """ - wait_time: Optional[int] = None + wait_time: Optional[int] = dataclass_field(default=None, kw_only=True) """ The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent """ - split_size: Optional[int] = None + split_size: Optional[int] = dataclass_field(default=None, kw_only=True) """ The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50 """ - from_name_a: Optional[str] = None + from_name_a: Optional[str] = dataclass_field(default=None, kw_only=True) """For campaigns split on 'From Name', the name for Group A""" - from_name_b: Optional[str] = None + from_name_b: Optional[str] = dataclass_field(default=None, kw_only=True) """For campaigns split on 'From Name', the name for Group B""" - reply_email_a: Optional[str] = None + reply_email_a: Optional[str] = dataclass_field(default=None, kw_only=True) """For campaigns split on 'From Name', the reply-to address for Group A""" - reply_email_b: Optional[str] = None + reply_email_b: Optional[str] = dataclass_field(default=None, kw_only=True) """For campaigns split on 'From Name', the reply-to address for Group B""" - subject_a: Optional[str] = None + subject_a: Optional[str] = dataclass_field(default=None, kw_only=True) """For campaigns split on 'Subject Line', the subject line for Group A""" - subject_b: Optional[str] = None + subject_b: Optional[str] = dataclass_field(default=None, kw_only=True) """For campaigns split on 'Subject Line', the subject line for Group B""" - send_time_a: Optional[str] = None + send_time_a: Optional[str] = dataclass_field(default=None, kw_only=True) """The send time for Group A""" - send_time_b: Optional[str] = None + send_time_b: Optional[str] = dataclass_field(default=None, kw_only=True) """The send time for Group B""" - send_time_winner: Optional[str] = None + send_time_winner: Optional[str] = dataclass_field(default=None, kw_only=True) """The send time for the winning version""" @@ -562,20 +684,20 @@ class ReportSummary: Definition: Report_Summary """ - opens: Optional[int] = None + opens: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of opens for a campaign""" - unique_opens: Optional[int] = None + unique_opens: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of unique opens""" - open_rate: Optional[float] = None + open_rate: Optional[float] = dataclass_field(default=None, kw_only=True) """ The number of unique opens divided by the total number of successful deliveries """ - clicks: Optional[int] = None + clicks: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of clicks for an campaign""" - subscriber_clicks: Optional[float] = None + subscriber_clicks: Optional[float] = dataclass_field(default=None, kw_only=True) """The number of unique clicks""" - click_rate: Optional[float] = None + click_rate: Optional[float] = dataclass_field(default=None, kw_only=True) """ The number of unique clicks divided by the total number of successful deliveries @@ -588,17 +710,17 @@ class DeliveryStatus: Definition: Delivery_Status """ - enabled: Optional[bool] = None + enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether Campaign Delivery Status is enabled for this account and campaign """ - can_cancel: Optional[bool] = None + can_cancel: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether a campaign send can be canceled""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The current state of a campaign delivery""" - emails_sent: Optional[int] = None + emails_sent: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of emails confirmed sent for this campaign so far""" - emails_canceled: Optional[int] = None + emails_canceled: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of emails canceled for this campaign""" @@ -608,27 +730,28 @@ class Link: Definition: Link """ - rel: Optional[str] = None + rel: Optional[str] = dataclass_field(default=None, kw_only=True) """As with an HTML 'rel' attribute, this describes the type of link""" - href: Optional[str] = None + href: Optional[str] = dataclass_field(default=None, kw_only=True) """ This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action """ - method: Optional[str] = None + method: Optional[str] = dataclass_field(default=None, kw_only=True) """ The HTTP method that should be used when accessing the URL defined in 'href'. (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD) """ - target_schema: Optional[str] = field( + target_schema: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetSchema"}, ) """ For GETs, this is a URL representing the schema that the response should conform to """ - schema: Optional[str] = None + schema: Optional[str] = dataclass_field(default=None, kw_only=True) """ For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to @@ -641,18 +764,28 @@ class NewCampaignRequest: Definition: NewCampaignRequest """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """ There are four types of campaigns you can create in MailChimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. Possible Values: regular, plaintext, absplit, rss, variate """ - recipients: Optional[Recipient] = None - settings: Optional[Settings] = None - variate_settings: Optional[VariateSettings] = None - tracking: Optional[Tracking] = None - rss_opts: Optional[RSSOpts] = None - social_card: Optional[SocialCard] = None + recipients: Recipient | Mapping[str, Any] + settings: Settings | Mapping[str, Any] + variate_settings: Optional[ + VariateSettings | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + tracking: Optional[Tracking | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + rss_opts: Optional[RSSOpts | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + social_card: Optional[ + SocialCard | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -661,27 +794,27 @@ class NewListRequest: Definition: NewListRequest """ - name: Optional[str] = None + name: str """The name of the list""" - contact: Optional[Contact] = None - permission_reminder: Optional[str] = None + contact: Contact | Mapping[str, Any] + permission_reminder: str """Text to remind people how they signed up to this list""" - use_archive_bar: Optional[bool] = None + use_archive_bar: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether campaigns for this list use the Archive Bar in archives by default """ - campaign_defaults: Optional[CampaignDefaults] = None - notify_on_subscribe: Optional[str] = None + campaign_defaults: CampaignDefaults | Mapping[str, Any] + notify_on_subscribe: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address to send subscribe notifications to""" - notify_on_unsubscribe: Optional[str] = None + notify_on_unsubscribe: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address to send unsubscribe notifications to""" - email_type_option: Optional[bool] = None + email_type_option: bool """ When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup """ - visibility: Optional[str] = None + visibility: Optional[str] = dataclass_field(default=None, kw_only=True) """Whether this list is public or private""" @@ -691,21 +824,21 @@ class Contact: Definition: Contact """ - company: Optional[str] = None + company: str """The company name for the list""" - address1: Optional[str] = None + address1: str """The street address for the list contact""" - address2: Optional[str] = None + address2: Optional[str] = dataclass_field(default=None, kw_only=True) """The street address for the list contact""" - city: Optional[str] = None + city: str """The city for the list contact""" - state: Optional[str] = None + state: str """The state for the list contact""" - zip: Optional[str] = None + zip: str """The postal or zip code for the list contact""" - country: Optional[str] = None + country: str """A two-character ISO3166 country code. Defaults to US if invalid""" - phone: Optional[str] = None + phone: str """The phone number for the list contact""" @@ -715,13 +848,13 @@ class CampaignDefaults: Definition: Campaign_Defaults """ - from_name: Optional[str] = None + from_name: str """The default from name for campaigns sent to this list""" - from_email: Optional[str] = None + from_email: str """The default from email for campaigns sent to this list""" - subject: Optional[str] = None + subject: str """The default subject line for campaigns sent to this list""" - language: Optional[str] = None + language: str """The default language for this list's forms""" @@ -731,62 +864,62 @@ class Stats: Definition: Stats """ - member_count: Optional[int] = None + member_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of active members in the list""" - unsubscribe_count: Optional[int] = None + unsubscribe_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of members who have unsubscribed from the list""" - cleaned_count: Optional[int] = None + cleaned_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of members cleaned from the list""" - member_count_since_send: Optional[int] = None + member_count_since_send: Optional[int] = dataclass_field(default=None, kw_only=True) """ The number of active members in the list since the last campaign was sent """ - unsubscribe_count_since_send: Optional[int] = None + unsubscribe_count_since_send: Optional[int] = dataclass_field(default=None, kw_only=True) """ The number of members who have unsubscribed since the last campaign was sent """ - cleaned_count_since_send: Optional[int] = None + cleaned_count_since_send: Optional[int] = dataclass_field(default=None, kw_only=True) """ The number of members cleaned from the list since the last campaign was sent """ - campaign_count: Optional[int] = None + campaign_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of campaigns in any status that use this list""" - campaign_last_sent: Optional[str] = None + campaign_last_sent: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time the last campaign was sent to this list""" - merge_field_count: Optional[int] = None + merge_field_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of merge vars for this list (not EMAIL, which is required)""" - avg_sub_rate: Optional[float] = None + avg_sub_rate: Optional[float] = dataclass_field(default=None, kw_only=True) """ The average number of subscriptions per month for the list(not returned if we haven't calculated it yet) """ - avg_unsub_rate: Optional[float] = None + avg_unsub_rate: Optional[float] = dataclass_field(default=None, kw_only=True) """ The average number of unsubscriptions per month for the list(not returned if we haven't calculated it yet) """ - target_sub_rate: Optional[float] = None + target_sub_rate: Optional[float] = dataclass_field(default=None, kw_only=True) """ The target number of subscriptions per month for the list to keep it growing(not returned if we haven't calculated it yet) """ - open_rate: Optional[float] = None + open_rate: Optional[float] = dataclass_field(default=None, kw_only=True) """ The average open rate(a percentage represented as a number between 0 and 100) per campaign for the list(not returned if we haven't calculated it yet) """ - click_rate: Optional[float] = None + click_rate: Optional[float] = dataclass_field(default=None, kw_only=True) """ The average click rate(a percentage represented as a number between 0 and 100) per campaign for the list(not returned if we haven't calculated it yet) """ - last_sub_date: Optional[str] = None + last_sub_date: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time of the last time someone subscribed to this list""" - last_unsub_date: Optional[str] = None + last_unsub_date: Optional[str] = dataclass_field(default=None, kw_only=True) """ The date and time of the last time someone unsubscribed from this list """ @@ -798,13 +931,13 @@ class NewMembersInListRequest: Definition: NewMembersInListRequest """ - members: Optional[List[NewMemberInListRequest]] = None + members: List[NewMemberInListRequest | Mapping[str, Any]] """ An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call. """ - update_existing: Optional[bool] = None + update_existing: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether this batch operation will change existing members' subscription status. @@ -817,20 +950,25 @@ class NewMemberInListRequest: Definition: NewMemberInListRequest """ - email_type: Optional[str] = None + email_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of email this member asked to get ('html' or 'text')""" - status: Optional[str] = None + status: str """ Subscriber's current status. Possible Values: subscribed, unsubscribed, cleaned, pending """ - merge_fields: Optional[FirstAndLastName] = None - language: Optional[str] = None + merge_fields: Optional[ + FirstAndLastName | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + language: Optional[str] = dataclass_field(default=None, kw_only=True) """If set/detected, the subscriber's language""" - vip: Optional[bool] = None + vip: Optional[bool] = dataclass_field(default=None, kw_only=True) """VIP status for subscriber""" - location: Optional[Location] = None - email_address: Optional[str] = None + location: Optional[Location | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + email_address: str """Email address for a subscriber""" @@ -840,13 +978,15 @@ class FirstAndLastName: Definition: FirstAndLastName """ - f_n_a_m_e: Optional[str] = field( + f_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FNAME"}, ) """First name of the subscriber""" - l_n_a_m_e: Optional[str] = field( + l_n_a_m_e: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LNAME"}, ) """Last name of the subscriber""" @@ -858,9 +998,9 @@ class Location: Definition: Location """ - latitude: Optional[float] = None + latitude: Optional[float] = dataclass_field(default=None, kw_only=True) """The location latitude""" - longitude: Optional[float] = None + longitude: Optional[float] = dataclass_field(default=None, kw_only=True) """The location longitude""" @@ -870,13 +1010,13 @@ class LastNote: Definition: Last_Note """ - note_id: Optional[int] = None + note_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The note id""" - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """The date the note was created""" - created_by: Optional[str] = None + created_by: Optional[str] = dataclass_field(default=None, kw_only=True) """The author of the note""" - note: Optional[str] = None + note: Optional[str] = dataclass_field(default=None, kw_only=True) """The content of the note""" @@ -886,7 +1026,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -899,19 +1039,24 @@ class UpdateMemberInListRequest: Definition: UpdateMemberInListRequest """ - email_type: Optional[str] = None + email_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of email this member asked to get ('html' or 'text')""" - status: Optional[str] = None + status: str """ Subscriber's current status. Possible Values: subscribed, unsubscribed, cleaned, pending """ - merge_fields: Optional[FirstAndLastName] = None - language: Optional[str] = None + merge_fields: Optional[ + FirstAndLastName | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + language: Optional[str] = dataclass_field(default=None, kw_only=True) """If set/detected, the subscriber's language""" - vip: Optional[bool] = None + vip: Optional[bool] = dataclass_field(default=None, kw_only=True) """VIP status for subscriber""" - location: Optional[Location] = None + location: Optional[Location | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -920,47 +1065,48 @@ class AddUserResponseModel: Definition: AddUserResponseModel """ - id: Optional[str] = None + id: str """ The MD5 hash of the lowercase version of the list member's email address """ - email_address: Optional[str] = None + email_address: str """Email address for a subscriber""" - unique_email_id: Optional[str] = None + unique_email_id: Optional[str] = dataclass_field(default=None, kw_only=True) """An identifier for the address across all of MailChimp""" - email_type: Optional[str] = None + email_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of email this member asked to get ('html' or 'text').""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Subscriber's current status. Possible Values: subscribed, unsubscribed, cleaned, pending """ - merge_fields: Optional[FirstAndLastName] = None - stats: Optional[Stats] = None - ip_signup: Optional[str] = None + merge_fields: FirstAndLastName | Mapping[str, Any] + stats: Optional[Stats | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + ip_signup: Optional[str] = dataclass_field(default=None, kw_only=True) """IP address the subscriber signed up from""" - timestamp_signup: Optional[str] = None + timestamp_signup: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time the subscriber signed up for the list""" - ip_opt: Optional[str] = None + ip_opt: Optional[str] = dataclass_field(default=None, kw_only=True) """The IP address the subscriber used to confirm their opt-in status""" - timestamp_opt: Optional[str] = None + timestamp_opt: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time the subscribe confirmed their opt-in status""" - member_rating: Optional[int] = None + member_rating: Optional[int] = dataclass_field(default=None, kw_only=True) """Star rating for this member, between 1 and 5""" - last_changed: Optional[str] = None + last_changed: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time the member's info was last changed""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """If set/detected, the subscriber's language""" - vip: Optional[bool] = None + vip: Optional[bool] = dataclass_field(default=None, kw_only=True) """VIP status for subscriber""" - email_client: Optional[str] = None + email_client: Optional[str] = dataclass_field(default=None, kw_only=True) """The list member's email client""" - location: Optional[Location] = None - last_note: Optional[LastNote] = None - list_id: Optional[str] = None + location: Optional[Location | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + last_note: Optional[LastNote | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + list_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The list id""" - links: Optional[List[Link]] = field( + links: Optional[List[Link | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) """A list of link types and descriptions for the API schema documents""" @@ -977,7 +1123,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -994,8 +1140,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1016,7 +1162,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1031,43 +1177,158 @@ def __init__( def connector_name(self) -> str: return "mailchimp" - async def get_campaigns_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_campaigns( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List campaigns This operation retrieves a list of campaigns in an account + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetCampaigns`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/campaigns" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("campaigns", []): + yield item + + return None, items() - async def sendcampaign_async( + return AsyncItemPaged(get_next, extract_data) + + async def sendcampaign( self, campaign_id: str, *, @@ -1080,13 +1341,28 @@ async def sendcampaign_async( Send Campaign Send an existing campaign + + Swagger operation ID: `sendcampaign`. + + Args: + campaign_id: The unique id for the list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/campaigns/{quote(str(campaign_id), safe='')}/actions/send" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1100,13 +1376,14 @@ async def sendcampaign_async( request_url, response.status, response.text, + response=response, ) - async def get_lists_async( + async def get_lists( self, + *, count: Optional[int] = None, offset: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1116,6 +1393,24 @@ async def get_lists_async( Get all the lists Find all the lists for the current user + + Swagger operation ID: `GetLists`. + + Args: + count: The number of records to return. Default value is 10. + Maximum value is 1000. + offset: The number of records from a collection to skip. Default + value is 0. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/lists" query_params = [] @@ -1132,7 +1427,7 @@ async def get_lists_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1146,6 +1441,7 @@ async def get_lists_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1153,9 +1449,9 @@ async def get_lists_async( return json.loads(response.text) - async def newlist_async( + async def newlist( self, - input: NewListRequest, + input: NewListRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1166,10 +1462,26 @@ async def newlist_async( New List Create a new list in your MailChimp account + + Swagger operation ID: `newlist`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/lists" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1183,6 +1495,7 @@ async def newlist_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1190,13 +1503,13 @@ async def newlist_async( return json.loads(response.text) - async def add_members_async( + async def add_members( self, - input: NewMembersInListRequest, + input: NewMembersInListRequest | Mapping[str, Any], list_id: str, + *, skip_merge_validation: Optional[bool] = None, skip_duplicate_check: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1206,6 +1519,26 @@ async def add_members_async( Subscribe or unsubscribe list members Batch subscribe or unsubscribe list members. + + Swagger operation ID: `AddMembers`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + list_id: The unique id for the list. + skip_merge_validation: Allows member data to be accepted without + merge field values. + skip_duplicate_check: Ignores duplicates sent in the request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1225,7 +1558,7 @@ async def add_members_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1239,6 +1572,7 @@ async def add_members_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1246,12 +1580,12 @@ async def add_members_async( return json.loads(response.text) - async def get_list_members_async( + async def get_list_members( self, list_id: str, + *, count: Optional[int] = None, offset: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1261,6 +1595,25 @@ async def get_list_members_async( Show list members Show all the members of a list + + Swagger operation ID: `GetListMembers`. + + Args: + list_id: The unique id for the list. + count: The number of records to return. Default value is 10. + Maximum value is 1000. + offset: The number of records from a collection to skip. Default + value is 0. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1280,7 +1633,7 @@ async def get_list_members_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1294,6 +1647,7 @@ async def get_list_members_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1301,9 +1655,9 @@ async def get_list_members_async( return json.loads(response.text) - async def addmember_async( + async def addmember( self, - input: NewMemberInListRequest, + input: NewMemberInListRequest | Mapping[str, Any], list_id: str, *, timeout: Optional[float] = None, @@ -1315,13 +1669,30 @@ async def addmember_async( Add member to list Add or update a list member + + Swagger operation ID: `addmember`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + list_id: The unique id for the list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/lists/{quote(str(list_id), safe='')}/members" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1335,6 +1706,7 @@ async def addmember_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1342,9 +1714,9 @@ async def addmember_async( return json.loads(response.text) - async def newcampaign_async( + async def newcampaign( self, - input: NewCampaignRequest, + input: NewCampaignRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1356,10 +1728,26 @@ async def newcampaign_async( Create a new campaign based on a Campaign Type, Recipients list and Campaign Settings (subject line, title, from_name and reply_to). + + Swagger operation ID: `newcampaignV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/campaigns" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1373,6 +1761,7 @@ async def newcampaign_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1380,7 +1769,7 @@ async def newcampaign_async( return json.loads(response.text) - async def removemember_async( + async def removemember( self, list_id: str, *, @@ -1393,6 +1782,21 @@ async def removemember_async( Remove Member from list Delete a member from a list. + + Swagger operation ID: `removemember_v2`. + + Args: + list_id: The unique id for the list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1402,7 +1806,7 @@ async def removemember_async( f"/members" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1416,11 +1820,12 @@ async def removemember_async( request_url, response.status, response.text, + response=response, ) - async def updatemember_async( + async def updatemember( self, - input: UpdateMemberInListRequest, + input: UpdateMemberInListRequest | Mapping[str, Any], list_id: str, *, timeout: Optional[float] = None, @@ -1432,6 +1837,23 @@ async def updatemember_async( Update member information Update information for a specific list member. + + Swagger operation ID: `updatemember_v2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + list_id: The unique id for the list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1441,7 +1863,7 @@ async def updatemember_async( f"/members" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1455,6 +1877,7 @@ async def updatemember_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/meetingroommap.py b/src/azure/connectors/meetingroommap.py index 4cbdf09e..73178d3f 100644 --- a/src/azure/connectors/meetingroommap.py +++ b/src/azure/connectors/meetingroommap.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,22 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "MeetingroommapClient", + "AADMeetingRoom", + "AADMeetingRoomCollection", + "GetCustomLocationListByImageNameQuery", + "GetCustomLocationsByCategoriesQuery", + "GetCustomLocationsByImageNameResponse", + "GetOfficeLocationsByImageResponse", + "GetRoomWithPersonsDetailsResponse", + "GetRoomsByImageNameResponse", + "UserDetailsDTO", +] + # Type Definitions @@ -29,13 +44,15 @@ class GetCustomLocationsByImageNameResponse: Response for Get locations by image """ - custom_location_collection: Optional[List[Dict[str, Any]]] = field( + custom_location_collection: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customLocationCollection"}, ) """customLocationCollection""" - map_image: Optional[Dict[str, Any]] = field( + map_image: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mapImage"}, ) """mapImage""" @@ -47,10 +64,11 @@ class GetOfficeLocationsByImageResponse: Response for Get office locations on image """ - image: Optional[Dict[str, Any]] = None + image: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """image""" - attached_office_locations: Optional[List[Dict[str, Any]]] = field( + attached_office_locations: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "attachedOfficeLocations"}, ) """attachedOfficeLocations""" @@ -62,13 +80,15 @@ class GetRoomWithPersonsDetailsResponse: Response for Get office location details """ - office_location_map: Optional[Dict[str, Any]] = field( + office_location_map: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "officeLocationMap"}, ) """officeLocationMap""" - map_image: Optional[Dict[str, Any]] = field( + map_image: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mapImage"}, ) """mapImage""" @@ -80,7 +100,12 @@ class AADMeetingRoomCollection: Response for Get all rooms """ - rooms: Optional[List[AADMeetingRoom]] = None + rooms: Optional[ + List[AADMeetingRoom | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -89,13 +114,15 @@ class GetRoomsByImageNameResponse: Response for Get all meeting rooms by image """ - meeting_room_collection: Optional[Dict[str, Any]] = field( + meeting_room_collection: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingRoomCollection"}, ) """meetingRoomCollection""" - map_image: Optional[Dict[str, Any]] = field( + map_image: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mapImage"}, ) """mapImage""" @@ -107,7 +134,7 @@ class GetCustomLocationsByCategoriesQuery: Definition: GetCustomLocationsByCategoriesQuery """ - categories: Optional[List[str]] = None + categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -116,12 +143,9 @@ class GetCustomLocationListByImageNameQuery: Definition: GetCustomLocationListByImageNameQuery """ - image_name: Optional[str] = field( - default=None, - metadata={"wire_name": "imageName"}, - ) + image_name: str = dataclass_field(metadata={"wire_name": "imageName"}) """The unique image name""" - categories: Optional[List[str]] = None + categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -130,8 +154,8 @@ class AADMeetingRoom: Definition: AADMeetingRoom """ - name: Optional[str] = None - address: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + address: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -140,11 +164,12 @@ class UserDetailsDTO: Definition: UserDetailsDTO """ - tenant_id: Optional[str] = field( + tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tenantId"}, ) - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) # Client Class @@ -158,7 +183,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -175,8 +200,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -197,7 +222,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -212,9 +237,86 @@ def __init__( def connector_name(self) -> str: return "meetingroommap" - async def get_custom_locations_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def get_custom_locations( self, - input: GetCustomLocationsByCategoriesQuery, + input: GetCustomLocationsByCategoriesQuery | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -225,13 +327,29 @@ async def get_custom_locations_async( Get all custom locations Get all custom locations + + Swagger operation ID: `GetCustomLocations`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/CustomLocations/GetCustomLocations" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -245,11 +363,12 @@ async def get_custom_locations_async( request_url, response.status, response.text, + response=response, ) - async def get_custom_locations_by_image_name_async( + async def get_custom_locations_by_image_name( self, - input: GetCustomLocationListByImageNameQuery, + input: GetCustomLocationListByImageNameQuery | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -260,13 +379,29 @@ async def get_custom_locations_by_image_name_async( Get locations by image Get all custom locations for a given image + + Swagger operation ID: `GetCustomLocationsByImageName`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/CustomLocations/GetCustomLocationsByImageName" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -280,6 +415,7 @@ async def get_custom_locations_by_image_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -287,45 +423,83 @@ async def get_custom_locations_by_image_name_async( return json.loads(response.text) - async def get_categories_async( + def list_categories( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ GetCategories Get custom categories + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetCategories`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/api/CustomLocations/categories" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def location_details_async( + async def location_details( self, location_id: str, *, @@ -338,13 +512,28 @@ async def location_details_async( Get location by id Get location details including image url by the location id + + Swagger operation ID: `LocationDetails`. + + Args: + location_id: Location identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/CustomLocations/{quote(str(location_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -358,22 +547,42 @@ async def location_details_async( request_url, response.status, response.text, + response=response, ) - async def search_locations_async( + def list_search_locations( self, location_name: str, - category: Optional[str] = None, *, + category: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Search location by name Search custom locations by name + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SearchLocations`. + + Args: + location_name: Search string for location. + category: Optional category filter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -390,33 +599,54 @@ async def search_locations_async( query_params.append(f"Category={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_custom_location_image_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_custom_location_image( self, location_id: str, - large: Optional[bool] = None, *, + large: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -426,6 +656,22 @@ async def get_custom_location_image_async( Get image for location Get image for specific custom location + + Swagger operation ID: `GetCustomLocationImage`. + + Args: + location_id: Unique identifier for location. + large: Large image returned. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -443,7 +689,7 @@ async def get_custom_location_image_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -457,51 +703,90 @@ async def get_custom_location_image_async( request_url, response.status, response.text, + response=response, ) return response.content - async def images_async( + def list_images( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all images Get list of all floorplans/images + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Images`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/MapImage/thumbnails" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_meeting_room_image_async( + async def get_meeting_room_image( self, room_name: str, - large: Optional[bool] = None, *, + large: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -511,6 +796,22 @@ async def get_meeting_room_image_async( Get image for meeting room Get image for a specific meeting room + + Swagger operation ID: `GetMeetingRoomImage`. + + Args: + room_name: The name of the room to get image for. + large: Large image. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -525,7 +826,7 @@ async def get_meeting_room_image_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -539,11 +840,12 @@ async def get_meeting_room_image_async( request_url, response.status, response.text, + response=response, ) return response.content - async def next_meetings_async( + async def next_meetings( self, meeting_count: int, *, @@ -556,6 +858,21 @@ async def next_meetings_async( Get next meetings Get the next meetings for the current user + + Swagger operation ID: `NextMeetings`. + + Args: + meeting_count: Count of meetings. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -566,7 +883,7 @@ async def next_meetings_async( f"/roomdetails" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -580,9 +897,10 @@ async def next_meetings_async( request_url, response.status, response.text, + response=response, ) - async def get_meeting_room_details_async( + async def get_meeting_room_details( self, room_name: str, *, @@ -595,13 +913,28 @@ async def get_meeting_room_details_async( Get meetingroom details Get meetingroom details + + Swagger operation ID: `GetMeetingRoomDetails`. + + Args: + room_name: The room name to get details for. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/MapImage/roomdetails_v2/{quote(str(room_name), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -615,9 +948,10 @@ async def get_meeting_room_details_async( request_url, response.status, response.text, + response=response, ) - async def get_office_locations_async( + async def get_office_locations( self, *, timeout: Optional[float] = None, @@ -629,10 +963,24 @@ async def get_office_locations_async( Get all office locations Get all office locations + + Swagger operation ID: `GetOfficeLocations`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/officelocations" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -646,9 +994,10 @@ async def get_office_locations_async( request_url, response.status, response.text, + response=response, ) - async def search_coworkers_async( + def list_search_coworkers( self, person_search: str, *, @@ -656,11 +1005,29 @@ async def search_coworkers_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Search coworker Search coworker by name/email + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SearchCoworkers`. + + Args: + person_search: Search string. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -669,29 +1036,50 @@ async def search_coworkers_async( f"/searchCoworkers" f"/{quote(str(person_search), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_office_locations_by_image_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_office_locations_by_image( self, image_name: str, *, @@ -704,6 +1092,21 @@ async def get_office_locations_by_image_async( Get office locations on image Get all office locations mapped to a specific image + + Swagger operation ID: `GetOfficeLocationsByImage`. + + Args: + image_name: The image identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -713,7 +1116,7 @@ async def get_office_locations_by_image_async( f"/{quote(str(image_name), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -727,6 +1130,7 @@ async def get_office_locations_by_image_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -734,11 +1138,11 @@ async def get_office_locations_by_image_async( return json.loads(response.text) - async def get_room_with_persons_details_async( + async def get_room_with_persons_details( self, office_location_name: str, - inlude_user_info: Optional[bool] = None, *, + inlude_user_info: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -749,6 +1153,22 @@ async def get_room_with_persons_details_async( Get office location details including list of people for that office location + + Swagger operation ID: `GetRoomWithPersonsDetails`. + + Args: + office_location_name: The office location name. + inlude_user_info: Flag to indicate if user info should be included. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -766,7 +1186,7 @@ async def get_room_with_persons_details_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -780,6 +1200,7 @@ async def get_room_with_persons_details_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -787,11 +1208,11 @@ async def get_room_with_persons_details_async( return json.loads(response.text) - async def get_office_location_image_async( + async def get_office_location_image( self, office_location_name: str, - large: Optional[bool] = None, *, + large: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -801,6 +1222,22 @@ async def get_office_location_image_async( Get image of office location Get image of specific office location + + Swagger operation ID: `GetOfficeLocationImage`. + + Args: + office_location_name: Office location identifier. + large: Image size. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -818,7 +1255,7 @@ async def get_office_location_image_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -832,47 +1269,86 @@ async def get_office_location_image_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_rooms_async( + def list_rooms( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all rooms Get all rooms (defined in Azure AD as meeting rooms) + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetRooms`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/rooms" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("rooms", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def search_meeting_rooms_async( + def list_search_meeting_rooms( self, name: str, *, @@ -880,75 +1356,152 @@ async def search_meeting_rooms_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Search for meeting room Get rooms by name search (from Azure AD meeting rooms) + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SearchMeetingRooms`. + + Args: + name: Search string. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/rooms/findbyname/{quote(str(name), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("rooms", []): + yield item + + return None, items() - async def room_lists_async( + return AsyncItemPaged(get_next, extract_data) + + def list_room_lists( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get meeting rooms lists Get meeting rooms lists as defined in Azure AD + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `RoomLists`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/rooms/lists" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("rooms", []): + yield item + + return None, items() - async def rooms_by_list_address_async( + return AsyncItemPaged(get_next, extract_data) + + def list_rooms_by_list_address( self, meeting_room_list_address: str, *, @@ -956,39 +1509,78 @@ async def rooms_by_list_address_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get meeting rooms by list Get all meeting rooms from specific list name + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `RoomsByListAddress`. + + Args: + meeting_room_list_address: Name of list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/rooms/{quote(str(meeting_room_list_address), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("rooms", []): + yield item + + return None, items() - async def get_rooms_by_image_name_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_rooms_by_image_name( self, image_name: str, *, @@ -1001,13 +1593,28 @@ async def get_rooms_by_image_name_async( Get all meeting rooms by image Get all meeting rooms mapped to a specific image + + Swagger operation ID: `GetRoomsByImageName`. + + Args: + image_name: The unique image name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/rooms/GetRoomsByImageName/{quote(str(image_name), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1021,6 +1628,7 @@ async def get_rooms_by_image_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/microsoftbookings.py b/src/azure/connectors/microsoftbookings.py index 8b1f5da1..4a68c666 100644 --- a/src/azure/connectors/microsoftbookings.py +++ b/src/azure/connectors/microsoftbookings.py @@ -5,10 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -17,8 +19,25 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "MicrosoftbookingsClient", + "AppointmentData", + "CancelAppointmentInput", + "CreateAppointmentInput", + "CustomQuestion", + "CustomerData", + "DeleteWebhookResponse", + "ListMailboxResponse", + "MailboxEntity", + "StaffMemberData", + "UpdateAppointmentInput", + "WebhookResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -28,7 +47,7 @@ class CreateAppointmentInput: When a appointment is Created """ - webhook: Optional[Dict[str, Any]] = None + webhook: Dict[str, Any] @dataclass @@ -37,8 +56,9 @@ class WebhookResponse: Response for When a appointment is Created """ - webhook_id: Optional[str] = field( + webhook_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webhookId"}, ) """Webhook ID.""" @@ -50,7 +70,7 @@ class UpdateAppointmentInput: When an appointment is Updated """ - webhook: Optional[Dict[str, Any]] = None + webhook: Dict[str, Any] @dataclass @@ -59,7 +79,7 @@ class CancelAppointmentInput: When an appointment is Cancelled """ - webhook: Optional[Dict[str, Any]] = None + webhook: Dict[str, Any] @dataclass @@ -68,7 +88,12 @@ class ListMailboxResponse: Response for List Booking Businesses where user is an admin """ - mailboxes: Optional[List[MailboxEntity]] = None + mailboxes: Optional[ + List[MailboxEntity | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """All mailbox entities.""" @@ -81,12 +106,13 @@ class MailboxEntity: Definition: MailboxEntity """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Mailbox Display name.""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """SMTP of the Booking mailbox.""" @@ -96,128 +122,158 @@ class AppointmentData: Definition: AppointmentData """ - additional_info: Optional[str] = field( + additional_info: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AdditionalInfo"}, ) """Additional Info about the booking.""" - customer_email: Optional[str] = field( + customer_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomerEmail"}, ) """Customer Email address in case of 1:1 bookings.""" - customer_id: Optional[str] = field( + customer_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomerId"}, ) """Customer Id in case of 1:1 bookings.""" - customer_location: Optional[Dict[str, Any]] = field( + customer_location: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomerLocation"}, ) """Location of customer in 1:1 booking""" - customer_name: Optional[str] = field( + customer_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomerName"}, ) """Customer Name for 1:1 booking.""" - customer_notes: Optional[str] = field( + customer_notes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomerNotes"}, ) """Customer Notes for 1:1 booking.""" - custom_question_answers: Optional[List[CustomQuestion]] = field( + custom_question_answers: Optional[ + List[CustomQuestion | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomQuestionAnswers"}, ) """All the custom questions and answers for 1:1 booking.""" - customer_phone: Optional[str] = field( + customer_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomerPhone"}, ) """Customer phone for 1:1 booking.""" - customer_time_zone: Optional[str] = field( + customer_time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomerTimeZone"}, ) """Customer Time Zone for 1:1 booking.""" - customers: Optional[List[CustomerData]] = field( + customers: Optional[List[CustomerData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Customers"}, ) """List of customers in the 1:N booking""" - duration: Optional[int] = field( + duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Duration"}, ) """Duration of the appointment""" - end_time: Optional[str] = field( + end_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndTime"}, ) """End Time of the appointment.""" - filled_attendees_count: Optional[int] = field( + filled_attendees_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FilledAttendeesCount"}, ) """Number of attendees who have booked this appoinment slot.""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """ [Deprecated] - use selfServiceAppointmentId as unique identifier for the bookings appointment. """ - is_s_m_s_notifications_enabled: Optional[bool] = field( + is_s_m_s_notifications_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsSMSNotificationsEnabled"}, ) """Field to check if SMS notification is enabled for the appointment.""" - join_web_u_r_l: Optional[str] = field( + join_web_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JoinWebURL"}, ) """URL for joining this online appointment.""" - max_attendees_count: Optional[int] = field( + max_attendees_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MaxAttendeesCount"}, ) """Max number of attendees allowed in this appoinment.""" - self_service_appointment_id: Optional[str] = field( + self_service_appointment_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SelfServiceAppointmentId"}, ) """Appointment id for the booking appointment.""" - service_id: Optional[str] = field( + service_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ServiceId"}, ) """Unique Service Identifier.""" - service_name: Optional[str] = field( + service_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ServiceName"}, ) """Name of the bookings service.""" - service_notes: Optional[str] = field( + service_notes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ServiceNotes"}, ) """Service level notes for the staff and admin.""" - staff_members: Optional[List[StaffMemberData]] = field( + staff_members: Optional[List[StaffMemberData | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StaffMembers"}, ) """List of staff members""" - start_time: Optional[str] = field( + start_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartTime"}, ) """Start Time of the appointment.""" - tracking_data: Optional[str] = field( + tracking_data: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TrackingData"}, ) """Campaign tracking Data.""" - cancel_reason: Optional[str] = field( + cancel_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CancelReason"}, ) """Reason for cancellation of this booking appointment""" @@ -229,26 +285,45 @@ class CustomerData: Definition: CustomerData """ - email: Optional[str] = field(default=None, metadata={"wire_name": "Email"}) + email: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Email"}, + ) """Email of the customer in the group booking.""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Unique ID of the customer in the group booking.""" - location: Optional[Dict[str, Any]] = field( + location: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location of customer in a group booking.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Display Name of the customer in the group booking.""" - notes: Optional[str] = field(default=None, metadata={"wire_name": "Notes"}) + notes: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Notes"}, + ) """Notes of the customer in the group booking.""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeZone"}, ) """Timezone of the customer in the group booking.""" - answers: Optional[List[CustomQuestion]] = field( + answers: Optional[List[CustomQuestion | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Answers"}, ) """All the custom questions and answers.""" @@ -260,17 +335,23 @@ class StaffMemberData: Definition: StaffMemberData """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Display Name of the staff assigned for this appointment.""" - email_address: Optional[str] = field( + email_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmailAddress"}, ) """Email Address of the staff assigned to this appointment.""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Unique Staff identifier.""" @@ -280,33 +361,39 @@ class CustomQuestion: Definition: CustomQuestion """ - answer: Optional[str] = field( + answer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Answer"}, ) """Answer to this custom question.""" - answer_options: Optional[List[str]] = field( + answer_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AnswerOptions"}, ) """All the answer options.""" - is_required: Optional[bool] = field( + is_required: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsRequired"}, ) """Tells if answering this question is mandatory.""" - question: Optional[str] = field( + question: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Question"}, ) """Question to be answered.""" - question_id: Optional[str] = field( + question_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "QuestionID"}, ) """Unique Identifier of the Question to be answered.""" - selected_options: Optional[List[int]] = field( + selected_options: Optional[List[int]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SelectedOptions"}, ) """All the selected answer options.""" @@ -323,7 +410,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -340,8 +427,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -362,7 +449,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -377,45 +464,160 @@ def __init__( def connector_name(self) -> str: return "microsoftbookings" - async def list_bookings_business_user_as_admin_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_bookings_business_user_as_admin( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Booking Businesses where user is an admin Operation used to list all mailboxes for which the accessing user is an Administrator. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListBookingsBusinessUserAsAdmin`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/BookingsService/api/V1/bookingBusinessesUserAsAdmin" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("mailboxes", []): + yield item - if not response.text: - return None + return None, items() - return json.loads(response.text) + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/microsoftforms.py b/src/azure/connectors/microsoftforms.py index d0636cd6..efa52ad7 100644 --- a/src/azure/connectors/microsoftforms.py +++ b/src/azure/connectors/microsoftforms.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,20 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "MicrosoftformsClient", + "FormsList", + "GetFormDetailsByIdResult", + "GetFormResponseByIdResult", + "NewResponses", + "WebhookPayload", + "WebhookRequestBody", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +42,7 @@ class GetFormResponseByIdResult: Response for Get response details """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -42,22 +55,25 @@ class GetFormDetailsByIdResult: Response for Get form details """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the form.""" - modified_date: Optional[str] = field( + modified_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "modifiedDate"}, ) """Datetime when form was last modified.""" - created_date: Optional[str] = field( + created_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDate"}, ) """Datetime when form was created.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the form.""" - created_by: Optional[str] = field( + created_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) """User who created the form.""" @@ -72,17 +88,13 @@ class WebhookRequestBody: Definition: WebhookRequestBody """ - event_type: Optional[str] = field( - default=None, - metadata={"wire_name": "eventType"}, - ) + event_type: str = dataclass_field(metadata={"wire_name": "eventType"}) """Webhook event""" - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "notificationUrl"}, ) """Webhook callback url""" - source: Optional[str] = None + source: str """Source of webhook registration""" @@ -92,7 +104,7 @@ class WebhookPayload: Definition: WebhookPayload """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) NewResponses = List[Dict[str, Any]] @@ -109,7 +121,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -126,8 +138,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -148,7 +160,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -163,7 +175,84 @@ def __init__( def connector_name(self) -> str: return "microsoftforms" - async def get_form_response_by_id_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def get_form_response_by_id( self, form_id: str, response_id: int, @@ -177,6 +266,22 @@ async def get_form_response_by_id_async( Get response details This action retrieves a form response + + Swagger operation ID: `GetFormResponseById`. + + Args: + form_id: Unique identifier of the form. + response_id: Unique identifier of the response. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -190,7 +295,7 @@ async def get_form_response_by_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -204,6 +309,7 @@ async def get_form_response_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -211,7 +317,7 @@ async def get_form_response_by_id_async( return json.loads(response.text) - async def get_form_details_by_id_async( + async def get_form_details_by_id( self, form_id: str, *, @@ -224,6 +330,21 @@ async def get_form_details_by_id_async( Get form details This action retrieves the details of a form + + Swagger operation ID: `GetFormDetailsById`. + + Args: + form_id: Unique identifier of the form. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -239,7 +360,7 @@ async def get_form_details_by_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -253,6 +374,7 @@ async def get_form_details_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -260,43 +382,81 @@ async def get_form_details_by_id_async( return json.loads(response.text) - async def list_forms_async( + def list_forms( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List forms This operation returns a list of forms in your account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListForms`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/formapi/api/forms" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_questions_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_questions( self, form_id: str, *, @@ -309,13 +469,28 @@ async def get_questions_async( Get questions Get questions definition in a form. + + Swagger operation ID: `GetQuestions`. + + Args: + form_id: Unique id of the form. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/formapi/api/forms('{quote(str(form_id), safe='')}')/questions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -329,6 +504,7 @@ async def get_questions_async( request_url, response.status, response.text, + response=response, ) diff --git a/src/azure/connectors/monday.py b/src/azure/connectors/monday.py index bd5e040f..eb1f033e 100644 --- a/src/azure/connectors/monday.py +++ b/src/azure/connectors/monday.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,78 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "MondayClient", + "CreateBoardInput", + "CreateBoardResponse", + "CreateColumnInput", + "CreateColumnResponse", + "CreateGroupInput", + "CreateGroupResponse", + "CreateItemInput", + "CreateItemResponse", + "CreateNotificationInput", + "CreateNotificationResponse", + "CreateSubitemInput", + "CreateSubitemResponse", + "CreateUpdateInput", + "CreateUpdateResponse", + "CreateWorkspaceInput", + "CreateWorkspaceResponse", + "DuplicateBoardInput", + "DuplicateBoardResponse", + "DynamicGetColumnNamesForUpdateWebhook", + "DynamicGetColumnNamesForWebhook", + "DynamicGetGetItemsSchema", + "DynamicGetSubitemColumnNamesForWebhook", + "DynamicResponseGetListSchema", + "DynamicResponseGetListSchemaGet", + "DynamicResponseGetSingleColumnSchema", + "FieldBoard", + "FieldColumnsToUpdateSingleColumn", + "FieldWorkspace", + "GetColumnNamesSchemaForColumnChangesWebhookResponse", + "GetColumnNamesSchemaForItemNameChangeWebhookResponse", + "GetColumnNamesSchemaForSubitemNameChangeWebhookResponse", + "GetColumnNamesSchemaForUpdateWebhookResponse", + "GetColumnNamesSchemaForWebhookResponse", + "GetColumnNamesSchemaResponse", + "GetSchemaForGetItemsActionResponse", + "GetSingleColumnSchemaResponse", + "GetSubitemColumnNamesForGetSubitems", + "GetSubitemColumnNamesResponse", + "GetSubitemSchemaResponse", + "GetTagsResponse", + "GetUsersResponse", + "GetWorkspacesResponse", + "MoveItemToGroupInput", + "MoveItemToGroupResponse", + "UpdateItemColumnInput", + "UpdateItemColumnResponse", + "UpdateMultipleItemColumnsInput", + "UpdateMultipleItemColumnsResponse", + "WebhookAnyColumnChangesInput", + "WebhookAnyColumnChangesResponse", + "WebhookChangeNameInput", + "WebhookChangeNameResponse", + "WebhookChangeSubitemNameInput", + "WebhookChangeSubitemNameResponse", + "WebhookColumnChangesInput", + "WebhookColumnChangesResponse", + "WebhookCreateItemInput", + "WebhookCreateItemResponse", + "WebhookCreateSubitemInput", + "WebhookCreateSubitemResponse", + "WebhookCreateUpdateInput", + "WebhookCreateUpdateResponse", + "WebhookSubitemColumnChangesInput", + "WebhookSubitemColumnChangesResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,20 +100,11 @@ class WebhookCreateItemInput: When an item is created """ - workspace_id: Optional[str] = field( - default=None, - metadata={"wire_name": "workspaceId"}, - ) + workspace_id: str = dataclass_field(metadata={"wire_name": "workspaceId"}) """Select a workspace from the drop-down or specify a workspace ID.""" - board_id: Optional[str] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) + board_id: str = dataclass_field(metadata={"wire_name": "boardId"}) """Select a board from the drop-down or specify a board ID.""" - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """Specify the callback URL""" @@ -52,7 +114,7 @@ class WebhookCreateItemResponse: Response for When an item is created """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -65,20 +127,11 @@ class WebhookCreateUpdateInput: When a new update is posted """ - workspace_id: Optional[str] = field( - default=None, - metadata={"wire_name": "workspaceId"}, - ) + workspace_id: str = dataclass_field(metadata={"wire_name": "workspaceId"}) """Select a workspace from the drop-down or specify a workspace ID.""" - board_id: Optional[str] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) + board_id: str = dataclass_field(metadata={"wire_name": "boardId"}) """Select a board from the drop-down or specify a board ID.""" - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """Specify the callback URL.""" @@ -88,7 +141,7 @@ class WebhookCreateUpdateResponse: Response for When a new update is posted """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -101,20 +154,11 @@ class WebhookChangeNameInput: When an item's name changes """ - workspace_id: Optional[str] = field( - default=None, - metadata={"wire_name": "workspaceId"}, - ) + workspace_id: str = dataclass_field(metadata={"wire_name": "workspaceId"}) """Select a workspace from the drop-down or specify a workspace ID.""" - board_id: Optional[str] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) + board_id: str = dataclass_field(metadata={"wire_name": "boardId"}) """Select a board from the drop-down or specify a board ID.""" - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """Specify the callback URL.""" @@ -124,7 +168,7 @@ class WebhookChangeNameResponse: Response for When an item's name changes """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -137,20 +181,11 @@ class WebhookChangeSubitemNameInput: When a subitem's name changes """ - workspace_id: Optional[str] = field( - default=None, - metadata={"wire_name": "workspaceId"}, - ) + workspace_id: str = dataclass_field(metadata={"wire_name": "workspaceId"}) """Select a workspace from the drop-down or specify a workspace ID.""" - board_id: Optional[str] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) + board_id: str = dataclass_field(metadata={"wire_name": "boardId"}) """Select a board from the drop-down or specify a board ID.""" - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """Specify the callback URL.""" @@ -160,7 +195,7 @@ class WebhookChangeSubitemNameResponse: Response for When a subitem's name changes """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -173,20 +208,11 @@ class WebhookCreateSubitemInput: When a subitem is created """ - workspace_id: Optional[str] = field( - default=None, - metadata={"wire_name": "workspaceId"}, - ) + workspace_id: str = dataclass_field(metadata={"wire_name": "workspaceId"}) """Select a workspace from the drop-down or specify a workspace ID.""" - board_id: Optional[str] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) + board_id: str = dataclass_field(metadata={"wire_name": "boardId"}) """Select a board from the drop-down or specify a board ID.""" - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """Specify the callback URL.""" @@ -196,7 +222,7 @@ class WebhookCreateSubitemResponse: Response for When a subitem is created """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -209,25 +235,13 @@ class WebhookColumnChangesInput: When a column changes """ - workspace_id: Optional[str] = field( - default=None, - metadata={"wire_name": "workspaceId"}, - ) + workspace_id: str = dataclass_field(metadata={"wire_name": "workspaceId"}) """Select a workspace from the drop-down or specify a workspace ID.""" - board_id: Optional[str] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) + board_id: str = dataclass_field(metadata={"wire_name": "boardId"}) """Select a board from the drop-down or specify a board ID.""" - column_id: Optional[str] = field( - default=None, - metadata={"wire_name": "columnId"}, - ) + column_id: str = dataclass_field(metadata={"wire_name": "columnId"}) """Select a column from the drop-down.""" - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """Specify the callback URL.""" @@ -237,7 +251,7 @@ class WebhookColumnChangesResponse: Response for When a column changes """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -250,20 +264,11 @@ class WebhookAnyColumnChangesInput: When any column changes """ - workspace_id: Optional[str] = field( - default=None, - metadata={"wire_name": "workspaceId"}, - ) + workspace_id: str = dataclass_field(metadata={"wire_name": "workspaceId"}) """Select a workspace from the drop-down or specify a workspace ID.""" - board_id: Optional[str] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) + board_id: str = dataclass_field(metadata={"wire_name": "boardId"}) """Select a board from the drop-down or specify a board ID.""" - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """Specify the callback URL.""" @@ -273,7 +278,7 @@ class WebhookAnyColumnChangesResponse: Response for When any column changes """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -286,20 +291,11 @@ class WebhookSubitemColumnChangesInput: When any subitem column changes """ - workspace_id: Optional[str] = field( - default=None, - metadata={"wire_name": "workspaceId"}, - ) + workspace_id: str = dataclass_field(metadata={"wire_name": "workspaceId"}) """Select a workspace from the drop-down or specify a workspace ID.""" - board_id: Optional[str] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) + board_id: str = dataclass_field(metadata={"wire_name": "boardId"}) """Select a board from the drop-down or specify a board ID.""" - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """Specify the callback URL.""" @@ -309,7 +305,7 @@ class WebhookSubitemColumnChangesResponse: Response for When any subitem column changes """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -322,26 +318,17 @@ class CreateItemInput: Create an item """ - workspace_id: Optional[FieldWorkspace] = field( - default=None, + workspace_id: FieldWorkspace = dataclass_field( metadata={"wire_name": "workspaceId"}, ) - board_id: Optional[FieldBoard] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) - group_id: Optional[str] = field( - default=None, - metadata={"wire_name": "groupId"}, - ) + board_id: FieldBoard = dataclass_field(metadata={"wire_name": "boardId"}) + group_id: str = dataclass_field(metadata={"wire_name": "groupId"}) """Select a group from the drop-down or specify a group ID.""" - item_name: Optional[str] = field( - default=None, - metadata={"wire_name": "itemName"}, - ) + item_name: str = dataclass_field(metadata={"wire_name": "itemName"}) """Specify the name of the item you want to create.""" - column_values: Optional[DynamicResponseGetListSchema] = field( + column_values: Optional[DynamicResponseGetListSchema | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnValues"}, ) @@ -352,7 +339,7 @@ class CreateItemResponse: Response for Create an item """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -361,38 +348,37 @@ class DuplicateBoardInput: Duplicate a board """ - source_workspace_id: Optional[str] = field( - default=None, + source_workspace_id: str = dataclass_field( metadata={"wire_name": "sourceWorkspaceId"}, ) """Select the workspace for the board you want to duplicate.""" - source_board_id: Optional[str] = field( - default=None, + source_board_id: str = dataclass_field( metadata={"wire_name": "sourceBoardId"}, ) """Select the board to duplicate.""" - duplicated_board_name: Optional[str] = field( + duplicated_board_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "duplicatedBoardName"}, ) """Specify the name of the duplicated board.""" - duplication_type: Optional[str] = field( - default=None, + duplication_type: str = dataclass_field( metadata={"wire_name": "duplicationType"}, ) """Select the duplication type from the drop-down.""" - destination_workspace_id: Optional[str] = field( + destination_workspace_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "destinationWorkspaceId"}, ) """Select the destination workspace for the duplicated board.""" - destination_folder: Optional[str] = field( + destination_folder: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "destinationFolder"}, ) """Select the destination folder for the duplicated board.""" - keep_board_subscribers: Optional[bool] = field( - default=None, + keep_board_subscribers: bool = dataclass_field( metadata={"wire_name": "keepBoardSubscribers"}, ) """Select whether to keep board subscribers.""" @@ -404,7 +390,7 @@ class DuplicateBoardResponse: Response for Duplicate a board """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the duplicated board""" @@ -414,15 +400,9 @@ class CreateBoardInput: Create a board """ - workspace_id: Optional[str] = field( - default=None, - metadata={"wire_name": "workspaceId"}, - ) + workspace_id: str = dataclass_field(metadata={"wire_name": "workspaceId"}) """Specify the ID of a monday.com workspace.""" - board_name: Optional[str] = field( - default=None, - metadata={"wire_name": "boardName"}, - ) + board_name: str = dataclass_field(metadata={"wire_name": "boardName"}) """Specify the desired name of the board you want to create.""" @@ -432,7 +412,7 @@ class CreateBoardResponse: Response for Create a board """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -441,22 +421,15 @@ class CreateColumnInput: Create a column """ - workspace_id: Optional[FieldWorkspace] = field( - default=None, + workspace_id: FieldWorkspace = dataclass_field( metadata={"wire_name": "workspaceId"}, ) - board_id: Optional[FieldBoard] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) - title: Optional[str] = None + board_id: FieldBoard = dataclass_field(metadata={"wire_name": "boardId"}) + title: str """Specify the title of the column you want to create.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Specify the description of the column you want to create.""" - column_type: Optional[str] = field( - default=None, - metadata={"wire_name": "columnType"}, - ) + column_type: str = dataclass_field(metadata={"wire_name": "columnType"}) """Select a column type from the drop-down.""" @@ -466,7 +439,7 @@ class CreateColumnResponse: Response for Create a column """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -475,18 +448,11 @@ class CreateGroupInput: Create a group """ - workspace_id: Optional[FieldWorkspace] = field( - default=None, + workspace_id: FieldWorkspace = dataclass_field( metadata={"wire_name": "workspaceId"}, ) - board_id: Optional[FieldBoard] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) - group_name: Optional[str] = field( - default=None, - metadata={"wire_name": "groupName"}, - ) + board_id: FieldBoard = dataclass_field(metadata={"wire_name": "boardId"}) + group_name: str = dataclass_field(metadata={"wire_name": "groupName"}) """Specify your desired group name.""" @@ -496,7 +462,7 @@ class CreateGroupResponse: Response for Create a group """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -505,27 +471,16 @@ class UpdateItemColumnInput: Update an item's column value """ - workspace_id: Optional[str] = field( - default=None, - metadata={"wire_name": "workspaceId"}, - ) + workspace_id: str = dataclass_field(metadata={"wire_name": "workspaceId"}) """Select the workspace the item belongs to from the drop-down.""" - board_id: Optional[str] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) + board_id: str = dataclass_field(metadata={"wire_name": "boardId"}) """Select the board the item belongs to from the drop-down.""" - column_id: Optional[FieldColumnsToUpdateSingleColumn] = field( - default=None, + column_id: FieldColumnsToUpdateSingleColumn = dataclass_field( metadata={"wire_name": "columnId"}, ) - item_id: Optional[str] = field( - default=None, - metadata={"wire_name": "itemId"}, - ) + item_id: str = dataclass_field(metadata={"wire_name": "itemId"}) """Specify the ID of the item to update.""" - column_values: Optional[DynamicResponseGetSingleColumnSchema] = field( - default=None, + column_values: DynamicResponseGetSingleColumnSchema | Mapping[str, Any] = dataclass_field( metadata={"wire_name": "columnValues"}, ) @@ -536,7 +491,7 @@ class UpdateItemColumnResponse: Response for Update an item's column value """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -545,30 +500,23 @@ class UpdateMultipleItemColumnsInput: Update multiple item column values """ - workspace_id: Optional[str] = field( - default=None, - metadata={"wire_name": "workspaceId"}, - ) + workspace_id: str = dataclass_field(metadata={"wire_name": "workspaceId"}) """Select the workspace the item belongs to from the drop-down.""" - board_id: Optional[str] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) + board_id: str = dataclass_field(metadata={"wire_name": "boardId"}) """Select the board the item belongs to from the drop-down.""" - item_id: Optional[str] = field( - default=None, - metadata={"wire_name": "itemId"}, - ) + item_id: str = dataclass_field(metadata={"wire_name": "itemId"}) """Specify the ID of the item to update.""" - item_name: Optional[str] = field( + item_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "itemName"}, ) """ Specify a new name for the item. Leave blank to keep the current name. """ - column_values: Optional[DynamicResponseGetListSchema] = field( + column_values: Optional[DynamicResponseGetListSchema | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnValues"}, ) @@ -579,7 +527,7 @@ class UpdateMultipleItemColumnsResponse: Response for Update multiple item column values """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -588,23 +536,13 @@ class MoveItemToGroupInput: Move an item to a group """ - workspace_id: Optional[FieldWorkspace] = field( - default=None, + workspace_id: FieldWorkspace = dataclass_field( metadata={"wire_name": "workspaceId"}, ) - board_id: Optional[FieldBoard] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) - group_id: Optional[str] = field( - default=None, - metadata={"wire_name": "groupId"}, - ) + board_id: FieldBoard = dataclass_field(metadata={"wire_name": "boardId"}) + group_id: str = dataclass_field(metadata={"wire_name": "groupId"}) """Select the group to move the item to from the drop-down.""" - item_id: Optional[str] = field( - default=None, - metadata={"wire_name": "itemId"}, - ) + item_id: str = dataclass_field(metadata={"wire_name": "itemId"}) """Specify the ID of the item to move.""" @@ -614,7 +552,7 @@ class MoveItemToGroupResponse: Response for Move an item to a group """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -623,17 +561,11 @@ class CreateNotificationInput: Create a notification """ - user_id: Optional[str] = field( - default=None, - metadata={"wire_name": "userId"}, - ) + user_id: str = dataclass_field(metadata={"wire_name": "userId"}) """Select a user from the drop-down or specify a user ID.""" - target_id: Optional[str] = field( - default=None, - metadata={"wire_name": "targetId"}, - ) + target_id: str = dataclass_field(metadata={"wire_name": "targetId"}) """Specify a board ID or item ID the notification will go to.""" - text: Optional[str] = None + text: str """Specify the notification text.""" @@ -643,7 +575,7 @@ class CreateNotificationResponse: Response for Create a notification """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Data""" @@ -653,27 +585,20 @@ class CreateSubitemInput: Create a subitem """ - workspace_id: Optional[FieldWorkspace] = field( - default=None, + workspace_id: FieldWorkspace = dataclass_field( metadata={"wire_name": "workspaceId"}, ) - board_id: Optional[str] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) + board_id: str = dataclass_field(metadata={"wire_name": "boardId"}) """Select a board from the drop-down or specify a board ID.""" - parent_item_id: Optional[str] = field( - default=None, + parent_item_id: str = dataclass_field( metadata={"wire_name": "parentItemId"}, ) """Select a parent item from the drop-down or specify a parent item ID.""" - item_name: Optional[str] = field( - default=None, - metadata={"wire_name": "itemName"}, - ) + item_name: str = dataclass_field(metadata={"wire_name": "itemName"}) """Specify a name for the subitem.""" - column_values: Optional[DynamicResponseGetListSchema] = field( + column_values: Optional[DynamicResponseGetListSchema | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnValues"}, ) @@ -684,7 +609,7 @@ class CreateSubitemResponse: Response for Create a subitem """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -693,7 +618,7 @@ class GetSubitemColumnNamesForGetSubitems: Response for Get subitems """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -706,25 +631,15 @@ class CreateUpdateInput: Create an update """ - workspace_id: Optional[FieldWorkspace] = field( - default=None, + workspace_id: FieldWorkspace = dataclass_field( metadata={"wire_name": "workspaceId"}, ) - board_id: Optional[FieldBoard] = field( - default=None, - metadata={"wire_name": "boardId"}, - ) - group_id: Optional[str] = field( - default=None, - metadata={"wire_name": "groupId"}, - ) + board_id: FieldBoard = dataclass_field(metadata={"wire_name": "boardId"}) + group_id: str = dataclass_field(metadata={"wire_name": "groupId"}) """Select a group from the drop-down or specify a group ID.""" - item_id: Optional[str] = field( - default=None, - metadata={"wire_name": "itemId"}, - ) + item_id: str = dataclass_field(metadata={"wire_name": "itemId"}) """Select an item from the drop-down or specify an item ID.""" - body: Optional[str] = None + body: str """Specify text for the update.""" @@ -734,7 +649,7 @@ class CreateUpdateResponse: Response for Create an update """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -743,7 +658,7 @@ class DynamicResponseGetListSchemaGet: Response for Get an item by ID """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -756,9 +671,9 @@ class CreateWorkspaceInput: Create a workspace """ - name: Optional[str] = None + name: str """Specify a name for the new workspace.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Specify a description for the new workspace.""" @@ -768,7 +683,7 @@ class CreateWorkspaceResponse: Response for Create a workspace """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -777,7 +692,7 @@ class DynamicGetGetItemsSchema: Response for Get items """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -790,7 +705,7 @@ class GetTagsResponse: Response for Get tags """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -799,7 +714,7 @@ class GetUsersResponse: Response for Get users """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -808,7 +723,7 @@ class GetWorkspacesResponse: Response for Get workspaces """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -818,7 +733,7 @@ class GetColumnNamesSchemaResponse: Response for Get column names for a board ID """ - schema: Optional[Dict[str, Any]] = None + schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Schema of the requested schema type""" @@ -828,7 +743,7 @@ class GetSingleColumnSchemaResponse: Response for Gets single column schema for a board ID """ - schema: Optional[Dict[str, Any]] = None + schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Schema of the requested schema type""" @@ -838,7 +753,7 @@ class GetColumnNamesSchemaForWebhookResponse: Response for Get column names for a board ID for a webhook """ - schema: Optional[Dict[str, Any]] = None + schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Schema of the requested schema type""" @@ -848,7 +763,7 @@ class GetSchemaForGetItemsActionResponse: Response for Get column names for a board ID for a webhook """ - schema: Optional[Dict[str, Any]] = None + schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Schema of the requested schema type""" @@ -858,7 +773,7 @@ class GetColumnNamesSchemaForUpdateWebhookResponse: Response for Get column names for a board ID for an update webhook """ - schema: Optional[Dict[str, Any]] = None + schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Schema of the requested schema type""" @@ -868,7 +783,7 @@ class GetSubitemColumnNamesResponse: Response for Get subitem column names """ - schema: Optional[Dict[str, Any]] = None + schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Schema of the requested schema type""" @@ -878,7 +793,7 @@ class GetSubitemSchemaResponse: Response for Get subitem column names """ - schema: Optional[Dict[str, Any]] = None + schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Schema of the requested schema type""" @@ -888,7 +803,7 @@ class GetColumnNamesSchemaForItemNameChangeWebhookResponse: Response for Get column names schema for column changes """ - schema: Optional[Dict[str, Any]] = None + schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Schema of the requested schema type""" @@ -898,7 +813,7 @@ class GetColumnNamesSchemaForSubitemNameChangeWebhookResponse: Response for Get column names schema for column changes """ - schema: Optional[Dict[str, Any]] = None + schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Schema of the requested schema type""" @@ -908,7 +823,7 @@ class GetColumnNamesSchemaForColumnChangesWebhookResponse: Response for Get column names schema for column changes """ - schema: Optional[Dict[str, Any]] = None + schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Schema of the requested schema type""" @@ -918,7 +833,7 @@ class DynamicResponseGetListSchema: Definition: DynamicResponseGetListSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -931,7 +846,7 @@ class DynamicResponseGetSingleColumnSchema: Definition: DynamicResponseGetSingleColumnSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -944,7 +859,7 @@ class DynamicGetColumnNamesForWebhook: Definition: DynamicGetColumnNamesForWebhook """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -957,7 +872,7 @@ class DynamicGetColumnNamesForUpdateWebhook: Definition: DynamicGetColumnNamesForUpdateWebhook """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -970,7 +885,7 @@ class DynamicGetSubitemColumnNamesForWebhook: Definition: DynamicGetSubitemColumnNamesForWebhook """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -997,7 +912,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1014,8 +929,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1036,7 +951,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1051,9 +966,86 @@ def __init__( def connector_name(self) -> str: return "monday" - async def create_item_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def create_item( self, - input: CreateItemInput, + input: CreateItemInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1064,13 +1056,29 @@ async def create_item_async( Create an item Creates an item in the selected monday.com board and group. + + Swagger operation ID: `CreateItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/CreateItem" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1084,6 +1092,7 @@ async def create_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1091,9 +1100,9 @@ async def create_item_async( return json.loads(response.text) - async def duplicate_board_async( + async def duplicate_board( self, - input: DuplicateBoardInput, + input: DuplicateBoardInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1104,13 +1113,29 @@ async def duplicate_board_async( Duplicate a board Duplicates a board in monday.com. + + Swagger operation ID: `DuplicateBoard`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/DuplicateBoard" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1124,6 +1149,7 @@ async def duplicate_board_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1131,9 +1157,9 @@ async def duplicate_board_async( return json.loads(response.text) - async def create_board_async( + async def create_board( self, - input: CreateBoardInput, + input: CreateBoardInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1144,13 +1170,29 @@ async def create_board_async( Create a board Creates a board in monday.com. + + Swagger operation ID: `CreateBoard`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/CreateBoard" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1164,6 +1206,7 @@ async def create_board_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1171,9 +1214,9 @@ async def create_board_async( return json.loads(response.text) - async def create_column_async( + async def create_column( self, - input: CreateColumnInput, + input: CreateColumnInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1184,13 +1227,29 @@ async def create_column_async( Create a column Creates a column in monday.com for the specified board. + + Swagger operation ID: `CreateColumn`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/CreateColumn" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1204,6 +1263,7 @@ async def create_column_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1211,9 +1271,9 @@ async def create_column_async( return json.loads(response.text) - async def create_group_async( + async def create_group( self, - input: CreateGroupInput, + input: CreateGroupInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1224,13 +1284,29 @@ async def create_group_async( Create a group Creates a group in monday.com for the specified board. + + Swagger operation ID: `CreateGroup`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/CreateGroup" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1244,6 +1320,7 @@ async def create_group_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1251,9 +1328,9 @@ async def create_group_async( return json.loads(response.text) - async def update_item_column_async( + async def update_item_column( self, - input: UpdateItemColumnInput, + input: UpdateItemColumnInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1265,13 +1342,29 @@ async def update_item_column_async( Updates a single item's column. If the value is blank, the column value will be cleared. + + Swagger operation ID: `UpdateItemColumn`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/UpdateItemColumn" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1285,6 +1378,7 @@ async def update_item_column_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1292,9 +1386,9 @@ async def update_item_column_async( return json.loads(response.text) - async def update_multiple_item_columns_async( + async def update_multiple_item_columns( self, - input: UpdateMultipleItemColumnsInput, + input: UpdateMultipleItemColumnsInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1306,13 +1400,29 @@ async def update_multiple_item_columns_async( Updates multiple item columns. Leave the column value blank to keep the current value. + + Swagger operation ID: `UpdateMultipleItemColumns`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/UpdateMultipleItemColumns" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1326,6 +1436,7 @@ async def update_multiple_item_columns_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1333,9 +1444,9 @@ async def update_multiple_item_columns_async( return json.loads(response.text) - async def move_item_to_group_async( + async def move_item_to_group( self, - input: MoveItemToGroupInput, + input: MoveItemToGroupInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1346,13 +1457,29 @@ async def move_item_to_group_async( Move an item to a group Moves an item to another group on the same board. + + Swagger operation ID: `MoveItemToGroup`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/MoveItemToGroup" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1366,6 +1493,7 @@ async def move_item_to_group_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1373,9 +1501,9 @@ async def move_item_to_group_async( return json.loads(response.text) - async def create_notification_async( + async def create_notification( self, - input: CreateNotificationInput, + input: CreateNotificationInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1387,13 +1515,29 @@ async def create_notification_async( Creates a notification in monday.com for a user for either a specific board or item. + + Swagger operation ID: `CreateNotification`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/CreateNotification" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1407,6 +1551,7 @@ async def create_notification_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1414,9 +1559,9 @@ async def create_notification_async( return json.loads(response.text) - async def create_subitem_async( + async def create_subitem( self, - input: CreateSubitemInput, + input: CreateSubitemInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1427,13 +1572,29 @@ async def create_subitem_async( Create a subitem Creates a subitem in monday.com for the selected board and parent item. + + Swagger operation ID: `CreateSubitem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/CreateSubitem" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1447,6 +1608,7 @@ async def create_subitem_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1454,7 +1616,7 @@ async def create_subitem_async( return json.loads(response.text) - async def get_subitems_async( + async def get_subitems( self, workspace_id: str, board_id: str, @@ -1469,6 +1631,25 @@ async def get_subitems_async( Get subitems Gets subitems in monday.com for a specific item in a board. + + Swagger operation ID: `GetSubitems`. + + Args: + workspace_id: Select a workspace from the drop-down or specify a + workspace ID. + board_id: Select the item's board from the drop-down or specify a + board ID. + item_id: Specify an item ID to retrieve the subitems for. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getData/getSubitems" query_params = [] @@ -1487,7 +1668,7 @@ async def get_subitems_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1501,6 +1682,7 @@ async def get_subitems_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1508,9 +1690,9 @@ async def get_subitems_async( return json.loads(response.text) - async def create_update_async( + async def create_update( self, - input: CreateUpdateInput, + input: CreateUpdateInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1521,13 +1703,29 @@ async def create_update_async( Create an update Creates an update in monday.com for a specific item. + + Swagger operation ID: `CreateUpdate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/CreateUpdate" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1541,6 +1739,7 @@ async def create_update_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1548,7 +1747,7 @@ async def create_update_async( return json.loads(response.text) - async def get_item_by_id_async( + async def get_item_by_id( self, item_id: str, workspace_id: str, @@ -1563,6 +1762,25 @@ async def get_item_by_id_async( Get an item by ID Gets a monday.com item using the specified item ID and board. + + Swagger operation ID: `GetItemById`. + + Args: + item_id: Specify an item ID to retrieve. + workspace_id: Select the item's workspace from the drop-down or + specify a workspace ID. + board_id: Select the item's board from the drop-down or specify a + board ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getData/getItemById" query_params = [] @@ -1581,7 +1799,7 @@ async def get_item_by_id_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1595,6 +1813,7 @@ async def get_item_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1602,9 +1821,9 @@ async def get_item_by_id_async( return json.loads(response.text) - async def create_workspace_async( + async def create_workspace( self, - input: CreateWorkspaceInput, + input: CreateWorkspaceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1616,13 +1835,29 @@ async def create_workspace_async( Creates a monday.com workspace with a user-specified name and description. + + Swagger operation ID: `CreateWorkspace_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/executePowerAutomateAction/CreateWorkspaceV2" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1636,6 +1871,7 @@ async def create_workspace_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1643,11 +1879,12 @@ async def create_workspace_async( return json.loads(response.text) - async def get_items_async( + async def get_items( self, workspace_id: str, board_id: str, group_id: str, + *, filter1_column: Optional[str] = None, filter1_operator: Optional[str] = None, filter1_value: Optional[str] = None, @@ -1660,7 +1897,6 @@ async def get_items_async( filter4_column: Optional[str] = None, filter4_operator: Optional[str] = None, filter4_value: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1673,6 +1909,40 @@ async def get_items_async( by column values using the filters found under advanced options. More info on filtering can be found here: https://plugingenie.com/docs/filtering-items. + + Swagger operation ID: `GetItems_V2`. + + Args: + workspace_id: Select a workspace from the drop-down or specify a + workspace ID. + board_id: Select a board from the drop-down or specify a board ID. + group_id: Select a group from the drop-down or specify a group ID. + filter1_column: Select a column from the drop-down or specify a + column ID. + filter1_operator: Select an operator from the drop-down. + filter1_value: Specify a value (if applicable). + filter2_column: Select a column from the drop-down or specify a + column ID. + filter2_operator: Select an operator from the drop-down. + filter2_value: Specify a value (if applicable). + filter3_column: Select a column from the drop-down or specify a + column ID. + filter3_operator: Select an operator from the drop-down. + filter3_value: Specify a value (if applicable). + filter4_column: Select a column from the drop-down or specify a + column ID. + filter4_operator: Select an operator from the drop-down. + filter4_value: Specify a value (if applicable). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getData/getItemsV2" query_params = [] @@ -1751,7 +2021,7 @@ async def get_items_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1765,6 +2035,7 @@ async def get_items_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1772,7 +2043,7 @@ async def get_items_async( return json.loads(response.text) - async def get_tags_async( + async def get_tags( self, *, timeout: Optional[float] = None, @@ -1784,10 +2055,24 @@ async def get_tags_async( Get tags This operation gets monday.com tags. + + Swagger operation ID: `GetTags_V2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getData/getTagsV2" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1801,6 +2086,7 @@ async def get_tags_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1808,7 +2094,7 @@ async def get_tags_async( return json.loads(response.text) - async def get_users_async( + async def get_users( self, *, timeout: Optional[float] = None, @@ -1821,10 +2107,24 @@ async def get_users_async( This operation gets the name, email, and ID of users in your monday.com account. + + Swagger operation ID: `GetUsers_V2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getData/getUsersV2" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1838,6 +2138,7 @@ async def get_users_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1845,7 +2146,7 @@ async def get_users_async( return json.loads(response.text) - async def get_workspaces_async( + async def get_workspaces( self, *, timeout: Optional[float] = None, @@ -1857,10 +2158,24 @@ async def get_workspaces_async( Get workspaces This operation gets the workspaces from monday.com. + + Swagger operation ID: `GetWorkspaces_V2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getData/getWorkspacesV2" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1874,6 +2189,7 @@ async def get_workspaces_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1881,19 +2197,37 @@ async def get_workspaces_async( return json.loads(response.text) - async def get_boards_async( + def list_boards( self, - workspace_id: Optional[str] = None, *, + workspace_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get boards This operation gets the boards from monday.com. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetBoards`. + + Args: + workspace_id: Specify the ID of the monday.com workspace. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getData/getBoards" query_params = [] @@ -1904,29 +2238,50 @@ async def get_boards_async( query_params.append(f"workspaceId={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_groups_for_get_items_async( + return AsyncItemPaged(get_next, extract_data) + + def list_groups_for_get_items( self, board_id: str, *, @@ -1934,12 +2289,30 @@ async def get_groups_for_get_items_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get groups for the Get Items operation This operation gets the groups from monday.com, which includes the option to select all groups. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetGroupsForGetItems`. + + Args: + board_id: Specify the ID of a monday.com board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/getData/getGroupsForGetItems" @@ -1951,29 +2324,50 @@ async def get_groups_for_get_items_async( query_params.append(f"boardId={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_columns_for_item_filtering_async( + return AsyncItemPaged(get_next, extract_data) + + def list_columns_for_item_filtering( self, board_id: str, *, @@ -1981,11 +2375,29 @@ async def get_columns_for_item_filtering_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get columns for item filtering This operation gets the columns from monday.com for item filtering. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetColumnsForItemFiltering`. + + Args: + board_id: Specify the ID of a monday.com board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1998,43 +2410,83 @@ async def get_columns_for_item_filtering_async( query_params.append(f"boardId={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def get_column_filter_operator_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_column_filter_operator( self, board_id: str, - column_id: Optional[str] = None, *, + column_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get column filter operator This operation gets the available item filter operator for the selected monday.com column. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetColumnFilterOperator`. + + Args: + board_id: Specify the ID of a monday.com board. + column_id: Specify the ID of a monday.com column. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/getData/getColumnFilterOperator" @@ -2051,32 +2503,53 @@ async def get_column_filter_operator_async( query_params.append(f"columnId={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_column_names_schema_async( + async def get_column_names_schema( self, - board_id: Optional[str] = None, *, + board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2086,6 +2559,21 @@ async def get_column_names_schema_async( Get column names for a board ID This operation gets the column names for a board ID. + + Swagger operation ID: `GetColumnNamesSchema`. + + Args: + board_id: Specify the ID of a monday.com board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/getSchema/getColumnNames" @@ -2099,7 +2587,7 @@ async def get_column_names_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2113,6 +2601,7 @@ async def get_column_names_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2120,11 +2609,11 @@ async def get_column_names_schema_async( return json.loads(response.text) - async def get_single_column_schema_async( + async def get_single_column_schema( self, + *, board_id: Optional[str] = None, column_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2134,6 +2623,22 @@ async def get_single_column_schema_async( Gets single column schema for a board ID This operation gets the single column schema for a board ID. + + Swagger operation ID: `GetSingleColumnSchema`. + + Args: + board_id: Specify the ID of a monday.com board. + column_id: Specify the ID of a monday.com column. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/getSchema/getSingleColumnSchema" @@ -2152,7 +2657,7 @@ async def get_single_column_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2166,6 +2671,7 @@ async def get_single_column_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2173,10 +2679,10 @@ async def get_single_column_schema_async( return json.loads(response.text) - async def get_column_names_schema_for_webhook_async( + async def get_column_names_schema_for_webhook( self, - board_id: Optional[str] = None, *, + board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2187,6 +2693,21 @@ async def get_column_names_schema_for_webhook_async( This operation gets the column names for a board ID for a webhook (includes itemId). + + Swagger operation ID: `GetColumnNamesSchemaForWebhook`. + + Args: + board_id: Specify the ID of a monday.com board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2201,7 +2722,7 @@ async def get_column_names_schema_for_webhook_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2215,6 +2736,7 @@ async def get_column_names_schema_for_webhook_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2222,10 +2744,10 @@ async def get_column_names_schema_for_webhook_async( return json.loads(response.text) - async def get_schema_for_get_items_action_async( + async def get_schema_for_get_items_action( self, - board_id: Optional[str] = None, *, + board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2235,6 +2757,21 @@ async def get_schema_for_get_items_action_async( Get column names for a board ID for a webhook This operation gets the schema for the GetItems action. + + Swagger operation ID: `GetSchemaForGetItemsAction`. + + Args: + board_id: Specify the ID of a monday.com board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2249,7 +2786,7 @@ async def get_schema_for_get_items_action_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2263,6 +2800,7 @@ async def get_schema_for_get_items_action_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2270,10 +2808,10 @@ async def get_schema_for_get_items_action_async( return json.loads(response.text) - async def get_column_names_schema_for_update_webhook_async( + async def get_column_names_schema_for_update_webhook( self, - board_id: Optional[str] = None, *, + board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2284,6 +2822,21 @@ async def get_column_names_schema_for_update_webhook_async( This operation gets the column names for a board ID for a webhook (includes itemId). + + Swagger operation ID: `GetColumnNamesSchemaForUpdateWebhook`. + + Args: + board_id: Specify the ID of a monday.com board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2298,7 +2851,7 @@ async def get_column_names_schema_for_update_webhook_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2312,6 +2865,7 @@ async def get_column_names_schema_for_update_webhook_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2319,7 +2873,7 @@ async def get_column_names_schema_for_update_webhook_async( return json.loads(response.text) - async def get_subitem_column_names_async( + async def get_subitem_column_names( self, parent_board_id: str, *, @@ -2332,6 +2886,21 @@ async def get_subitem_column_names_async( Get subitem column names Gets subitem column names in monday.com given a board ID. + + Swagger operation ID: `GetSubitemColumnNames`. + + Args: + parent_board_id: Specify the ID of the monday.com parent board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/getSchema/getSubitemColumnNames" @@ -2344,7 +2913,7 @@ async def get_subitem_column_names_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2358,6 +2927,7 @@ async def get_subitem_column_names_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2365,7 +2935,7 @@ async def get_subitem_column_names_async( return json.loads(response.text) - async def get_subitem_schema_async( + async def get_subitem_schema( self, parent_board_id: str, *, @@ -2378,6 +2948,21 @@ async def get_subitem_schema_async( Get subitem column names Gets subitem schema in monday.com given a board ID. + + Swagger operation ID: `GetSubitemSchema`. + + Args: + parent_board_id: Specify the ID of the monday.com parent board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/getSchema/getSubitemSchema" @@ -2390,7 +2975,7 @@ async def get_subitem_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2404,6 +2989,7 @@ async def get_subitem_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2411,10 +2997,10 @@ async def get_subitem_schema_async( return json.loads(response.text) - async def get_column_names_schema_for_item_name_change_webhook_async( + async def get_column_names_schema_for_item_name_change_webhook( self, - board_id: Optional[str] = None, *, + board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2425,6 +3011,21 @@ async def get_column_names_schema_for_item_name_change_webhook_async( This operation gets the column names for a board ID for a webhook when the item's name changes. + + Swagger operation ID: `GetColumnNamesSchemaForItemNameChangeWebhook`. + + Args: + board_id: Specify the ID of a monday.com board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2439,7 +3040,7 @@ async def get_column_names_schema_for_item_name_change_webhook_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2453,6 +3054,7 @@ async def get_column_names_schema_for_item_name_change_webhook_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2460,7 +3062,7 @@ async def get_column_names_schema_for_item_name_change_webhook_async( return json.loads(response.text) - async def get_column_names_schema_for_subitem_name_change_webhook_async( + async def get_column_names_schema_for_subitem_name_change_webhook( self, parent_board_id: str, *, @@ -2474,6 +3076,22 @@ async def get_column_names_schema_for_subitem_name_change_webhook_async( This operation gets the column names for a board ID for a webhook when the subitem's name changes. + + Swagger operation ID: + `GetColumnNamesSchemaForSubitemNameChangeWebhook`. + + Args: + parent_board_id: Specify the ID of the monday.com parent board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2487,7 +3105,7 @@ async def get_column_names_schema_for_subitem_name_change_webhook_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2501,6 +3119,7 @@ async def get_column_names_schema_for_subitem_name_change_webhook_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2508,10 +3127,10 @@ async def get_column_names_schema_for_subitem_name_change_webhook_async( return json.loads(response.text) - async def get_column_names_schema_for_column_changes_webhook_async( + async def get_column_names_schema_for_column_changes_webhook( self, - board_id: Optional[str] = None, *, + board_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2522,6 +3141,21 @@ async def get_column_names_schema_for_column_changes_webhook_async( This operation gets the column names for a board ID for a webhook (includes itemId). + + Swagger operation ID: `GetColumnNamesSchemaForColumnChangesWebhook`. + + Args: + board_id: Specify the ID of a monday.com board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2536,7 +3170,7 @@ async def get_column_names_schema_for_column_changes_webhook_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2550,6 +3184,7 @@ async def get_column_names_schema_for_column_changes_webhook_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/mq.py b/src/azure/connectors/mq.py index ece091e3..17c1caeb 100644 --- a/src/azure/connectors/mq.py +++ b/src/azure/connectors/mq.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Any, Mapping import json @@ -19,6 +19,19 @@ ConnectorResponseHook, ) +__all__ = [ + "MqClient", + "Item", + "ItemsList", + "MultipleGetValidOptions", + "ObjectEntity", + "ProcedureMetadata", + "SendResponse", + "SendValidDataOptions", + "SendValidDataOptionsArray", + "SingleGetValidOptions", +] + # Type Definitions @@ -28,81 +41,100 @@ class Item: Response for Delete message """ - item_internal_id: Optional[str] = field( + item_internal_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ItemInternalId"}, ) - message_data: Optional[str] = field( - default=None, - metadata={"wire_name": "MessageData"}, - ) - message_id: Optional[str] = field( + message_data: str = dataclass_field(metadata={"wire_name": "MessageData"}) + message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageId"}, ) - correlation_id: Optional[str] = field( + correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CorrelationId"}, ) - put_date_time: Optional[str] = field( + put_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PutDateTime"}, ) - user_identifier: Optional[str] = field( + user_identifier: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserIdentifier"}, ) - put_application_name: Optional[str] = field( + put_application_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PutApplicationName"}, ) - put_application_type: Optional[str] = field( + put_application_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PutApplicationType"}, ) - format: Optional[str] = field( + format: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Format"}, ) - accounting_token: Optional[str] = field( + accounting_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountingToken"}, ) - ccsid: Optional[int] = field(default=None, metadata={"wire_name": "Ccsid"}) - group_id: Optional[str] = field( + ccsid: Optional[int] = dataclass_field( default=None, + kw_only=True, + metadata={"wire_name": "Ccsid"}, + ) + group_id: Optional[str] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "GroupId"}, ) - logical_sequence_number: Optional[int] = field( + logical_sequence_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LogicalSequenceNumber"}, ) - message_type: Optional[str] = field( + message_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageType"}, ) - offset: Optional[int] = field( + offset: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Offset"}, ) - original_length: Optional[int] = field( + original_length: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OriginalLength"}, ) - persistence: Optional[str] = field( + persistence: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Persistence"}, ) - priority: Optional[int] = field( + priority: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Priority"}, ) - reply_to_queue: Optional[str] = field( + reply_to_queue: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyToQueue"}, ) - reply_to_queue_manager: Optional[str] = field( + reply_to_queue_manager: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyToQueueManager"}, ) @@ -113,7 +145,12 @@ class ItemsList: Response for Delete messages """ - value: Optional[List[Item]] = None + value: Optional[ + List[Item | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -122,20 +159,24 @@ class SendResponse: Response for Send message """ - item_internal_id: Optional[str] = field( + item_internal_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ItemInternalId"}, ) - message_data: Optional[str] = field( + message_data: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageData"}, ) - message_id: Optional[str] = field( + message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageId"}, ) - correlation_id: Optional[str] = field( + correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CorrelationId"}, ) @@ -146,9 +187,9 @@ class ProcedureMetadata: Definition: ProcedureMetadata """ - name: Optional[str] = None - title: Optional[str] = None - schema: Optional[ObjectEntity] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + title: Optional[str] = dataclass_field(default=None, kw_only=True) + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -157,7 +198,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -170,51 +211,63 @@ class SingleGetValidOptions: Definition: SingleGetValidOptions """ - queue: Optional[str] = field(default=None, metadata={"wire_name": "Queue"}) + queue: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Queue"}, + ) """When specified, overrides the queue defined in the connection.""" - message_id: Optional[str] = field( + message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageId"}, ) """Base64 string that represents a byte array with 24 bytes.""" - correlation_id: Optional[str] = field( + correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CorrelationId"}, ) """Base64 string that represents a byte array with 24 bytes.""" - group_id: Optional[str] = field( + group_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GroupId"}, ) """Base64 string that represents a byte array with 24 bytes.""" - message_token: Optional[str] = field( + message_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageToken"}, ) """Base64 string that represents a byte array with 16 bytes.""" - offset: Optional[float] = field( + offset: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Offset"}, ) """ Offset in bytes of the data in the physical message from the start of the logical message. """ - logical_sequence_number: Optional[float] = field( + logical_sequence_number: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LogicalSequenceNumber"}, ) """Sequence number of a logical message within a group.""" - include_info: Optional[str] = field( + include_info: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IncludeInfo"}, ) """ Indicates if additional message info should be included. Expects true or false. """ - timeout: Optional[str] = field( + timeout: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Timeout"}, ) """ @@ -229,59 +282,72 @@ class MultipleGetValidOptions: Definition: MultipleGetValidOptions """ - queue: Optional[str] = field(default=None, metadata={"wire_name": "Queue"}) + queue: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Queue"}, + ) """When specified, overrides the queue defined in the connection.""" - message_id: Optional[str] = field( + message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageId"}, ) """Base64 string that represents a byte array with 24 bytes.""" - correlation_id: Optional[str] = field( + correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CorrelationId"}, ) """Base64 string that represents a byte array with 24 bytes.""" - group_id: Optional[str] = field( + group_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GroupId"}, ) """Base64 string that represents a byte array with 24 bytes.""" - message_token: Optional[str] = field( + message_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageToken"}, ) """Base64 string that represents a byte array with 16 bytes.""" - offset: Optional[float] = field( + offset: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Offset"}, ) """ Offset in bytes of the data in the physical message from the start of the logical message. """ - logical_sequence_number: Optional[float] = field( + logical_sequence_number: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LogicalSequenceNumber"}, ) """Sequence number of a logical message within a group.""" - include_info: Optional[str] = field( + include_info: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IncludeInfo"}, ) """ Indicates if additional message info should be included. Expects true or false. """ - timeout: Optional[str] = field( + timeout: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Timeout"}, ) """ Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss. """ - batch_size: Optional[float] = field( + batch_size: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BatchSize"}, ) """Maximum number of messages to be retrieved from the queue.""" @@ -293,53 +359,62 @@ class SendValidDataOptions: Definition: SendValidDataOptions """ - queue: Optional[str] = field(default=None, metadata={"wire_name": "Queue"}) - """When specified, overrides the queue defined in the connection.""" - message: Optional[str] = field( + queue: Optional[str] = dataclass_field( default=None, - metadata={"wire_name": "Message"}, + kw_only=True, + metadata={"wire_name": "Queue"}, ) + """When specified, overrides the queue defined in the connection.""" + message: str = dataclass_field(metadata={"wire_name": "Message"}) """Message data""" - message_type: Optional[str] = field( + message_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageType"}, ) """Message type""" - correlation_id: Optional[str] = field( + correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CorrelationId"}, ) """Base64 string that represents a byte array with 24 bytes.""" - message_id: Optional[str] = field( + message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageId"}, ) """Base64 string that represents a byte array with 24 bytes.""" - reply_to_queue: Optional[str] = field( + reply_to_queue: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyToQueue"}, ) """Reply-to queue""" - reply_to_queue_manager: Optional[str] = field( + reply_to_queue_manager: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyToQueueManager"}, ) """Reply-to queue manager""" - code_char_set_id: Optional[float] = field( + code_char_set_id: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CodeCharSetId"}, ) """Character set for the message.""" - offset: Optional[float] = field( + offset: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Offset"}, ) """ Offset in bytes of the data in the physical message from the start of the logical message. """ - format: Optional[str] = field( + format: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Format"}, ) """Format field for the message.""" @@ -351,7 +426,7 @@ class SendValidDataOptionsArray: Definition: SendValidDataOptionsArray """ - messages: Optional[List[SendValidDataOptions]] = None + messages: List[SendValidDataOptions | Mapping[str, Any]] # Client Class @@ -365,7 +440,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -382,8 +457,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -404,7 +479,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -419,9 +494,9 @@ def __init__( def connector_name(self) -> str: return "mq" - async def delete_async( + async def delete( self, - input: SingleGetValidOptions, + input: SingleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -432,10 +507,26 @@ async def delete_async( Delete message Deletes one message from the queue, by doing a destructive get. + + Swagger operation ID: `DeleteV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/delete" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -449,6 +540,7 @@ async def delete_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -456,9 +548,9 @@ async def delete_async( return json.loads(response.text) - async def delete_all_async( + async def delete_all( self, - input: MultipleGetValidOptions, + input: MultipleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -469,10 +561,26 @@ async def delete_all_async( Delete messages Deletes messages from the queue, by doing a destructive get. + + Swagger operation ID: `DeleteAllV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/deleteall" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -486,6 +594,7 @@ async def delete_all_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -493,9 +602,9 @@ async def delete_all_async( return json.loads(response.text) - async def read_async( + async def read( self, - input: SingleGetValidOptions, + input: SingleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -506,10 +615,26 @@ async def read_async( Browse message Browse one message from the queue. + + Swagger operation ID: `ReadV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/read" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -523,6 +648,7 @@ async def read_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -530,9 +656,9 @@ async def read_async( return json.loads(response.text) - async def read_all_async( + async def read_all( self, - input: MultipleGetValidOptions, + input: MultipleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -543,10 +669,26 @@ async def read_all_async( Browse messages Browse messages in a queue. + + Swagger operation ID: `ReadAllV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/readall" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -560,6 +702,7 @@ async def read_all_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -567,9 +710,9 @@ async def read_all_async( return json.loads(response.text) - async def receive_async( + async def receive( self, - input: SingleGetValidOptions, + input: SingleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -580,10 +723,26 @@ async def receive_async( Receive message Returns one message from the queue, by doing a destructive get. + + Swagger operation ID: `ReceiveV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/receive" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -597,6 +756,7 @@ async def receive_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -604,9 +764,9 @@ async def receive_async( return json.loads(response.text) - async def receive_all_async( + async def receive_all( self, - input: MultipleGetValidOptions, + input: MultipleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -617,10 +777,26 @@ async def receive_all_async( Receive messages Returns messages from the queue, by doing a destructive get. + + Swagger operation ID: `ReceiveAllV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/receiveall" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -634,6 +810,7 @@ async def receive_all_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -641,9 +818,9 @@ async def receive_all_async( return json.loads(response.text) - async def send_async( + async def send( self, - input: SendValidDataOptions, + input: SendValidDataOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -654,10 +831,26 @@ async def send_async( Send message Send a message to a queue. + + Swagger operation ID: `SendV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/send" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -671,6 +864,7 @@ async def send_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/msgraphgroupsanduser.py b/src/azure/connectors/msgraphgroupsanduser.py index f30ba929..e6916478 100644 --- a/src/azure/connectors/msgraphgroupsanduser.py +++ b/src/azure/connectors/msgraphgroupsanduser.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,21 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "MsgraphgroupsanduserClient", + "GetGroupPropertiesResponse", + "GetMemberGroupsInput", + "GetMemberGroupsResponse", + "GetMemberLicenseDetailsResponse", + "ListDirectGroupMembersResponse", + "ListGroupsByDisplayNameSearchResponse", + "ListSubscribedSkusResponse", + "ListUsersResponse", +] + # Type Definitions @@ -29,12 +43,13 @@ class ListUsersResponse: Response for List Users """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The Odata.context link.""" - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -44,17 +59,19 @@ class ListGroupsByDisplayNameSearchResponse: Response for List Groups By Display Name Search """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The Odata.context link.""" - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.count"}, ) """@odata.count""" - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -64,12 +81,13 @@ class ListSubscribedSkusResponse: Response for List Subscribed Skus """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The Odata.context link.""" - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -79,17 +97,19 @@ class ListDirectGroupMembersResponse: Response for List Direct Group Members """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The Odata.context link.""" - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.count"}, ) """@odata.count""" - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -99,12 +119,13 @@ class GetMemberLicenseDetailsResponse: Response for Get Member License Details """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The Odata.context link.""" - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -114,158 +135,185 @@ class GetGroupPropertiesResponse: Response for Get Group Properties """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The Odata.context link.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Object id of the group""" - deleted_date_time: Optional[str] = field( + deleted_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "deletedDateTime"}, ) """Group's deletion date time""" - classification: Optional[str] = None + classification: Optional[str] = dataclass_field(default=None, kw_only=True) """classification""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """Group's creation date time""" - creation_options: Optional[List[str]] = field( + creation_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creationOptions"}, ) """Created options of the group.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """description""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Group's display name""" - expiration_date_time: Optional[str] = field( + expiration_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "expirationDateTime"}, ) """Group's expiration date time""" - group_types: Optional[List[str]] = field( + group_types: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "groupTypes"}, ) """Group types for the group.""" - is_assignable_to_role: Optional[str] = field( + is_assignable_to_role: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAssignableToRole"}, ) """Can a role be assigned to this group?""" - mail: Optional[str] = None + mail: Optional[str] = dataclass_field(default=None, kw_only=True) """Group's email""" - mail_enabled: Optional[bool] = field( + mail_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mailEnabled"}, ) """Is group email enabled?""" - mail_nickname: Optional[str] = field( + mail_nickname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mailNickname"}, ) """Group's email nick name""" - membership_rule: Optional[str] = field( + membership_rule: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "membershipRule"}, ) """The rule that is used for membership evaluation.""" - membership_rule_processing_state: Optional[str] = field( + membership_rule_processing_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "membershipRuleProcessingState"}, ) """ The processing state of the rule that is used for membership evaluation. """ - on_premises_domain_name: Optional[str] = field( + on_premises_domain_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesDomainName"}, ) """ Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. """ - on_premises_last_sync_date_time: Optional[str] = field( + on_premises_last_sync_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesLastSyncDateTime"}, ) """ The time and date at which the tenant was last synced with the on-premise directory. """ - on_premises_net_bios_name: Optional[str] = field( + on_premises_net_bios_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesNetBiosName"}, ) """Name of networking service for on-premise server.""" - on_premises_sam_account_name: Optional[str] = field( + on_premises_sam_account_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesSamAccountName"}, ) """Sam account name for on-premise directory.""" - on_premises_security_identifier: Optional[str] = field( + on_premises_security_identifier: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesSecurityIdentifier"}, ) """The on-premises security identifier.""" - on_premises_sync_enabled: Optional[bool] = field( + on_premises_sync_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesSyncEnabled"}, ) """True if on-premises sync is enabled for the group.""" - preferred_data_location: Optional[str] = field( + preferred_data_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredDataLocation"}, ) """Preferred data location of the group.""" - preferred_language: Optional[str] = field( + preferred_language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredLanguage"}, ) """Preferred language as configured in Microsoft Entra ID.""" - proxy_addresses: Optional[List[str]] = field( + proxy_addresses: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "proxyAddresses"}, ) """Proxy addresses of the group.""" - renewed_date_time: Optional[str] = field( + renewed_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "renewedDateTime"}, ) """Renewed date time of the group.""" - resource_behavior_options: Optional[List[str]] = field( + resource_behavior_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceBehaviorOptions"}, ) """Resource behavior options of the group.""" - resource_provisioning_options: Optional[List[str]] = field( + resource_provisioning_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceProvisioningOptions"}, ) """Resource provisioning options of the group.""" - security_enabled: Optional[bool] = field( + security_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "securityEnabled"}, ) """Indicates if the group is security enabled.""" - security_identifier: Optional[str] = field( + security_identifier: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "securityIdentifier"}, ) """Security identifier of the group.""" - theme: Optional[str] = None + theme: Optional[str] = dataclass_field(default=None, kw_only=True) """Theme of Microsoft Entra ID group.""" - visibility: Optional[str] = None + visibility: Optional[str] = dataclass_field(default=None, kw_only=True) """Visibility of the group.""" - on_premises_provisioning_errors: Optional[List[str]] = field( + on_premises_provisioning_errors: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onPremisesProvisioningErrors"}, ) """On premise provisioning errors of the group.""" @@ -277,8 +325,7 @@ class GetMemberGroupsInput: Get Member Groups """ - security_enabled_only: Optional[bool] = field( - default=None, + security_enabled_only: bool = dataclass_field( metadata={"wire_name": "securityEnabledOnly"}, ) """Do you want to retrieve security enabled groups only?""" @@ -290,12 +337,13 @@ class GetMemberGroupsResponse: Response for Get Member Groups """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The Odata.context link.""" - value: Optional[List[str]] = None + value: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """value""" @@ -310,7 +358,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -327,8 +375,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -349,7 +397,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -364,55 +412,189 @@ def __init__( def connector_name(self) -> str: return "msgraphgroupsanduser" - async def list_users_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_users( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Users Retrieve all users in the organization (Microsoft Entra ID Tenant) + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListUsers`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/users" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def list_groups_by_display_name_search_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_groups_by_display_name_search( self, - search: Optional[str] = None, *, + search: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Groups By Display Name Search Retrieve groups by searching group's display name + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListGroupsByDisplayNameSearch`. + + Args: + search: Search by keyword in display name of the Microsoft Entra ID + group. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/groups" query_params = [] @@ -424,79 +606,158 @@ async def list_groups_by_display_name_search_async( query_params.append(f"$search={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def list_subscribed_skus_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_subscribed_skus( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Subscribed Skus Details of organization's subscribed license plan SKUs + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListSubscribedSkus`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/subscribedSkus" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_direct_group_members_async( + def list_direct_group_members( self, group_id: str, + *, filter: Optional[str] = None, select: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Direct Group Members Retrieve direct members of a group with count + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListDirectGroupMembers`. + + Args: + group_id: Object ID of the Microsoft Entra ID group. + filter: Filter By. + select: Select which columns to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -516,42 +777,82 @@ async def list_direct_group_members_async( query_params.append(f"$select={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_member_license_details_async( + def list_member_license_details( self, id: str, - select: Optional[str] = None, *, + select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Member License Details Retrieve group member(user)'s license details + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMemberLicenseDetails`. + + Args: + id: Object ID of the Microsoft Entra ID member(user). + select: Selection of data points(columns). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -565,29 +866,50 @@ async def get_member_license_details_async( query_params.append(f"$select={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_group_properties_async( + async def get_group_properties( self, group_id: str, *, @@ -600,13 +922,28 @@ async def get_group_properties_async( Get Group Properties Retrieve properties and relationships of an Microsoft Entra ID group + + Swagger operation ID: `GetGroupProperties`. + + Args: + group_id: Object ID of the Microsoft Entra ID group. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/groups/{quote(str(group_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -620,6 +957,7 @@ async def get_group_properties_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -627,43 +965,84 @@ async def get_group_properties_async( return json.loads(response.text) - async def get_member_groups_async( + def list_member_groups( self, - input: GetMemberGroupsInput, + input: GetMemberGroupsInput | Mapping[str, Any], member_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get Member Groups Group memberships for a user (member) + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMemberGroups`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + member_id: Object ID of the Microsoft Entra ID member(user). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/users/{quote(str(member_id), safe='')}/getMemberGroups" ) + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/office365.py b/src/azure/connectors/office365.py index 016fb850..2258bc6a 100644 --- a/src/azure/connectors/office365.py +++ b/src/azure/connectors/office365.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,131 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "Office365Client", + "ApprovalEmailResponse", + "ApprovalEmailSubscription", + "ApprovalMessage", + "AssignCategoryBulkInput", + "Attendee", + "AutomaticRepliesSettingClient", + "BatchItemFailureResult", + "BatchOperationResult", + "BatchResponseClientReceiveMessage", + "BatchResponseGraphClientReceiveMessage", + "BatchResponseSensitivityLabel", + "BlobDataSetsMetadata", + "CalendarEventBackend", + "CalendarEventClient", + "CalendarEventClientReceive", + "CalendarEventClientReceiveStringEnums", + "CalendarEventClientWithActionType", + "CalendarEventHtmlClient", + "CalendarEventList", + "CalendarEventListClientReceive", + "CalendarEventListWithActionType", + "CalendarGetTablesResponse", + "ClientReceiveFileAttachment", + "ClientReceiveMessage", + "ClientReceiveMessageStringEnums", + "ClientSendAttachment", + "ClientSendMessage", + "ClientSubscription", + "Contact", + "ContactResponse", + "DataSet", + "DataSetsList", + "DataSetsMetadata", + "DateTimeTimeZone", + "DirectForwardMessage", + "DraftEmailInput", + "EmailAddress", + "EmailAddressV2", + "EntityListResponseCalendarEventBackend", + "EntityListResponseCalendarEventClientReceiveStringEnums", + "EntityListResponseContactResponse", + "EntityListResponseFilePickerFile", + "EntityListResponseGraphCalendarEventClientReceive", + "EntityListResponseGraphContactFolder", + "EntityListResponseTable", + "FilePickerFile", + "FindMeetingTimesInput", + "FindMeetingTimesResponse", + "GeoCoordinates", + "GetAttachmentResponse", + "GetMailTipsInput", + "GetMailTipsResponse", + "GetRoomListsResponse", + "GetRoomsInRoomListResponse", + "GetRoomsResponse", + "GraphCalendarEventClient", + "GraphCalendarEventClientReceive", + "GraphCalendarEventClientWithActionType", + "GraphCalendarEventListClientReceive", + "GraphCalendarEventListWithActionType", + "GraphClientReceiveFileAttachment", + "GraphClientReceiveMessage", + "GraphContactFolder", + "GraphOutlookCategory", + "InternetMessageHeader", + "ItemBody", + "Location", + "LocationConstraint", + "MCPQueryRequest", + "MCPQueryResponse", + "MailTipsAutomaticReplies", + "MailTipsClientReceive", + "MarkAsReadInput", + "MeetingTimeSuggestions", + "MessageWithOptions", + "ObjectEntity", + "ObjectWithoutType", + "OptionsEmailSubscription", + "OutlookReceiveAttachment", + "OutlookReceiveMessage", + "PaginatedListResponseCalendarEventClientReceiveStringEnums", + "PassThroughNativeQuery", + "PatternedRecurrence", + "PhysicalAddress", + "Procedure", + "ReceiveMessageMetadata", + "Recipient", + "RecurrencePattern", + "RecurrenceRange", + "ReplyEmailInput", + "ReplyMessage", + "ResponseStatus", + "ResponseToEventInvite", + "SendEmailInput", + "SensitivityLabel", + "SensitivityLabelMetadata", + "SetAutomaticRepliesSettingInput", + "SetAutomaticRepliesSettingResponse", + "SharedMailboxClientSendMessage", + "SharedMailboxSendEmailInput", + "SubscriptionEvent", + "SubscriptionPayloadEntityOutlookReceiveMessage", + "SubscriptionPayloadEntitySubscriptionEvent", + "SubscriptionPayloadOutlookReceiveMessage", + "SubscriptionPayloadSubscriptionEvent", + "SubscriptionResponse", + "Table", + "TableCapabilitiesMetadata", + "TableFilterRestrictionsMetadata", + "TableMetadata", + "TableSelectRestrictionsMetadata", + "TableSortRestrictionsMetadata", + "TabularDataSetsMetadata", + "TriggerBatchResponseClientReceiveMessage", + "TriggerBatchResponseGraphClientReceiveMessage", + "TriggerBatchResponseReceiveMessageMetadata", + "UpdateEmailFlag", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,10 +153,11 @@ class GraphOutlookCategory: Response for Get Outlook category names """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the Outlook Category.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The display name of the Outlook Category.""" @@ -44,93 +169,119 @@ class OutlookReceiveMessage: Response for Draft an email message """ - internet_message_id: Optional[str] = field( + internet_message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InternetMessageId"}, ) """Internet Message Id""" - body_preview: Optional[str] = field( + body_preview: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BodyPreview"}, ) """Body preview""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Id""" - conversation_id: Optional[str] = field( + conversation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ConversationId"}, ) """Conversation Id""" - has_attachments: Optional[bool] = field( + has_attachments: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HasAttachments"}, ) """Has attachments""" - is_read: Optional[bool] = field( + is_read: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsRead"}, ) """Is read""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedDateTime"}, ) """Created date and time""" - received_date_time: Optional[str] = field( + received_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDateTime"}, ) """Received date and time""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModifiedDateTime"}, ) """Last modified date and time""" - attachments: Optional[List[OutlookReceiveAttachment]] = field( + attachments: Optional[ + List[OutlookReceiveAttachment | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - to_recipients: Optional[List[Recipient]] = field( + to_recipients: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ToRecipients"}, ) """To Recipient""" - cc_recipients: Optional[List[Recipient]] = field( + cc_recipients: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CcRecipients"}, ) """Cc Recipients""" - bcc_recipients: Optional[List[Recipient]] = field( + bcc_recipients: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BccRecipients"}, ) """Bcc Recipients""" - reply_to: Optional[List[Recipient]] = field( + reply_to: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Subject""" - body: Optional[ItemBody] = field( + body: Optional[ItemBody | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Body"}, ) - from_: Optional[Recipient] = field( + from_: Optional[Recipient | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "From"}, ) - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" - internet_message_headers: Optional[List[InternetMessageHeader]] = field( + internet_message_headers: Optional[ + List[InternetMessageHeader | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InternetMessageHeaders"}, ) """Internet message headers""" @@ -145,12 +296,18 @@ class BatchOperationResult: Response for Assign a category to multiple emails """ - success_count: Optional[int] = field( + success_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "successCount"}, ) """The count of messages processed successfully.""" - failures: Optional[List[BatchItemFailureResult]] = None + failures: Optional[ + List[BatchItemFailureResult | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of failed messages with errors.""" @@ -160,17 +317,19 @@ class SubscriptionResponse: Response for Send email with options """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the subscription""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """Resource of the subscription request""" - notification_type: Optional[str] = field( + notification_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationType"}, ) """Notification Type""" - notification_url: Optional[str] = field( + notification_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationUrl"}, ) """Notification Url""" @@ -182,7 +341,7 @@ class ObjectWithoutType: Response for Send an HTTP request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -195,12 +354,12 @@ class MCPQueryResponse: Response for Email Management MCP Server (deprecated) """ - jsonrpc: Optional[str] = None - id: Optional[str] = None - method: Optional[str] = None - params: Optional[Dict[str, Any]] = None - result: Optional[Dict[str, Any]] = None - error: Optional[Dict[str, Any]] = None + jsonrpc: Optional[str] = dataclass_field(default=None, kw_only=True) + id: Optional[str] = dataclass_field(default=None, kw_only=True) + method: Optional[str] = dataclass_field(default=None, kw_only=True) + params: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + result: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + error: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -209,153 +368,174 @@ class GraphCalendarEventClientReceive: Response for Get event """ - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """Event subject""" - start: Optional[str] = None + start: Optional[str] = dataclass_field(default=None, kw_only=True) """Start time of the event (example: '2017-08-29T04:00:00.0000000')""" - end: Optional[str] = None + end: Optional[str] = dataclass_field(default=None, kw_only=True) """End time of the event (example: '2017-08-29T05:00:00.0000000')""" - start_with_time_zone: Optional[str] = field( + start_with_time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startWithTimeZone"}, ) """ Start time of the event with time zone (example: '2017-08-29T04:00:00.0000000+00:00') """ - end_with_time_zone: Optional[str] = field( + end_with_time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endWithTimeZone"}, ) """ End time of the event with time zone (example: '2017-08-29T05:00:00.0000000+00:00') """ - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """Body of the message associated with the event""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isHtml"}, ) """Set to true if the body is Html""" - response_type: Optional[str] = field( + response_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseType"}, ) """ The response type of the event (none, organizer, tentativelyAccepted, accepted, declined or notResponded) """ - response_time: Optional[str] = field( + response_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseTime"}, ) """The response time of the event""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The event's unique identifier""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The date and time that the event was created""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """The date and time that the event was last modified""" - organizer: Optional[str] = None + organizer: Optional[str] = dataclass_field(default=None, kw_only=True) """The organizer of the event""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timeZone"}, ) """Time zone of the event""" - series_master_id: Optional[str] = field( + series_master_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "seriesMasterId"}, ) """Unique identifier for Series Master event type""" - i_cal_u_id: Optional[str] = field( + i_cal_u_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "iCalUId"}, ) """ A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series """ - categories: Optional[List[str]] = None + categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """The categories associated with the event""" - web_link: Optional[str] = field( + web_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webLink"}, ) """The URL to open the event in Outlook Web App""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "optionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """Location of the event""" - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """The importance of the event: low, normal, or high""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAllDay"}, ) """Set to true if the event lasts all day""" - recurrence: Optional[str] = None + recurrence: Optional[str] = dataclass_field(default=None, kw_only=True) """ The recurrence pattern for the event: none, daily, weekly, monthly or yearly """ - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recurrenceEnd"}, ) """End Date of the recurrence""" - number_of_occurences: Optional[int] = field( + number_of_occurences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "numberOfOccurences"}, ) """How many times to repeat the event""" - reminder_minutes_before_start: Optional[int] = field( + reminder_minutes_before_start: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderMinutesBeforeStart"}, ) """Time in minutes before event start to remind""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """Set to true if an alert is set to remind the user of the event.""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showAs"}, ) """ Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown """ - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseRequested"}, ) """ Set to true if the sender would like a response when the event is accepted or declined """ - sensitivity: Optional[str] = None + sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True) """The possible values are: normal, personal, private, confidential""" @@ -365,7 +545,12 @@ class GraphCalendarEventListClientReceive: Response for Get events """ - value: Optional[List[GraphCalendarEventClientReceive]] = None + value: Optional[ + List[GraphCalendarEventClientReceive | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of calendar items""" @@ -375,7 +560,12 @@ class GraphCalendarEventListWithActionType: Response for When an event is added, updated or deleted """ - value: Optional[List[GraphCalendarEventClientWithActionType]] = None + value: Optional[ + List[GraphCalendarEventClientWithActionType | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of calendar items""" @@ -385,7 +575,7 @@ class CalendarGetTablesResponse: Response for Get calendars """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -395,145 +585,170 @@ class ContactResponse: Response for Get contact """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's unique identifier.""" - parent_folder_id: Optional[str] = field( + parent_folder_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentFolderId"}, ) """The ID of the contact's parent folder""" - birthday: Optional[str] = None + birthday: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's birthday""" - file_as: Optional[str] = field( + file_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fileAs"}, ) """The name the contact is filed under""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The contact's display name""" - given_name: Optional[str] = field( + given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "givenName"}, ) """The contact's given name""" - initials: Optional[str] = None + initials: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's initials""" - middle_name: Optional[str] = field( + middle_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "middleName"}, ) """The contact's middle name""" - nick_name: Optional[str] = field( + nick_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nickName"}, ) """The contact's nickname""" - surname: Optional[str] = None + surname: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's surname""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's title""" - generation: Optional[str] = None + generation: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's generation""" - email_addresses: Optional[List[EmailAddressV2]] = field( + email_addresses: Optional[List[EmailAddressV2 | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "emailAddresses"}, ) """The contact's email addresses""" - im_addresses: Optional[List[str]] = field( + im_addresses: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "imAddresses"}, ) """The contact's instant messaging (IM) addresses""" - job_title: Optional[str] = field( + job_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobTitle"}, ) """The contact's job title""" - company_name: Optional[str] = field( + company_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "companyName"}, ) """The name of the contact's company""" - department: Optional[str] = None + department: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's department""" - office_location: Optional[str] = field( + office_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "officeLocation"}, ) """The location of the contact's office""" - profession: Optional[str] = None + profession: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's profession""" - business_home_page: Optional[str] = field( + business_home_page: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "businessHomePage"}, ) """The business home page of the contact""" - assistant_name: Optional[str] = field( + assistant_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assistantName"}, ) """The name of the contact's assistant""" - manager: Optional[str] = None + manager: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the contact's manager""" - home_phones: Optional[List[str]] = field( + home_phones: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "homePhones"}, ) """The contact's home phone numbers""" - business_phones: Optional[List[str]] = field( + business_phones: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "businessPhones"}, ) """The contact's business phone numbers""" - mobile_phone: Optional[str] = field( + mobile_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mobilePhone"}, ) """The contact's mobile phone number""" - home_address: Optional[PhysicalAddress] = field( + home_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "homeAddress"}, ) - business_address: Optional[PhysicalAddress] = field( + business_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "businessAddress"}, ) - other_address: Optional[PhysicalAddress] = field( + other_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "otherAddress"}, ) - yomi_company_name: Optional[str] = field( + yomi_company_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "yomiCompanyName"}, ) """The phonetic Japanese company name of the contact""" - yomi_given_name: Optional[str] = field( + yomi_given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "yomiGivenName"}, ) """The phonetic Japanese given name (first name) of the contact""" - yomi_surname: Optional[str] = field( + yomi_surname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "yomiSurname"}, ) """The phonetic Japanese surname (last name) of the contact""" - categories: Optional[List[str]] = None + categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """The categories associated with the contact""" - change_key: Optional[str] = field( + change_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "changeKey"}, ) """Identifies the version of the event object""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The time the contact was created""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """The time the contact was modified""" @@ -545,10 +760,16 @@ class EntityListResponseContactResponse: Response for Get contacts """ - value: Optional[List[ContactResponse]] = None + value: Optional[ + List[ContactResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -560,7 +781,12 @@ class EntityListResponseGraphContactFolder: Response for Get contact folders """ - value: Optional[List[GraphContactFolder]] = None + value: Optional[ + List[GraphContactFolder | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -570,50 +796,66 @@ class FindMeetingTimesInput: Find meeting times """ - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequiredAttendees"}, ) """List of semicolon separated email addresses""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OptionalAttendees"}, ) """List of semicolon separated email addresses""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - meeting_duration: Optional[int] = field( + meeting_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MeetingDuration"}, ) """Duration of the meeting in minutes""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Start"}, + ) """Start time for meeting time suggestions""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "End"}, + ) """End time for meeting time suggestions""" - max_candidates: Optional[int] = field( + max_candidates: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MaxCandidates"}, ) """The maximum number of meeting suggestions to return in the response""" - minimum_attendee_percentage: Optional[str] = field( + minimum_attendee_percentage: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MinimumAttendeePercentage"}, ) """ The minimum required confidence for a time slot to be returned in the response """ - is_organizer_optional: Optional[bool] = field( + is_organizer_optional: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsOrganizerOptional"}, ) """true if the organizer doesn't have to attend. The default is false""" - activity_domain: Optional[str] = field( + activity_domain: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActivityDomain"}, ) """Work, Personal, Unrestricted, or Unknown""" @@ -625,13 +867,15 @@ class FindMeetingTimesResponse: Response for Find meeting times """ - empty_suggestions_reason: Optional[str] = field( + empty_suggestions_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "emptySuggestionsReason"}, ) """Empty Suggestions Reason""" - meeting_time_suggestions: Optional[MeetingTimeSuggestions] = field( + meeting_time_suggestions: Optional[MeetingTimeSuggestions] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingTimeSuggestions"}, ) @@ -642,39 +886,47 @@ class GetAttachmentResponse: Response for Get Attachment """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the attachment.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of attachment.""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """Content type of attachment.""" - size: Optional[int] = None + size: Optional[int] = dataclass_field(default=None, kw_only=True) """Size of attachment.""" - content_bytes: Optional[str] = field( + content_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentBytes"}, ) """Content of attachment.""" - is_inline: Optional[bool] = field( + is_inline: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isInline"}, ) """Set to true if this is an inline attachment.""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """The date and time when the attachment was last modified.""" - content_id: Optional[str] = field( + content_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentId"}, ) """Content Id""" - sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field( + sensitivity_label_info: Optional[ + List[SensitivityLabelMetadata | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelInfo"}, ) @@ -685,75 +937,98 @@ class GraphClientReceiveMessage: Response for Get email """ - from_: Optional[str] = field(default=None, metadata={"wire_name": "from"}) + from_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "from"}, + ) """The mailbox owner and sender of the message""" - to_recipients: Optional[str] = field( + to_recipients: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "toRecipients"}, ) """The recipients for the message""" - cc_recipients: Optional[str] = field( + cc_recipients: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ccRecipients"}, ) """The Cc recipients for the message""" - bcc_recipients: Optional[str] = field( + bcc_recipients: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "bccRecipients"}, ) """The Bcc recipients for the message""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "replyTo"}, ) """The email addresses to use when replying""" - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """The subject of the message""" - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """The body of the message""" - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """The importance of the message (low, normal, high)""" - body_preview: Optional[str] = field( + body_preview: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "bodyPreview"}, ) """The preview of the message""" - has_attachments: Optional[bool] = field( + has_attachments: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasAttachments"}, ) """Indicates whether the message has attachments""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique identifier of the message""" - internet_message_id: Optional[str] = field( + internet_message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "internetMessageId"}, ) """The message ID in the format specified by RFC2822""" - conversation_id: Optional[str] = field( + conversation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "conversationId"}, ) """The Id of the conversation the email belongs to""" - received_date_time: Optional[str] = field( + received_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "receivedDateTime"}, ) """The date and time the message was received""" - is_read: Optional[bool] = field( + is_read: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isRead"}, ) """Indicates whether the message has been read""" - attachments: Optional[List[GraphClientReceiveFileAttachment]] = None + attachments: Optional[ + List[GraphClientReceiveFileAttachment | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The file attachments for the message""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isHtml"}, ) """Is Html?""" - sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field( + sensitivity_label_info: Optional[ + List[SensitivityLabelMetadata | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelInfo"}, ) @@ -764,7 +1039,12 @@ class BatchResponseGraphClientReceiveMessage: Response for Get emails """ - value: Optional[List[GraphClientReceiveMessage]] = None + value: Optional[ + List[GraphClientReceiveMessage | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of the response objects""" @@ -774,7 +1054,12 @@ class EntityListResponseGraphCalendarEventClientReceive: Response for Get calendar view of events """ - value: Optional[List[GraphCalendarEventClientReceive]] = None + value: Optional[ + List[GraphCalendarEventClientReceive | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -784,13 +1069,11 @@ class GetMailTipsInput: Get mail tips for a mailbox """ - mail_tips_options: Optional[str] = field( - default=None, + mail_tips_options: str = dataclass_field( metadata={"wire_name": "MailTipsOptions"}, ) """Flags that represents the mailtips.""" - email_addresses: Optional[List[str]] = field( - default=None, + email_addresses: List[str] = dataclass_field( metadata={"wire_name": "EmailAddresses"}, ) """Address of the mailbox to get mail tips for.""" @@ -802,7 +1085,12 @@ class GetMailTipsResponse: Response for Get mail tips for a mailbox """ - value: Optional[List[MailTipsClientReceive]] = None + value: Optional[ + List[MailTipsClientReceive | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -811,7 +1099,7 @@ class GetRoomListsResponse: Response for Get room lists """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -821,7 +1109,7 @@ class GetRoomsResponse: Response for Get rooms """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -831,7 +1119,7 @@ class GetRoomsInRoomListResponse: Response for Get rooms in room list """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -841,10 +1129,7 @@ class MarkAsReadInput: Mark as read or unread """ - is_read: Optional[bool] = field( - default=None, - metadata={"wire_name": "isRead"}, - ) + is_read: bool = dataclass_field(metadata={"wire_name": "isRead"}) """Mark as read/unread.""" @@ -854,7 +1139,12 @@ class TriggerBatchResponseGraphClientReceiveMessage: Response for When an email is flagged """ - value: Optional[List[GraphClientReceiveMessage]] = None + value: Optional[ + List[GraphClientReceiveMessage | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of the response objects""" @@ -864,8 +1154,11 @@ class SetAutomaticRepliesSettingInput: Set up automatic replies """ - automatic_replies_setting: Optional[AutomaticRepliesSettingClient] = field( + automatic_replies_setting: Optional[ + AutomaticRepliesSettingClient | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "automaticRepliesSetting"}, ) @@ -876,8 +1169,11 @@ class SetAutomaticRepliesSettingResponse: Response for Set up automatic replies """ - automatic_replies_setting: Optional[AutomaticRepliesSettingClient] = field( + automatic_replies_setting: Optional[ + AutomaticRepliesSettingClient | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "automaticRepliesSetting"}, ) @@ -888,26 +1184,30 @@ class TableMetadata: Definition: TableMetadata """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Table name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Table title""" - x_ms_permission: Optional[str] = field( + x_ms_permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-permission"}, ) """Table permission""" - x_ms_capabilities: Optional[TableCapabilitiesMetadata] = field( + x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-capabilities"}, ) - schema: Optional[ObjectEntity] = None - referenced_entities: Optional[ObjectEntity] = field( + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referencedEntities"}, ) - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """Url link""" @@ -919,30 +1219,42 @@ class TableCapabilitiesMetadata: Definition: TableCapabilitiesMetadata """ - sort_restrictions: Optional[TableSortRestrictionsMetadata] = field( + sort_restrictions: Optional[ + TableSortRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortRestrictions"}, ) - filter_restrictions: Optional[TableFilterRestrictionsMetadata] = field( + filter_restrictions: Optional[ + TableFilterRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterRestrictions"}, ) - select_restrictions: Optional[TableSelectRestrictionsMetadata] = field( + select_restrictions: Optional[ + TableSelectRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectRestrictions"}, ) - is_only_server_pagable: Optional[bool] = field( + is_only_server_pagable: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOnlyServerPagable"}, ) """Server paging restrictions""" - filter_function_support: Optional[List[str]] = field( + filter_function_support: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterFunctionSupport"}, ) """List of supported filter capabilities""" - server_paging_options: Optional[List[str]] = field( + server_paging_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serverPagingOptions"}, ) """List of supported server-driven paging capabilities""" @@ -954,7 +1266,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -967,15 +1279,17 @@ class TableSortRestrictionsMetadata: Definition: TableSortRestrictionsMetadata """ - sortable: Optional[bool] = None + sortable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has sortable columns""" - unsortable_properties: Optional[List[str]] = field( + unsortable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unsortableProperties"}, ) """List of unsortable properties""" - ascending_only_properties: Optional[List[str]] = field( + ascending_only_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ascendingOnlyProperties"}, ) """List of properties which support ascending order only""" @@ -987,15 +1301,17 @@ class TableFilterRestrictionsMetadata: Definition: TableFilterRestrictionsMetadata """ - filterable: Optional[bool] = None + filterable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has filterable columns""" - non_filterable_properties: Optional[List[str]] = field( + non_filterable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nonFilterableProperties"}, ) """List of non filterable properties""" - required_properties: Optional[List[str]] = field( + required_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredProperties"}, ) """List of required properties""" @@ -1007,7 +1323,7 @@ class TableSelectRestrictionsMetadata: Definition: TableSelectRestrictionsMetadata """ - selectable: Optional[bool] = None + selectable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has selectable columns""" @@ -1017,7 +1333,12 @@ class CalendarEventList: Definition: CalendarEventList """ - value: Optional[List[CalendarEventBackend]] = None + value: Optional[ + List[CalendarEventBackend | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of calendar items""" @@ -1027,153 +1348,183 @@ class CalendarEventBackend: Definition: CalendarEventBackend """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The Event's unique identifier""" - attendees: Optional[List[Attendee]] = field( + attendees: Optional[List[Attendee | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attendees"}, ) """List of attendees for the event""" - body: Optional[ItemBody] = field( + body: Optional[ItemBody | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Body"}, ) - body_preview: Optional[str] = field( + body_preview: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BodyPreview"}, ) """The preview of the message associated with the event""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """The categories associated with the event""" - change_key: Optional[str] = field( + change_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChangeKey"}, ) """ This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well. """ - date_time_created: Optional[str] = field( + date_time_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeCreated"}, ) """The date and time that the event was created""" - date_time_last_modified: Optional[str] = field( + date_time_last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeLastModified"}, ) """The date and time that the event was last modified""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: str = dataclass_field(metadata={"wire_name": "End"}) """The end time of the event""" - end_time_zone: Optional[str] = field( + end_time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndTimeZone"}, ) """ This property specifies the time zone of the meeting end time. The value must be as defined in Windows (example: 'Pacific Standard Time'). """ - has_attachments: Optional[bool] = field( + has_attachments: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HasAttachments"}, ) """Set to true if the event has attachments""" - i_cal_u_id: Optional[str] = field( + i_cal_u_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ICalUId"}, ) """ A unique identifier that is shared by all instances of an event across different calendars """ - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event: Low, Normal, or High""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - is_cancelled: Optional[bool] = field( + is_cancelled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsCancelled"}, ) """Set to true if the event has been canceled""" - is_organizer: Optional[bool] = field( + is_organizer: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsOrganizer"}, ) """Set to true if the message sender is also the organizer""" - location: Optional[Location] = field( + location: Optional[Location | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) - organizer: Optional[Recipient] = field( + organizer: Optional[Recipient | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Organizer"}, ) - recurrence: Optional[PatternedRecurrence] = field( + recurrence: Optional[PatternedRecurrence | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ Set to true if the sender would like a response when the event is accepted or declined """ - response_status: Optional[ResponseStatus] = field( + response_status: Optional[ResponseStatus | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseStatus"}, ) - series_master_id: Optional[str] = field( + series_master_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SeriesMasterId"}, ) """Unique identifier for Series Master event type""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """Shows as free or busy""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: str = dataclass_field(metadata={"wire_name": "Start"}) """The start time of the event""" - start_time_zone: Optional[str] = field( + start_time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartTimeZone"}, ) """ This property specifies the time zone of the meeting start time. The value must be as defined in Windows (example: 'Pacific Standard Time'). """ - subject: Optional[str] = field( + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) + """Event subject""" + type_: Optional[str] = dataclass_field( default=None, - metadata={"wire_name": "Subject"}, + kw_only=True, + metadata={"wire_name": "Type"}, ) - """Event subject""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) """ The event type: Single Instance, Occurrence, Exception, or Series Master """ - web_link: Optional[str] = field( + web_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebLink"}, ) """The preview of the message associated with the event""" - reason: Optional[str] = field( + reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reason"}, ) """ @@ -1188,13 +1539,19 @@ class Attendee: Definition: Attendee """ - status: Optional[ResponseStatus] = field( + status: Optional[ResponseStatus | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Status"}, ) - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) - email_address: Optional[EmailAddress] = field( + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) + email_address: Optional[EmailAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmailAddress"}, ) @@ -1205,12 +1562,14 @@ class ItemBody: Definition: ItemBody """ - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentType"}, ) - content: Optional[str] = field( + content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Content"}, ) @@ -1221,16 +1580,19 @@ class Location: Definition: Location """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) - address: Optional[PhysicalAddress] = field( + address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Address"}, ) - coordinates: Optional[GeoCoordinates] = field( + coordinates: Optional[GeoCoordinates | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Coordinates"}, ) @@ -1241,8 +1603,9 @@ class Recipient: Definition: Recipient """ - email_address: Optional[EmailAddress] = field( + email_address: Optional[EmailAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmailAddress"}, ) @@ -1253,12 +1616,14 @@ class PatternedRecurrence: Definition: PatternedRecurrence """ - pattern: Optional[RecurrencePattern] = field( + pattern: Optional[RecurrencePattern | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Pattern"}, ) - range: Optional[RecurrenceRange] = field( + range: Optional[RecurrenceRange | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Range"}, ) @@ -1269,11 +1634,16 @@ class ResponseStatus: Definition: ResponseStatus """ - response: Optional[str] = field( + response: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Response"}, ) - time: Optional[str] = field(default=None, metadata={"wire_name": "Time"}) + time: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Time"}, + ) @dataclass @@ -1282,9 +1652,14 @@ class EmailAddress: Definition: EmailAddress """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) - address: Optional[str] = field( + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) + address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Address"}, ) @@ -1295,24 +1670,29 @@ class GeoCoordinates: Definition: GeoCoordinates """ - altitude: Optional[float] = field( + altitude: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Altitude"}, ) - latitude: Optional[float] = field( + latitude: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Latitude"}, ) - longitude: Optional[float] = field( + longitude: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Longitude"}, ) - accuracy: Optional[float] = field( + accuracy: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Accuracy"}, ) - altitude_accuracy: Optional[float] = field( + altitude_accuracy: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AltitudeAccuracy"}, ) @@ -1323,25 +1703,41 @@ class RecurrencePattern: Definition: RecurrencePattern """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) - interval: Optional[int] = field( + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) + interval: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Interval"}, ) - month: Optional[int] = field(default=None, metadata={"wire_name": "Month"}) - day_of_month: Optional[int] = field( + month: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Month"}, + ) + day_of_month: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DayOfMonth"}, ) - days_of_week: Optional[List[str]] = field( + days_of_week: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DaysOfWeek"}, ) - first_day_of_week: Optional[str] = field( + first_day_of_week: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FirstDayOfWeek"}, ) - index: Optional[str] = field(default=None, metadata={"wire_name": "Index"}) + index: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Index"}, + ) @dataclass @@ -1350,17 +1746,24 @@ class RecurrenceRange: Definition: RecurrenceRange """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) - start_date: Optional[str] = field( + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDate"}, ) - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndDate"}, ) - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) @@ -1371,7 +1774,12 @@ class CalendarEventListClientReceive: Definition: CalendarEventListClientReceive """ - value: Optional[List[CalendarEventClientReceive]] = None + value: Optional[ + List[CalendarEventClientReceive | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of calendar items""" @@ -1381,143 +1789,183 @@ class CalendarEventClientReceive: Definition: CalendarEventClientReceive """ - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Event subject""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Start"}, + ) """Start time of the event (example: '2016-11-01T14:30:00Z')""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "End"}, + ) """End time of the event (example: '2016-11-01T15:30:00Z')""" - show_as: Optional[int] = field( + show_as: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """ Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4) """ - recurrence: Optional[int] = field( + recurrence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) """ The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4) """ - response_type: Optional[int] = field( + response_type: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseType"}, ) """ The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5) """ - response_time: Optional[str] = field( + response_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseTime"}, ) """The response time of the event""" - i_cal_u_id: Optional[str] = field( + i_cal_u_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ICalUId"}, ) """ A unique identifier that is shared by all instances of an event across different calendars """ - importance: Optional[int] = field( + importance: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event (0 - Low, 1 - Normal, 2 - High)""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The event's unique identifier""" - date_time_created: Optional[str] = field( + date_time_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeCreated"}, ) """The date and time that the event was created""" - date_time_last_modified: Optional[str] = field( + date_time_last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeLastModified"}, ) """The date and time that the event was last modified""" - organizer: Optional[str] = field( + organizer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Organizer"}, ) """The organizer of the event""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeZone"}, ) """Time zone of the event""" - series_master_id: Optional[str] = field( + series_master_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SeriesMasterId"}, ) """Unique identifier for Series Master event type""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """The categories associated with the event""" - web_link: Optional[str] = field( + web_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebLink"}, ) """The URL to open the event in Outlook Web App""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OptionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the message associated with the event""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Set to true if the body is Html""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location of the event""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecurrenceEnd"}, ) """End time of the recurrence""" - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) """How many times to repeat the event""" - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ @@ -1532,8 +1980,11 @@ class PaginatedListResponseCalendarEventClientReceiveStringEnums: Definition: PaginatedListResponse[CalendarEventClientReceiveStringEnums] """ - values: Optional[List[CalendarEventClientReceiveStringEnums]] = field( + values: Optional[ + List[CalendarEventClientReceiveStringEnums | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Values"}, ) """Values""" @@ -1545,137 +1996,177 @@ class CalendarEventClientReceiveStringEnums: Definition: CalendarEventClientReceiveStringEnums """ - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event: Low, Normal, or High""" - response_type: Optional[str] = field( + response_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseType"}, ) """ The response type of the event: None, Organizer, TentativelyAccepted, Accepted, Declined or NotResponded """ - recurrence: Optional[str] = field( + recurrence: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) """The recurrence pattern for the event""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """Status to show during the event""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Event subject""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Start"}, + ) """Start time of the event (example: '2016-11-01T14:30:00Z')""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "End"}, + ) """End time of the event (example: '2016-11-01T15:30:00Z')""" - response_time: Optional[str] = field( + response_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseTime"}, ) """The response time of the event""" - i_cal_u_id: Optional[str] = field( + i_cal_u_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ICalUId"}, ) """ A unique identifier that is shared by all instances of an event across different calendars """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The event's unique identifier""" - date_time_created: Optional[str] = field( + date_time_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeCreated"}, ) """The date and time that the event was created""" - date_time_last_modified: Optional[str] = field( + date_time_last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeLastModified"}, ) """The date and time that the event was last modified""" - organizer: Optional[str] = field( + organizer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Organizer"}, ) """The organizer of the event""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeZone"}, ) """Time zone of the event""" - series_master_id: Optional[str] = field( + series_master_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SeriesMasterId"}, ) """Unique identifier for Series Master event type""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """The categories associated with the event""" - web_link: Optional[str] = field( + web_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebLink"}, ) """The URL to open the event in Outlook Web App""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OptionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the message associated with the event""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Set to true if the body is Html""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location of the event""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecurrenceEnd"}, ) """End time of the recurrence""" - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) """How many times to repeat the event""" - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ @@ -1690,8 +2181,7 @@ class ClientSubscription: Definition: ClientSubscription """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "NotificationUrl"}, ) """ @@ -1706,7 +2196,12 @@ class EntityListResponseFilePickerFile: Definition: EntityListResponse[FilePickerFile] """ - value: Optional[List[FilePickerFile]] = None + value: Optional[ + List[FilePickerFile | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -1716,19 +2211,29 @@ class FilePickerFile: Definition: FilePickerFile """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Uniquely identifies the file""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Display name for the file""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """Set to true if the file is a folder""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """Path of the file""" @@ -1738,54 +2243,68 @@ class ClientSendMessage: Definition: ClientSendMessage """ - from_: Optional[str] = field(default=None, metadata={"wire_name": "From"}) + from_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "From"}, + ) """ Email address to send mail from (requires \"Send as\" or \"Send on behalf of\" permission for that mailbox). For more info on granting permissions please refer https://docs.microsoft.com/office365/admin/manage/send-email-as-distribution-list """ - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: str = dataclass_field(metadata={"wire_name": "To"}) """ Specify email addresses separated by semicolons like someone@contoso.com """ - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Specify the subject of the mail""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: str = dataclass_field(metadata={"wire_name": "Body"}) """Specify the body of the mail""" - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - sensitivity: Optional[str] = field( + sensitivity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sensitivity"}, ) """Sensitivity""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Is Html?""" @@ -1797,10 +2316,9 @@ class ClientSendAttachment: Definition: ClientSendAttachment """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: str = dataclass_field(metadata={"wire_name": "Name"}) """Attachment name""" - content_bytes: Optional[str] = field( - default=None, + content_bytes: str = dataclass_field( metadata={"wire_name": "ContentBytes"}, ) """Attachment content""" @@ -1812,70 +2330,107 @@ class ClientReceiveMessageStringEnums: Definition: ClientReceiveMessageStringEnums """ - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the message""" - from_: Optional[str] = field(default=None, metadata={"wire_name": "From"}) + from_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "From"}, + ) """The mailbox owner and sender of the message""" - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """The recipients for the message""" - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """The Cc recipients for the message""" - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """The Bcc recipients for the message""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """The subject of the message""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """The body of the message""" - body_preview: Optional[str] = field( + body_preview: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BodyPreview"}, ) """The preview of the message""" - has_attachment: Optional[bool] = field( + has_attachment: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HasAttachment"}, ) """Indicates whether the message has attachments""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique identifier of the message""" - internet_message_id: Optional[str] = field( + internet_message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InternetMessageId"}, ) """The message ID in the format specified by RFC2822""" - conversation_id: Optional[str] = field( + conversation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ConversationId"}, ) """The Id of the conversation the email belongs to""" - date_time_received: Optional[str] = field( + date_time_received: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeReceived"}, ) """The date and time the message was received""" - is_read: Optional[bool] = field( + is_read: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsRead"}, ) """Indicates whether the message has been read""" - attachments: Optional[List[ClientReceiveFileAttachment]] = field( + attachments: Optional[ + List[ClientReceiveFileAttachment | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """The file attachments for the message""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Is Html?""" @@ -1887,34 +2442,51 @@ class ClientReceiveFileAttachment: Definition: ClientReceiveFileAttachment """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Attachment Id""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Attachment name""" - content_bytes: Optional[str] = field( + content_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentBytes"}, ) """Attachment content""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentType"}, ) """Attachment content type""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size in bytes of the attachment""" - is_inline: Optional[bool] = field( + is_inline: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsInline"}, ) """Set to true if this is an inline attachment""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModifiedDateTime"}, ) """The date and time when the attachment was last modified""" - content_id: Optional[str] = field( + content_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentId"}, ) """Content Id""" @@ -1926,49 +2498,62 @@ class SendEmailInput: Definition: ClientSendHtmlMessage """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: str = dataclass_field(metadata={"wire_name": "To"}) """ Specify email addresses separated by semicolons like someone@contoso.com """ - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Specify the subject of the mail""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: str = dataclass_field(metadata={"wire_name": "Body"}) """Specify the body of the mail""" - from_: Optional[str] = field(default=None, metadata={"wire_name": "From"}) + from_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "From"}, + ) """ Email address to send mail from (requires \"Send as\" or \"Send on behalf of\" permission for that mailbox). For more info on granting permissions please refer https://docs.microsoft.com/office365/admin/manage/send-email-as-distribution-list """ - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - sensitivity: Optional[str] = field( + sensitivity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sensitivity"}, ) """Sensitivity""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" @@ -1980,49 +2565,62 @@ class DraftEmailInput: Definition: ClientDraftHtmlMessage """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: str = dataclass_field(metadata={"wire_name": "To"}) """ Specify email addresses separated by semicolons like someone@contoso.com """ - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Specify the subject of the mail""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: str = dataclass_field(metadata={"wire_name": "Body"}) """Specify the body of the mail""" - from_: Optional[str] = field(default=None, metadata={"wire_name": "From"}) + from_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "From"}, + ) """ Email address to send mail from (requires \"Send as\" or \"Send on behalf of\" permission for that mailbox). For more info on granting permissions please refer https://docs.microsoft.com/office365/admin/manage/send-email-as-distribution-list """ - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - sensitivity: Optional[str] = field( + sensitivity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sensitivity"}, ) """Sensitivity""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" @@ -2034,12 +2632,17 @@ class BatchItemFailureResult: Definition: BatchItemFailureResult """ - message_id: Optional[str] = field( + message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageId"}, ) """The ID of the failed message.""" - error: Optional[str] = field(default=None, metadata={"wire_name": "Error"}) + error: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Error"}, + ) """The error message of the failure.""" @@ -2049,7 +2652,12 @@ class BatchResponseClientReceiveMessage: Definition: BatchResponse[ClientReceiveMessage] """ - value: Optional[List[ClientReceiveMessage]] = None + value: Optional[ + List[ClientReceiveMessage | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of the response objects""" @@ -2059,70 +2667,107 @@ class ClientReceiveMessage: Definition: ClientReceiveMessage """ - from_: Optional[str] = field(default=None, metadata={"wire_name": "From"}) + from_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "From"}, + ) """The mailbox owner and sender of the message""" - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """The recipients for the message""" - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """The Cc recipients for the message""" - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """The Bcc recipients for the message""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """The subject of the message""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """The body of the message""" - importance: Optional[int] = field( + importance: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the message (0 - Low, 1 - Normal, 2 - High)""" - body_preview: Optional[str] = field( + body_preview: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BodyPreview"}, ) """The preview of the message""" - has_attachment: Optional[bool] = field( + has_attachment: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HasAttachment"}, ) """Indicates whether the message has attachments""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique identifier of the message""" - internet_message_id: Optional[str] = field( + internet_message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InternetMessageId"}, ) """The message ID in the format specified by RFC2822""" - conversation_id: Optional[str] = field( + conversation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ConversationId"}, ) """The Id of the conversation the email belongs to""" - date_time_received: Optional[str] = field( + date_time_received: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeReceived"}, ) """The date and time the message was received""" - is_read: Optional[bool] = field( + is_read: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsRead"}, ) """Indicates whether the message has been read""" - attachments: Optional[List[ClientReceiveFileAttachment]] = field( + attachments: Optional[ + List[ClientReceiveFileAttachment | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """The file attachments for the message""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Is Html?""" @@ -2134,34 +2779,39 @@ class GraphClientReceiveFileAttachment: Definition: GraphClientReceiveFileAttachment """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Attachment Id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Attachment name""" - content_bytes: Optional[str] = field( + content_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentBytes"}, ) """Attachment content""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """Attachment content type""" - size: Optional[int] = None + size: Optional[int] = dataclass_field(default=None, kw_only=True) """The size in bytes of the attachment""" - is_inline: Optional[bool] = field( + is_inline: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isInline"}, ) """Set to true if this is an inline attachment""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """The date and time when the attachment was last modified""" - content_id: Optional[str] = field( + content_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentId"}, ) """Content Id""" @@ -2173,36 +2823,57 @@ class ReplyMessage: Definition: ReplyMessage """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Email subject (if empty, the original subject used).""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Content of the email.""" - reply_all: Optional[bool] = field( + reply_all: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyAll"}, ) """True to reply to all recipients. (default: False)""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """True to send the reply as HTML. (default: True)""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Pick an importance. (default: Low)""" - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Details of attachments to be sent along with the reply.""" @@ -2214,31 +2885,51 @@ class ReplyEmailInput: Definition: ReplyHtmlMessage """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Email subject (if empty, the original subject used).""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Content of the email.""" - reply_all: Optional[bool] = field( + reply_all: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyAll"}, ) """True to reply to all recipients. (default: False)""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Pick an importance. (default: Low)""" - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Details of attachments to be sent along with the reply.""" @@ -2250,7 +2941,12 @@ class TriggerBatchResponseClientReceiveMessage: Definition: TriggerBatchResponse[ClientReceiveMessage] """ - value: Optional[List[ClientReceiveMessage]] = None + value: Optional[ + List[ClientReceiveMessage | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of the response objects""" @@ -2260,7 +2956,12 @@ class BatchResponseSensitivityLabel: Definition: BatchResponse[SensitivityLabel] """ - value: Optional[List[SensitivityLabel]] = None + value: Optional[ + List[SensitivityLabel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of the response objects""" @@ -2270,20 +2971,27 @@ class SensitivityLabel: Definition: SensitivityLabel """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Gets or sets the identifier.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Gets or sets the display name.""" - applicable_to: Optional[str] = field( + applicable_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApplicableTo"}, ) """Gets or sets the applicable to.""" - sub_labels: Optional[List[SensitivityLabel]] = field( + sub_labels: Optional[List[SensitivityLabel | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SubLabels"}, ) """Gets or sets sub labels.""" @@ -2295,7 +3003,12 @@ class TriggerBatchResponseReceiveMessageMetadata: Definition: TriggerBatchResponse[ReceiveMessageMetadata] """ - value: Optional[List[ReceiveMessageMetadata]] = None + value: Optional[ + List[ReceiveMessageMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of the response objects""" @@ -2305,43 +3018,69 @@ class ReceiveMessageMetadata: Definition: ReceiveMessageMetadata """ - from_: Optional[str] = field(default=None, metadata={"wire_name": "From"}) + from_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "From"}, + ) """The mailbox owner and sender of the message""" - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """The recipients for the message""" - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """The Cc recipients for the message""" - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """The Bcc recipients for the message""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """The subject of the message""" - importance: Optional[int] = field( + importance: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the message (0 - Low, 1 - Normal, 2 - High)""" - has_attachment: Optional[bool] = field( + has_attachment: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HasAttachment"}, ) """Indicates whether the message has attachments""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique identifier of the message""" - date_time_received: Optional[str] = field( + date_time_received: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeReceived"}, ) """The date and time the message was received""" - is_read: Optional[bool] = field( + is_read: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsRead"}, ) """Indicates whether the message has been read""" @@ -2353,8 +3092,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -2363,25 +3112,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -2393,15 +3146,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -2413,15 +3168,13 @@ class OptionsEmailSubscription: Definition: OptionsEmailSubscription """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "NotificationUrl"}, ) """ Gets or sets callback url to flow engine. It is expected as part of request """ - message: Optional[MessageWithOptions] = field( - default=None, + message: MessageWithOptions | Mapping[str, Any] = dataclass_field( metadata={"wire_name": "Message"}, ) @@ -2432,49 +3185,61 @@ class MessageWithOptions: Definition: MessageWithOptions """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: str = dataclass_field(metadata={"wire_name": "To"}) """ Specify email addresses separated by semicolons like someone@contoso.com """ - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Subject of the email""" - options: Optional[str] = field( + options: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Options"}, ) """List of comma separated options for the email response""" - header_text: Optional[str] = field( + header_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HeaderText"}, ) """Header text for email body""" - selection_text: Optional[str] = field( + selection_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SelectionText"}, ) """Header text for users options selection""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the email""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - use_only_h_t_m_l_message: Optional[bool] = field( + use_only_h_t_m_l_message: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UseOnlyHTMLMessage"}, ) """Use only HTML message""" - hide_h_t_m_l_message: Optional[bool] = field( + hide_h_t_m_l_message: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HideHTMLMessage"}, ) """ @@ -2482,16 +3247,18 @@ class MessageWithOptions: displayed. Email clients which do not support actionable messages will display HTML message regardless of the parameter value. """ - show_h_t_m_l_confirmation_dialog: Optional[bool] = field( + show_h_t_m_l_confirmation_dialog: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowHTMLConfirmationDialog"}, ) """ If set to Yes then a dialog wil be shown to confirm selected option of HTML message """ - hide_microsoft_footer: Optional[bool] = field( + hide_microsoft_footer: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HideMicrosoftFooter"}, ) """If set to Yes, then the Microsoft footer is hidden in the email body.""" @@ -2503,13 +3270,15 @@ class ApprovalEmailResponse: Definition: ApprovalEmailResponse """ - selected_option: Optional[str] = field( + selected_option: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SelectedOption"}, ) """User response""" - user_email_address: Optional[str] = field( + user_email_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserEmailAddress"}, ) """ @@ -2517,16 +3286,18 @@ class ApprovalEmailResponse: users and user ID for the members in Distribution Group or Mail Enabled Security Group. """ - user_tenant_id: Optional[str] = field( + user_tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserTenantId"}, ) """ User tenant ID. The value is the tenant id of the user for both individual users and the members in Distribution Group or Mail Enabled Security Group. """ - user_id: Optional[str] = field( + user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserId"}, ) """ @@ -2541,15 +3312,13 @@ class ApprovalEmailSubscription: Definition: ApprovalEmailSubscription """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "NotificationUrl"}, ) """ Gets or sets callback url to flow engine. It is expected as part of request """ - message: Optional[ApprovalMessage] = field( - default=None, + message: ApprovalMessage | Mapping[str, Any] = dataclass_field( metadata={"wire_name": "Message"}, ) @@ -2560,49 +3329,61 @@ class ApprovalMessage: Definition: ApprovalMessage """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: str = dataclass_field(metadata={"wire_name": "To"}) """ Specify email addresses separated by semicolons like someone@contoso.com """ - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Subject""" - options: Optional[str] = field( + options: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Options"}, ) """User Options""" - header_text: Optional[str] = field( + header_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HeaderText"}, ) """Header text for email body""" - selection_text: Optional[str] = field( + selection_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SelectionText"}, ) """Header text for users options selection""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - use_only_h_t_m_l_message: Optional[bool] = field( + use_only_h_t_m_l_message: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UseOnlyHTMLMessage"}, ) """Use only HTML message""" - hide_h_t_m_l_message: Optional[bool] = field( + hide_h_t_m_l_message: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HideHTMLMessage"}, ) """ @@ -2610,8 +3391,9 @@ class ApprovalMessage: displayed. Email clients which do not support actionable messages will display HTML message regardless of the parameter value. """ - show_h_t_m_l_confirmation_dialog: Optional[bool] = field( + show_h_t_m_l_confirmation_dialog: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowHTMLConfirmationDialog"}, ) """ @@ -2626,52 +3408,61 @@ class SharedMailboxClientSendMessage: Definition: SharedMailboxClientSendMessage """ - mailbox_address: Optional[str] = field( - default=None, + mailbox_address: str = dataclass_field( metadata={"wire_name": "MailboxAddress"}, ) """Specify email address of a shared mailbox like someone@contoso.com""" - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: str = dataclass_field(metadata={"wire_name": "To"}) """ Specify email addresses separated by semicolons like someone@contoso.com """ - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Specify the subject of the mail""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: str = dataclass_field(metadata={"wire_name": "Body"}) """Specify the body of the mail""" - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - sensitivity: Optional[str] = field( + sensitivity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sensitivity"}, ) """Sensitivity""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Is Html?""" @@ -2683,47 +3474,55 @@ class SharedMailboxSendEmailInput: Definition: SharedMailboxClientSendHtmlMessage """ - mailbox_address: Optional[str] = field( - default=None, + mailbox_address: str = dataclass_field( metadata={"wire_name": "MailboxAddress"}, ) """Specify email address of a shared mailbox like someone@contoso.com""" - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: str = dataclass_field(metadata={"wire_name": "To"}) """ Specify email addresses separated by semicolons like someone@contoso.com """ - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Specify the subject of the mail""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: str = dataclass_field(metadata={"wire_name": "Body"}) """Specify the body of the mail""" - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - sensitivity: Optional[str] = field( + sensitivity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sensitivity"}, ) """Sensitivity""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" @@ -2735,7 +3534,12 @@ class SubscriptionPayloadOutlookReceiveMessage: Definition: SubscriptionPayload[OutlookReceiveMessage] """ - value: Optional[List[SubscriptionPayloadEntityOutlookReceiveMessage]] = None + value: Optional[ + List[SubscriptionPayloadEntityOutlookReceiveMessage | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -2745,28 +3549,33 @@ class SubscriptionPayloadEntityOutlookReceiveMessage: Definition: SubscriptionPayloadEntity[OutlookReceiveMessage] """ - sequence_number: Optional[int] = field( + sequence_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SequenceNumber"}, ) """Sequence number""" - change_type: Optional[str] = field( + change_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChangeType"}, ) """Change type""" - client_state: Optional[str] = field( + client_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClientState"}, ) """Client state""" - resource: Optional[str] = field( + resource: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Resource"}, ) """Resource""" - resource_data: Optional[OutlookReceiveMessage] = field( + resource_data: Optional[OutlookReceiveMessage | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceData"}, ) @@ -2777,54 +3586,75 @@ class OutlookReceiveAttachment: Definition: OutlookReceiveAttachment """ - type_: Optional[str] = field( + type_: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.type"}, ) """OData type""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Attachment Id""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Attachment name""" - content_bytes: Optional[str] = field( + content_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentBytes"}, ) """Attachment content""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentType"}, ) """Attachment content type""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """Attachment size in bytes""" - permission: Optional[str] = field( + permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Permission"}, ) """Permission associated with a reference attachment""" - provider_type: Optional[str] = field( + provider_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ProviderType"}, ) """Provider for the reference attachment""" - source_url: Optional[str] = field( + source_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SourceUrl"}, ) """Reference attachment source url""" - is_inline: Optional[bool] = field( + is_inline: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsInline"}, ) """Set to true if this is an inline attachment""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModifiedDateTime"}, ) """The date and time when the attachment was last modified""" - content_id: Optional[str] = field( + content_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentId"}, ) """Content Id""" @@ -2836,9 +3666,17 @@ class InternetMessageHeader: Definition: InternetMessageHeader """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Header name""" - value: Optional[str] = field(default=None, metadata={"wire_name": "Value"}) + value: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Value"}, + ) """Header value""" @@ -2848,7 +3686,12 @@ class SubscriptionPayloadSubscriptionEvent: Definition: SubscriptionPayload[SubscriptionEvent] """ - value: Optional[List[SubscriptionPayloadEntitySubscriptionEvent]] = None + value: Optional[ + List[SubscriptionPayloadEntitySubscriptionEvent | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -2858,28 +3701,33 @@ class SubscriptionPayloadEntitySubscriptionEvent: Definition: SubscriptionPayloadEntity[SubscriptionEvent] """ - sequence_number: Optional[int] = field( + sequence_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SequenceNumber"}, ) """Sequence number""" - change_type: Optional[str] = field( + change_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChangeType"}, ) """Change type""" - client_state: Optional[str] = field( + client_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClientState"}, ) """Client state""" - resource: Optional[str] = field( + resource: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Resource"}, ) """Resource""" - resource_data: Optional[SubscriptionEvent] = field( + resource_data: Optional[SubscriptionEvent | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceData"}, ) @@ -2890,7 +3738,11 @@ class SubscriptionEvent: Definition: SubscriptionEvent """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The Event's unique identifier""" @@ -2900,7 +3752,12 @@ class EntityListResponseTable: Definition: EntityListResponse[Table] """ - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -2910,15 +3767,21 @@ class Table: Definition: Table """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the table. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the table.""" - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """Additional table properties provided by the connector to the clients.""" @@ -2930,7 +3793,12 @@ class EntityListResponseCalendarEventBackend: Definition: EntityListResponse[CalendarEventBackend] """ - value: Optional[List[CalendarEventBackend]] = None + value: Optional[ + List[CalendarEventBackend | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -2940,7 +3808,12 @@ class EntityListResponseCalendarEventClientReceiveStringEnums: Definition: EntityListResponse[CalendarEventClientReceiveStringEnums] """ - value: Optional[List[CalendarEventClientReceiveStringEnums]] = None + value: Optional[ + List[CalendarEventClientReceiveStringEnums | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -2950,84 +3823,99 @@ class CalendarEventClient: Definition: CalendarEventClient """ - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Event subject""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: str = dataclass_field(metadata={"wire_name": "Start"}) """Start time of the event (example: '2016-11-01T14:30:00Z')""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: str = dataclass_field(metadata={"wire_name": "End"}) """End time of the event (example: '2016-11-01T15:30:00Z')""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeZone"}, ) """Time zone of the event""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OptionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the message associated with the event""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Set to true if the body is Html""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location of the event""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event: Low, Normal, or High""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - recurrence: Optional[str] = field( + recurrence: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) """The recurrence pattern for the event""" - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecurrenceEnd"}, ) """End time of the recurrence""" - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) """How many times to repeat the event""" - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """Status to show during the event""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ @@ -3042,79 +3930,93 @@ class CalendarEventHtmlClient: Definition: CalendarEventHtmlClient """ - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Event subject""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: str = dataclass_field(metadata={"wire_name": "Start"}) """Start time of the event (example: '2016-11-01T14:30:00Z')""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: str = dataclass_field(metadata={"wire_name": "End"}) """End time of the event (example: '2016-11-01T15:30:00Z')""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeZone"}, ) """Time zone of the event""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OptionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the message associated with the event""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location of the event""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event: Low, Normal, or High""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - recurrence: Optional[str] = field( + recurrence: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) """The recurrence pattern for the event""" - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecurrenceEnd"}, ) """End time of the recurrence""" - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) """How many times to repeat the event""" - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """Status to show during the event""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ @@ -3129,92 +4031,100 @@ class GraphCalendarEventClient: Definition: GraphCalendarEventClient """ - subject: Optional[str] = None + subject: str """Event subject""" - start: Optional[str] = None + start: str """Start time of the event (example: '2017-08-29T04:00:00')""" - end: Optional[str] = None + end: str """End time of the event (example: '2017-08-29T05:00:00')""" - time_zone: Optional[str] = field( - default=None, - metadata={"wire_name": "timeZone"}, - ) - """Time zone of the event""" - required_attendees: Optional[str] = field( + time_zone: str = dataclass_field(metadata={"wire_name": "timeZone"}) + """Time zone of the event""" + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "optionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """Body of the message associated with the event""" - categories: Optional[List[str]] = None + categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """The categories associated with the event""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """Location of the event""" - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """The importance of the event: low, normal, or high""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAllDay"}, ) """Set to true if the event lasts all day""" - recurrence: Optional[str] = None + recurrence: Optional[str] = dataclass_field(default=None, kw_only=True) """ The recurrence pattern for the event: none, daily, weekly, monthly or yearly """ - selected_days_of_week: Optional[List[str]] = field( + selected_days_of_week: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectedDaysOfWeek"}, ) """Days of week for weekly recurrence""" - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recurrenceEnd"}, ) """End Date of the recurrence""" - number_of_occurences: Optional[int] = field( + number_of_occurences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "numberOfOccurences"}, ) """How many times to repeat the event""" - reminder_minutes_before_start: Optional[int] = field( + reminder_minutes_before_start: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderMinutesBeforeStart"}, ) """Time in minutes before event start to remind""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """Set to true if an alert is set to remind the user of the event.""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showAs"}, ) """ Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown """ - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseRequested"}, ) """ Set to true if the sender would like a response when the event is accepted or declined """ - sensitivity: Optional[str] = None + sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True) """The possible values are: normal, personal, private, confidential""" @@ -3224,7 +4134,12 @@ class CalendarEventListWithActionType: Definition: CalendarEventListWithActionType """ - value: Optional[List[CalendarEventClientWithActionType]] = None + value: Optional[ + List[CalendarEventClientWithActionType | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of calendar items""" @@ -3234,164 +4149,207 @@ class CalendarEventClientWithActionType: Definition: CalendarEventClientWithActionType """ - action_type: Optional[str] = field( + action_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActionType"}, ) """Changed action type of the event - added, updated or deleted.""" - is_added: Optional[bool] = field( + is_added: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAdded"}, ) """ Flag that indicates whether the event was added since the last poll of the trigger. """ - is_updated: Optional[bool] = field( + is_updated: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsUpdated"}, ) """ Flag that indicates whether the event was updated since the last poll of the trigger. """ - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Event subject""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Start"}, + ) """Start time of the event (example: '2016-11-01T14:30:00Z')""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "End"}, + ) """End time of the event (example: '2016-11-01T15:30:00Z')""" - show_as: Optional[int] = field( + show_as: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """ Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4) """ - recurrence: Optional[int] = field( + recurrence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) """ The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4) """ - response_type: Optional[int] = field( + response_type: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseType"}, ) """ The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5) """ - response_time: Optional[str] = field( + response_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseTime"}, ) """The response time of the event""" - i_cal_u_id: Optional[str] = field( + i_cal_u_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ICalUId"}, ) """ A unique identifier that is shared by all instances of an event across different calendars """ - importance: Optional[int] = field( + importance: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event (0 - Low, 1 - Normal, 2 - High)""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The event's unique identifier""" - date_time_created: Optional[str] = field( + date_time_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeCreated"}, ) """The date and time that the event was created""" - date_time_last_modified: Optional[str] = field( + date_time_last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeLastModified"}, ) """The date and time that the event was last modified""" - organizer: Optional[str] = field( + organizer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Organizer"}, ) """The organizer of the event""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeZone"}, ) """Time zone of the event""" - series_master_id: Optional[str] = field( + series_master_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SeriesMasterId"}, ) """Unique identifier for Series Master event type""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """The categories associated with the event""" - web_link: Optional[str] = field( + web_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebLink"}, ) """The URL to open the event in Outlook Web App""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OptionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the message associated with the event""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Set to true if the body is Html""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location of the event""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecurrenceEnd"}, ) """End time of the recurrence""" - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) """How many times to repeat the event""" - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ @@ -3406,174 +4364,198 @@ class GraphCalendarEventClientWithActionType: Definition: GraphCalendarEventClientWithActionType """ - action_type: Optional[str] = field( + action_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActionType"}, ) """Changed action type of the event - added, updated or deleted.""" - is_added: Optional[bool] = field( + is_added: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAdded"}, ) """ Flag that indicates whether the event was added since the last poll of the trigger. """ - is_updated: Optional[bool] = field( + is_updated: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsUpdated"}, ) """ Flag that indicates whether the event was updated since the last poll of the trigger. """ - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """Event subject""" - start: Optional[str] = None + start: Optional[str] = dataclass_field(default=None, kw_only=True) """Start time of the event (example: '2017-08-29T04:00:00.0000000')""" - end: Optional[str] = None + end: Optional[str] = dataclass_field(default=None, kw_only=True) """End time of the event (example: '2017-08-29T05:00:00.0000000')""" - start_with_time_zone: Optional[str] = field( + start_with_time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startWithTimeZone"}, ) """ Start time of the event with time zone (example: '2017-08-29T04:00:00.0000000+00:00') """ - end_with_time_zone: Optional[str] = field( + end_with_time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endWithTimeZone"}, ) """ End time of the event with time zone (example: '2017-08-29T05:00:00.0000000+00:00') """ - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """Body of the message associated with the event""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isHtml"}, ) """Set to true if the body is Html""" - response_type: Optional[str] = field( + response_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseType"}, ) """ The response type of the event (none, organizer, tentativelyAccepted, accepted, declined or notResponded) """ - response_time: Optional[str] = field( + response_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseTime"}, ) """The response time of the event""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The event's unique identifier""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The date and time that the event was created""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """The date and time that the event was last modified""" - organizer: Optional[str] = None + organizer: Optional[str] = dataclass_field(default=None, kw_only=True) """The organizer of the event""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timeZone"}, ) """Time zone of the event""" - series_master_id: Optional[str] = field( + series_master_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "seriesMasterId"}, ) """Unique identifier for Series Master event type""" - i_cal_u_id: Optional[str] = field( + i_cal_u_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "iCalUId"}, ) """ A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series """ - categories: Optional[List[str]] = None + categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """The categories associated with the event""" - web_link: Optional[str] = field( + web_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webLink"}, ) """The URL to open the event in Outlook Web App""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "optionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """Location of the event""" - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """The importance of the event: low, normal, or high""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAllDay"}, ) """Set to true if the event lasts all day""" - recurrence: Optional[str] = None + recurrence: Optional[str] = dataclass_field(default=None, kw_only=True) """ The recurrence pattern for the event: none, daily, weekly, monthly or yearly """ - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recurrenceEnd"}, ) """End Date of the recurrence""" - number_of_occurences: Optional[int] = field( + number_of_occurences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "numberOfOccurences"}, ) """How many times to repeat the event""" - reminder_minutes_before_start: Optional[int] = field( + reminder_minutes_before_start: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderMinutesBeforeStart"}, ) """Time in minutes before event start to remind""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """Set to true if an alert is set to remind the user of the event.""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showAs"}, ) """ Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown """ - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseRequested"}, ) """ Set to true if the sender would like a response when the event is accepted or declined """ - sensitivity: Optional[str] = None + sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True) """The possible values are: normal, personal, private, confidential""" @@ -3583,15 +4565,17 @@ class GraphContactFolder: Definition: GraphContactFolder """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the contacts folder""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The name of the contacts folder""" - parent_folder_id: Optional[str] = field( + parent_folder_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentFolderId"}, ) """The ID of the parent folder""" @@ -3603,7 +4587,12 @@ class DataSetsList: Definition: DataSetsList """ - value: Optional[List[DataSet]] = None + value: Optional[ + List[DataSet | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of datasets""" @@ -3613,14 +4602,24 @@ class DataSet: Definition: DataSet """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Dataset name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Dataset display name""" - query: Optional[List[PassThroughNativeQuery]] = None + query: Optional[ + List[PassThroughNativeQuery | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Pass-through Native Queries""" @@ -3630,10 +4629,15 @@ class Procedure: Definition: Procedure """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Procedure name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Procedure display name""" @@ -3645,8 +4649,9 @@ class PassThroughNativeQuery: Definition: PassThroughNativeQuery """ - language: Optional[str] = field( + language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Language"}, ) """Query language""" @@ -3658,30 +4663,33 @@ class AutomaticRepliesSettingClient: Definition: AutomaticRepliesSettingClient """ - status: Optional[str] = None + status: str """Automatic reply setting status""" - external_audience: Optional[str] = field( - default=None, + external_audience: str = dataclass_field( metadata={"wire_name": "externalAudience"}, ) """The audience that will see the external reply message""" - scheduled_start_date_time: Optional[Dict[str, Any]] = field( + scheduled_start_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "scheduledStartDateTime"}, ) """Scheduled start time (example: '2017-08-29T04:00:00.0000000')""" - scheduled_end_date_time: Optional[Dict[str, Any]] = field( + scheduled_end_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "scheduledEndDateTime"}, ) """Scheduled end time (example: '2017-08-29T05:00:00.0000000')""" - internal_reply_message: Optional[str] = field( + internal_reply_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "internalReplyMessage"}, ) """Message for people within your organization""" - external_reply_message: Optional[str] = field( + external_reply_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "externalReplyMessage"}, ) """Message for people outside your organization""" @@ -3693,37 +4701,44 @@ class MailTipsClientReceive: Definition: MailTipsClientReceive """ - automatic_replies: Optional[MailTipsAutomaticReplies] = field( + automatic_replies: Optional[MailTipsAutomaticReplies | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "automaticReplies"}, ) - delivery_restricted: Optional[bool] = field( + delivery_restricted: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "deliveryRestricted"}, ) """Is delivery restricted""" - external_member_count: Optional[int] = field( + external_member_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "externalMemberCount"}, ) """Number of external members""" - is_moderated: Optional[bool] = field( + is_moderated: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isModerated"}, ) """Is moderated""" - mailbox_full: Optional[bool] = field( + mailbox_full: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mailboxFull"}, ) """Is mailbox full""" - max_message_size: Optional[int] = field( + max_message_size: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "maxMessageSize"}, ) """Maximum message size""" - total_member_count: Optional[int] = field( + total_member_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "totalMemberCount"}, ) """Total member count""" @@ -3735,7 +4750,7 @@ class MailTipsAutomaticReplies: Definition: MailTipsAutomaticReplies """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """Automatic replies message""" @@ -3745,7 +4760,7 @@ class UpdateEmailFlag: Definition: UpdateEmailFlag """ - flag: Optional[Dict[str, Any]] = None + flag: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Flag status""" @@ -3755,13 +4770,15 @@ class ResponseToEventInvite: Definition: ResponseToEventInvite """ - comment: Optional[str] = field( + comment: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comment"}, ) """Comment""" - send_response: Optional[bool] = field( + send_response: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SendResponse"}, ) """Send response to organizer?""" @@ -3773,13 +4790,13 @@ class DirectForwardMessage: Definition: DirectForwardMessage """ - comment: Optional[str] = field( + comment: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comment"}, ) """Comment""" - to_recipients: Optional[str] = field( - default=None, + to_recipients: str = dataclass_field( metadata={"wire_name": "ToRecipients"}, ) """Semicolon separated list of recipients to forward the message to""" @@ -3794,18 +4811,21 @@ class LocationConstraint: Definition: LocationConstraint """ - is_required: Optional[bool] = field( + is_required: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsRequired"}, ) """Should a meeting location be returned for the meeting?""" - suggest_location: Optional[bool] = field( + suggest_location: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SuggestLocation"}, ) """Should the response provide one or more meeting location suggestions?""" - locations: Optional[List[Dict[str, Any]]] = field( + locations: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Locations"}, ) """Locations""" @@ -3817,13 +4837,15 @@ class DateTimeTimeZone: Definition: DateTimeTimeZone """ - date_time: Optional[str] = field( + date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dateTime"}, ) """DateTime (example: '2017-08-29T04:00:00.0000000')""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timeZone"}, ) """TimeZone (example: 'Pacific Standard Time')""" @@ -3835,8 +4857,8 @@ class EmailAddressV2: Definition: EmailAddress_V2 """ - name: Optional[str] = None - address: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + address: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -3845,19 +4867,21 @@ class PhysicalAddress: Definition: PhysicalAddress """ - street: Optional[str] = None + street: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's street address.""" - city: Optional[str] = None + city: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's city.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's state.""" - country_or_region: Optional[str] = field( + country_or_region: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "countryOrRegion"}, ) """The contact's country of region.""" - postal_code: Optional[str] = field( + postal_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "postalCode"}, ) """The contact's postal code.""" @@ -3869,145 +4893,164 @@ class Contact: Definition: Contact """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's unique identifier.""" - parent_folder_id: Optional[str] = field( + parent_folder_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentFolderId"}, ) """The ID of the contact's parent folder""" - birthday: Optional[str] = None + birthday: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's birthday""" - file_as: Optional[str] = field( + file_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fileAs"}, ) """The name the contact is filed under""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The contact's display name""" - given_name: Optional[str] = field( - default=None, - metadata={"wire_name": "givenName"}, - ) + given_name: str = dataclass_field(metadata={"wire_name": "givenName"}) """The contact's given name""" - initials: Optional[str] = None + initials: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's initials""" - middle_name: Optional[str] = field( + middle_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "middleName"}, ) """The contact's middle name""" - nick_name: Optional[str] = field( + nick_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nickName"}, ) """The contact's nickname""" - surname: Optional[str] = None + surname: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's surname""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's title""" - generation: Optional[str] = None + generation: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's generation""" - email_addresses: Optional[List[EmailAddressV2]] = field( + email_addresses: Optional[List[EmailAddressV2 | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "emailAddresses"}, ) """The contact's email addresses""" - im_addresses: Optional[List[str]] = field( + im_addresses: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "imAddresses"}, ) """The contact's instant messaging (IM) addresses""" - job_title: Optional[str] = field( + job_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobTitle"}, ) """The contact's job title""" - company_name: Optional[str] = field( + company_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "companyName"}, ) """The name of the contact's company""" - department: Optional[str] = None + department: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's department""" - office_location: Optional[str] = field( + office_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "officeLocation"}, ) """The location of the contact's office""" - profession: Optional[str] = None + profession: Optional[str] = dataclass_field(default=None, kw_only=True) """The contact's profession""" - business_home_page: Optional[str] = field( + business_home_page: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "businessHomePage"}, ) """The business home page of the contact""" - assistant_name: Optional[str] = field( + assistant_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assistantName"}, ) """The name of the contact's assistant""" - manager: Optional[str] = None + manager: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the contact's manager""" - home_phones: Optional[List[str]] = field( - default=None, + home_phones: List[str] = dataclass_field( metadata={"wire_name": "homePhones"}, ) """The contact's home phone numbers""" - business_phones: Optional[List[str]] = field( + business_phones: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "businessPhones"}, ) """The contact's business phone numbers""" - mobile_phone: Optional[str] = field( + mobile_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mobilePhone"}, ) """The contact's mobile phone number""" - home_address: Optional[PhysicalAddress] = field( + home_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "homeAddress"}, ) - business_address: Optional[PhysicalAddress] = field( + business_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "businessAddress"}, ) - other_address: Optional[PhysicalAddress] = field( + other_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "otherAddress"}, ) - yomi_company_name: Optional[str] = field( + yomi_company_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "yomiCompanyName"}, ) """The phonetic Japanese company name of the contact""" - yomi_given_name: Optional[str] = field( + yomi_given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "yomiGivenName"}, ) """The phonetic Japanese given name (first name) of the contact""" - yomi_surname: Optional[str] = field( + yomi_surname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "yomiSurname"}, ) """The phonetic Japanese surname (last name) of the contact""" - categories: Optional[List[str]] = None + categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """The categories associated with the contact""" - change_key: Optional[str] = field( + change_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "changeKey"}, ) """Identifies the version of the event object""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The time the contact was created""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """The time the contact was modified""" @@ -4019,41 +5062,47 @@ class SensitivityLabelMetadata: Definition: sensitivityLabelMetadata """ - sensitivity_label_id: Optional[str] = field( + sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelId"}, ) """SensitivityLabel Id.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel name.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """SensitivityLabel displayName info""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel details on tooltip.""" - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """SensitivityLabel priority.""" - color: Optional[str] = None + color: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel color.""" - is_encrypted: Optional[bool] = field( + is_encrypted: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEncrypted"}, ) """ is SensitivityLabel Encrypted.""" - is_enabled: Optional[bool] = field( + is_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEnabled"}, ) """Whether SensitivityLabel is Enabled.""" - is_parent: Optional[bool] = field( + is_parent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isParent"}, ) """Whether SensitivityLabel is Parent.""" - parent_sensitivity_label_id: Optional[str] = field( + parent_sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentSensitivityLabelId"}, ) """Parent SensitivityLabel Id.""" @@ -4065,14 +5114,15 @@ class MCPQueryRequest: Definition: MCPQueryRequest """ - jsonrpc: Optional[str] = None - id: Optional[str] = None - method: Optional[str] = None - params: Optional[Dict[str, Any]] = None - result: Optional[Dict[str, Any]] = None - error: Optional[Dict[str, Any]] = None - callback_endpoint: Optional[str] = field( + jsonrpc: Optional[str] = dataclass_field(default=None, kw_only=True) + id: Optional[str] = dataclass_field(default=None, kw_only=True) + method: Optional[str] = dataclass_field(default=None, kw_only=True) + params: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + result: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + error: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + callback_endpoint: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callbackEndpoint"}, ) @@ -4088,7 +5138,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -4105,8 +5155,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -4127,7 +5177,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -4143,15 +5193,49 @@ def connector_name(self) -> str: return "office365" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -4168,7 +5252,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -4181,49 +5269,87 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def get_outlook_category_names_async( + def list_outlook_category_names( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Outlook category names This operation gets Outlook category display names. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetOutlookCategoryNames`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Categories" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def draft_email_async( + async def draft_email( self, - input: DraftEmailInput, + input: DraftEmailInput | Mapping[str, Any], + *, message_id: Optional[str] = None, draft_type: Optional[str] = None, comment: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4233,6 +5359,25 @@ async def draft_email_async( Draft an email message This operation drafts an email message. + + Swagger operation ID: `DraftEmail`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + message_id: Message Id. + draft_type: Draft Type. + comment: Draft Comment. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Draft" query_params = [] @@ -4254,7 +5399,7 @@ async def draft_email_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4268,6 +5413,7 @@ async def draft_email_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4275,9 +5421,9 @@ async def draft_email_async( return json.loads(response.text) - async def update_draft_email_async( + async def update_draft_email( self, - input: DraftEmailInput, + input: DraftEmailInput | Mapping[str, Any], message_id: str, *, timeout: Optional[float] = None, @@ -4289,6 +5435,23 @@ async def update_draft_email_async( Updates an email Draft message This operation updates an an email Draft message. + + Swagger operation ID: `UpdateDraftEmail`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + message_id: Message Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Draft" query_params = [] @@ -4299,7 +5462,7 @@ async def update_draft_email_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -4313,9 +5476,10 @@ async def update_draft_email_async( request_url, response.status, response.text, + response=response, ) - async def send_draft_email_async( + async def send_draft_email( self, message_id: str, *, @@ -4328,13 +5492,28 @@ async def send_draft_email_async( Send a Draft message This operation sends a Draft message. + + Swagger operation ID: `SendDraftEmail`. + + Args: + message_id: Message Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Draft/Send/{quote(str(message_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -4348,9 +5527,10 @@ async def send_draft_email_async( request_url, response.status, response.text, + response=response, ) - async def assign_category_async( + async def assign_category( self, message_id: str, category: str, @@ -4364,6 +5544,22 @@ async def assign_category_async( Assigns an Outlook category This operation assigns an Outlook category to an email. + + Swagger operation ID: `AssignCategory`. + + Args: + message_id: Message Id. + category: Category. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/Mail/Category" query_params = [] @@ -4378,7 +5574,7 @@ async def assign_category_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -4392,9 +5588,10 @@ async def assign_category_async( request_url, response.status, response.text, + response=response, ) - async def assign_category_bulk_async( + async def assign_category_bulk( self, input: AssignCategoryBulkInput, category_name: str, @@ -4408,13 +5605,29 @@ async def assign_category_bulk_async( Assign a category to multiple emails This operation assigns an Outlook category to multiple emails. + + Swagger operation ID: `AssignCategoryBulk`. + + Args: + input: The request body. + category_name: Category Name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Mail/Category/Bulk/{quote(str(category_name), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4428,6 +5641,7 @@ async def assign_category_bulk_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4435,9 +5649,9 @@ async def assign_category_bulk_async( return json.loads(response.text) - async def send_mail_with_options_async( + async def send_mail_with_options( self, - input: OptionsEmailSubscription, + input: OptionsEmailSubscription | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4452,12 +5666,28 @@ async def send_mail_with_options_async( following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages. + + Swagger operation ID: `SendMailWithOptions`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/mailwithoptions/$subscriptions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4471,6 +5701,7 @@ async def send_mail_with_options_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4478,9 +5709,9 @@ async def send_mail_with_options_async( return json.loads(response.text) - async def send_approval_mail_async( + async def send_approval_mail( self, - input: ApprovalEmailSubscription, + input: ApprovalEmailSubscription | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4494,12 +5725,28 @@ async def send_approval_mail_async( the recipient. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages. + + Swagger operation ID: `SendApprovalMail`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/approvalmail/$subscriptions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4513,6 +5760,7 @@ async def send_approval_mail_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4520,7 +5768,7 @@ async def send_approval_mail_async( return json.loads(response.text) - async def update_my_contact_photo_async( + async def update_my_contact_photo( self, input: bytes, folder: str, @@ -4536,6 +5784,23 @@ async def update_my_contact_photo_async( Updates the photo of the specified contact of the current user. The size of the photo must be less than 4 MB. + + Swagger operation ID: `UpdateMyContactPhoto`. + + Args: + input: The binary request body. + folder: Select a contacts folder. + id: Unique identifier of a contact to update photo. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4550,7 +5815,7 @@ async def update_my_contact_photo_async( f"/$value" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, @@ -4567,9 +5832,10 @@ async def update_my_contact_photo_async( request_url, response.status, response.text, + response=response, ) - async def http_request_async( + async def http_request( self, input: bytes, *, @@ -4586,10 +5852,25 @@ async def http_request_async( messages, mailFolders, events, calendar, calendars, outlook, inferenceClassification. Learn more: https://docs.microsoft.com/en-us/graph/use-the-api. + + Swagger operation ID: `HttpRequest`. + + Args: + input: The binary request body. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/codeless/httprequest" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -4606,6 +5887,7 @@ async def http_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4613,11 +5895,11 @@ async def http_request_async( return json.loads(response.text) - async def mcp_emails_management_async( + async def mcp_emails_management( self, - input: MCPQueryRequest, - session_id: Optional[str] = None, + input: MCPQueryRequest | Mapping[str, Any], *, + session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4627,6 +5909,23 @@ async def mcp_emails_management_async( Email Management MCP Server (deprecated) This MCP server manages email messages from your Office 365 account + + Swagger operation ID: `mcp_EmailsManagement`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + session_id: sessionId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/mcp/EmailsManagement" query_params = [] @@ -4638,7 +5937,7 @@ async def mcp_emails_management_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4652,6 +5951,7 @@ async def mcp_emails_management_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4659,11 +5959,11 @@ async def mcp_emails_management_async( return json.loads(response.text) - async def mcp_meeting_management_async( + async def mcp_meeting_management( self, - input: MCPQueryRequest, - session_id: Optional[str] = None, + input: MCPQueryRequest | Mapping[str, Any], *, + session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4673,6 +5973,23 @@ async def mcp_meeting_management_async( Meeting Management MCP Server (deprecated) This MCP server manages events, calendars and meetings + + Swagger operation ID: `mcp_MeetingManagement`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + session_id: sessionId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/mcp/MeetingManagement" query_params = [] @@ -4684,7 +6001,7 @@ async def mcp_meeting_management_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4698,6 +6015,7 @@ async def mcp_meeting_management_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4705,11 +6023,11 @@ async def mcp_meeting_management_async( return json.loads(response.text) - async def mcp_contacts_management_async( + async def mcp_contacts_management( self, - input: MCPQueryRequest, - session_id: Optional[str] = None, + input: MCPQueryRequest | Mapping[str, Any], *, + session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4719,6 +6037,23 @@ async def mcp_contacts_management_async( Contact Management MCP Server This MCP server manages contacts + + Swagger operation ID: `mcp_ContactsManagement`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + session_id: sessionId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/mcp/ContactsManagement" query_params = [] @@ -4730,7 +6065,7 @@ async def mcp_contacts_management_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4744,6 +6079,7 @@ async def mcp_contacts_management_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4751,7 +6087,7 @@ async def mcp_contacts_management_async( return json.loads(response.text) - async def calendar_delete_item_async( + async def calendar_delete_item( self, calendar: str, event: str, @@ -4765,6 +6101,22 @@ async def calendar_delete_item_async( Delete event This operation deletes an event in a calendar. + + Swagger operation ID: `CalendarDeleteItem_V2`. + + Args: + calendar: Select a calendar. + event: Select an event. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4777,7 +6129,7 @@ async def calendar_delete_item_async( f"/{quote(quote(str(event), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -4791,9 +6143,10 @@ async def calendar_delete_item_async( request_url, response.status, response.text, + response=response, ) - async def calendar_get_item_async( + async def calendar_get_item( self, table: str, id: str, @@ -4807,6 +6160,22 @@ async def calendar_get_item_async( Get event This operation gets a specific event from a calendar using Graph API. + + Swagger operation ID: `V3CalendarGetItem`. + + Args: + table: Select a calendar. + id: Select an event. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4819,7 +6188,7 @@ async def calendar_get_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4833,6 +6202,7 @@ async def calendar_get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4840,23 +6210,47 @@ async def calendar_get_item_async( return json.loads(response.text) - async def calendar_get_items_async( + def list_calendar_get_items( self, table: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get events This operation gets events from a calendar using Graph API. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `V4CalendarGetItems`. + + Args: + table: Select a calendar. + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4890,40 +6284,78 @@ async def calendar_get_items_async( query_params.append(f"$skip={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def calendar_get_tables_async( + return AsyncItemPaged(get_next, extract_data) + + def list_calendar_get_tables( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get calendars This operation lists available calendars. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `CalendarGetTables_V2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/codeless/v1.0/me/calendars" @@ -4934,31 +6366,52 @@ async def calendar_get_tables_async( query_params.append("orderBy=" + quote("name", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def calendar_patch_item_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def calendar_patch_item( self, - input: GraphCalendarEventClient, + input: GraphCalendarEventClient | Mapping[str, Any], table: str, id: str, *, @@ -4971,6 +6424,24 @@ async def calendar_patch_item_async( Update event This operation updates an event in a calendar using Graph API. + + Swagger operation ID: `V4CalendarPatchItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + table: Select a calendar. + id: Select an event. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4983,7 +6454,7 @@ async def calendar_patch_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -4997,6 +6468,7 @@ async def calendar_patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5004,9 +6476,9 @@ async def calendar_patch_item_async( return json.loads(response.text) - async def calendar_post_item_async( + async def calendar_post_item( self, - input: GraphCalendarEventClient, + input: GraphCalendarEventClient | Mapping[str, Any], table: str, *, timeout: Optional[float] = None, @@ -5018,6 +6490,23 @@ async def calendar_post_item_async( Create event This operation creates a new event in a calendar. + + Swagger operation ID: `V4CalendarPostItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + table: Select a calendar. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5029,7 +6518,7 @@ async def calendar_post_item_async( f"/items" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5043,6 +6532,7 @@ async def calendar_post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5050,7 +6540,7 @@ async def calendar_post_item_async( return json.loads(response.text) - async def contact_delete_item_async( + async def contact_delete_item( self, folder: str, id: str, @@ -5064,6 +6554,22 @@ async def contact_delete_item_async( Delete contact This operation deletes a contact from a contacts folder. + + Swagger operation ID: `ContactDeleteItem_V2`. + + Args: + folder: Select a contacts folder. + id: Unique identifier of contact to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5076,7 +6582,7 @@ async def contact_delete_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5090,9 +6596,10 @@ async def contact_delete_item_async( request_url, response.status, response.text, + response=response, ) - async def contact_get_item_async( + async def contact_get_item( self, folder: str, id: str, @@ -5106,6 +6613,22 @@ async def contact_get_item_async( Get contact This operation gets a specific contact from a contacts folder. + + Swagger operation ID: `ContactGetItem_V2`. + + Args: + folder: Select a contacts folder. + id: Unique identifier of a contact to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5118,7 +6641,7 @@ async def contact_get_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5132,6 +6655,7 @@ async def contact_get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5139,26 +6663,48 @@ async def contact_get_item_async( return json.loads(response.text) - async def contact_get_items_async( + def list_contact_get_items( self, folder: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get contacts This operation gets contacts from a contacts folder. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ContactGetItems_V2`. + + Args: + folder: Unique identifier of the contacts folder to retrieve. + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5192,11 +6738,18 @@ async def contact_get_items_async( query_params.append(f"$skip={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -5209,63 +6762,110 @@ async def contact_get_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def contact_get_tables_async( + return AsyncItemPaged(get_next, extract_data) + + def list_contact_get_tables( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get contact folders This operation lists available contacts folders using Graph API + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ContactGetTablesV2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v2/datasets/contacts/tables" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None - - return json.loads(response.text) - - async def contact_patch_item_async( - self, - input: Contact, + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) + + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def contact_patch_item( + self, + input: Contact | Mapping[str, Any], folder: str, id: str, *, @@ -5278,6 +6878,24 @@ async def contact_patch_item_async( Update contact This operation updates a contact in a contacts folder. + + Swagger operation ID: `ContactPatchItem_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + folder: Select a contacts folder. + id: Unique identifier of contact to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5290,7 +6908,7 @@ async def contact_patch_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -5304,6 +6922,7 @@ async def contact_patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5311,9 +6930,9 @@ async def contact_patch_item_async( return json.loads(response.text) - async def contact_post_item_async( + async def contact_post_item( self, - input: Contact, + input: Contact | Mapping[str, Any], folder: str, *, timeout: Optional[float] = None, @@ -5325,6 +6944,23 @@ async def contact_post_item_async( Create contact This operation creates a new contact in a contacts folder. + + Swagger operation ID: `ContactPostItem_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + folder: Select a contacts folder. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5336,7 +6972,7 @@ async def contact_post_item_async( f"/contacts" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5350,6 +6986,7 @@ async def contact_post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5357,11 +6994,11 @@ async def contact_post_item_async( return json.loads(response.text) - async def delete_email_async( + async def delete_email( self, message_id: str, - mailbox_address: Optional[str] = None, *, + mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5371,6 +7008,22 @@ async def delete_email_async( Delete email This operation deletes an email by id. + + Swagger operation ID: `DeleteEmail_V2`. + + Args: + message_id: Id of the email to delete. + mailbox_address: Address of the shared mailbox to delete mail from. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5385,7 +7038,7 @@ async def delete_email_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5399,13 +7052,14 @@ async def delete_email_async( request_url, response.status, response.text, + response=response, ) - async def export_email_async( + async def export_email( self, message_id: str, - mailbox_address: Optional[str] = None, *, + mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5415,6 +7069,22 @@ async def export_email_async( Export email Export the content of the email in the EML file format. + + Swagger operation ID: `ExportEmail_V2`. + + Args: + message_id: Id of the email to export. + mailbox_address: Address of the shared mailbox to export from. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5434,7 +7104,7 @@ async def export_email_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5448,13 +7118,14 @@ async def export_email_async( request_url, response.status, response.text, + response=response, ) return response.content - async def find_meeting_times_async( + async def find_meeting_times( self, - input: FindMeetingTimesInput, + input: FindMeetingTimesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5466,12 +7137,28 @@ async def find_meeting_times_async( Find meeting time suggestions based on organizer, attendee availability, and time or location constraints + + Swagger operation ID: `FindMeetingTimes_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/codeless/beta/me/findMeetingTimes" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5485,6 +7172,7 @@ async def find_meeting_times_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5492,12 +7180,12 @@ async def find_meeting_times_async( return json.loads(response.text) - async def flag_async( + async def flag( self, - input: UpdateEmailFlag, + input: UpdateEmailFlag | Mapping[str, Any], message_id: str, - mailbox_address: Optional[str] = None, *, + mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5507,6 +7195,24 @@ async def flag_async( Flag email This operation updates an email flag. + + Swagger operation ID: `Flag_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + message_id: Id of the email to be flagged. + mailbox_address: Address of the shared mailbox to update mail. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5526,7 +7232,7 @@ async def flag_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -5540,16 +7246,17 @@ async def flag_async( request_url, response.status, response.text, + response=response, ) - async def forward_email_async( + async def forward_email( self, - input: DirectForwardMessage, + input: DirectForwardMessage | Mapping[str, Any], message_id: str, + *, mailbox_address: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5559,6 +7266,30 @@ async def forward_email_async( Forward an email Forward an email. + + Swagger operation ID: `ForwardEmail_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + message_id: Id of the message to forward. (You can use 'Message Id' + from trigger or 'Get Emails' action output). + mailbox_address: Address of the shared mailbox to forward mail + from. + extract_sensitivity_label: Select if you want to extract + Sensitivity label ( false, true). + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5588,7 +7319,7 @@ async def forward_email_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5602,16 +7333,17 @@ async def forward_email_async( request_url, response.status, response.text, + response=response, ) - async def get_attachment_async( + async def get_attachment( self, message_id: str, attachment_id: str, + *, mailbox_address: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5621,6 +7353,28 @@ async def get_attachment_async( Get Attachment This operation gets an email attachment by id. + + Swagger operation ID: `GetAttachment_V2`. + + Args: + message_id: Id of the email. + attachment_id: Id of the attachment to download. + mailbox_address: Address of the shared mailbox to retrieve + attachment from. + extract_sensitivity_label: Select if you want to extract + Sensitivity label ( false, true). + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5651,7 +7405,7 @@ async def get_attachment_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5665,6 +7419,7 @@ async def get_attachment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5672,15 +7427,15 @@ async def get_attachment_async( return json.loads(response.text) - async def get_email_async( + async def get_email( self, message_id: str, + *, mailbox_address: Optional[str] = None, include_attachments: Optional[bool] = None, internet_message_id: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5690,6 +7445,30 @@ async def get_email_async( Get email This operation gets an email by id. + + Swagger operation ID: `GetEmailV2`. + + Args: + message_id: Id of the email. + mailbox_address: Address of the shared mailbox to retrieve mail + from. + include_attachments: If set to true, attachments content will also + be retrieved along with the email. + internet_message_id: Internet Message Id. + extract_sensitivity_label: Select if you want to extract + Sensitivity label ( false, true). + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5724,7 +7503,7 @@ async def get_email_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5738,6 +7517,7 @@ async def get_email_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5745,8 +7525,9 @@ async def get_email_async( return json.loads(response.text) - async def get_emails_async( + def list_emails( self, + *, folder_path: Optional[str] = None, to: Optional[str] = None, cc: Optional[str] = None, @@ -5760,12 +7541,11 @@ async def get_emails_async( include_attachments: Optional[bool] = None, search_query: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get emails @@ -5774,6 +7554,47 @@ async def get_emails_async( Importance, Fetch Only With Attachments, Subject Filter, is performed using first 250 items in a given mail folder. To avoid that limitation you can use 'Search Query' field. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetEmailsV3`. + + Args: + folder_path: Mail folder to retrieve emails from (default: + 'Inbox'). + to: Recipient email addresses separated by semicolons (If any + match, the trigger will run). + cc: CC recipient email addresses separated by semicolons (If any + match, the trigger will run). + to_or_cc: To or CC recipient email addresses separated by + semicolons (If any match, the trigger will run). + from_: Sender email addresses separated by semicolons (If any + match, the trigger will run). + importance: Importance of the email (Any, High, Normal, Low). + fetch_only_with_attachment: If set to true, only emails with an + attachment will be retrieved. Emails without any attachments + will be skipped. If set to false, all emails will be retrieved. + subject_filter: String to look for in the subject line. + fetch_only_unread: Retrieve only unread emails?. + mailbox_address: Address of the shared mailbox to retrieve mails + from. + include_attachments: If set to true, attachments content will also + be retrieved along with the email. + search_query: Search query to filter emails. How to use '$search' + parameter please refer to: + https://docs.microsoft.com/graph/query-parameters#search-parameter. + top: Number of emails to retrieve (default: 10, max: 1000). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v3/Mail" query_params = [] @@ -5845,49 +7666,99 @@ async def get_emails_async( query_params.append(f"top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_events_calendar_view_async( + def list_events_calendar_view( self, calendar_id: str, start_date_time_utc: str, end_date_time_utc: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, search: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get calendar view of events This operation gets all events (including instances of recurrences) in a calendar using Graph API. Recurrence property is null in this case. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetEventsCalendarViewV3`. + + Args: + calendar_id: Select a calendar. + start_date_time_utc: Start time in UTC (example: + '2017-01-01T08:00:00'). + end_date_time_utc: End time in UTC (example: + '2017-02-01T08:00:00'). + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + search: Search text for matching event body and subject. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5933,145 +7804,282 @@ async def get_events_calendar_view_async( query_params.append(f"search={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_mail_tips_async( + def list_mail_tips( self, - input: GetMailTipsInput, + input: GetMailTipsInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get mail tips for a mailbox Get mail tips for a mailbox such as automatic replies / OOF message or if the mailbox is full. This is not available in GccHigh and Mooncake. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMailTips_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/codeless/v1.0/me/getMailTips" ) + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_room_lists_async( + return AsyncItemPaged(get_next, extract_data) + + def list_room_lists( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get room lists Get all the room lists defined in the user's tenant + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetRoomLists_V2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/codeless/beta/me/findRoomLists" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_rooms_async( + return AsyncItemPaged(get_next, extract_data) + + def list_rooms( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get rooms Get all the meeting rooms defined in the user's tenant + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetRooms_V2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/codeless/beta/me/findRooms" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_rooms_in_room_list_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_get_rooms_in_room( self, room_list: str, *, @@ -6079,11 +8087,29 @@ async def get_rooms_in_room_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get rooms in room list Get the meeting rooms in a specific room list + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetRoomsInRoomList_V2`. + + Args: + room_list: Room list to find rooms in. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6092,34 +8118,55 @@ async def get_rooms_in_room_list_async( f"/me" f"/findRooms(RoomList='{quote(str(room_list), safe='')}')" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def mark_as_read_async( + return AsyncItemPaged(get_next, extract_data) + + async def mark_as_read( self, - input: MarkAsReadInput, + input: MarkAsReadInput | Mapping[str, Any], message_id: str, - mailbox_address: Optional[str] = None, *, + mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -6129,6 +8176,24 @@ async def mark_as_read_async( Mark as read or unread This operation marks an email as read/unread. + + Swagger operation ID: `MarkAsRead_V3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + message_id: Id of the email to be marked. + mailbox_address: Address of the shared mailbox to update mail. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6149,7 +8214,7 @@ async def mark_as_read_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -6163,14 +8228,15 @@ async def mark_as_read_async( request_url, response.status, response.text, + response=response, ) - async def move_async( + async def move( self, message_id: str, folder_path: str, - mailbox_address: Optional[str] = None, *, + mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -6181,6 +8247,23 @@ async def move_async( This operation moves an email to the specified folder within the same mailbox. + + Swagger operation ID: `MoveV2`. + + Args: + message_id: Id of the email to be moved. + folder_path: Mail folder to move the email to. + mailbox_address: Address of the shared mailbox to move mail from. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6199,7 +8282,7 @@ async def move_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -6213,6 +8296,7 @@ async def move_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6220,12 +8304,12 @@ async def move_async( return json.loads(response.text) - async def reply_to_async( + async def reply_to( self, - input: ReplyEmailInput, + input: ReplyEmailInput | Mapping[str, Any], message_id: str, - mailbox_address: Optional[str] = None, *, + mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -6235,6 +8319,24 @@ async def reply_to_async( Reply to email This operation replies to an email. + + Swagger operation ID: `ReplyToV3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + message_id: Id of the email to reply to. + mailbox_address: Address of the shared mailbox to reply from. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6249,7 +8351,7 @@ async def reply_to_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6263,11 +8365,12 @@ async def reply_to_async( request_url, response.status, response.text, + response=response, ) - async def respond_to_event_async( + async def respond_to_event( self, - input: ResponseToEventInvite, + input: ResponseToEventInvite | Mapping[str, Any], event_id: str, response: str, *, @@ -6280,6 +8383,24 @@ async def respond_to_event_async( Respond to an event invite Respond to an event invite. + + Swagger operation ID: `RespondToEvent_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + event_id: Id of the event to respond to. + response: Response for the event invite. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6291,7 +8412,7 @@ async def respond_to_event_async( f"/{quote(str(response), safe='')}" ) - http_response = await self.http_client.send_async( + http_response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6305,11 +8426,12 @@ async def respond_to_event_async( request_url, http_response.status, http_response.text, + response=http_response, ) - async def send_email_async( + async def send_email( self, - input: SendEmailInput, + input: SendEmailInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6320,10 +8442,26 @@ async def send_email_async( Send an email This operation sends an email message. + + Swagger operation ID: `SendEmailV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/Mail" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6337,11 +8475,12 @@ async def send_email_async( request_url, response.status, response.text, + response=response, ) - async def set_automatic_replies_setting_async( + async def set_automatic_replies_setting( self, - input: SetAutomaticRepliesSettingInput, + input: SetAutomaticRepliesSettingInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6352,12 +8491,28 @@ async def set_automatic_replies_setting_async( Set up automatic replies Set the automatic replies setting for your mailbox. + + Swagger operation ID: `SetAutomaticRepliesSetting_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/codeless/v1.0/me/mailboxSettings" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -6371,6 +8526,7 @@ async def set_automatic_replies_setting_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6378,9 +8534,9 @@ async def set_automatic_replies_setting_async( return json.loads(response.text) - async def shared_mailbox_send_email_async( + async def shared_mailbox_send_email( self, - input: SharedMailboxSendEmailInput, + input: SharedMailboxSendEmailInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6393,10 +8549,26 @@ async def shared_mailbox_send_email_async( This operation sends an email from a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed. + + Swagger operation ID: `SharedMailboxSendEmailV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/SharedMailbox/Mail" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6410,6 +8582,7 @@ async def shared_mailbox_send_email_async( request_url, response.status, response.text, + response=response, ) diff --git a/src/azure/connectors/office365groups.py b/src/azure/connectors/office365groups.py index fced8626..29bf2097 100644 --- a/src/azure/connectors/office365groups.py +++ b/src/azure/connectors/office365groups.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,24 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "Office365groupsClient", + "CreateCalendarEventResponse", + "ListGroupMembersResponse", + "ListGroupsResponse", + "ListOwnedGroupsResponse", + "ObjectWithoutType", + "OnGroupMemberAddedOrRemovedResponse", + "OnNewEventResponse", + "SensitivityLabelMetadata", + "UpdateCalendarEventHTMLRequest", + "UpdateCalendarEventRequest", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,20 +46,22 @@ class ListGroupMembersResponse: Response for List group members """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The OData context.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """ Only used in Power Apps Canvas to genereate the `$skipToken` for pagination. Power Automate and Logic Apps must use the pagination setting. """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -55,20 +74,22 @@ class ListGroupsResponse: Response for List groups """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The OData context.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """ Only used in Power Apps Canvas to genereate the `$skipToken` for pagination. Power Automate and Logic Apps must use the pagination setting. """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -78,44 +99,49 @@ class CreateCalendarEventResponse: Response for Update a group event """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique id of the event.""" - reminder_minutes_before_start: Optional[int] = field( + reminder_minutes_before_start: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderMinutesBeforeStart"}, ) """Time in minutes before event starts to remind.""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """Set to true if the event has a reminder.""" - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the event.""" - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """The importance of the event: Low, Normal, or High.""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAllDay"}, ) """True if the event is an all day event.""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseRequested"}, ) """True if a response was requested for the event.""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showAs"}, ) """Status to show during the event.""" - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """body""" - start: Optional[Dict[str, Any]] = None + start: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """start""" - end: Optional[Dict[str, Any]] = None + end: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """end""" - location: Optional[Dict[str, Any]] = None + location: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """location""" @@ -128,7 +154,7 @@ class ObjectWithoutType: Response for Send an HTTP request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -141,12 +167,13 @@ class ListOwnedGroupsResponse: Response for List groups that I own and belong to """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The OData context.""" - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -156,41 +183,47 @@ class SensitivityLabelMetadata: Definition: SensitivityLabelMetadata """ - sensitivity_label_id: Optional[str] = field( + sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelId"}, ) """SensitivityLabel Id.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel name.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """SensitivityLabel displayName info""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel details on tooltip.""" - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """SensitivityLabel priority.""" - color: Optional[str] = None + color: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel color.""" - is_encrypted: Optional[bool] = field( + is_encrypted: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEncrypted"}, ) """ is SensitivityLabel Encrypted.""" - is_enabled: Optional[bool] = field( + is_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEnabled"}, ) """Whether SensitivityLabel is Enabled.""" - is_parent: Optional[bool] = field( + is_parent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isParent"}, ) """Whether SensitivityLabel is Parent.""" - parent_sensitivity_label_id: Optional[str] = field( + parent_sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentSensitivityLabelId"}, ) """Parent SensitivityLabel Id.""" @@ -202,36 +235,41 @@ class UpdateCalendarEventRequest: Definition: UpdateCalendarEvent_Request """ - subject: Optional[str] = None + subject: str """Title of the event.""" - start: Optional[Dict[str, Any]] = None - end: Optional[Dict[str, Any]] = None - body: Optional[Dict[str, Any]] = None - location: Optional[Dict[str, Any]] = None - importance: Optional[str] = None + start: Dict[str, Any] + end: Dict[str, Any] + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + location: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """The importance of the event: Low, Normal, or High.""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAllDay"}, ) """Set to true if the event lasts all day.""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """Set to true if the event has a reminder.""" - reminder_minutes_before_start: Optional[int] = field( + reminder_minutes_before_start: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderMinutesBeforeStart"}, ) """Time in minutes before event start to remind.""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showAs"}, ) """Status to show during the event.""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseRequested"}, ) """ @@ -246,36 +284,41 @@ class UpdateCalendarEventHTMLRequest: Definition: UpdateCalendarEvent_HTMLRequest """ - subject: Optional[str] = None + subject: str """Title of the event.""" - start: Optional[Dict[str, Any]] = None - end: Optional[Dict[str, Any]] = None - body: Optional[Dict[str, Any]] = None - location: Optional[Dict[str, Any]] = None - importance: Optional[str] = None + start: Dict[str, Any] + end: Dict[str, Any] + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + location: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """The importance of the event: Low, Normal, or High.""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAllDay"}, ) """Set to true if the event lasts all day.""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """Set to true if the event has a reminder.""" - reminder_minutes_before_start: Optional[int] = field( + reminder_minutes_before_start: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderMinutesBeforeStart"}, ) """Time in minutes before event start to remind.""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showAs"}, ) """Status to show during the event.""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseRequested"}, ) """ @@ -295,7 +338,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -312,8 +355,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -334,7 +377,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -350,15 +393,49 @@ def connector_name(self) -> str: return "office365groups" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -375,7 +452,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -388,16 +469,16 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def list_group_members_async( + def list_group_members( self, group_id: str, - top: Optional[int] = None, *, + top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List group members @@ -407,8 +488,26 @@ async def list_group_members_async( values please turn on Settings->Pagination feature and provide Threshold limit. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListGroupMembers`. + + Args: + group_id: Pick a group from the drop down or enter group id. + top: Number of group members to retrieve (from 1 to 999, default is + 100). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -422,11 +521,18 @@ async def list_group_members_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -439,23 +545,32 @@ async def list_group_members_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def add_member_to_group_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def add_member_to_group( self, group_id: str, user_upn: str, @@ -469,6 +584,22 @@ async def add_member_to_group_async( Add member to group This operation is used to add a member to an O365 group, using a UPN. + + Swagger operation ID: `AddMemberToGroup`. + + Args: + group_id: Pick a group from the drop down or enter group id. + user_upn: The user principal name (UPN) of the user. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -482,7 +613,7 @@ async def add_member_to_group_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -496,28 +627,53 @@ async def add_member_to_group_async( request_url, response.status, response.text, + response=response, ) - async def list_groups_async( + def list_groups( self, + *, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, filter: Optional[str] = None, top: Optional[int] = None, skiptoken: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List groups This operation returns a list of all groups in the organization. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListGroups`. + + Args: + extract_sensitivity_label: A boolean whether to extract sensitivity + label Id for associated artefact. + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + filter: Enter an OData style filter expression to limit which rows + are listed. + top: Sets the page size of results. + skiptoken: Token that references the next page of results and is + returned in the @odata.nextLink property in the response. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/groups" query_params = [] @@ -548,11 +704,18 @@ async def list_groups_async( query_params.append(f"$skiptoken={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -565,25 +728,34 @@ async def list_groups_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def update_calendar_event_async( + return AsyncItemPaged(get_next, extract_data) + + async def update_calendar_event( self, - input: UpdateCalendarEventHTMLRequest, + input: UpdateCalendarEventHTMLRequest | Mapping[str, Any], group_id: str, event: str, *, @@ -596,6 +768,24 @@ async def update_calendar_event_async( Update a group event This operation is used to update a new event in a group calendar. + + Swagger operation ID: `UpdateCalendarEvent`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Pick a group from the drop down or enter group id. + event: Select an event. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -606,7 +796,7 @@ async def update_calendar_event_async( f"/{quote(quote(str(event), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -620,6 +810,7 @@ async def update_calendar_event_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -627,7 +818,7 @@ async def update_calendar_event_async( return json.loads(response.text) - async def remove_member_from_group_async( + async def remove_member_from_group( self, group_id: str, user_upn: str, @@ -642,6 +833,22 @@ async def remove_member_from_group_async( This operation is used to remove a member from an O365 group, using a UPN. + + Swagger operation ID: `RemoveMemberFromGroup`. + + Args: + group_id: Pick a group from the drop down or enter group id. + user_upn: The user principal name (UPN) of the user. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -660,7 +867,7 @@ async def remove_member_from_group_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -674,33 +881,56 @@ async def remove_member_from_group_async( request_url, response.status, response.text, + response=response, ) - async def list_deleted_groups_async( + def list_deleted_groups( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List deleted groups Lists deleted groups that can be restored. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListDeletedGroups`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/directory/deletedItems/microsoft.graph.group" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -713,23 +943,32 @@ async def list_deleted_groups_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def restore_deleted_group_async( + return AsyncItemPaged(get_next, extract_data) + + async def restore_deleted_group( self, group_id: str, *, @@ -742,6 +981,21 @@ async def restore_deleted_group_async( Restore a deleted group Restore a recently deleted group + + Swagger operation ID: `RestoreDeletedGroup`. + + Args: + group_id: Pick a group from the drop down or enter group id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -752,7 +1006,7 @@ async def restore_deleted_group_async( f"/restore" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -766,33 +1020,56 @@ async def restore_deleted_group_async( request_url, response.status, response.text, + response=response, ) - async def list_deleted_groups_by_owner_async( + def list_deleted_groups_by_owner( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List deleted groups by owner List deleted groups that can be restored by owner - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListDeletedGroupsByOwner`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/directory/deletedItems/getUserOwnedObjects" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "POST", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -805,23 +1082,32 @@ async def list_deleted_groups_by_owner_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def calendar_delete_item_async( + async def calendar_delete_item( self, group_id: str, event: str, @@ -835,6 +1121,22 @@ async def calendar_delete_item_async( Delete event This operation deletes an event in a calendar. + + Swagger operation ID: `CalendarDeleteItem_V2`. + + Args: + group_id: Pick a group from the drop down or enter group id. + event: Select an event. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -845,7 +1147,7 @@ async def calendar_delete_item_async( f"/{quote(quote(str(event), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -859,11 +1161,12 @@ async def calendar_delete_item_async( request_url, response.status, response.text, + response=response, ) - async def create_calendar_event_async( + async def create_calendar_event( self, - input: UpdateCalendarEventHTMLRequest, + input: UpdateCalendarEventHTMLRequest | Mapping[str, Any], group_id: str, *, timeout: Optional[float] = None, @@ -875,13 +1178,30 @@ async def create_calendar_event_async( Create a group event This operation is used to create a new event in a group calendar. + + Swagger operation ID: `CreateCalendarEventV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Pick a group from the drop down or enter group id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/v1.0/groups/{quote(str(group_id), safe='')}/events" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -895,6 +1215,7 @@ async def create_calendar_event_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -902,7 +1223,7 @@ async def create_calendar_event_async( return json.loads(response.text) - async def http_request_async( + async def http_request( self, input: bytes, *, @@ -917,10 +1238,25 @@ async def http_request_async( Construct a Microsoft Graph REST API request to invoke. There is one segment that is supported: /groups. Learn more: https://docs.microsoft.com/en-us/graph/use-the-api. + + Swagger operation ID: `HttpRequestV2`. + + Args: + input: The binary request body. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/httprequest" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -937,6 +1273,7 @@ async def http_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -944,20 +1281,41 @@ async def http_request_async( return json.loads(response.text) - async def list_owned_groups_async( + def list_owned_groups( self, + *, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List groups that I own and belong to This operation returns a list of all groups that you own and belong to. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListOwnedGroups_V3`. + + Args: + extract_sensitivity_label: A boolean whether to extract sensitivity + label Id for associated artefact. + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -976,27 +1334,48 @@ async def list_owned_groups_async( query_params.append(f"fetchSensitivityLabelMetadata={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/office365groupsmail.py b/src/azure/connectors/office365groupsmail.py index d07ec91d..56d27ac6 100644 --- a/src/azure/connectors/office365groupsmail.py +++ b/src/azure/connectors/office365groupsmail.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,39 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "Office365groupsmailClient", + "Attachment", + "ClientSendAttachment", + "Conversation", + "ConversationThread", + "ConversationThreadTriggerResponse", + "ConversationTriggerResponse", + "CreateConversationBody", + "CreateConversationResponse", + "EmailAddress", + "ForwardPostBody", + "GetAttachmentsResponse", + "GetUsersGraphAction", + "ItemBody", + "ListConversationThreadsResponse", + "ListConversationsResponse", + "ListGroupThreadsResponse", + "ListGroupsResponse", + "ListThreadPostsResponse", + "NewConversationThreadResponse", + "NewPostBody", + "ObjectWithoutType", + "OnNewEmailInGroupResponse", + "Post", + "PostTriggerResponse", + "ReplyConversationThreadBody", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,12 +61,18 @@ class ListConversationsResponse: Response for List the conversations of a group """ - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """Link to get next page of results""" - value: Optional[List[Conversation]] = None + value: Optional[ + List[Conversation | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -43,19 +81,21 @@ class CreateConversationResponse: Response for Create a new conversation in a group """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The @odata.context link.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """New Conversation ID.""" - threads_odata_context: Optional[str] = field( + threads_odata_context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "threads@odata.context"}, ) """The threads@odata.context link.""" - threads: Optional[List[Dict[str, Any]]] = None + threads: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Created conversation thread.""" @@ -65,36 +105,44 @@ class Conversation: Response for Get a group conversation """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The conversations's unique identifier.""" - topic: Optional[str] = None + topic: Optional[str] = dataclass_field(default=None, kw_only=True) """The topic of the conversation.""" - has_attachments: Optional[bool] = field( + has_attachments: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasAttachments"}, ) """ Indicates whether any of the posts within this Conversation has at least one attachment. """ - last_delivered_date_time: Optional[str] = field( + last_delivered_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastDeliveredDateTime"}, ) """ The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. """ - unique_senders: Optional[List[str]] = field( + unique_senders: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "uniqueSenders"}, ) """All the users that sent a message to this Conversation.""" - preview: Optional[str] = None + preview: Optional[str] = dataclass_field(default=None, kw_only=True) """ A short summary from the body of the latest post in this Conversation. """ - threads: Optional[List[ConversationThread]] = None + threads: Optional[ + List[ConversationThread | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -103,17 +151,24 @@ class ListConversationThreadsResponse: Response for List the conversation threads of a conversation """ - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """Link to get next page of results""" - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The Odata.context link.""" - value: Optional[List[ConversationThread]] = None + value: Optional[ + List[ConversationThread | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -122,12 +177,13 @@ class NewConversationThreadResponse: Response for Create a conversation thread """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The @odata.context link.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """New conversation thread ID.""" @@ -137,12 +193,18 @@ class ListGroupThreadsResponse: Response for List the threads of a group """ - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """Link to get next page of results""" - value: Optional[List[ConversationThread]] = None + value: Optional[ + List[ConversationThread | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -151,51 +213,62 @@ class ConversationThread: Response for Get a conversation thread """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The conversation thread's unique identifier.""" - topic: Optional[str] = None + topic: Optional[str] = dataclass_field(default=None, kw_only=True) """The topic of the conversation.""" - has_attachments: Optional[bool] = field( + has_attachments: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasAttachments"}, ) """ Indicates whether any of the posts within this Conversation has at least one attachment. """ - last_delivered_date_time: Optional[str] = field( + last_delivered_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastDeliveredDateTime"}, ) """ The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. """ - unique_senders: Optional[List[str]] = field( + unique_senders: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "uniqueSenders"}, ) """All the users that sent a message to this Conversation.""" - preview: Optional[str] = None + preview: Optional[str] = dataclass_field(default=None, kw_only=True) """ A short summary from the body of the latest post in this Conversation. """ - is_locked: Optional[bool] = field( + is_locked: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isLocked"}, ) """Indicates if the thread is locked.""" - to_recipients: Optional[List[EmailAddress]] = field( + to_recipients: Optional[List[EmailAddress | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "toRecipients"}, ) """The To: recipients for the thread.""" - cc_recipients: Optional[List[EmailAddress]] = field( + cc_recipients: Optional[List[EmailAddress | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ccRecipients"}, ) """The Cc: recipients for the thread.""" - posts: Optional[List[Post]] = None + posts: Optional[ + List[Post | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -204,17 +277,24 @@ class ListThreadPostsResponse: Response for List the posts of a conversation thread """ - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """Link to get next page of results""" - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The @odata.context link.""" - value: Optional[List[Post]] = None + value: Optional[ + List[Post | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Array containing the posts in the specified thread.""" @@ -224,58 +304,72 @@ class Post: Response for Get a thread post """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The post's unique identifier.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) - change_key: Optional[str] = field( + change_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "changeKey"}, ) """Identifies the version of the post.""" - conversation_id: Optional[str] = field( + conversation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "conversationId"}, ) """Unique ID of the conversation the post belongs to.""" - conversation_thread_id: Optional[str] = field( + conversation_thread_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "conversationThreadId"}, ) """Unique ID of the conversation thread the post belongs to.""" - categories: Optional[List[str]] = None + categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """The categories associated with the post.""" - received_date_time: Optional[str] = field( + received_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "receivedDateTime"}, ) """Post received timestamp.""" - has_attachments: Optional[bool] = field( + has_attachments: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasAttachments"}, ) """Indicates whether the post has at least one attachment.""" - new_participants: Optional[List[EmailAddress]] = field( + new_participants: Optional[List[EmailAddress | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newParticipants"}, ) """ Conversation participants that were added to the thread as part of this post. """ - body: Optional[ItemBody] = None - from_: Optional[EmailAddress] = field( + body: Optional[ItemBody | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + from_: Optional[EmailAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "from"}, ) - sender: Optional[EmailAddress] = None - attachments: Optional[List[Attachment]] = None + sender: Optional[EmailAddress | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + attachments: Optional[ + List[Attachment | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -284,17 +378,24 @@ class GetAttachmentsResponse: Response for List the attachments of a post """ - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """Link to get next page of results""" - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The @odata.context link.""" - value: Optional[List[Attachment]] = None + value: Optional[ + List[Attachment | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Array containing the attachments of the post.""" @@ -304,7 +405,12 @@ class OnNewEmailInGroupResponse: Response for When a new email arrives to a group """ - value: Optional[List[ConversationTriggerResponse]] = None + value: Optional[ + List[ConversationTriggerResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Response of the trigger.""" @@ -314,7 +420,7 @@ class ObjectWithoutType: Response for Send an HTTP request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -327,7 +433,7 @@ class ListGroupsResponse: Response for List user groups """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Array with the groups the user is part of.""" @@ -337,19 +443,21 @@ class Attachment: Definition: Attachment """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the attachment.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of attachment.""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """Content type of attachment.""" - size: Optional[int] = None + size: Optional[int] = dataclass_field(default=None, kw_only=True) """Size of attachment.""" - content_bytes: Optional[str] = field( + content_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentBytes"}, ) """Content of attachment.""" @@ -361,8 +469,9 @@ class EmailAddress: Definition: EmailAddress """ - email_address: Optional[Dict[str, Any]] = field( + email_address: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "emailAddress"}, ) """ @@ -377,12 +486,13 @@ class ItemBody: Definition: ItemBody """ - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """Content type of the body.""" - content: Optional[str] = None + content: Optional[str] = dataclass_field(default=None, kw_only=True) """Content of the body.""" @@ -392,7 +502,7 @@ class ReplyConversationThreadBody: Definition: ReplyConversationThreadBody """ - post: Optional[NewPostBody] = None + post: Optional[NewPostBody | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -401,13 +511,13 @@ class ForwardPostBody: Definition: ForwardPost_V2Body """ - comment: Optional[str] = field( + comment: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comment"}, ) """Comment to forward with the post.""" - to_recipients: Optional[List[GetUsersGraphAction]] = field( - default=None, + to_recipients: List[GetUsersGraphAction | Mapping[str, Any]] = dataclass_field( metadata={"wire_name": "ToRecipients"}, ) """The recipients to whom the threaded is forwarded to.""" @@ -419,9 +529,9 @@ class CreateConversationBody: Definition: CreateConversationBody """ - topic: Optional[str] = None + topic: str """Topic of the new conversation.""" - post: Optional[NewPostBody] = None + post: Optional[NewPostBody | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -430,16 +540,24 @@ class NewPostBody: Definition: NewPostBody """ - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Body of the new post.""" - categories: Optional[List[str]] = None + categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """The categories associated with the post.""" - new_participants: Optional[List[GetUsersGraphAction]] = field( + new_participants: Optional[ + List[GetUsersGraphAction | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newParticipants"}, ) """Add participants to the thread as part of this post.""" - attachments: Optional[List[ClientSendAttachment]] = None + attachments: Optional[ + List[ClientSendAttachment | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """File attachments to include.""" @@ -449,8 +567,9 @@ class GetUsersGraphAction: Definition: GetUsers__GraphAction """ - email_address: Optional[Dict[str, Any]] = field( + email_address: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmailAddress"}, ) """User email address.""" @@ -462,15 +581,11 @@ class ClientSendAttachment: Definition: ClientSendAttachment """ - type_: Optional[str] = field( - default=None, - metadata={"wire_name": "@odata.type"}, - ) + type_: str = dataclass_field(metadata={"wire_name": "@odata.type"}) """@odata.type for a file attachment.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: str = dataclass_field(metadata={"wire_name": "Name"}) """Name of the attachment.""" - content_bytes: Optional[str] = field( - default=None, + content_bytes: str = dataclass_field( metadata={"wire_name": "ContentBytes"}, ) """Content of the attachment.""" @@ -482,17 +597,23 @@ class ConversationTriggerResponse: Definition: ConversationTriggerResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The conversation unique identifier.""" - last_delivered_date_time: Optional[str] = field( + last_delivered_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastDeliveredDateTime"}, ) """ The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. """ - threads: Optional[List[ConversationThreadTriggerResponse]] = None + threads: Optional[ + List[ConversationThreadTriggerResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -501,9 +622,14 @@ class ConversationThreadTriggerResponse: Definition: ConversationThreadTriggerResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The conversation thread's unique identifier.""" - posts: Optional[List[PostTriggerResponse]] = None + posts: Optional[ + List[PostTriggerResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -512,14 +638,16 @@ class PostTriggerResponse: Definition: PostTriggerResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The post's unique identifier.""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) - change_key: Optional[str] = field( + change_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "changeKey"}, ) """Identifies the version of the post.""" @@ -536,7 +664,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -553,8 +681,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -575,7 +703,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -591,15 +719,49 @@ def connector_name(self) -> str: return "office365groupsmail" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -616,7 +778,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -629,7 +795,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def list_conversations_async( + def list_conversations( self, group_id: str, *, @@ -637,24 +803,47 @@ async def list_conversations_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List the conversations of a group Get all the conversations in this group. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListConversations`. + + Args: + group_id: Pick a group from the drop down or enter group id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/groups/{quote(str(group_id), safe='')}/conversations" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -667,25 +856,34 @@ async def list_conversations_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def create_conversation_async( + async def create_conversation( self, - input: CreateConversationBody, + input: CreateConversationBody | Mapping[str, Any], group_id: str, *, timeout: Optional[float] = None, @@ -697,13 +895,30 @@ async def create_conversation_async( Create a new conversation in a group Create a new conversation in this group. + + Swagger operation ID: `CreateConversation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Pick a group from the drop down or enter group id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/groups/{quote(str(group_id), safe='')}/conversations" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -717,6 +932,7 @@ async def create_conversation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -724,7 +940,7 @@ async def create_conversation_async( return json.loads(response.text) - async def get_group_conversation_async( + async def get_group_conversation( self, group_id: str, conversation_id: str, @@ -738,6 +954,22 @@ async def get_group_conversation_async( Get a group conversation Retrieves the properties of a particular conversation. + + Swagger operation ID: `GetGroupConversation`. + + Args: + group_id: Pick a group from the drop down or enter group id. + conversation_id: Enter the conversation ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -748,7 +980,7 @@ async def get_group_conversation_async( f"/{quote(str(conversation_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -762,6 +994,7 @@ async def get_group_conversation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -769,7 +1002,7 @@ async def get_group_conversation_async( return json.loads(response.text) - async def list_conversation_threads_async( + def list_conversation_threads( self, group_id: str, conversation_id: str, @@ -778,14 +1011,31 @@ async def list_conversation_threads_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List the conversation threads of a conversation Get all the threads in a group conversation. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListConversationThreads`. + + Args: + group_id: Pick a group from the drop down or enter group id. + conversation_id: Enter the conversation ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -796,11 +1046,18 @@ async def list_conversation_threads_async( f"/{quote(str(conversation_id), safe='')}" f"/threads" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -813,25 +1070,34 @@ async def list_conversation_threads_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def create_conversation_thread_async( + async def create_conversation_thread( self, - input: CreateConversationBody, + input: CreateConversationBody | Mapping[str, Any], group_id: str, conversation_id: str, *, @@ -844,6 +1110,24 @@ async def create_conversation_thread_async( Create a conversation thread Create a new thread in the specified conversation. + + Swagger operation ID: `CreateConversationThread`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Pick a group from the drop down or enter group id. + conversation_id: Enter the conversation ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -855,7 +1139,7 @@ async def create_conversation_thread_async( f"/threads" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -869,6 +1153,7 @@ async def create_conversation_thread_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -876,7 +1161,7 @@ async def create_conversation_thread_async( return json.loads(response.text) - async def list_group_threads_async( + def list_group_threads( self, group_id: str, *, @@ -884,24 +1169,47 @@ async def list_group_threads_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List the threads of a group Get all the threads of a group. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListGroupThreads`. + + Args: + group_id: Pick a group from the drop down or enter group id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/groups/{quote(str(group_id), safe='')}/threads" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -914,25 +1222,34 @@ async def list_group_threads_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def create_group_thread_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_group_thread( self, - input: CreateConversationBody, + input: CreateConversationBody | Mapping[str, Any], group_id: str, *, timeout: Optional[float] = None, @@ -944,13 +1261,30 @@ async def create_group_thread_async( Start a new group conversation by creating a thread Start a new group conversation by first creating a thread. + + Swagger operation ID: `CreateGroupThread`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Pick a group from the drop down or enter group id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/groups/{quote(str(group_id), safe='')}/threads" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -964,6 +1298,7 @@ async def create_group_thread_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -971,7 +1306,7 @@ async def create_group_thread_async( return json.loads(response.text) - async def get_conversation_thread_async( + async def get_conversation_thread( self, group_id: str, thread_id: str, @@ -985,6 +1320,22 @@ async def get_conversation_thread_async( Get a conversation thread Get a specific thread that belongs to a group. + + Swagger operation ID: `GetConversationThread`. + + Args: + group_id: Pick a group from the drop down or enter group id. + thread_id: Enter the conversation thread ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -995,7 +1346,7 @@ async def get_conversation_thread_async( f"/{quote(str(thread_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1009,6 +1360,7 @@ async def get_conversation_thread_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1016,7 +1368,7 @@ async def get_conversation_thread_async( return json.loads(response.text) - async def delete_conversation_thread_async( + async def delete_conversation_thread( self, group_id: str, thread_id: str, @@ -1030,6 +1382,22 @@ async def delete_conversation_thread_async( Delete a conversation thread Deletes the specified conversation thread. + + Swagger operation ID: `DeleteConversationThread`. + + Args: + group_id: Pick a group from the drop down or enter group id. + thread_id: Enter the conversation thread ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1040,7 +1408,7 @@ async def delete_conversation_thread_async( f"/{quote(str(thread_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1054,9 +1422,10 @@ async def delete_conversation_thread_async( request_url, response.status, response.text, + response=response, ) - async def list_thread_posts_async( + def list_thread_posts( self, group_id: str, thread_id: str, @@ -1065,14 +1434,31 @@ async def list_thread_posts_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List the posts of a conversation thread Get all the posts of the specified conversation thread. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListThreadPosts`. + + Args: + group_id: Pick a group from the drop down or enter group id. + thread_id: Enter the conversation thread ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1083,11 +1469,18 @@ async def list_thread_posts_async( f"/{quote(str(thread_id), safe='')}" f"/posts" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1100,23 +1493,32 @@ async def list_thread_posts_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_thread_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_thread( self, group_id: str, thread_id: str, @@ -1131,6 +1533,23 @@ async def get_thread_async( Get a thread post Retrieves a post in a specified thread. + + Swagger operation ID: `GetThreadPost`. + + Args: + group_id: Pick a group from the drop down or enter group id. + thread_id: Enter the conversation thread ID. + post_id: Enter the post ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1147,7 +1566,7 @@ async def get_thread_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1161,6 +1580,7 @@ async def get_thread_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1168,7 +1588,7 @@ async def get_thread_async( return json.loads(response.text) - async def get_attachments_async( + def list_attachments( self, group_id: str, thread_id: str, @@ -1178,14 +1598,32 @@ async def get_attachments_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List the attachments of a post Retrieve a list of attachments that belong to a post. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetAttachments`. + + Args: + group_id: Pick a group from the drop down or enter group id. + thread_id: Enter the conversation thread ID. + post_id: Enter the post ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1198,11 +1636,18 @@ async def get_attachments_async( f"/{quote(str(post_id), safe='')}" f"/attachments" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1215,25 +1660,34 @@ async def get_attachments_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def reply_to_a_thread_async( + async def reply_to_a_thread( self, - input: ReplyConversationThreadBody, + input: ReplyConversationThreadBody | Mapping[str, Any], group_id: str, thread_id: str, *, @@ -1246,6 +1700,24 @@ async def reply_to_a_thread_async( Reply to a conversation thread Reply to a thread in a group conversation and add a new post to it. + + Swagger operation ID: `ReplyToAThread`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Pick a group from the drop down or enter group id. + thread_id: Enter the conversation thread ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1257,7 +1729,7 @@ async def reply_to_a_thread_async( f"/reply" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1271,11 +1743,12 @@ async def reply_to_a_thread_async( request_url, response.status, response.text, + response=response, ) - async def reply_async( + async def reply( self, - input: ReplyConversationThreadBody, + input: ReplyConversationThreadBody | Mapping[str, Any], group_id: str, thread_id: str, post_id: str, @@ -1290,6 +1763,25 @@ async def reply_async( Reply to a post and add a new post to the specified thread in a group conversation. + + Swagger operation ID: `ReplyPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Pick a group from the drop down or enter group id. + thread_id: Enter the conversation thread ID. + post_id: Enter the post ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1303,7 +1795,7 @@ async def reply_async( f"/reply" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1317,9 +1809,10 @@ async def reply_async( request_url, response.status, response.text, + response=response, ) - async def http_request_async( + async def http_request( self, input: bytes, *, @@ -1333,10 +1826,25 @@ async def http_request_async( Construct a Microsoft Graph REST API request to invoke. Learn more: https://docs.microsoft.com/en-us/graph/use-the-api + + Swagger operation ID: `HttpRequest`. + + Args: + input: The binary request body. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/httprequest" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -1353,6 +1861,7 @@ async def http_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1360,9 +1869,9 @@ async def http_request_async( return json.loads(response.text) - async def forward_async( + async def forward( self, - input: ForwardPostBody, + input: ForwardPostBody | Mapping[str, Any], group_mail: str, conversation_id: str, thread_id: str, @@ -1377,6 +1886,27 @@ async def forward_async( Forward a post Forward a post to a recipient. + + Swagger operation ID: `ForwardPost_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_mail: Pick a group from the drop down or enter the group mail + address. + conversation_id: Enter the conversation ID. + thread_id: Enter the conversation thread ID. + post_id: Enter the post ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1392,7 +1922,7 @@ async def forward_async( f"/forward" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1406,20 +1936,38 @@ async def forward_async( request_url, response.status, response.text, + response=response, ) - async def list_groups_async( + def list_groups( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List user groups Retrieves all Office 365 Groups the user is part of. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListGroups`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1431,27 +1979,48 @@ async def list_groups_async( query_params.append("$top=" + quote("999", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/office365users.py b/src/azure/connectors/office365users.py index c8f2ad75..d7ab32f1 100644 --- a/src/azure/connectors/office365users.py +++ b/src/azure/connectors/office365users.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,30 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "Office365usersClient", + "ClientPhotoMetadata", + "DirectReportsResponse", + "EntityListResponseIReadOnlyListUser", + "GraphTrending", + "GraphUser", + "GraphUserUpdateable", + "LinklessEntityListResponseListPerson", + "MyTrendingDocumentsResponse", + "ObjectEntity", + "ObjectWithoutType", + "Person", + "Phone", + "ResourceVisualization", + "ScoredEmailAddress", + "SensitivityLabelMetadata", + "TrendingDocumentsResponse", + "User", +] + # Type Definitions @@ -29,7 +52,12 @@ class MyTrendingDocumentsResponse: Response for Get my trending documents """ - value: Optional[List[GraphTrending]] = None + value: Optional[ + List[GraphTrending | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """value""" @@ -39,7 +67,12 @@ class LinklessEntityListResponseListPerson: Response for Get relevant people """ - value: Optional[List[Person]] = None + value: Optional[ + List[Person | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Value""" @@ -49,25 +82,33 @@ class ClientPhotoMetadata: Response for Get user photo metadata """ - has_photo: Optional[bool] = field( + has_photo: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HasPhoto"}, ) """Has photo""" - height: Optional[int] = field( + height: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Height"}, ) """Height of photo""" - width: Optional[int] = field(default=None, metadata={"wire_name": "Width"}) + width: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Width"}, + ) """Width of photo""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentType"}, ) """Content Type of photo""" - image_file_extension: Optional[str] = field( + image_file_extension: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImageFileExtension"}, ) """File extension for the photo (ex: \".jpg\")""" @@ -79,7 +120,12 @@ class TrendingDocumentsResponse: Response for Get trending documents """ - value: Optional[List[GraphTrending]] = None + value: Optional[ + List[GraphTrending | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """value""" @@ -89,7 +135,7 @@ class ObjectWithoutType: Response for Send an HTTP request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -102,7 +148,12 @@ class DirectReportsResponse: Response for Get direct reports """ - value: Optional[List[GraphUser]] = None + value: Optional[ + List[GraphUser | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Value""" @@ -112,96 +163,110 @@ class GraphUser: Response for Get manager """ - about_me: Optional[str] = field( + about_me: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "aboutMe"}, ) """About Me""" - account_enabled: Optional[bool] = field( + account_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "accountEnabled"}, ) """ true if the account is enabled; otherwise, false. This property is required when a user is created. """ - birthday: Optional[str] = None + birthday: Optional[str] = dataclass_field(default=None, kw_only=True) """Birthday""" - business_phones: Optional[List[str]] = field( + business_phones: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "businessPhones"}, ) """Business Phones""" - city: Optional[str] = None + city: Optional[str] = dataclass_field(default=None, kw_only=True) """The city in which the user is located.""" - company_name: Optional[str] = field( + company_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "companyName"}, ) """The name of the company in which the user works.""" - country: Optional[str] = None + country: Optional[str] = dataclass_field(default=None, kw_only=True) """ The country/region in which the user is located; for example, \"US\" or \"UK\". """ - department: Optional[str] = None + department: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the department in which the user works.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display Name""" - given_name: Optional[str] = field( + given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "givenName"}, ) """Given Name""" - hire_date: Optional[str] = field( + hire_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hireDate"}, ) """Hire Date""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id""" - interests: Optional[List[str]] = None + interests: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Interests""" - job_title: Optional[str] = field( + job_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobTitle"}, ) """Job Title""" - mail: Optional[str] = None + mail: Optional[str] = dataclass_field(default=None, kw_only=True) """Mail""" - mail_nickname: Optional[str] = field( + mail_nickname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mailNickname"}, ) """ The mail alias for the user. This property must be specified when a user is created. """ - mobile_phone: Optional[str] = field( + mobile_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mobilePhone"}, ) """Mobile Phone""" - my_site: Optional[str] = field( + my_site: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mySite"}, ) """My Site""" - office_location: Optional[str] = field( + office_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "officeLocation"}, ) """Office Location""" - past_projects: Optional[List[str]] = field( + past_projects: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pastProjects"}, ) """Past Projects""" - postal_code: Optional[str] = field( + postal_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "postalCode"}, ) """ @@ -209,38 +274,43 @@ class GraphUser: to the user's country/region. In the United States of America, this attribute contains the ZIP code. """ - preferred_language: Optional[str] = field( + preferred_language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredLanguage"}, ) """Preferred Language""" - preferred_name: Optional[str] = field( + preferred_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preferredName"}, ) """Preferred Name""" - responsibilities: Optional[List[str]] = None + responsibilities: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Responsibilities""" - schools: Optional[List[str]] = None + schools: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Schools""" - skills: Optional[List[str]] = None + skills: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Skills""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """State""" - street_address: Optional[str] = field( + street_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "streetAddress"}, ) """Street Address""" - surname: Optional[str] = None + surname: Optional[str] = dataclass_field(default=None, kw_only=True) """Surname""" - user_principal_name: Optional[str] = field( + user_principal_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userPrincipalName"}, ) """User Principal Name""" - user_type: Optional[str] = field( + user_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userType"}, ) """User Type""" @@ -252,10 +322,16 @@ class EntityListResponseIReadOnlyListUser: Response for Search for users """ - value: Optional[List[User]] = None + value: Optional[ + List[User | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Value""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """Next page link""" @@ -267,28 +343,31 @@ class GraphUserUpdateable: Definition: GraphUserUpdateable """ - about_me: Optional[str] = field( + about_me: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "aboutMe"}, ) """About Me""" - birthday: Optional[str] = None + birthday: Optional[str] = dataclass_field(default=None, kw_only=True) """Birthday""" - interests: Optional[List[str]] = None + interests: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Interests""" - my_site: Optional[str] = field( + my_site: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mySite"}, ) """My Site""" - past_projects: Optional[List[str]] = field( + past_projects: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pastProjects"}, ) """Past Projects""" - schools: Optional[List[str]] = None + schools: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Schools""" - skills: Optional[List[str]] = None + skills: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Skills""" @@ -298,16 +377,20 @@ class GraphTrending: Definition: GraphTrending """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the relationship""" - weight: Optional[float] = None + weight: Optional[float] = dataclass_field(default=None, kw_only=True) """Value indicating how much the document is currently trending""" - resource_visualization: Optional[ResourceVisualization] = field( + resource_visualization: Optional[ResourceVisualization | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceVisualization"}, ) - sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field( + sensitivity_label_info: Optional[ + List[SensitivityLabelMetadata | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelInfo"}, ) @@ -318,43 +401,53 @@ class ResourceVisualization: Definition: resourceVisualization """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The item's title text""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ The item's media type (can be used for filtering for a specific file based on a specific type) """ - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mediaType"}, ) """ The items media type (can be used for filtering for a specific type of file based on supported IANA Media MIME types) """ - preview_image_url: Optional[str] = field( + preview_image_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "previewImageUrl"}, ) """A URL leading to the preview image for the item""" - preview_text: Optional[str] = field( + preview_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "previewText"}, ) """A preview text for the item""" - container_web_url: Optional[str] = field( + container_web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "containerWebUrl"}, ) """A path leading to the folder in which the item is stored""" - container_display_name: Optional[str] = field( + container_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "containerDisplayName"}, ) """A string describing where the item is stored""" - container_type: Optional[str] = field( + container_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "containerType"}, ) """ @@ -369,41 +462,47 @@ class SensitivityLabelMetadata: Definition: sensitivityLabelMetadata """ - sensitivity_label_id: Optional[str] = field( + sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelId"}, ) """SensitivityLabel Id.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel name.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """SensitivityLabel displayName info""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel details on tooltip.""" - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """SensitivityLabel priority.""" - color: Optional[str] = None + color: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel color.""" - is_encrypted: Optional[bool] = field( + is_encrypted: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEncrypted"}, ) """ is SensitivityLabel Encrypted.""" - is_enabled: Optional[bool] = field( + is_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEnabled"}, ) """Whether SensitivityLabel is Enabled.""" - is_parent: Optional[bool] = field( + is_parent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isParent"}, ) """Whether SensitivityLabel is Parent.""" - parent_sensitivity_label_id: Optional[str] = field( + parent_sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentSensitivityLabelId"}, ) """Parent SensitivityLabel Id.""" @@ -415,53 +514,61 @@ class Person: Definition: Person """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """A unique identifier for the Person object in the directory""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The person's display name""" - given_name: Optional[str] = field( + given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "givenName"}, ) """The person's given name""" - surname: Optional[str] = None + surname: Optional[str] = dataclass_field(default=None, kw_only=True) """The person's surname""" - birthday: Optional[str] = None + birthday: Optional[str] = dataclass_field(default=None, kw_only=True) """The person's birthday""" - person_notes: Optional[str] = field( + person_notes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personNotes"}, ) """Free-form notes that the current user has taken about this person""" - is_favorite: Optional[bool] = field( + is_favorite: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isFavorite"}, ) """If the current user has flagged this person as a favorite""" - job_title: Optional[str] = field( + job_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobTitle"}, ) """The person's job title""" - company_name: Optional[str] = field( + company_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "companyName"}, ) """The name of the person's company""" - department: Optional[str] = None + department: Optional[str] = dataclass_field(default=None, kw_only=True) """The person's department""" - office_location: Optional[str] = field( + office_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "officeLocation"}, ) """The location of the person's office""" - profession: Optional[str] = None + profession: Optional[str] = dataclass_field(default=None, kw_only=True) """The person's profession""" - user_principal_name: Optional[str] = field( + user_principal_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userPrincipalName"}, ) """ @@ -471,17 +578,26 @@ class Person: @domain, where domain must be present in the tenant's collection of verified domains. """ - im_address: Optional[str] = field( + im_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "imAddress"}, ) """The person's VOIP SIP address""" - scored_email_addresses: Optional[List[ScoredEmailAddress]] = field( + scored_email_addresses: Optional[ + List[ScoredEmailAddress | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "scoredEmailAddresses"}, ) """Collection of the person's email addresses with a relevance score""" - phones: Optional[List[Phone]] = None + phones: Optional[ + List[Phone | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The person's phone numbers""" @@ -491,10 +607,11 @@ class ScoredEmailAddress: Definition: ScoredEmailAddress """ - address: Optional[str] = None + address: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address""" - relevance_score: Optional[float] = field( + relevance_score: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "relevanceScore"}, ) """ @@ -512,9 +629,13 @@ class Phone: Definition: Phone """ - number: Optional[str] = None + number: Optional[str] = dataclass_field(default=None, kw_only=True) """The phone number""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ The type of phone number. Possible values: home, business, mobile, other, assistant, homeFax, businessFax, otherFax, pager, radio. @@ -527,43 +648,53 @@ class User: Definition: User """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: str = dataclass_field(metadata={"wire_name": "Id"}) """A unique identifier for the user object in the directory.""" - account_enabled: Optional[bool] = field( + account_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountEnabled"}, ) """ true if the account is enabled; otherwise, false. This property is required when a user is created. """ - business_phones: Optional[List[str]] = field( + business_phones: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BusinessPhones"}, ) """A list of business phone numbers for the user""" - city: Optional[str] = field(default=None, metadata={"wire_name": "City"}) + city: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "City"}, + ) """The city in which the user is located.""" - company_name: Optional[str] = field( + company_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompanyName"}, ) """The name of the company in which the user works.""" - country: Optional[str] = field( + country: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Country"}, ) """ The country/region in which the user is located; for example, \"US\" or \"UK\". """ - department: Optional[str] = field( + department: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Department"}, ) """The name of the department in which the user works.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """ @@ -572,41 +703,51 @@ class User: property is required when a user is created and it cannot be cleared during updates. """ - given_name: Optional[str] = field( + given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GivenName"}, ) """The given name (first name) of the user.""" - job_title: Optional[str] = field( + job_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobTitle"}, ) """The user's job title.""" - mail: Optional[str] = field(default=None, metadata={"wire_name": "Mail"}) + mail: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Mail"}, + ) """ The SMTP/email address for the user, for example, \"jeff@contoso.onmicrosoft.com\". Read-Only. """ - mail_nickname: Optional[str] = field( + mail_nickname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MailNickname"}, ) """ The mail alias for the user. This property must be specified when a user is created. """ - mobile_phone: Optional[str] = field( + mobile_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mobilePhone"}, ) """The primary cellular telephone number for the user.""" - office_location: Optional[str] = field( + office_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfficeLocation"}, ) """The office location in the user's place of business.""" - postal_code: Optional[str] = field( + postal_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PostalCode"}, ) """ @@ -614,18 +755,21 @@ class User: to the user's country/region. In the United States of America, this attribute contains the ZIP code. """ - surname: Optional[str] = field( + surname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Surname"}, ) """The user's surname (family name or last name).""" - telephone_number: Optional[str] = field( + telephone_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TelephoneNumber"}, ) """The primary cellular telephone number for the user.""" - user_principal_name: Optional[str] = field( + user_principal_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserPrincipalName"}, ) """ @@ -643,7 +787,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -661,7 +805,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -678,8 +822,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -700,7 +844,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -716,15 +860,49 @@ def connector_name(self) -> str: return "office365users" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -741,7 +919,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -754,9 +936,9 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def update_my_profile_async( + async def update_my_profile( self, - input: GraphUserUpdateable, + input: GraphUserUpdateable | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -767,10 +949,26 @@ async def update_my_profile_async( Update my profile Updates the profile of the current user + + Swagger operation ID: `UpdateMyProfile`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/codeless/v1.0/me" - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -784,9 +982,10 @@ async def update_my_profile_async( request_url, response.status, response.text, + response=response, ) - async def update_my_photo_async( + async def update_my_photo( self, input: bytes, *, @@ -800,12 +999,27 @@ async def update_my_photo_async( Updates the profile photo of the current user. The size of the photo must be less than 4 MB. + + Swagger operation ID: `UpdateMyPhoto`. + + Args: + input: The binary request body. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/codeless/v1.0/me/photo/$value" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, @@ -822,23 +1036,48 @@ async def update_my_photo_async( request_url, response.status, response.text, + response=response, ) - async def my_trending_documents_async( + def list_my_trending_documents( self, + *, filter: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get my trending documents Retrieves the trending documents for the signed in user + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `MyTrendingDocuments`. + + Args: + filter: An OData filter to filter the resources selected. Filter + selected resources on ResourceVisualization/Type or + ResourceVisualization/containerType. + extract_sensitivity_label: Select if you want to extract + Sensitivity label ( false, true). + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -862,29 +1101,50 @@ async def my_trending_documents_async( query_params.append(f"fetchSensitivityLabelMetadata={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def relevant_people_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_relevant_people( self, user_id: str, *, @@ -892,39 +1152,78 @@ async def relevant_people_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get relevant people Get relevant people. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `RelevantPeople`. + + Args: + user_id: User principal name or id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/users/{quote(str(user_id), safe='')}/relevantpeople" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def user_photo_metadata_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def user_photo_metadata( self, user_id: str, *, @@ -937,6 +1236,21 @@ async def user_photo_metadata_async( Get user photo metadata Get user photo metadata. + + Swagger operation ID: `UserPhotoMetadata`. + + Args: + user_id: User principal name or id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/users/photo" query_params = [] @@ -947,7 +1261,7 @@ async def user_photo_metadata_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -961,6 +1275,7 @@ async def user_photo_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -968,22 +1283,47 @@ async def user_photo_metadata_async( return json.loads(response.text) - async def trending_documents_async( + def list_trending_documents( self, id: str, + *, filter: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get trending documents Retrieves the trending documents for a user + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `TrendingDocuments`. + + Args: + id: User principal name or id. + filter: An OData filter to filter the resources selected. Filter + selected resources on ResourceVisualization/Type or + ResourceVisualization/containerType. + extract_sensitivity_label: Select if you want to extract + Sensitivity label ( false, true). + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1007,29 +1347,50 @@ async def trending_documents_async( query_params.append(f"fetchSensitivityLabelMetadata={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def http_request_async( + return AsyncItemPaged(get_next, extract_data) + + async def http_request( self, input: bytes, *, @@ -1046,10 +1407,25 @@ async def http_request_async( messages, mailFolders, events, calendar, calendars, outlook, inferenceClassification. Learn more: https://docs.microsoft.com/en-us/graph/use-the-api. + + Swagger operation ID: `HttpRequest`. + + Args: + input: The binary request body. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/codeless/httprequest" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -1066,6 +1442,7 @@ async def http_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1073,23 +1450,45 @@ async def http_request_async( return json.loads(response.text) - async def direct_reports_async( + def list_direct_reports( self, id: str, + *, select: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get direct reports Retrieves the user profiles of the specified user's direct reports. Learn more about available fields to select: https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `DirectReports_V2`. + + Args: + id: User principal name or id. + select: Comma separated list of fields to select. Example: surname, + department, jobTitle. + top: Limit on the number of results to return. By default returns + all entries. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1108,33 +1507,54 @@ async def direct_reports_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def manager_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def manager( self, id: str, - select: Optional[str] = None, *, + select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1146,6 +1566,23 @@ async def manager_async( Retrieves the profile of the specified user's manager. Learn more about available fields to select: https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties + + Swagger operation ID: `Manager_V2`. + + Args: + id: User principal name or id. + select: Comma separated list of fields to select. Example: surname, + department, jobTitle. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1160,7 +1597,7 @@ async def manager_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1174,6 +1611,7 @@ async def manager_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1181,10 +1619,10 @@ async def manager_async( return json.loads(response.text) - async def my_profile_async( + async def my_profile( self, - select: Optional[str] = None, *, + select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1196,6 +1634,22 @@ async def my_profile_async( Retrieves the profile of the current user. Learn more about available fields to select: https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties + + Swagger operation ID: `MyProfile_V2`. + + Args: + select: Comma separated list of fields to select. Example: surname, + department, jobTitle. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/codeless/v1.0/me" query_params = [] @@ -1207,7 +1661,7 @@ async def my_profile_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1221,6 +1675,7 @@ async def my_profile_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1228,24 +1683,46 @@ async def my_profile_async( return json.loads(response.text) - async def search_user_async( + def list_search_user( self, + *, search_term: Optional[str] = None, top: Optional[int] = None, is_search_term_required: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Search for users Retrieves the user profiles that match the search term. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `SearchUserV2`. + + Args: + search_term: Search string (applies to: display name, given name, + surname, mail, mail nickname and user principal name). + top: Limit on the number of results to return. Minimum value is 1. + Default value is 1000. + is_search_term_required: If set to 'Yes' then no user profiles will + be returned when the search term is empty. If set to 'No' then + no filtering will be applied when the search term is empty. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/users" query_params = [] @@ -1266,11 +1743,18 @@ async def search_user_async( query_params.append(f"isSearchTermRequired={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1283,23 +1767,32 @@ async def search_user_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def user_photo_async( + async def user_photo( self, id: str, *, @@ -1312,13 +1805,28 @@ async def user_photo_async( Get user photo Retrieves the photo of the specified user if they have one + + Swagger operation ID: `UserPhoto_V2`. + + Args: + id: User principal name or id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/codeless/v1.0/users/{quote(str(id), safe='')}/photo/$value" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1332,15 +1840,16 @@ async def user_photo_async( request_url, response.status, response.text, + response=response, ) return response.content - async def user_profile_async( + async def user_profile( self, id: str, - select: Optional[str] = None, *, + select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1352,6 +1861,23 @@ async def user_profile_async( Retrieves the profile of a specific user. Learn more about available fields to select: https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties + + Swagger operation ID: `UserProfile_V2`. + + Args: + id: User principal name or id. + select: Comma separated list of fields to select. Example: surname, + department, jobTitle. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1366,7 +1892,7 @@ async def user_profile_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1380,6 +1906,7 @@ async def user_profile_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/onedrive.py b/src/azure/connectors/onedrive.py index 7694bcb4..2ef4fe93 100644 --- a/src/azure/connectors/onedrive.py +++ b/src/azure/connectors/onedrive.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,22 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "OnedriveClient", + "BlobDataSetsMetadata", + "BlobMetadata", + "BlobMetadataPage", + "DataSetsMetadata", + "SharingLink", + "TabularDataSetsMetadata", + "Tags", + "Thumbnail", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,51 +44,78 @@ class BlobMetadata: Response for Get file metadata """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique identifier of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - name_no_ext: Optional[str] = field( + name_no_ext: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameNoExt"}, ) """The name of the file or folder, without the file extension.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The file or folder size in bytes.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The file locator of the file or folder.""" - last_modified_by: Optional[str] = field( + last_modified_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModifiedBy"}, ) """The user who last modified the file or folder.""" @@ -85,8 +127,9 @@ class Tags: Response for Get file tags """ - tags: Optional[List[str]] = field( + tags: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Tags"}, ) """A list of tags.""" @@ -98,12 +141,21 @@ class Thumbnail: Response for Get file thumbnail """ - url: Optional[str] = field(default=None, metadata={"wire_name": "Url"}) + url: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Url"}, + ) """A URL that points to the thumbnail.""" - width: Optional[int] = field(default=None, metadata={"wire_name": "Width"}) + width: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Width"}, + ) """The thumbnail width in pixels.""" - height: Optional[int] = field( + height: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Height"}, ) """The thumbnail height in pixels.""" @@ -115,8 +167,9 @@ class SharingLink: Response for Create share link """ - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebUrl"}, ) """A URL that points to the file or folder.""" @@ -128,10 +181,16 @@ class BlobMetadataPage: Response for List files in folder """ - value: Optional[List[BlobMetadata]] = None + value: Optional[ + List[BlobMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Blob metadata collection.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """A URL which can be used to retrieve the next page.""" @@ -143,8 +202,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -153,25 +222,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -183,15 +256,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -208,7 +283,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -225,8 +300,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -247,7 +322,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -263,15 +338,49 @@ def connector_name(self) -> str: return "onedrive" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -288,7 +397,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -301,7 +414,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def get_file_metadata_async( + async def get_file_metadata( self, id: str, *, @@ -314,6 +427,21 @@ async def get_file_metadata_async( Get file metadata This operation gets the metadata for a file. + + Swagger operation ID: `GetFileMetadata`. + + Args: + id: The unique identifier of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -323,7 +451,7 @@ async def get_file_metadata_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -337,6 +465,7 @@ async def get_file_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -344,7 +473,7 @@ async def get_file_metadata_async( return json.loads(response.text) - async def update_file_async( + async def update_file( self, input: bytes, id: str, @@ -358,6 +487,22 @@ async def update_file_async( Update file This operation updates a file. + + Swagger operation ID: `UpdateFile`. + + Args: + input: The binary request body. + id: The unique identifier of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -367,7 +512,7 @@ async def update_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, @@ -384,6 +529,7 @@ async def update_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -391,7 +537,7 @@ async def update_file_async( return json.loads(response.text) - async def delete_file_async( + async def delete_file( self, id: str, *, @@ -404,6 +550,21 @@ async def delete_file_async( Delete file This operation deletes a file. + + Swagger operation ID: `DeleteFile`. + + Args: + id: The unique identifier of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -413,7 +574,7 @@ async def delete_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -427,9 +588,10 @@ async def delete_file_async( request_url, response.status, response.text, + response=response, ) - async def get_file_metadata_by_path_async( + async def get_file_metadata_by_path( self, path: str, *, @@ -442,6 +604,21 @@ async def get_file_metadata_by_path_async( Get file metadata using path This operation gets the metadata of a file using the path. + + Swagger operation ID: `GetFileMetadataByPath`. + + Args: + path: The unique path of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/GetFileByPath" @@ -454,7 +631,7 @@ async def get_file_metadata_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -468,6 +645,7 @@ async def get_file_metadata_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -475,11 +653,11 @@ async def get_file_metadata_by_path_async( return json.loads(response.text) - async def get_file_content_by_path_async( + async def get_file_content_by_path( self, path: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -489,6 +667,23 @@ async def get_file_content_by_path_async( Get file content using path This operation gets the content of a file using the path. + + Swagger operation ID: `GetFileContentByPath`. + + Args: + path: The unique path of the file. + infer_content_type: A boolean value (true, false) to infer + content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -507,7 +702,7 @@ async def get_file_content_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -521,15 +716,16 @@ async def get_file_content_by_path_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_file_content_async( + async def get_file_content( self, id: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -539,6 +735,23 @@ async def get_file_content_async( Get file content This operation gets the content of a file. + + Swagger operation ID: `GetFileContent`. + + Args: + id: The unique identifier of the file. + infer_content_type: A boolean value (true, false) to infer + content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -557,7 +770,7 @@ async def get_file_content_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -571,11 +784,12 @@ async def get_file_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def create_file_async( + async def create_file( self, input: bytes, folder_path: str, @@ -590,6 +804,24 @@ async def create_file_async( Create file This operation creates a file. + + Swagger operation ID: `CreateFile`. + + Args: + input: The binary request body. + folder_path: The unique path of the folder. + name: The name of the file. Certain characters are disallowed by + OneDrive and will be replaced by underscores. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/datasets/default/files" query_params = [] @@ -604,7 +836,7 @@ async def create_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -621,6 +853,7 @@ async def create_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -628,12 +861,12 @@ async def create_file_async( return json.loads(response.text) - async def copy_file_async( + async def copy_file( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -643,6 +876,23 @@ async def copy_file_async( Upload file from URL This operation uploads a file from a URL to OneDrive. + + Swagger operation ID: `CopyFile`. + + Args: + source: The url to the source file. + destination: The destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/copyFile" @@ -664,7 +914,7 @@ async def copy_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -678,6 +928,7 @@ async def copy_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -685,12 +936,12 @@ async def copy_file_async( return json.loads(response.text) - async def copy_drive_file_async( + async def copy_drive_file( self, id: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -700,6 +951,23 @@ async def copy_drive_file_async( Copy file This operation copies a file within OneDrive. + + Swagger operation ID: `CopyDriveFile`. + + Args: + id: The unique identifier of the file. + destination: The destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -722,7 +990,7 @@ async def copy_drive_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -736,6 +1004,7 @@ async def copy_drive_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -743,12 +1012,12 @@ async def copy_drive_file_async( return json.loads(response.text) - async def copy_drive_file_by_path_async( + async def copy_drive_file_by_path( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -758,6 +1027,23 @@ async def copy_drive_file_by_path_async( Copy file using path This operation copies a file within OneDrive by path. + + Swagger operation ID: `CopyDriveFileByPath`. + + Args: + source: The unique path of the file. + destination: The destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/CopyFileByPath" @@ -779,7 +1065,7 @@ async def copy_drive_file_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -793,6 +1079,7 @@ async def copy_drive_file_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -800,12 +1087,12 @@ async def copy_drive_file_by_path_async( return json.loads(response.text) - async def move_file_async( + async def move_file( self, id: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -815,6 +1102,23 @@ async def move_file_async( Move or rename a file This operation moves or renames a file. + + Swagger operation ID: `MoveFile`. + + Args: + id: The unique identifier of the file. + destination: The destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -837,7 +1141,7 @@ async def move_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -851,6 +1155,7 @@ async def move_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -858,12 +1163,12 @@ async def move_file_async( return json.loads(response.text) - async def move_file_by_path_async( + async def move_file_by_path( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -873,6 +1178,23 @@ async def move_file_by_path_async( Move or rename a file using path This operation moves or renames a file using the path. + + Swagger operation ID: `MoveFileByPath`. + + Args: + source: The unique path of the file. + destination: The destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/MoveFileByPath" @@ -894,7 +1216,7 @@ async def move_file_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -908,6 +1230,7 @@ async def move_file_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -915,11 +1238,11 @@ async def move_file_by_path_async( return json.loads(response.text) - async def convert_file_async( + async def convert_file( self, id: str, - type_: Optional[str] = None, *, + type_: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -930,6 +1253,22 @@ async def convert_file_async( This operation converts a file to another format. The list of supported conversions can be found at https://aka.ms/onedriveconversions + + Swagger operation ID: `ConvertFile`. + + Args: + id: The unique identifier of the file. + type_: The target file type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -948,7 +1287,7 @@ async def convert_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -962,15 +1301,16 @@ async def convert_file_async( request_url, response.status, response.text, + response=response, ) return response.content - async def convert_file_by_path_async( + async def convert_file_by_path( self, path: str, - type_: Optional[str] = None, *, + type_: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -982,6 +1322,22 @@ async def convert_file_by_path_async( This operation converts a file to another format using the path. The list of supported conversions can be found at https://aka.ms/onedriveconversions + + Swagger operation ID: `ConvertFileByPath`. + + Args: + path: The unique path of the file. + type_: The target file type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1000,7 +1356,7 @@ async def convert_file_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1014,11 +1370,12 @@ async def convert_file_by_path_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_file_tags_async( + def list_file_tags( self, id: str, *, @@ -1026,11 +1383,29 @@ async def get_file_tags_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get file tags This operation gets the tags of a file. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetFileTags`. + + Args: + id: The unique identifier of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1040,29 +1415,50 @@ async def get_file_tags_async( f"/{quote(quote(str(id), safe=''), safe='')}" f"/tags" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[str]: + for item in page.get("Tags", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def add_file_tag_async( + async def add_file_tag( self, id: str, tag: str, @@ -1076,6 +1472,22 @@ async def add_file_tag_async( Add file tag This operation adds a tag to a file. + + Swagger operation ID: `AddFileTag`. + + Args: + id: The unique identifier of the file. + tag: The name of the tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1093,7 +1505,7 @@ async def add_file_tag_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1107,6 +1519,7 @@ async def add_file_tag_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1114,7 +1527,7 @@ async def add_file_tag_async( return json.loads(response.text) - async def remove_file_tag_async( + async def remove_file_tag( self, id: str, tag: str, @@ -1128,6 +1541,22 @@ async def remove_file_tag_async( Remove file tag This operation removes a tag from a file. + + Swagger operation ID: `RemoveFileTag`. + + Args: + id: The unique identifier of the file. + tag: The name of the tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1145,7 +1574,7 @@ async def remove_file_tag_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1159,9 +1588,10 @@ async def remove_file_tag_async( request_url, response.status, response.text, + response=response, ) - async def get_file_thumbnail_async( + async def get_file_thumbnail( self, id: str, size: str, @@ -1176,6 +1606,22 @@ async def get_file_thumbnail_async( This operation gets the thumbnail of a file. The thumbnail will only be valid for 6 hours. + + Swagger operation ID: `GetFileThumbnail`. + + Args: + id: The unique identifier of the file. + size: The size of the thumbnail to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1193,7 +1639,7 @@ async def get_file_thumbnail_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1207,6 +1653,7 @@ async def get_file_thumbnail_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1214,62 +1661,125 @@ async def get_file_thumbnail_async( return json.loads(response.text) - async def list_root_folder_async( + def list_root_folder( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files in root folder This operation gets the list of files and subfolders in the root folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRootFolder`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/folders" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def find_files_async( + return AsyncItemPaged(get_next, extract_data) + + def list_find_files( self, id: str, query: str, find_mode: str, - max_file_count: Optional[int] = None, *, + max_file_count: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Find files in folder This operation finds files within a folder using search or name pattern match. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `FindFiles`. + + Args: + id: The unique identifier of the folder. + query: The search query to use. + find_mode: The search method to use. \"Search\" mode searches your + OneDrive using the search query (similar a normal search + engine). When \"Regular Expression Pattern Match\" mode is + selected, the search query will be treated as a regex pattern, + and it will return files with names that match the query. + max_file_count: Maximum number of files to return (1-100). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1295,45 +1805,91 @@ async def find_files_async( query_params.append(f"maxFileCount={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def find_files_by_path_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_find_files_by_path( self, query: str, path: str, find_mode: str, - max_file_count: Optional[int] = None, *, + max_file_count: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Find files in folder by path This operation finds files within a folder by path using search or name pattern match. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `FindFilesByPath`. + + Args: + query: The search query to use. + path: The unique path of the folder. + find_mode: The search method to use. \"Search\" mode searches your + OneDrive using the search query (similar a normal search + engine). When \"Regular Expression Pattern Match\" mode is + selected, the search query will be treated as a regex pattern, + and it will return files with names that match the query. + max_file_count: Maximum number of files to return (1-100). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/findFile" @@ -1358,29 +1914,50 @@ async def find_files_by_path_async( query_params.append(f"maxFileCount={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - async def create_share_link_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_share_link( self, id: str, type_: str, @@ -1394,6 +1971,22 @@ async def create_share_link_async( Create share link This operation creates a share link for a file. + + Swagger operation ID: `CreateShareLinkV2`. + + Args: + id: The unique identifier of the file. + type_: The type of link. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1411,7 +2004,7 @@ async def create_share_link_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1425,6 +2018,7 @@ async def create_share_link_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1432,7 +2026,7 @@ async def create_share_link_async( return json.loads(response.text) - async def create_share_link_by_path_async( + async def create_share_link_by_path( self, path: str, type_: str, @@ -1446,6 +2040,22 @@ async def create_share_link_by_path_async( Create share link by path This operation creates a share link for a file using the path. + + Swagger operation ID: `CreateShareLinkByPathV2`. + + Args: + path: The unique path of the file. + type_: The type of link. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1463,7 +2073,7 @@ async def create_share_link_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1477,6 +2087,7 @@ async def create_share_link_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1484,12 +2095,12 @@ async def create_share_link_by_path_async( return json.loads(response.text) - async def extract_folder_async( + async def extract_folder( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1500,6 +2111,23 @@ async def extract_folder_async( This operation extracts an archive file into a folder (example: .zip). Maximum archive size is 50 MB and 100 files inside. + + Swagger operation ID: `ExtractFolderV2`. + + Args: + source: The path to the archive file. + destination: The path to extract the archive contents. + overwrite: Overwrites the destination files if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/extractFolderV2" @@ -1521,7 +2149,7 @@ async def extract_folder_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1535,6 +2163,7 @@ async def extract_folder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1542,7 +2171,7 @@ async def extract_folder_async( return json.loads(response.text) - async def list_folder_async( + def list_folder( self, id: str, *, @@ -1550,14 +2179,30 @@ async def list_folder_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files in folder This operation gets the list of files and subfolders in a folder. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListFolderV2`. + + Args: + id: The unique identifier of the folder. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1571,11 +2216,18 @@ async def list_folder_async( query_params.append("top=" + quote("20", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1588,21 +2240,30 @@ async def list_folder_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/onedriveforbusiness.py b/src/azure/connectors/onedriveforbusiness.py index e6600797..2fc8d03d 100644 --- a/src/azure/connectors/onedriveforbusiness.py +++ b/src/azure/connectors/onedriveforbusiness.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,23 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "OnedriveforbusinessClient", + "BlobDataSetsMetadata", + "BlobMetadata", + "BlobMetadataPage", + "DataSetsMetadata", + "ForASelectedFileResponse", + "SharingLink", + "TabularDataSetsMetadata", + "Tags", + "Thumbnail", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,51 +45,78 @@ class BlobMetadata: Response for Get file metadata """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique identifier of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - name_no_ext: Optional[str] = field( + name_no_ext: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameNoExt"}, ) """The name of the file or folder, without the file extension.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The file or folder size in bytes.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The file locator of the file or folder.""" - last_modified_by: Optional[str] = field( + last_modified_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModifiedBy"}, ) """The user who last modified the file or folder.""" @@ -85,12 +128,21 @@ class Thumbnail: Response for Get file thumbnail """ - url: Optional[str] = field(default=None, metadata={"wire_name": "Url"}) + url: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Url"}, + ) """A URL that points to the thumbnail.""" - width: Optional[int] = field(default=None, metadata={"wire_name": "Width"}) + width: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Width"}, + ) """The thumbnail width in pixels.""" - height: Optional[int] = field( + height: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Height"}, ) """The thumbnail height in pixels.""" @@ -102,8 +154,9 @@ class SharingLink: Response for Create share link """ - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebUrl"}, ) """A URL that points to the file or folder.""" @@ -115,10 +168,16 @@ class BlobMetadataPage: Response for List files in folder """ - value: Optional[List[BlobMetadata]] = None + value: Optional[ + List[BlobMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Blob metadata collection.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """A URL which can be used to retrieve the next page.""" @@ -130,8 +189,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -140,25 +209,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -170,15 +243,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -190,8 +265,9 @@ class Tags: Definition: Tags """ - tags: Optional[List[str]] = field( + tags: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Tags"}, ) """A list of tags.""" @@ -203,13 +279,15 @@ class ForASelectedFileResponse: Definition: ForASelectedFileResponse """ - file_path: Optional[str] = field( + file_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filePath"}, ) """The unique path of the file.""" - file_url: Optional[str] = field( + file_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fileUrl"}, ) """The URL to the source file.""" @@ -226,7 +304,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -243,8 +321,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -265,7 +343,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -281,15 +359,49 @@ def connector_name(self) -> str: return "onedriveforbusiness" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -306,7 +418,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -319,7 +435,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def get_file_metadata_async( + async def get_file_metadata( self, id: str, *, @@ -332,6 +448,21 @@ async def get_file_metadata_async( Get file metadata This operation gets the metadata for a file. + + Swagger operation ID: `GetFileMetadata`. + + Args: + id: The unique identifier of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -341,7 +472,7 @@ async def get_file_metadata_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -355,6 +486,7 @@ async def get_file_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -362,7 +494,7 @@ async def get_file_metadata_async( return json.loads(response.text) - async def update_file_async( + async def update_file( self, input: bytes, id: str, @@ -376,6 +508,22 @@ async def update_file_async( Update file This operation updates a file. + + Swagger operation ID: `UpdateFile`. + + Args: + input: The binary request body. + id: The unique identifier of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -385,7 +533,7 @@ async def update_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, @@ -402,6 +550,7 @@ async def update_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -409,7 +558,7 @@ async def update_file_async( return json.loads(response.text) - async def delete_file_async( + async def delete_file( self, id: str, *, @@ -422,6 +571,21 @@ async def delete_file_async( Delete file This operation deletes a file. + + Swagger operation ID: `DeleteFile`. + + Args: + id: The unique identifier of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -431,7 +595,7 @@ async def delete_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -445,9 +609,10 @@ async def delete_file_async( request_url, response.status, response.text, + response=response, ) - async def get_file_metadata_by_path_async( + async def get_file_metadata_by_path( self, path: str, *, @@ -460,6 +625,21 @@ async def get_file_metadata_by_path_async( Get file metadata using path This operation gets the metadata of a file using the path. + + Swagger operation ID: `GetFileMetadataByPath`. + + Args: + path: The unique path of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/GetFileByPath" @@ -472,7 +652,7 @@ async def get_file_metadata_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -486,6 +666,7 @@ async def get_file_metadata_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -493,11 +674,11 @@ async def get_file_metadata_by_path_async( return json.loads(response.text) - async def get_file_content_by_path_async( + async def get_file_content_by_path( self, path: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -507,6 +688,23 @@ async def get_file_content_by_path_async( Get file content using path This operation gets the content of a file using the path. + + Swagger operation ID: `GetFileContentByPath`. + + Args: + path: The unique path of the file. + infer_content_type: A boolean value (true, false) to infer + content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -525,7 +723,7 @@ async def get_file_content_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -539,15 +737,16 @@ async def get_file_content_by_path_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_file_content_async( + async def get_file_content( self, id: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -557,6 +756,23 @@ async def get_file_content_async( Get file content This operation gets the content of a file. + + Swagger operation ID: `GetFileContent`. + + Args: + id: The unique identifier of the file. + infer_content_type: A boolean value (true, false) to infer + content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -575,7 +791,7 @@ async def get_file_content_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -589,11 +805,12 @@ async def get_file_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def create_file_async( + async def create_file( self, input: bytes, folder_path: str, @@ -608,6 +825,24 @@ async def create_file_async( Create file This operation creates a file. + + Swagger operation ID: `CreateFile`. + + Args: + input: The binary request body. + folder_path: The unique path of the folder. + name: The name of the file. Certain characters are disallowed by + OneDrive and will be replaced by underscores. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/datasets/default/files" query_params = [] @@ -622,7 +857,7 @@ async def create_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -639,6 +874,7 @@ async def create_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -646,12 +882,12 @@ async def create_file_async( return json.loads(response.text) - async def copy_file_async( + async def copy_file( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -661,6 +897,23 @@ async def copy_file_async( Upload file from URL This operation uploads a file from a URL to OneDrive. + + Swagger operation ID: `CopyFile`. + + Args: + source: The url to the source file. + destination: The destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/copyFile" @@ -682,7 +935,7 @@ async def copy_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -696,6 +949,7 @@ async def copy_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -703,12 +957,12 @@ async def copy_file_async( return json.loads(response.text) - async def copy_drive_file_async( + async def copy_drive_file( self, id: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -718,6 +972,23 @@ async def copy_drive_file_async( Copy file This operation copies a file within OneDrive. + + Swagger operation ID: `CopyDriveFile`. + + Args: + id: The unique identifier of the file. + destination: The destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -740,7 +1011,7 @@ async def copy_drive_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -754,6 +1025,7 @@ async def copy_drive_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -761,12 +1033,12 @@ async def copy_drive_file_async( return json.loads(response.text) - async def copy_drive_file_by_path_async( + async def copy_drive_file_by_path( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -776,6 +1048,23 @@ async def copy_drive_file_by_path_async( Copy file using path This operation copies a file within OneDrive by path. + + Swagger operation ID: `CopyDriveFileByPath`. + + Args: + source: The unique path of the file. + destination: The destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/CopyFileByPath" @@ -797,7 +1086,7 @@ async def copy_drive_file_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -811,6 +1100,7 @@ async def copy_drive_file_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -818,12 +1108,12 @@ async def copy_drive_file_by_path_async( return json.loads(response.text) - async def move_file_async( + async def move_file( self, id: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -833,6 +1123,23 @@ async def move_file_async( Move or rename a file This operation moves or renames a file. + + Swagger operation ID: `MoveFile`. + + Args: + id: The unique identifier of the file. + destination: The destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -855,7 +1162,7 @@ async def move_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -869,6 +1176,7 @@ async def move_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -876,12 +1184,12 @@ async def move_file_async( return json.loads(response.text) - async def move_file_by_path_async( + async def move_file_by_path( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -891,6 +1199,23 @@ async def move_file_by_path_async( Move or rename a file using path This operation moves or renames a file using the path. + + Swagger operation ID: `MoveFileByPath`. + + Args: + source: The unique path of the file. + destination: The destination file path, including target filename. + overwrite: Overwrites the destination file if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/MoveFileByPath" @@ -912,7 +1237,7 @@ async def move_file_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -926,6 +1251,7 @@ async def move_file_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -933,11 +1259,11 @@ async def move_file_by_path_async( return json.loads(response.text) - async def convert_file_async( + async def convert_file( self, id: str, - type_: Optional[str] = None, *, + type_: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -948,6 +1274,22 @@ async def convert_file_async( This operation converts a file to another format. The list of supported conversions can be found at https://aka.ms/onedriveconversions + + Swagger operation ID: `ConvertFile`. + + Args: + id: The unique identifier of the file. + type_: The target file type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -966,7 +1308,7 @@ async def convert_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -980,15 +1322,16 @@ async def convert_file_async( request_url, response.status, response.text, + response=response, ) return response.content - async def convert_file_by_path_async( + async def convert_file_by_path( self, path: str, - type_: Optional[str] = None, *, + type_: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1000,6 +1343,22 @@ async def convert_file_by_path_async( This operation converts a file to another format using the path. The list of supported conversions can be found at https://aka.ms/onedriveconversions + + Swagger operation ID: `ConvertFileByPath`. + + Args: + path: The unique path of the file. + type_: The target file type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1018,7 +1377,7 @@ async def convert_file_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1032,11 +1391,12 @@ async def convert_file_by_path_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_file_thumbnail_async( + async def get_file_thumbnail( self, id: str, size: str, @@ -1051,6 +1411,22 @@ async def get_file_thumbnail_async( This operation gets the thumbnail of a file. The thumbnail will only be valid for 6 hours. + + Swagger operation ID: `GetFileThumbnail`. + + Args: + id: The unique identifier of the file. + size: The size of the thumbnail to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1068,7 +1444,7 @@ async def get_file_thumbnail_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1082,6 +1458,7 @@ async def get_file_thumbnail_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1089,62 +1466,125 @@ async def get_file_thumbnail_async( return json.loads(response.text) - async def list_root_folder_async( + def list_root_folder( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files in root folder This operation gets the list of files and subfolders in the root folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRootFolder`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/folders" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def find_files_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_find_files( self, id: str, query: str, find_mode: str, - max_file_count: Optional[int] = None, *, + max_file_count: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Find files in folder This operation finds files within a folder using search or name pattern match. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `FindFiles`. + + Args: + id: The unique identifier of the folder. + query: The search query to use. + find_mode: The search method to use. \"Search\" mode searches your + OneDrive using the search query (similar a normal search + engine). When \"Regular Expression Pattern Match\" mode is + selected, the search query will be treated as a regex pattern, + and it will return files with names that match the query. + max_file_count: Maximum number of files to return (1-100). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1170,45 +1610,91 @@ async def find_files_async( query_params.append(f"maxFileCount={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def find_files_by_path_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_find_files_by_path( self, query: str, path: str, find_mode: str, - max_file_count: Optional[int] = None, *, + max_file_count: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Find files in folder by path This operation finds files within a folder by path using search or name pattern match. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `FindFilesByPath`. + + Args: + query: The search query to use. + path: The unique path of the folder. + find_mode: The search method to use. \"Search\" mode searches your + OneDrive using the search query (similar a normal search + engine). When \"Regular Expression Pattern Match\" mode is + selected, the search query will be treated as a regex pattern, + and it will return files with names that match the query. + max_file_count: Maximum number of files to return (1-100). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/findFile" @@ -1233,34 +1719,55 @@ async def find_files_by_path_async( query_params.append(f"maxFileCount={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - async def create_share_link_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_share_link( self, id: str, type_: str, - scope: Optional[str] = None, *, + scope: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1270,6 +1777,23 @@ async def create_share_link_async( Create share link This operation creates a share link for a file. + + Swagger operation ID: `CreateShareLinkV2`. + + Args: + id: The unique identifier of the file. + type_: The type of link. + scope: The scope of the link. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1292,7 +1816,7 @@ async def create_share_link_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1306,6 +1830,7 @@ async def create_share_link_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1313,12 +1838,12 @@ async def create_share_link_async( return json.loads(response.text) - async def create_share_link_by_path_async( + async def create_share_link_by_path( self, path: str, type_: str, - scope: Optional[str] = None, *, + scope: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1328,6 +1853,23 @@ async def create_share_link_by_path_async( Create share link by path This operation creates a share link for a file using the path. + + Swagger operation ID: `CreateShareLinkByPathV2`. + + Args: + path: The unique path of the file. + type_: The type of link. + scope: The scope of the link. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1350,7 +1892,7 @@ async def create_share_link_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1364,6 +1906,7 @@ async def create_share_link_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1371,12 +1914,12 @@ async def create_share_link_by_path_async( return json.loads(response.text) - async def extract_folder_async( + async def extract_folder( self, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1387,6 +1930,23 @@ async def extract_folder_async( This operation extracts an archive file into a folder (example: .zip). Maximum archive size is 50 MB and 100 files inside. + + Swagger operation ID: `ExtractFolderV2`. + + Args: + source: The path to the archive file. + destination: The path to extract the archive contents. + overwrite: Overwrites the destination files if set to 'true'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/extractFolderV2" @@ -1408,7 +1968,7 @@ async def extract_folder_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1422,6 +1982,7 @@ async def extract_folder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1429,7 +1990,7 @@ async def extract_folder_async( return json.loads(response.text) - async def list_folder_async( + def list_folder( self, id: str, *, @@ -1437,14 +1998,30 @@ async def list_folder_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List files in folder This operation gets the list of files and subfolders in a folder. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListFolderV2`. + + Args: + id: The unique identifier of the folder. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1458,11 +2035,18 @@ async def list_folder_async( query_params.append("top=" + quote("20", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1475,21 +2059,30 @@ async def list_folder_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/onenote.py b/src/azure/connectors/onenote.py index 8a70e430..bd192169 100644 --- a/src/azure/connectors/onenote.py +++ b/src/azure/connectors/onenote.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,34 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "OnenoteClient", + "CreatePageInQuickNotesInput", + "CreatePageInSectionInput", + "CreateSectionInNotebookResponse", + "CreateSectionRequest", + "GetPageResponse", + "GetPagesInSectionResponse", + "GetSectionsInNotebookResponse", + "Link", + "NewPageResponse", + "NewSectionGroupResponse", + "NewSectionResponse", + "Notebook", + "OneNoteClientUrl", + "OneNoteWebUrl", + "Page", + "ParentNotebook", + "SectionGroupResponse", + "SectionListItem", + "SectionResponse", + "UpdatePageContentRequest", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,47 +56,54 @@ class CreateSectionInNotebookResponse: Response for Create section in a notebook """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The OData context.""" - created_by: Optional[str] = field( + created_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) """This section created by name.""" - created_time: Optional[str] = field( + created_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdTime"}, ) """This section created time.""" - id: Optional[str] = None - is_default: Optional[bool] = field( + id: Optional[str] = dataclass_field(default=None, kw_only=True) + is_default: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isDefault"}, ) """A flag to indication if this is the default section.""" - last_modified_by: Optional[str] = field( + last_modified_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedBy"}, ) """Last modified by name.""" - last_modified_time: Optional[str] = field( + last_modified_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedTime"}, ) """The time this section was last modified.""" - links: Optional[Dict[str, Any]] = None + links: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """OneNote client links.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the section.""" - pages_url: Optional[str] = field( + pages_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pagesUrl"}, ) """The url of the pages.""" - self: Optional[str] = None + self: Optional[str] = dataclass_field(default=None, kw_only=True) """The url to create section in notebook group.""" @@ -82,25 +116,28 @@ class Page: Response for Create page in a section """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the page.""" - links: Optional[Link] = None - content_url: Optional[str] = field( + links: Optional[Link | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + content_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentUrl"}, ) """A url to the page content.""" - last_modified_time: Optional[str] = field( + last_modified_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedTime"}, ) """The last modified date of the page.""" - created_time: Optional[str] = field( + created_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdTime"}, ) """The date the page was created.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique identifier of the page.""" @@ -110,15 +147,17 @@ class GetPagesInSectionResponse: Response for Get pages for a specific section """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The OData context.""" - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -133,11 +172,16 @@ class Notebook: Response for Get recent notebooks """ - file_name: Optional[str] = field( + file_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileName"}, ) - key: Optional[str] = field(default=None, metadata={"wire_name": "Key"}) + key: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Key"}, + ) @dataclass @@ -146,7 +190,12 @@ class GetSectionsInNotebookResponse: Response for Get sections in notebook """ - value: Optional[List[SectionListItem]] = None + value: Optional[ + List[SectionListItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -155,7 +204,12 @@ class NewSectionResponse: Response for When a new section is created """ - value: Optional[List[SectionResponse]] = None + value: Optional[ + List[SectionResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """An array of objects, each representing a specific section.""" @@ -165,7 +219,12 @@ class NewSectionGroupResponse: Response for When a new section group is created """ - value: Optional[List[SectionGroupResponse]] = None + value: Optional[ + List[SectionGroupResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """An array of objects, each representing a specific section group.""" @@ -175,7 +234,12 @@ class NewPageResponse: Response for When a new page is created in a section """ - value: Optional[List[Page]] = None + value: Optional[ + List[Page | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """An array of objects, each representing a specific page.""" @@ -185,7 +249,7 @@ class CreateSectionRequest: Definition: CreateSectionRequest """ - name: Optional[str] = None + name: str """The name of the new section.""" @@ -198,12 +262,13 @@ class GetPageResponse: Definition: GetPageResponse """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """The OData context.""" - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """This page response value.""" @@ -213,11 +278,11 @@ class ParentNotebook: Definition: ParentNotebook """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique identifier of the parent notebook.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the parent notebook.""" - self: Optional[str] = None + self: Optional[str] = dataclass_field(default=None, kw_only=True) """A url link to the parent notebook.""" @@ -227,12 +292,10 @@ class Link: Definition: Link """ - one_note_client_url: Optional[OneNoteClientUrl] = field( - default=None, + one_note_client_url: OneNoteClientUrl | Mapping[str, Any] = dataclass_field( metadata={"wire_name": "oneNoteClientUrl"}, ) - one_note_web_url: Optional[OneNoteWebUrl] = field( - default=None, + one_note_web_url: OneNoteWebUrl | Mapping[str, Any] = dataclass_field( metadata={"wire_name": "oneNoteWebUrl"}, ) @@ -243,7 +306,7 @@ class OneNoteClientUrl: Definition: OneNoteClientUrl """ - href: Optional[str] = None + href: str """A link to the notebook using the OneNote windows client.""" @@ -253,7 +316,7 @@ class OneNoteWebUrl: Definition: OneNoteWebUrl """ - href: Optional[str] = None + href: str """A link to the notebook using the OneNote web client.""" @@ -263,14 +326,15 @@ class SectionListItem: Definition: SectionListItem """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the section.""" - pages_url: Optional[str] = field( + pages_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pagesUrl"}, ) """The key used to reference this section; also a url to the pages.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the section.""" @@ -280,45 +344,52 @@ class SectionResponse: Definition: SectionResponse """ - created_by: Optional[str] = field( + created_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) """The creator of the section.""" - created_time: Optional[str] = field( + created_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdTime"}, ) """The creation date and time of the section.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the section.""" - is_default: Optional[bool] = field( + is_default: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isDefault"}, ) """Indicates whether it is the default section.""" - last_modified_by: Optional[str] = field( + last_modified_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedBy"}, ) """The user who last modified the section.""" - last_modified_time: Optional[str] = field( + last_modified_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedTime"}, ) """The last modified date and time of the section.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the section.""" - pages_url: Optional[str] = field( + pages_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pagesUrl"}, ) """Url to the pages in this section.""" - parent_notebook: Optional[ParentNotebook] = field( + parent_notebook: Optional[ParentNotebook | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentNotebook"}, ) - self: Optional[str] = None + self: Optional[str] = dataclass_field(default=None, kw_only=True) """The url to this section.""" @@ -328,36 +399,41 @@ class SectionGroupResponse: Definition: SectionGroupResponse """ - created_time: Optional[str] = field( + created_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdTime"}, ) """The creation date and time of the section group.""" - created_by: Optional[str] = field( + created_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) """The creator of the section group.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the section group.""" - last_modified_by: Optional[str] = field( + last_modified_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedBy"}, ) """The user who last modified the section group.""" - last_modified_time: Optional[str] = field( + last_modified_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedTime"}, ) """The last modification date and time of the section group.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the section group.""" - sections_url: Optional[str] = field( + sections_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sectionsUrl"}, ) """Url of the sections within this section group.""" - self: Optional[str] = None + self: Optional[str] = dataclass_field(default=None, kw_only=True) """The url to this section group.""" @@ -372,7 +448,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -389,8 +465,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -411,7 +487,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -427,15 +503,49 @@ def connector_name(self) -> str: return "onenote" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -452,7 +562,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -465,9 +579,9 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def create_section_in_notebook_async( + async def create_section_in_notebook( self, - input: CreateSectionRequest, + input: CreateSectionRequest | Mapping[str, Any], notebook_key: str, *, timeout: Optional[float] = None, @@ -479,6 +593,24 @@ async def create_section_in_notebook_async( Create section in a notebook Create section in a notebook. + + Swagger operation ID: `CreateSectionInNotebook`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + notebook_key: A key identifying the notebook. Note this is specific + to the API and cannot be hand-typed. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/notebooks/Dynamic/sections" @@ -491,7 +623,7 @@ async def create_section_in_notebook_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -505,6 +637,7 @@ async def create_section_in_notebook_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -512,7 +645,7 @@ async def create_section_in_notebook_async( return json.loads(response.text) - async def create_page_in_section_async( + async def create_page_in_section( self, input: CreatePageInSectionInput, notebook_key: str, @@ -527,6 +660,24 @@ async def create_page_in_section_async( Create page in a section Create new page in a specified section. + + Swagger operation ID: `CreatePageInSection`. + + Args: + input: The request body. + notebook_key: A key identifying the notebook. Note this is specific + to the API and cannot be hand-typed. + section_id: API URL of the section pages. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/sections/Dynamic/pages" query_params = [] @@ -541,7 +692,7 @@ async def create_page_in_section_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -555,6 +706,7 @@ async def create_page_in_section_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -562,7 +714,7 @@ async def create_page_in_section_async( return json.loads(response.text) - async def get_pages_in_section_async( + def list_pages_in_section( self, notebook_key: str, section_id: str, @@ -571,14 +723,32 @@ async def get_pages_in_section_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get pages for a specific section Get pages for a specific section. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetPagesInSection`. + + Args: + notebook_key: A key identifying the notebook. Note this is specific + to the API and cannot be hand-typed. + section_id: API URL of the section pages. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/sections/Dynamic/pages" query_params = [] @@ -592,11 +762,18 @@ async def get_pages_in_section_async( query_params.append(f"sectionId={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -609,23 +786,32 @@ async def get_pages_in_section_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def create_page_in_quick_notes_async( + async def create_page_in_quick_notes( self, input: CreatePageInQuickNotesInput, *, @@ -638,10 +824,25 @@ async def create_page_in_quick_notes_async( Create a page in Quick Notes Create a new page in the Quick Notes section. + + Swagger operation ID: `CreatePageInQuickNotes`. + + Args: + input: The request body. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/pages" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -655,6 +856,7 @@ async def create_page_in_quick_notes_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -662,7 +864,7 @@ async def create_page_in_quick_notes_async( return json.loads(response.text) - async def delete_page_async( + async def delete_page( self, notebook_key: str, section_id: str, @@ -677,6 +879,24 @@ async def delete_page_async( Delete a page Delete a page. + + Swagger operation ID: `DeletePage`. + + Args: + notebook_key: A key identifying the notebook. Note this is specific + to the API and cannot be hand-typed. + section_id: API URL of the section pages. + page_id: Unique id of the page. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/pages" query_params = [] @@ -695,7 +915,7 @@ async def delete_page_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -709,9 +929,10 @@ async def delete_page_async( request_url, response.status, response.text, + response=response, ) - async def get_page_content_async( + async def get_page_content( self, notebook_key: str, section_id: str, @@ -726,6 +947,24 @@ async def get_page_content_async( Get page content Get HTML page content. + + Swagger operation ID: `GetPageContent`. + + Args: + notebook_key: A key identifying the notebook. Note this is specific + to the API and cannot be hand-typed. + section_id: API URL of the section pages. + page_id: Unique id of the page. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/pages/Dynamic/content" query_params = [] @@ -745,7 +984,7 @@ async def get_page_content_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -759,6 +998,7 @@ async def get_page_content_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -766,7 +1006,7 @@ async def get_page_content_async( return json.loads(response.text) - async def update_page_content_async( + async def update_page_content( self, input: UpdatePageContentRequest, notebook_key: str, @@ -782,6 +1022,25 @@ async def update_page_content_async( Update page content Update HTML page content. + + Swagger operation ID: `UpdatePageContent`. + + Args: + input: The request body. + notebook_key: A key identifying the notebook. Note this is specific + to the API and cannot be hand-typed. + section_id: API URL of the section pages. + page_id: Unique id of the page. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/pages/Dynamic/content" query_params = [] @@ -800,7 +1059,7 @@ async def update_page_content_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -814,6 +1073,7 @@ async def update_page_content_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -821,43 +1081,81 @@ async def update_page_content_async( return json.loads(response.text) - async def get_notebooks_async( + def list_notebooks( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get recent notebooks Get recent notebooks. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetNotebooks`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/notebooks" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_sections_in_notebook_async( + def list_sections_in_notebook( self, notebook_key: str, *, @@ -865,11 +1163,30 @@ async def get_sections_in_notebook_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get sections in notebook Get sections in a specific notebook. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetSectionsInNotebook`. + + Args: + notebook_key: A key identifying the notebook. Note this is specific + to the API and cannot be hand-typed. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/notebooks/notebookKey/sections" @@ -881,27 +1198,48 @@ async def get_sections_in_notebook_async( query_params.append(f"notebookKey={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/orderful.py b/src/azure/connectors/orderful.py index 555074b2..8eb7ecf5 100644 --- a/src/azure/connectors/orderful.py +++ b/src/azure/connectors/orderful.py @@ -5,9 +5,10 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, Any, Mapping from urllib.parse import quote +import json from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential @@ -19,6 +20,16 @@ ConnectorResponseHook, ) +__all__ = [ + "OrderfulClient", + "CommunicationChannelCreationResponse", + "CommunicationChannelEventResponse", + "CommunicationChannelInput", + "CommunicationChannelRequestBody", + "CreateTransactionInput", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -28,7 +39,7 @@ class CreateTransactionInput: Create Transaction """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -41,18 +52,12 @@ class CommunicationChannelInput: Listen to Communication Channel """ - is_active: Optional[bool] = field( - default=None, - metadata={"wire_name": "isActive"}, - ) - name: Optional[str] = None + is_active: bool = dataclass_field(metadata={"wire_name": "isActive"}) + name: str """Communication Channel Name.""" - config: Optional[Dict[str, Any]] = None + config: Dict[str, Any] """Configuration of the Trigger""" - owner_id: Optional[int] = field( - default=None, - metadata={"wire_name": "ownerId"}, - ) + owner_id: int = dataclass_field(metadata={"wire_name": "ownerId"}) """Owner of the Orderful account.""" @@ -62,7 +67,7 @@ class CommunicationChannelCreationResponse: Response for Listen to Communication Channel """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) @dataclass @@ -71,7 +76,7 @@ class CommunicationChannelEventResponse: Definition: CommunicationChannelEventResponse """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -84,19 +89,13 @@ class CommunicationChannelRequestBody: Definition: CommunicationChannelRequestBody """ - is_active: Optional[bool] = field( - default=None, - metadata={"wire_name": "isActive"}, - ) + is_active: bool = dataclass_field(metadata={"wire_name": "isActive"}) """If the State of the Trigger is active.""" - name: Optional[str] = None + name: str """Communication Channel Name.""" - config: Optional[Dict[str, Any]] = None + config: Dict[str, Any] """Configuration of the Trigger.""" - owner_id: Optional[int] = field( - default=None, - metadata={"wire_name": "ownerId"}, - ) + owner_id: int = dataclass_field(metadata={"wire_name": "ownerId"}) """Owner of the Orderful account.""" @@ -111,7 +110,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -128,8 +127,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -150,7 +149,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -165,23 +164,37 @@ def __init__( def connector_name(self) -> str: return "orderful" - async def list_transactions_async( + async def list_transactions( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> None: + ) -> dict[str, Any] | None: """ List Transactions Fetches a list of transactions as specified by the filter/sort parameters supplied. + + Swagger operation ID: `ListTransactions`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/transactions" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -195,11 +208,17 @@ async def list_transactions_async( request_url, response.status, response.text, + response=response, ) - async def create_transaction_async( + if not response.text: + return None + + return json.loads(response.text) + + async def create_transaction( self, - input: CreateTransactionInput, + input: CreateTransactionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -210,10 +229,26 @@ async def create_transaction_async( Create Transaction Create Transaction. + + Swagger operation ID: `CreateTransaction`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/transactions" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -227,9 +262,10 @@ async def create_transaction_async( request_url, response.status, response.text, + response=response, ) - async def get_transaction_by_id_async( + async def get_transaction_by_id( self, transaction_id: int, *, @@ -242,13 +278,28 @@ async def get_transaction_by_id_async( Get Transaction by ID Get transaction by ID. + + Swagger operation ID: `GetTransactionById`. + + Args: + transaction_id: The transaction Id used to retrieve transaction.. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/transactions/{quote(str(transaction_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -262,6 +313,7 @@ async def get_transaction_by_id_async( request_url, response.status, response.text, + response=response, ) diff --git a/src/azure/connectors/outlook.py b/src/azure/connectors/outlook.py index 9e80793d..9462439f 100644 --- a/src/azure/connectors/outlook.py +++ b/src/azure/connectors/outlook.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,84 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "OutlookClient", + "ApprovalEmailResponse", + "ApprovalEmailSubscription", + "ApprovalMessage", + "Attendee", + "BatchResponseClientReceiveMessage", + "BlobDataSetsMetadata", + "CalendarEventBackend", + "CalendarEventClient", + "CalendarEventClientReceive", + "CalendarEventClientReceiveStringEnums", + "CalendarEventClientWithActionType", + "CalendarEventHtmlClient", + "CalendarEventList", + "CalendarEventListClientReceive", + "CalendarEventListWithActionType", + "ClientReceiveFileAttachment", + "ClientReceiveMessage", + "ClientReceiveMessageStringEnums", + "ClientSendAttachment", + "ClientSendHtmlMessage", + "ClientSendMessage", + "ClientSubscription", + "Contact", + "ContactResponse", + "DataSet", + "DataSetsList", + "DataSetsMetadata", + "DirectForwardMessage", + "EmailAddress", + "EntityListResponseCalendarEventBackend", + "EntityListResponseCalendarEventClientReceiveStringEnums", + "EntityListResponseContactResponse", + "EntityListResponseFilePickerFile", + "EntityListResponseTable", + "FilePickerFile", + "GeoCoordinates", + "InternetMessageHeader", + "ItemBody", + "Location", + "MessageWithOptions", + "ObjectEntity", + "OptionsEmailSubscription", + "OutlookReceiveAttachment", + "OutlookReceiveMessage", + "PaginatedListResponseCalendarEventClientReceiveStringEnums", + "PassThroughNativeQuery", + "PatternedRecurrence", + "PhysicalAddress", + "Procedure", + "Recipient", + "RecurrencePattern", + "RecurrenceRange", + "ReplyHtmlMessage", + "ReplyMessage", + "ResponseStatus", + "ResponseToEventInvite", + "SubscriptionEvent", + "SubscriptionPayloadEntityOutlookReceiveMessage", + "SubscriptionPayloadEntitySubscriptionEvent", + "SubscriptionPayloadOutlookReceiveMessage", + "SubscriptionPayloadSubscriptionEvent", + "SubscriptionResponse", + "Table", + "TableCapabilitiesMetadata", + "TableFilterRestrictionsMetadata", + "TableMetadata", + "TableSelectRestrictionsMetadata", + "TableSortRestrictionsMetadata", + "TabularDataSetsMetadata", + "TriggerBatchResponseClientReceiveMessage", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,70 +106,107 @@ class ClientReceiveMessage: Response for Get email """ - from_: Optional[str] = field(default=None, metadata={"wire_name": "From"}) + from_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "From"}, + ) """The mailbox owner and sender of the message""" - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """The recipients for the message""" - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """The Cc recipients for the message""" - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """The Bcc recipients for the message""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """The subject of the message""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """The body of the message""" - importance: Optional[int] = field( + importance: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the message (0 - Low, 1 - Normal, 2 - High)""" - body_preview: Optional[str] = field( + body_preview: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BodyPreview"}, ) """The preview of the message""" - has_attachment: Optional[bool] = field( + has_attachment: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HasAttachment"}, ) """Indicates whether the message has attachments""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique identifier of the message""" - internet_message_id: Optional[str] = field( + internet_message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InternetMessageId"}, ) """The message ID in the format specified by RFC2822""" - conversation_id: Optional[str] = field( + conversation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ConversationId"}, ) """The Id of the conversation the email belongs to""" - date_time_received: Optional[str] = field( + date_time_received: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeReceived"}, ) """The date and time the message was received""" - is_read: Optional[bool] = field( + is_read: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsRead"}, ) """Indicates whether the message has been read""" - attachments: Optional[List[ClientReceiveFileAttachment]] = field( + attachments: Optional[ + List[ClientReceiveFileAttachment | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """The file attachments for the message""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Is Html?""" @@ -104,70 +218,107 @@ class ClientReceiveMessageStringEnums: Response for Move email """ - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the message""" - from_: Optional[str] = field(default=None, metadata={"wire_name": "From"}) + from_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "From"}, + ) """The mailbox owner and sender of the message""" - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """The recipients for the message""" - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """The Cc recipients for the message""" - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """The Bcc recipients for the message""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """The subject of the message""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """The body of the message""" - body_preview: Optional[str] = field( + body_preview: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BodyPreview"}, ) """The preview of the message""" - has_attachment: Optional[bool] = field( + has_attachment: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HasAttachment"}, ) """Indicates whether the message has attachments""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique identifier of the message""" - internet_message_id: Optional[str] = field( + internet_message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InternetMessageId"}, ) """The message ID in the format specified by RFC2822""" - conversation_id: Optional[str] = field( + conversation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ConversationId"}, ) """The Id of the conversation the email belongs to""" - date_time_received: Optional[str] = field( + date_time_received: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeReceived"}, ) """The date and time the message was received""" - is_read: Optional[bool] = field( + is_read: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsRead"}, ) """Indicates whether the message has been read""" - attachments: Optional[List[ClientReceiveFileAttachment]] = field( + attachments: Optional[ + List[ClientReceiveFileAttachment | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """The file attachments for the message""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Is Html?""" @@ -179,17 +330,19 @@ class SubscriptionResponse: Response for Send email with options """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the subscription""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """Resource of the subscription request""" - notification_type: Optional[str] = field( + notification_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationType"}, ) """Notification Type""" - notification_url: Optional[str] = field( + notification_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationUrl"}, ) """Notification Url""" @@ -201,7 +354,12 @@ class EntityListResponseTable: Response for Get calendars """ - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -211,7 +369,12 @@ class EntityListResponseContactResponse: Response for Get contacts """ - value: Optional[List[ContactResponse]] = None + value: Optional[ + List[ContactResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -221,169 +384,210 @@ class ContactResponse: Response for Create contact """ - given_name: Optional[str] = field( + given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GivenName"}, ) """The contact's given name""" - home_phones: Optional[List[str]] = field( + home_phones: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HomePhones"}, ) """The contact's home phone numbers""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The contact's unique identifier.""" - parent_folder_id: Optional[str] = field( + parent_folder_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ParentFolderId"}, ) """The ID of the contact's parent folder""" - birthday: Optional[str] = field( + birthday: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Birthday"}, ) """The contact's birthday""" - file_as: Optional[str] = field( + file_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileAs"}, ) """The name the contact is filed under""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The contact's display name""" - initials: Optional[str] = field( + initials: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Initials"}, ) """The contact's initials""" - middle_name: Optional[str] = field( + middle_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MiddleName"}, ) """The contact's middle name""" - nick_name: Optional[str] = field( + nick_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NickName"}, ) """The contact's nickname""" - surname: Optional[str] = field( + surname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Surname"}, ) """The contact's surname""" - title: Optional[str] = field(default=None, metadata={"wire_name": "Title"}) + title: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Title"}, + ) """The contact's title""" - generation: Optional[str] = field( + generation: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Generation"}, ) """The contact's generation""" - email_addresses: Optional[List[EmailAddress]] = field( + email_addresses: Optional[List[EmailAddress | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmailAddresses"}, ) """The contact's email addresses""" - im_addresses: Optional[List[str]] = field( + im_addresses: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImAddresses"}, ) """The contact's instant messaging (IM) addresses""" - job_title: Optional[str] = field( + job_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobTitle"}, ) """The contact's job title""" - company_name: Optional[str] = field( + company_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompanyName"}, ) """The name of the contact's company""" - department: Optional[str] = field( + department: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Department"}, ) """The contact's department""" - office_location: Optional[str] = field( + office_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfficeLocation"}, ) """The location of the contact's office""" - profession: Optional[str] = field( + profession: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Profession"}, ) """The contact's profession""" - business_home_page: Optional[str] = field( + business_home_page: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BusinessHomePage"}, ) """The business home page of the contact""" - assistant_name: Optional[str] = field( + assistant_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AssistantName"}, ) """The name of the contact's assistant""" - manager: Optional[str] = field( + manager: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Manager"}, ) """The name of the contact's manager""" - business_phones: Optional[List[str]] = field( + business_phones: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BusinessPhones"}, ) """The contact's business phone numbers""" - mobile_phone1: Optional[str] = field( + mobile_phone1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MobilePhone1"}, ) """The contact's mobile phone number""" - home_address: Optional[PhysicalAddress] = field( + home_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HomeAddress"}, ) - business_address: Optional[PhysicalAddress] = field( + business_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BusinessAddress"}, ) - other_address: Optional[PhysicalAddress] = field( + other_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OtherAddress"}, ) - yomi_company_name: Optional[str] = field( + yomi_company_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "YomiCompanyName"}, ) """The phonetic Japanese company name of the contact""" - yomi_given_name: Optional[str] = field( + yomi_given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "YomiGivenName"}, ) """The phonetic Japanese given name (first name) of the contact""" - yomi_surname: Optional[str] = field( + yomi_surname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "YomiSurname"}, ) """The phonetic Japanese surname (last name) of the contact""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """The categories associated with the contact""" - change_key: Optional[str] = field( + change_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChangeKey"}, ) """Identifies the version of the event object""" - date_time_created: Optional[str] = field( + date_time_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeCreated"}, ) """The time the contact was created""" - date_time_last_modified: Optional[str] = field( + date_time_last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeLastModified"}, ) """The time the contact was modified""" @@ -395,137 +599,177 @@ class CalendarEventClientReceiveStringEnums: Response for Get event """ - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event: Low, Normal, or High""" - response_type: Optional[str] = field( + response_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseType"}, ) """ The response type of the event: None, Organizer, TentativelyAccepted, Accepted, Declined or NotResponded """ - recurrence: Optional[str] = field( + recurrence: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) """The recurrence pattern for the event""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """Status to show during the event""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Event subject""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Start"}, + ) """Start time of the event (example: '2016-11-01T14:30:00Z')""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "End"}, + ) """End time of the event (example: '2016-11-01T15:30:00Z')""" - response_time: Optional[str] = field( + response_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseTime"}, ) """The response time of the event""" - i_cal_u_id: Optional[str] = field( + i_cal_u_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ICalUId"}, ) """ A unique identifier that is shared by all instances of an event across different calendars """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The event's unique identifier""" - date_time_created: Optional[str] = field( + date_time_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeCreated"}, ) """The date and time that the event was created""" - date_time_last_modified: Optional[str] = field( + date_time_last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeLastModified"}, ) """The date and time that the event was last modified""" - organizer: Optional[str] = field( + organizer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Organizer"}, ) """The organizer of the event""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeZone"}, ) """Time zone of the event""" - series_master_id: Optional[str] = field( + series_master_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SeriesMasterId"}, ) """Unique identifier for Series Master event type""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """The categories associated with the event""" - web_link: Optional[str] = field( + web_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebLink"}, ) """The URL to open the event in Outlook Web App""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OptionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the message associated with the event""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Set to true if the body is Html""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location of the event""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecurrenceEnd"}, ) """End time of the recurrence""" - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) """How many times to repeat the event""" - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ @@ -540,7 +784,12 @@ class CalendarEventListClientReceive: Response for Get events """ - value: Optional[List[CalendarEventClientReceive]] = None + value: Optional[ + List[CalendarEventClientReceive | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of calendar items""" @@ -550,7 +799,12 @@ class CalendarEventListWithActionType: Response for When an event is added, updated or deleted """ - value: Optional[List[CalendarEventClientWithActionType]] = None + value: Optional[ + List[CalendarEventClientWithActionType | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of calendar items""" @@ -560,7 +814,12 @@ class BatchResponseClientReceiveMessage: Response for Get emails """ - value: Optional[List[ClientReceiveMessage]] = None + value: Optional[ + List[ClientReceiveMessage | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of the response objects""" @@ -570,7 +829,12 @@ class EntityListResponseCalendarEventClientReceiveStringEnums: Response for Get calendar view of events """ - value: Optional[List[CalendarEventClientReceiveStringEnums]] = None + value: Optional[ + List[CalendarEventClientReceiveStringEnums | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -580,7 +844,12 @@ class TriggerBatchResponseClientReceiveMessage: Response for When an email is flagged """ - value: Optional[List[ClientReceiveMessage]] = None + value: Optional[ + List[ClientReceiveMessage | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of the response objects""" @@ -590,26 +859,30 @@ class TableMetadata: Definition: TableMetadata """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Table name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Table title""" - x_ms_permission: Optional[str] = field( + x_ms_permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-permission"}, ) """Table permission""" - x_ms_capabilities: Optional[TableCapabilitiesMetadata] = field( + x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-capabilities"}, ) - schema: Optional[ObjectEntity] = None - referenced_entities: Optional[ObjectEntity] = field( + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referencedEntities"}, ) - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """Url link""" @@ -621,30 +894,42 @@ class TableCapabilitiesMetadata: Definition: TableCapabilitiesMetadata """ - sort_restrictions: Optional[TableSortRestrictionsMetadata] = field( + sort_restrictions: Optional[ + TableSortRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortRestrictions"}, ) - filter_restrictions: Optional[TableFilterRestrictionsMetadata] = field( + filter_restrictions: Optional[ + TableFilterRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterRestrictions"}, ) - select_restrictions: Optional[TableSelectRestrictionsMetadata] = field( + select_restrictions: Optional[ + TableSelectRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectRestrictions"}, ) - is_only_server_pagable: Optional[bool] = field( + is_only_server_pagable: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOnlyServerPagable"}, ) """Server paging restrictions""" - filter_function_support: Optional[List[str]] = field( + filter_function_support: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterFunctionSupport"}, ) """List of supported filter capabilities""" - server_paging_options: Optional[List[str]] = field( + server_paging_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serverPagingOptions"}, ) """List of supported server-driven paging capabilities""" @@ -656,7 +941,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -669,15 +954,17 @@ class TableSortRestrictionsMetadata: Definition: TableSortRestrictionsMetadata """ - sortable: Optional[bool] = None + sortable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has sortable columns""" - unsortable_properties: Optional[List[str]] = field( + unsortable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unsortableProperties"}, ) """List of unsortable properties""" - ascending_only_properties: Optional[List[str]] = field( + ascending_only_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ascendingOnlyProperties"}, ) """List of properties which support ascending order only""" @@ -689,15 +976,17 @@ class TableFilterRestrictionsMetadata: Definition: TableFilterRestrictionsMetadata """ - filterable: Optional[bool] = None + filterable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has filterable columns""" - non_filterable_properties: Optional[List[str]] = field( + non_filterable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nonFilterableProperties"}, ) """List of non filterable properties""" - required_properties: Optional[List[str]] = field( + required_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredProperties"}, ) """List of required properties""" @@ -709,7 +998,7 @@ class TableSelectRestrictionsMetadata: Definition: TableSelectRestrictionsMetadata """ - selectable: Optional[bool] = None + selectable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has selectable columns""" @@ -719,7 +1008,12 @@ class CalendarEventList: Definition: CalendarEventList """ - value: Optional[List[CalendarEventBackend]] = None + value: Optional[ + List[CalendarEventBackend | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of calendar items""" @@ -729,153 +1023,183 @@ class CalendarEventBackend: Definition: CalendarEventBackend """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The Event's unique identifier""" - attendees: Optional[List[Attendee]] = field( + attendees: Optional[List[Attendee | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attendees"}, ) """List of attendees for the event""" - body: Optional[ItemBody] = field( + body: Optional[ItemBody | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Body"}, ) - body_preview: Optional[str] = field( + body_preview: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BodyPreview"}, ) """The preview of the message associated with the event""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """The categories associated with the event""" - change_key: Optional[str] = field( + change_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChangeKey"}, ) """ This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well. """ - date_time_created: Optional[str] = field( + date_time_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeCreated"}, ) """The date and time that the event was created""" - date_time_last_modified: Optional[str] = field( + date_time_last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeLastModified"}, ) """The date and time that the event was last modified""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: str = dataclass_field(metadata={"wire_name": "End"}) """The end time of the event""" - end_time_zone: Optional[str] = field( + end_time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndTimeZone"}, ) """ This property specifies the time zone of the meeting end time. The value must be as defined in Windows (example: 'Pacific Standard Time'). """ - has_attachments: Optional[bool] = field( + has_attachments: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HasAttachments"}, ) """Set to true if the event has attachments""" - i_cal_u_id: Optional[str] = field( + i_cal_u_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ICalUId"}, ) """ A unique identifier that is shared by all instances of an event across different calendars """ - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event: Low, Normal, or High""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - is_cancelled: Optional[bool] = field( + is_cancelled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsCancelled"}, ) """Set to true if the event has been canceled""" - is_organizer: Optional[bool] = field( + is_organizer: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsOrganizer"}, ) """Set to true if the message sender is also the organizer""" - location: Optional[Location] = field( + location: Optional[Location | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) - organizer: Optional[Recipient] = field( + organizer: Optional[Recipient | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Organizer"}, ) - recurrence: Optional[PatternedRecurrence] = field( + recurrence: Optional[PatternedRecurrence | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ Set to true if the sender would like a response when the event is accepted or declined """ - response_status: Optional[ResponseStatus] = field( + response_status: Optional[ResponseStatus | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseStatus"}, ) - series_master_id: Optional[str] = field( + series_master_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SeriesMasterId"}, ) """Unique identifier for Series Master event type""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """Shows as free or busy""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: str = dataclass_field(metadata={"wire_name": "Start"}) """The start time of the event""" - start_time_zone: Optional[str] = field( + start_time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartTimeZone"}, ) """ This property specifies the time zone of the meeting start time. The value must be as defined in Windows (example: 'Pacific Standard Time'). """ - subject: Optional[str] = field( + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) + """Event subject""" + type_: Optional[str] = dataclass_field( default=None, - metadata={"wire_name": "Subject"}, + kw_only=True, + metadata={"wire_name": "Type"}, ) - """Event subject""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) """ The event type: Single Instance, Occurrence, Exception, or Series Master """ - web_link: Optional[str] = field( + web_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebLink"}, ) """The preview of the message associated with the event""" - reason: Optional[str] = field( + reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reason"}, ) """ @@ -890,13 +1214,19 @@ class Attendee: Definition: Attendee """ - status: Optional[ResponseStatus] = field( + status: Optional[ResponseStatus | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Status"}, ) - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) - email_address: Optional[EmailAddress] = field( + type_: Optional[str] = dataclass_field( default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) + email_address: Optional[EmailAddress | Mapping[str, Any]] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "EmailAddress"}, ) @@ -907,12 +1237,14 @@ class ItemBody: Definition: ItemBody """ - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentType"}, ) - content: Optional[str] = field( + content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Content"}, ) @@ -923,16 +1255,19 @@ class Location: Definition: Location """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) - address: Optional[PhysicalAddress] = field( + address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Address"}, ) - coordinates: Optional[GeoCoordinates] = field( + coordinates: Optional[GeoCoordinates | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Coordinates"}, ) @@ -943,8 +1278,9 @@ class Recipient: Definition: Recipient """ - email_address: Optional[EmailAddress] = field( + email_address: Optional[EmailAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmailAddress"}, ) @@ -955,12 +1291,14 @@ class PatternedRecurrence: Definition: PatternedRecurrence """ - pattern: Optional[RecurrencePattern] = field( + pattern: Optional[RecurrencePattern | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Pattern"}, ) - range: Optional[RecurrenceRange] = field( + range: Optional[RecurrenceRange | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Range"}, ) @@ -971,11 +1309,16 @@ class ResponseStatus: Definition: ResponseStatus """ - response: Optional[str] = field( + response: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Response"}, ) - time: Optional[str] = field(default=None, metadata={"wire_name": "Time"}) + time: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Time"}, + ) @dataclass @@ -984,9 +1327,14 @@ class EmailAddress: Definition: EmailAddress """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) - address: Optional[str] = field( + name: Optional[str] = dataclass_field( default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) + address: Optional[str] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "Address"}, ) @@ -997,18 +1345,29 @@ class PhysicalAddress: Definition: PhysicalAddress """ - street: Optional[str] = field( + street: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street"}, ) - city: Optional[str] = field(default=None, metadata={"wire_name": "City"}) - state: Optional[str] = field(default=None, metadata={"wire_name": "State"}) - country_or_region: Optional[str] = field( + city: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "City"}, + ) + state: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "State"}, + ) + country_or_region: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CountryOrRegion"}, ) - postal_code: Optional[str] = field( + postal_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PostalCode"}, ) @@ -1019,24 +1378,29 @@ class GeoCoordinates: Definition: GeoCoordinates """ - altitude: Optional[float] = field( + altitude: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Altitude"}, ) - latitude: Optional[float] = field( + latitude: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Latitude"}, ) - longitude: Optional[float] = field( + longitude: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Longitude"}, ) - accuracy: Optional[float] = field( + accuracy: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Accuracy"}, ) - altitude_accuracy: Optional[float] = field( + altitude_accuracy: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AltitudeAccuracy"}, ) @@ -1047,25 +1411,41 @@ class RecurrencePattern: Definition: RecurrencePattern """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) - interval: Optional[int] = field( + type_: Optional[str] = dataclass_field( default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) + interval: Optional[int] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "Interval"}, ) - month: Optional[int] = field(default=None, metadata={"wire_name": "Month"}) - day_of_month: Optional[int] = field( + month: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Month"}, + ) + day_of_month: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DayOfMonth"}, ) - days_of_week: Optional[List[str]] = field( + days_of_week: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DaysOfWeek"}, ) - first_day_of_week: Optional[str] = field( + first_day_of_week: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FirstDayOfWeek"}, ) - index: Optional[str] = field(default=None, metadata={"wire_name": "Index"}) + index: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Index"}, + ) @dataclass @@ -1074,17 +1454,24 @@ class RecurrenceRange: Definition: RecurrenceRange """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) - start_date: Optional[str] = field( + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDate"}, ) - end_date: Optional[str] = field( + end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndDate"}, ) - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) @@ -1095,143 +1482,183 @@ class CalendarEventClientReceive: Definition: CalendarEventClientReceive """ - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Event subject""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Start"}, + ) """Start time of the event (example: '2016-11-01T14:30:00Z')""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "End"}, + ) """End time of the event (example: '2016-11-01T15:30:00Z')""" - show_as: Optional[int] = field( + show_as: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """ Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4) """ - recurrence: Optional[int] = field( + recurrence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) """ The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4) """ - response_type: Optional[int] = field( + response_type: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseType"}, ) """ The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5) """ - response_time: Optional[str] = field( + response_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseTime"}, ) """The response time of the event""" - i_cal_u_id: Optional[str] = field( + i_cal_u_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ICalUId"}, ) """ A unique identifier that is shared by all instances of an event across different calendars """ - importance: Optional[int] = field( + importance: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event (0 - Low, 1 - Normal, 2 - High)""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The event's unique identifier""" - date_time_created: Optional[str] = field( + date_time_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeCreated"}, ) """The date and time that the event was created""" - date_time_last_modified: Optional[str] = field( + date_time_last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeLastModified"}, ) """The date and time that the event was last modified""" - organizer: Optional[str] = field( + organizer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Organizer"}, ) """The organizer of the event""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeZone"}, ) """Time zone of the event""" - series_master_id: Optional[str] = field( + series_master_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SeriesMasterId"}, ) """Unique identifier for Series Master event type""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """The categories associated with the event""" - web_link: Optional[str] = field( + web_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebLink"}, ) """The URL to open the event in Outlook Web App""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OptionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the message associated with the event""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Set to true if the body is Html""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location of the event""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecurrenceEnd"}, ) """End time of the recurrence""" - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) """How many times to repeat the event""" - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ @@ -1246,8 +1673,11 @@ class PaginatedListResponseCalendarEventClientReceiveStringEnums: Definition: PaginatedListResponse[CalendarEventClientReceiveStringEnums] """ - values: Optional[List[CalendarEventClientReceiveStringEnums]] = field( + values: Optional[ + List[CalendarEventClientReceiveStringEnums | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Values"}, ) """Values""" @@ -1259,8 +1689,7 @@ class ClientSubscription: Definition: ClientSubscription """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "NotificationUrl"}, ) """ @@ -1275,7 +1704,12 @@ class EntityListResponseFilePickerFile: Definition: EntityListResponse[FilePickerFile] """ - value: Optional[List[FilePickerFile]] = None + value: Optional[ + List[FilePickerFile | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -1285,19 +1719,29 @@ class FilePickerFile: Definition: FilePickerFile """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Uniquely identifies the file""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Display name for the file""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """Set to true if the file is a folder""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """Path of the file""" @@ -1307,42 +1751,51 @@ class ClientSendMessage: Definition: ClientSendMessage """ - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: str = dataclass_field(metadata={"wire_name": "To"}) """ Specify email addresses separated by semicolons like someone@contoso.com """ - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Specify the subject of the mail""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: str = dataclass_field(metadata={"wire_name": "Body"}) """Specify the body of the mail""" - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Is Html?""" @@ -1354,10 +1807,9 @@ class ClientSendAttachment: Definition: ClientSendAttachment """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: str = dataclass_field(metadata={"wire_name": "Name"}) """Attachment name""" - content_bytes: Optional[str] = field( - default=None, + content_bytes: str = dataclass_field( metadata={"wire_name": "ContentBytes"}, ) """Attachment content""" @@ -1369,34 +1821,51 @@ class ClientReceiveFileAttachment: Definition: ClientReceiveFileAttachment """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Attachment Id""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Attachment name""" - content_bytes: Optional[str] = field( + content_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentBytes"}, ) """Attachment content""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentType"}, ) """Attachment content type""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size in bytes of the attachment""" - is_inline: Optional[bool] = field( + is_inline: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsInline"}, ) """Set to true if this is an inline attachment""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModifiedDateTime"}, ) """The date and time when the attachment was last modified""" - content_id: Optional[str] = field( + content_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentId"}, ) """Content Id""" @@ -1408,44 +1877,56 @@ class ClientSendHtmlMessage: Definition: ClientSendHtmlMessage """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: str = dataclass_field(metadata={"wire_name": "To"}) """ Specify email addresses separated by semicolons like someone@contoso.com """ - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Specify the subject of the mail""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: str = dataclass_field(metadata={"wire_name": "Body"}) """Specify the body of the mail""" - from_: Optional[str] = field(default=None, metadata={"wire_name": "From"}) + from_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "From"}, + ) """ Email address to send mail from (requires \"Send as\" or \"Send on behalf of\" permission for that mailbox). For more info on granting permissions please refer https://docs.microsoft.com/office365/admin/manage/send-email-as-distribution-list """ - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """ Specify email addresses separated by semicolons like someone@contoso.com """ - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" @@ -1457,36 +1938,57 @@ class ReplyMessage: Definition: ReplyMessage """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Email subject (if empty, the original subject used).""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Content of the email.""" - reply_all: Optional[bool] = field( + reply_all: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyAll"}, ) """True to reply to all recipients. (default: False)""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """True to send the reply as HTML. (default: True)""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Pick an importance. (default: Low)""" - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Details of attachments to be sent along with the reply.""" @@ -1498,31 +2000,51 @@ class ReplyHtmlMessage: Definition: ReplyHtmlMessage """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - cc: Optional[str] = field(default=None, metadata={"wire_name": "Cc"}) + cc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cc"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """Example: recipient1@domain.com; recipient2@domain.com""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Email subject (if empty, the original subject used).""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Content of the email.""" - reply_all: Optional[bool] = field( + reply_all: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyAll"}, ) """True to reply to all recipients. (default: False)""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Pick an importance. (default: Low)""" - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Details of attachments to be sent along with the reply.""" @@ -1534,8 +2056,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1544,25 +2076,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -1574,15 +2110,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -1594,15 +2132,13 @@ class OptionsEmailSubscription: Definition: OptionsEmailSubscription """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "NotificationUrl"}, ) """ Gets or sets callback url to flow engine. It is expected as part of request """ - message: Optional[MessageWithOptions] = field( - default=None, + message: MessageWithOptions | Mapping[str, Any] = dataclass_field( metadata={"wire_name": "Message"}, ) @@ -1613,49 +2149,61 @@ class MessageWithOptions: Definition: MessageWithOptions """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: str = dataclass_field(metadata={"wire_name": "To"}) """ Specify email addresses separated by semicolons like someone@contoso.com """ - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Subject of the email""" - options: Optional[str] = field( + options: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Options"}, ) """List of comma separated options for the email response""" - header_text: Optional[str] = field( + header_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HeaderText"}, ) """Header text for email body""" - selection_text: Optional[str] = field( + selection_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SelectionText"}, ) """Header text for users options selection""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the email""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - use_only_h_t_m_l_message: Optional[bool] = field( + use_only_h_t_m_l_message: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UseOnlyHTMLMessage"}, ) """Use only HTML message""" - hide_h_t_m_l_message: Optional[bool] = field( + hide_h_t_m_l_message: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HideHTMLMessage"}, ) """ @@ -1663,8 +2211,9 @@ class MessageWithOptions: displayed. Email clients which do not support actionable messages will display HTML message regardless of the parameter value. """ - show_h_t_m_l_confirmation_dialog: Optional[bool] = field( + show_h_t_m_l_confirmation_dialog: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowHTMLConfirmationDialog"}, ) """ @@ -1679,8 +2228,9 @@ class ApprovalEmailResponse: Definition: ApprovalEmailResponse """ - selected_option: Optional[str] = field( + selected_option: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SelectedOption"}, ) """User response""" @@ -1692,15 +2242,13 @@ class ApprovalEmailSubscription: Definition: ApprovalEmailSubscription """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "NotificationUrl"}, ) """ Gets or sets callback url to flow engine. It is expected as part of request """ - message: Optional[ApprovalMessage] = field( - default=None, + message: ApprovalMessage | Mapping[str, Any] = dataclass_field( metadata={"wire_name": "Message"}, ) @@ -1711,49 +2259,61 @@ class ApprovalMessage: Definition: ApprovalMessage """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: str = dataclass_field(metadata={"wire_name": "To"}) """ Specify email addresses separated by semicolons like someone@contoso.com """ - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Subject""" - options: Optional[str] = field( + options: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Options"}, ) """User Options""" - header_text: Optional[str] = field( + header_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HeaderText"}, ) """Header text for email body""" - selection_text: Optional[str] = field( + selection_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SelectionText"}, ) """Header text for users options selection""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" - attachments: Optional[List[ClientSendAttachment]] = field( + attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - use_only_h_t_m_l_message: Optional[bool] = field( + use_only_h_t_m_l_message: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UseOnlyHTMLMessage"}, ) """Use only HTML message""" - hide_h_t_m_l_message: Optional[bool] = field( + hide_h_t_m_l_message: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HideHTMLMessage"}, ) """ @@ -1761,8 +2321,9 @@ class ApprovalMessage: displayed. Email clients which do not support actionable messages will display HTML message regardless of the parameter value. """ - show_h_t_m_l_confirmation_dialog: Optional[bool] = field( + show_h_t_m_l_confirmation_dialog: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowHTMLConfirmationDialog"}, ) """ @@ -1777,7 +2338,12 @@ class SubscriptionPayloadOutlookReceiveMessage: Definition: SubscriptionPayload[OutlookReceiveMessage] """ - value: Optional[List[SubscriptionPayloadEntityOutlookReceiveMessage]] = None + value: Optional[ + List[SubscriptionPayloadEntityOutlookReceiveMessage | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -1787,28 +2353,33 @@ class SubscriptionPayloadEntityOutlookReceiveMessage: Definition: SubscriptionPayloadEntity[OutlookReceiveMessage] """ - sequence_number: Optional[int] = field( + sequence_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SequenceNumber"}, ) """Sequence number""" - change_type: Optional[str] = field( + change_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChangeType"}, ) """Change type""" - client_state: Optional[str] = field( + client_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClientState"}, ) """Client state""" - resource: Optional[str] = field( + resource: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Resource"}, ) """Resource""" - resource_data: Optional[OutlookReceiveMessage] = field( + resource_data: Optional[OutlookReceiveMessage | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceData"}, ) @@ -1819,93 +2390,119 @@ class OutlookReceiveMessage: Definition: OutlookReceiveMessage """ - internet_message_id: Optional[str] = field( + internet_message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InternetMessageId"}, ) """Internet Message Id""" - body_preview: Optional[str] = field( + body_preview: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BodyPreview"}, ) """Body preview""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Id""" - conversation_id: Optional[str] = field( + conversation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ConversationId"}, ) """Conversation Id""" - has_attachments: Optional[bool] = field( + has_attachments: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HasAttachments"}, ) """Has attachments""" - is_read: Optional[bool] = field( + is_read: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsRead"}, ) """Is read""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedDateTime"}, ) """Created date and time""" - received_date_time: Optional[str] = field( + received_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDateTime"}, ) """Received date and time""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModifiedDateTime"}, ) """Last modified date and time""" - attachments: Optional[List[OutlookReceiveAttachment]] = field( + attachments: Optional[ + List[OutlookReceiveAttachment | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments""" - to_recipients: Optional[List[Recipient]] = field( + to_recipients: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ToRecipients"}, ) """To Recipient""" - cc_recipients: Optional[List[Recipient]] = field( + cc_recipients: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CcRecipients"}, ) """Cc Recipients""" - bcc_recipients: Optional[List[Recipient]] = field( + bcc_recipients: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BccRecipients"}, ) """Bcc Recipients""" - reply_to: Optional[List[Recipient]] = field( + reply_to: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """The email addresses to use when replying""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Subject""" - body: Optional[ItemBody] = field( + body: Optional[ItemBody | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Body"}, ) - from_: Optional[Recipient] = field( + from_: Optional[Recipient | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "From"}, ) - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance""" - internet_message_headers: Optional[List[InternetMessageHeader]] = field( + internet_message_headers: Optional[ + List[InternetMessageHeader | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InternetMessageHeaders"}, ) """Internet message headers""" @@ -1917,54 +2514,75 @@ class OutlookReceiveAttachment: Definition: OutlookReceiveAttachment """ - type_: Optional[str] = field( + type_: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.type"}, ) """OData type""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Attachment Id""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Attachment name""" - content_bytes: Optional[str] = field( + content_bytes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentBytes"}, ) """Attachment content""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentType"}, ) """Attachment content type""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """Attachment size in bytes""" - permission: Optional[str] = field( + permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Permission"}, ) """Permission associated with a reference attachment""" - provider_type: Optional[str] = field( + provider_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ProviderType"}, ) """Provider for the reference attachment""" - source_url: Optional[str] = field( + source_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SourceUrl"}, ) """Reference attachment source url""" - is_inline: Optional[bool] = field( + is_inline: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsInline"}, ) """Set to true if this is an inline attachment""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModifiedDateTime"}, ) """The date and time when the attachment was last modified""" - content_id: Optional[str] = field( + content_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentId"}, ) """Content Id""" @@ -1976,9 +2594,17 @@ class InternetMessageHeader: Definition: InternetMessageHeader """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Header name""" - value: Optional[str] = field(default=None, metadata={"wire_name": "Value"}) + value: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Value"}, + ) """Header value""" @@ -1988,7 +2614,12 @@ class SubscriptionPayloadSubscriptionEvent: Definition: SubscriptionPayload[SubscriptionEvent] """ - value: Optional[List[SubscriptionPayloadEntitySubscriptionEvent]] = None + value: Optional[ + List[SubscriptionPayloadEntitySubscriptionEvent | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -1998,28 +2629,33 @@ class SubscriptionPayloadEntitySubscriptionEvent: Definition: SubscriptionPayloadEntity[SubscriptionEvent] """ - sequence_number: Optional[int] = field( + sequence_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SequenceNumber"}, ) """Sequence number""" - change_type: Optional[str] = field( + change_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChangeType"}, ) """Change type""" - client_state: Optional[str] = field( + client_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClientState"}, ) """Client state""" - resource: Optional[str] = field( + resource: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Resource"}, ) """Resource""" - resource_data: Optional[SubscriptionEvent] = field( + resource_data: Optional[SubscriptionEvent | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceData"}, ) @@ -2030,7 +2666,11 @@ class SubscriptionEvent: Definition: SubscriptionEvent """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The Event's unique identifier""" @@ -2040,15 +2680,21 @@ class Table: Definition: Table """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the table. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the table.""" - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """Additional table properties provided by the connector to the clients.""" @@ -2060,7 +2706,12 @@ class EntityListResponseCalendarEventBackend: Definition: EntityListResponse[CalendarEventBackend] """ - value: Optional[List[CalendarEventBackend]] = None + value: Optional[ + List[CalendarEventBackend | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -2070,84 +2721,99 @@ class CalendarEventClient: Definition: CalendarEventClient """ - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Event subject""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: str = dataclass_field(metadata={"wire_name": "Start"}) """Start time of the event (example: '2016-11-01T14:30:00Z')""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: str = dataclass_field(metadata={"wire_name": "End"}) """End time of the event (example: '2016-11-01T15:30:00Z')""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeZone"}, ) """Time zone of the event""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OptionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the message associated with the event""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Set to true if the body is Html""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location of the event""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event: Low, Normal, or High""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - recurrence: Optional[str] = field( + recurrence: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) """The recurrence pattern for the event""" - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecurrenceEnd"}, ) """End time of the recurrence""" - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) """How many times to repeat the event""" - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """Status to show during the event""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ @@ -2162,79 +2828,93 @@ class CalendarEventHtmlClient: Definition: CalendarEventHtmlClient """ - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Event subject""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: str = dataclass_field(metadata={"wire_name": "Start"}) """Start time of the event (example: '2016-11-01T14:30:00Z')""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: str = dataclass_field(metadata={"wire_name": "End"}) """End time of the event (example: '2016-11-01T15:30:00Z')""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeZone"}, ) """Time zone of the event""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OptionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the message associated with the event""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location of the event""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event: Low, Normal, or High""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - recurrence: Optional[str] = field( + recurrence: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) """The recurrence pattern for the event""" - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecurrenceEnd"}, ) """End time of the recurrence""" - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) """How many times to repeat the event""" - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """Status to show during the event""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ @@ -2249,164 +2929,207 @@ class CalendarEventClientWithActionType: Definition: CalendarEventClientWithActionType """ - action_type: Optional[str] = field( + action_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActionType"}, ) """Changed action type of the event - added, updated or deleted.""" - is_added: Optional[bool] = field( + is_added: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAdded"}, ) """ Flag that indicates whether the event was added since the last poll of the trigger. """ - is_updated: Optional[bool] = field( + is_updated: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsUpdated"}, ) """ Flag that indicates whether the event was updated since the last poll of the trigger. """ - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Event subject""" - start: Optional[str] = field(default=None, metadata={"wire_name": "Start"}) + start: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Start"}, + ) """Start time of the event (example: '2016-11-01T14:30:00Z')""" - end: Optional[str] = field(default=None, metadata={"wire_name": "End"}) + end: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "End"}, + ) """End time of the event (example: '2016-11-01T15:30:00Z')""" - show_as: Optional[int] = field( + show_as: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ShowAs"}, ) """ Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4) """ - recurrence: Optional[int] = field( + recurrence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Recurrence"}, ) """ The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4) """ - response_type: Optional[int] = field( + response_type: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseType"}, ) """ The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5) """ - response_time: Optional[str] = field( + response_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseTime"}, ) """The response time of the event""" - i_cal_u_id: Optional[str] = field( + i_cal_u_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ICalUId"}, ) """ A unique identifier that is shared by all instances of an event across different calendars """ - importance: Optional[int] = field( + importance: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """The importance of the event (0 - Low, 1 - Normal, 2 - High)""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The event's unique identifier""" - date_time_created: Optional[str] = field( + date_time_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeCreated"}, ) """The date and time that the event was created""" - date_time_last_modified: Optional[str] = field( + date_time_last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeLastModified"}, ) """The date and time that the event was last modified""" - organizer: Optional[str] = field( + organizer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Organizer"}, ) """The organizer of the event""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeZone"}, ) """Time zone of the event""" - series_master_id: Optional[str] = field( + series_master_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SeriesMasterId"}, ) """Unique identifier for Series Master event type""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """The categories associated with the event""" - web_link: Optional[str] = field( + web_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebLink"}, ) """The URL to open the event in Outlook Web App""" - required_attendees: Optional[str] = field( + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OptionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - resource_attendees: Optional[str] = field( + resource_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResourceAttendees"}, ) """Resource attendees for the event separated by semicolons""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Body of the message associated with the event""" - is_html: Optional[bool] = field( + is_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsHtml"}, ) """Set to true if the body is Html""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location of the event""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsAllDay"}, ) """Set to true if the event lasts all day""" - recurrence_end: Optional[str] = field( + recurrence_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecurrenceEnd"}, ) """End time of the recurrence""" - number_of_occurrences: Optional[int] = field( + number_of_occurrences: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfOccurrences"}, ) """How many times to repeat the event""" - reminder: Optional[int] = field( + reminder: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reminder"}, ) """Time in minutes before event start to remind""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResponseRequested"}, ) """ @@ -2421,169 +3144,204 @@ class Contact: Definition: Contact """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The contact's unique identifier.""" - parent_folder_id: Optional[str] = field( + parent_folder_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ParentFolderId"}, ) """The ID of the contact's parent folder""" - birthday: Optional[str] = field( + birthday: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Birthday"}, ) """The contact's birthday""" - file_as: Optional[str] = field( + file_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileAs"}, ) """The name the contact is filed under""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The contact's display name""" - given_name: Optional[str] = field( - default=None, - metadata={"wire_name": "GivenName"}, - ) + given_name: str = dataclass_field(metadata={"wire_name": "GivenName"}) """The contact's given name""" - initials: Optional[str] = field( + initials: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Initials"}, ) """The contact's initials""" - middle_name: Optional[str] = field( + middle_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MiddleName"}, ) """The contact's middle name""" - nick_name: Optional[str] = field( + nick_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NickName"}, ) """The contact's nickname""" - surname: Optional[str] = field( + surname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Surname"}, ) """The contact's surname""" - title: Optional[str] = field(default=None, metadata={"wire_name": "Title"}) + title: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Title"}, + ) """The contact's title""" - generation: Optional[str] = field( + generation: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Generation"}, ) """The contact's generation""" - email_addresses: Optional[List[EmailAddress]] = field( + email_addresses: Optional[List[EmailAddress | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmailAddresses"}, ) """The contact's email addresses""" - im_addresses: Optional[List[str]] = field( + im_addresses: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImAddresses"}, ) """The contact's instant messaging (IM) addresses""" - job_title: Optional[str] = field( + job_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobTitle"}, ) """The contact's job title""" - company_name: Optional[str] = field( + company_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompanyName"}, ) """The name of the contact's company""" - department: Optional[str] = field( + department: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Department"}, ) """The contact's department""" - office_location: Optional[str] = field( + office_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfficeLocation"}, ) """The location of the contact's office""" - profession: Optional[str] = field( + profession: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Profession"}, ) """The contact's profession""" - business_home_page: Optional[str] = field( + business_home_page: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BusinessHomePage"}, ) """The business home page of the contact""" - assistant_name: Optional[str] = field( + assistant_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AssistantName"}, ) """The name of the contact's assistant""" - manager: Optional[str] = field( + manager: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Manager"}, ) """The name of the contact's manager""" - home_phones: Optional[List[str]] = field( - default=None, + home_phones: List[str] = dataclass_field( metadata={"wire_name": "HomePhones"}, ) """The contact's home phone numbers""" - business_phones: Optional[List[str]] = field( + business_phones: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BusinessPhones"}, ) """The contact's business phone numbers""" - mobile_phone1: Optional[str] = field( + mobile_phone1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MobilePhone1"}, ) """The contact's mobile phone number""" - home_address: Optional[PhysicalAddress] = field( + home_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HomeAddress"}, ) - business_address: Optional[PhysicalAddress] = field( + business_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BusinessAddress"}, ) - other_address: Optional[PhysicalAddress] = field( + other_address: Optional[PhysicalAddress | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OtherAddress"}, ) - yomi_company_name: Optional[str] = field( + yomi_company_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "YomiCompanyName"}, ) """The phonetic Japanese company name of the contact""" - yomi_given_name: Optional[str] = field( + yomi_given_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "YomiGivenName"}, ) """The phonetic Japanese given name (first name) of the contact""" - yomi_surname: Optional[str] = field( + yomi_surname: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "YomiSurname"}, ) """The phonetic Japanese surname (last name) of the contact""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """The categories associated with the contact""" - change_key: Optional[str] = field( + change_key: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChangeKey"}, ) """Identifies the version of the event object""" - date_time_created: Optional[str] = field( + date_time_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeCreated"}, ) """The time the contact was created""" - date_time_last_modified: Optional[str] = field( + date_time_last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateTimeLastModified"}, ) """The time the contact was modified""" @@ -2595,7 +3353,12 @@ class DataSetsList: Definition: DataSetsList """ - value: Optional[List[DataSet]] = None + value: Optional[ + List[DataSet | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of datasets""" @@ -2605,14 +3368,24 @@ class DataSet: Definition: DataSet """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Dataset name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Dataset display name""" - query: Optional[List[PassThroughNativeQuery]] = None + query: Optional[ + List[PassThroughNativeQuery | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Pass-through Native Queries""" @@ -2622,10 +3395,15 @@ class Procedure: Definition: Procedure """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Procedure name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Procedure display name""" @@ -2637,8 +3415,9 @@ class PassThroughNativeQuery: Definition: PassThroughNativeQuery """ - language: Optional[str] = field( + language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Language"}, ) """Query language""" @@ -2650,13 +3429,15 @@ class ResponseToEventInvite: Definition: ResponseToEventInvite """ - comment: Optional[str] = field( + comment: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comment"}, ) """Comment""" - send_response: Optional[bool] = field( + send_response: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SendResponse"}, ) """Send response to organizer?""" @@ -2668,13 +3449,13 @@ class DirectForwardMessage: Definition: DirectForwardMessage """ - comment: Optional[str] = field( + comment: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comment"}, ) """Comment""" - to_recipients: Optional[str] = field( - default=None, + to_recipients: str = dataclass_field( metadata={"wire_name": "ToRecipients"}, ) """Semicolon separated list of recipients to forward the message to""" @@ -2691,7 +3472,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -2708,8 +3489,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -2730,7 +3511,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -2745,12 +3526,89 @@ def __init__( def connector_name(self) -> str: return "outlook" - async def get_email_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def get_email( self, message_id: str, + *, include_attachments: Optional[bool] = None, internet_message_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2760,6 +3618,24 @@ async def get_email_async( Get email This operation gets an email by id. + + Swagger operation ID: `GetEmail`. + + Args: + message_id: Id of the email. + include_attachments: If set to true, attachments content will also + be retrieved along with the email. + internet_message_id: Internet Message Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2779,7 +3655,7 @@ async def get_email_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2793,6 +3669,7 @@ async def get_email_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2800,7 +3677,7 @@ async def get_email_async( return json.loads(response.text) - async def delete_email_async( + async def delete_email( self, message_id: str, *, @@ -2813,13 +3690,28 @@ async def delete_email_async( Delete email This operation deletes an email by id. + + Swagger operation ID: `DeleteEmail`. + + Args: + message_id: Id of the email to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Mail/{quote(str(message_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2833,9 +3725,10 @@ async def delete_email_async( request_url, response.status, response.text, + response=response, ) - async def move_async( + async def move( self, message_id: str, folder_path: str, @@ -2849,6 +3742,22 @@ async def move_async( Move email This operation moves an email to the specified folder. + + Swagger operation ID: `Move`. + + Args: + message_id: Id of the email to be moved. + folder_path: Mail folder to move the email to. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2862,7 +3771,7 @@ async def move_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2876,6 +3785,7 @@ async def move_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2883,7 +3793,7 @@ async def move_async( return json.loads(response.text) - async def flag_async( + async def flag( self, message_id: str, *, @@ -2896,13 +3806,28 @@ async def flag_async( Flag email This operation flags an email. + + Swagger operation ID: `Flag`. + + Args: + message_id: Id of the email to be flagged. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Mail/Flag/{quote(str(message_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2916,9 +3841,10 @@ async def flag_async( request_url, response.status, response.text, + response=response, ) - async def mark_as_read_async( + async def mark_as_read( self, message_id: str, *, @@ -2931,13 +3857,28 @@ async def mark_as_read_async( Mark as read This operation marks an email as having been read. + + Swagger operation ID: `MarkAsRead`. + + Args: + message_id: Id of the email to be marked as read. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/Mail/MarkAsRead/{quote(str(message_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2951,9 +3892,10 @@ async def mark_as_read_async( request_url, response.status, response.text, + response=response, ) - async def get_attachment_async( + async def get_attachment( self, message_id: str, attachment_id: str, @@ -2967,6 +3909,22 @@ async def get_attachment_async( Get attachment This operation gets an email attachment by id. + + Swagger operation ID: `GetAttachment`. + + Args: + message_id: Id of the email. + attachment_id: Id of the attachment to download. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2976,7 +3934,7 @@ async def get_attachment_async( f"/{quote(str(attachment_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2990,13 +3948,14 @@ async def get_attachment_async( request_url, response.status, response.text, + response=response, ) return response.content - async def send_mail_with_options_async( + async def send_mail_with_options( self, - input: OptionsEmailSubscription, + input: OptionsEmailSubscription | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -3011,12 +3970,28 @@ async def send_mail_with_options_async( following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages. + + Swagger operation ID: `SendMailWithOptions`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/mailwithoptions/$subscriptions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3030,6 +4005,7 @@ async def send_mail_with_options_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3037,9 +4013,9 @@ async def send_mail_with_options_async( return json.loads(response.text) - async def send_approval_mail_async( + async def send_approval_mail( self, - input: ApprovalEmailSubscription, + input: ApprovalEmailSubscription | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -3053,12 +4029,28 @@ async def send_approval_mail_async( the recipient. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages. + + Swagger operation ID: `SendApprovalMail`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/approvalmail/$subscriptions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3072,6 +4064,7 @@ async def send_approval_mail_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3079,45 +4072,83 @@ async def send_approval_mail_async( return json.loads(response.text) - async def calendar_get_tables_async( + def list_calendar_get_tables( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get calendars This operation lists available calendars. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `CalendarGetTables`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/calendars/tables" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def calendar_delete_item_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def calendar_delete_item( self, table: str, id: str, @@ -3131,6 +4162,22 @@ async def calendar_delete_item_async( Delete event This operation deletes an event in a calendar. + + Swagger operation ID: `CalendarDeleteItem`. + + Args: + table: Select a calendar. + id: Select an event. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3142,7 +4189,7 @@ async def calendar_delete_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -3156,63 +4203,126 @@ async def calendar_delete_item_async( request_url, response.status, response.text, + response=response, ) - async def contact_get_tables_async( + def list_contact_get_tables( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get contact folders This operation lists available contacts folders. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ContactGetTables`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/contacts/tables" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def contact_get_items_async( + def list_contact_get_items( self, table: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get contacts This operation gets contacts from a contacts folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ContactGetItems`. + + Args: + table: Unique identifier of the contacts folder to retrieve. + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3245,31 +4355,52 @@ async def contact_get_items_async( query_params.append(f"$skip={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def contact_post_item_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def contact_post_item( self, - input: Contact, + input: Contact | Mapping[str, Any], table: str, *, timeout: Optional[float] = None, @@ -3281,6 +4412,23 @@ async def contact_post_item_async( Create contact This operation creates a new contact in a contacts folder. + + Swagger operation ID: `ContactPostItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + table: Select a contacts folder. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3291,7 +4439,7 @@ async def contact_post_item_async( f"/items" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3305,6 +4453,7 @@ async def contact_post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3312,7 +4461,7 @@ async def contact_post_item_async( return json.loads(response.text) - async def contact_get_item_async( + async def contact_get_item( self, table: str, id: str, @@ -3326,6 +4475,22 @@ async def contact_get_item_async( Get contact This operation gets a specific contact from a contacts folder. + + Swagger operation ID: `ContactGetItem`. + + Args: + table: Select a contacts folder. + id: Unique identifier of a contact to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3337,7 +4502,7 @@ async def contact_get_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3351,6 +4516,7 @@ async def contact_get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3358,7 +4524,7 @@ async def contact_get_item_async( return json.loads(response.text) - async def contact_delete_item_async( + async def contact_delete_item( self, table: str, id: str, @@ -3372,6 +4538,22 @@ async def contact_delete_item_async( Delete contact This operation deletes a contact from a contacts folder. + + Swagger operation ID: `ContactDeleteItem`. + + Args: + table: Select a contacts folder. + id: Unique identifier of contact to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3383,7 +4565,7 @@ async def contact_delete_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -3397,11 +4579,12 @@ async def contact_delete_item_async( request_url, response.status, response.text, + response=response, ) - async def contact_patch_item_async( + async def contact_patch_item( self, - input: Contact, + input: Contact | Mapping[str, Any], table: str, id: str, *, @@ -3414,6 +4597,24 @@ async def contact_patch_item_async( Update contact This operation updates a contact in a contacts folder. + + Swagger operation ID: `ContactPatchItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + table: Select a contacts folder. + id: Unique identifier of contact to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3425,7 +4626,7 @@ async def contact_patch_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -3439,6 +4640,7 @@ async def contact_patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3446,9 +4648,9 @@ async def contact_patch_item_async( return json.loads(response.text) - async def respond_to_event_async( + async def respond_to_event( self, - input: ResponseToEventInvite, + input: ResponseToEventInvite | Mapping[str, Any], event_id: str, response: str, *, @@ -3461,6 +4663,24 @@ async def respond_to_event_async( Respond to an event invite Respond to an event invite. + + Swagger operation ID: `RespondToEvent`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + event_id: Id of the event to respond to. + response: Response for the event invite. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3473,7 +4693,7 @@ async def respond_to_event_async( f"/{quote(str(response), safe='')}" ) - http_response = await self.http_client.send_async( + http_response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3487,11 +4707,12 @@ async def respond_to_event_async( request_url, http_response.status, http_response.text, + response=http_response, ) - async def forward_email_async( + async def forward_email( self, - input: DirectForwardMessage, + input: DirectForwardMessage | Mapping[str, Any], message_id: str, *, timeout: Optional[float] = None, @@ -3503,6 +4724,23 @@ async def forward_email_async( Forward an email Forward an email. + + Swagger operation ID: `ForwardEmail`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + message_id: Id of the message to forward. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3515,7 +4753,7 @@ async def forward_email_async( f"/forward" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3529,9 +4767,10 @@ async def forward_email_async( request_url, response.status, response.text, + response=response, ) - async def calendar_get_item_async( + async def calendar_get_item( self, table: str, id: str, @@ -3545,6 +4784,22 @@ async def calendar_get_item_async( Get event This operation gets a specific event from a calendar. + + Swagger operation ID: `V2CalendarGetItem`. + + Args: + table: Select a calendar. + id: Select an event. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3557,7 +4812,7 @@ async def calendar_get_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3571,6 +4826,7 @@ async def calendar_get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3578,23 +4834,47 @@ async def calendar_get_item_async( return json.loads(response.text) - async def calendar_get_items_async( + def list_calendar_get_items( self, table: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get events This operation gets events from a calendar. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `V3CalendarGetItems`. + + Args: + table: Select a calendar. + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3628,31 +4908,52 @@ async def calendar_get_items_async( query_params.append(f"$skip={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def calendar_patch_item_async( + async def calendar_patch_item( self, - input: CalendarEventHtmlClient, + input: CalendarEventHtmlClient | Mapping[str, Any], table: str, id: str, *, @@ -3665,6 +4966,24 @@ async def calendar_patch_item_async( Update event This operation updates an event in a calendar. + + Swagger operation ID: `V3CalendarPatchItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + table: Select a calendar. + id: Select an event. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3677,7 +4996,7 @@ async def calendar_patch_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -3691,6 +5010,7 @@ async def calendar_patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3698,9 +5018,9 @@ async def calendar_patch_item_async( return json.loads(response.text) - async def calendar_post_item_async( + async def calendar_post_item( self, - input: CalendarEventHtmlClient, + input: CalendarEventHtmlClient | Mapping[str, Any], table: str, *, timeout: Optional[float] = None, @@ -3712,6 +5032,23 @@ async def calendar_post_item_async( Create event This operation creates a new event in a calendar. + + Swagger operation ID: `V3CalendarPostItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + table: Select a calendar. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3723,7 +5060,7 @@ async def calendar_post_item_async( f"/items" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3737,6 +5074,7 @@ async def calendar_post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3744,8 +5082,9 @@ async def calendar_post_item_async( return json.loads(response.text) - async def get_emails_async( + def list_emails( self, + *, folder_path: Optional[str] = None, to: Optional[str] = None, cc: Optional[str] = None, @@ -3758,16 +5097,54 @@ async def get_emails_async( include_attachments: Optional[bool] = None, search_query: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get emails This operation gets emails from a folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetEmailsV2`. + + Args: + folder_path: Mail folder to retrieve emails from (default: + 'Inbox'). + to: Recipient email addresses separated by semicolons (If any + match, the trigger will run). + cc: CC recipient email addresses separated by semicolons (If any + match, the trigger will run). + to_or_cc: To or CC recipient email addresses separated by + semicolons (If any match, the trigger will run). + from_: Sender email addresses separated by semicolons (If any + match, the trigger will run). + importance: Importance of the email (Any, High, Normal, Low). + fetch_only_with_attachment: If set to true, only emails with an + attachment will be retrieved. Emails without any attachments + will be skipped. If set to false, all emails will be retrieved. + subject_filter: String to look for in the subject line. + fetch_only_unread: Retrieve only unread emails?. + include_attachments: If set to true, attachments content will also + be retrieved along with the email. + search_query: Search query to filter emails. How to use '$search' + parameter please refer to: + https://docs.microsoft.com/previous-versions/office/office-365-api/api/version-2.0/complex-types-for-mail-contacts-calendar#search-requests. + top: Number of emails to retrieve (default: 10). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/Mail" query_params = [] @@ -3834,49 +5211,99 @@ async def get_emails_async( query_params.append(f"top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_events_calendar_view_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_events_calendar_view( self, calendar_id: str, start_date_time_offset: str, end_date_time_offset: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, search: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get calendar view of events This operation gets all events (including instances of recurrences) in a calendar. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetEventsCalendarViewV2`. + + Args: + calendar_id: Select a calendar. + start_date_time_offset: Start time (example: + '2017-01-01T08:00:00-07:00'). + end_date_time_offset: End time (example: + '2017-02-01T08:00:00-07:00'). + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + search: Search text for matching event body and subject. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3922,31 +5349,52 @@ async def get_events_calendar_view_async( query_params.append(f"search={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def reply_to_async( + async def reply_to( self, - input: ReplyHtmlMessage, + input: ReplyHtmlMessage | Mapping[str, Any], message_id: str, *, timeout: Optional[float] = None, @@ -3958,13 +5406,30 @@ async def reply_to_async( Reply to email This operation replies to an email. + + Swagger operation ID: `ReplyToV3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + message_id: Id of the email to reply to. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v3/Mail/ReplyTo/{quote(str(message_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3978,11 +5443,12 @@ async def reply_to_async( request_url, response.status, response.text, + response=response, ) - async def send_email_async( + async def send_email( self, - input: ClientSendHtmlMessage, + input: ClientSendHtmlMessage | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -3993,10 +5459,26 @@ async def send_email_async( Send an email This operation sends an email message. + + Swagger operation ID: `SendEmailV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/Mail" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4010,6 +5492,7 @@ async def send_email_async( request_url, response.status, response.text, + response=response, ) diff --git a/src/azure/connectors/pdfco.py b/src/azure/connectors/pdfco.py index eb7179fc..cf1b170a 100644 --- a/src/azure/connectors/pdfco.py +++ b/src/azure/connectors/pdfco.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Any, Mapping import json @@ -19,6 +19,116 @@ ConnectorResponseHook, ) +__all__ = [ + "PdfcoClient", + "BarcodeGeneratorInput", + "BarcodeGeneratorResponse", + "BarcodeReaderInput", + "BarcodeReaderResponse", + "DocumentParserInput", + "DocumentParserResponse", + "EmailAttachmentExtractionInput", + "EmailAttachmentExtractionResponse", + "EmailDecodeInput", + "EmailDecodeResponse", + "EmailSendInput", + "EmailSendResponse", + "HtmlToPdfInput", + "HtmlToPdfResponse", + "JobCheckInput", + "JobCheckResponse", + "MergePdfInput", + "MergePdfResponse", + "MergePdfSimplifiedInput", + "MergePdfSimplifiedResponse", + "PDFAddSecurityInput", + "PDFAddSecurityResponse", + "PDFAttachmentExtractionInput", + "PDFAttachmentExtractionResponse", + "PDFAutoRotatePagesInput", + "PDFAutoRotatePagesResponse", + "PDFClassifierInput", + "PDFClassifierResponse", + "PDFCompressInput", + "PDFCompressResponse", + "PDFDeletePagesInput", + "PDFDeletePagesResponse", + "PDFFindTableInput", + "PDFFindTableResponse", + "PDFFormsInfoReaderInput", + "PDFFormsInfoReaderResponse", + "PDFFromCSVInput", + "PDFFromCSVResponse", + "PDFFromDocInput", + "PDFFromDocResponse", + "PDFFromEmailInput", + "PDFFromEmailResponse", + "PDFFromImagesInput", + "PDFFromImagesResponse", + "PDFFromXLSXLSXInput", + "PDFFromXLSXLSXResponse", + "PDFInfoReaderInput", + "PDFInfoReaderResponse", + "PDFRotatePagesInput", + "PDFRotatePagesResponse", + "PDFSearchTextInput", + "PDFSearchTextResponse", + "PDFSearchableInput", + "PDFSearchableResponse", + "PDFSecurityRemoveInput", + "PDFSecurityRemoveResponse", + "PDFToCSVInput", + "PDFToCSVResponse", + "PDFToJPGInput", + "PDFToJPGResponse", + "PDFToJSONInput", + "PDFToJSONMetaInput", + "PDFToJSONMetaResponse", + "PDFToJSONResponse", + "PDFToPNGInput", + "PDFToPNGResponse", + "PDFToTIFFInput", + "PDFToTIFFResponse", + "PDFToTextInput", + "PDFToTextResponse", + "PDFToTextSimpleInput", + "PDFToTextSimpleResponse", + "PDFToWEBPInput", + "PDFToWEBPResponse", + "PDFToXLSInput", + "PDFToXLSResponse", + "PDFToXLSXInput", + "PDFToXLSXResponse", + "PDFToXMLInput", + "PDFToXMLResponse", + "PDFUnSearchableInput", + "PDFUnSearchableResponse", + "PdfFillerInput", + "PdfFillerResponse", + "SearchAndDeleteTextInput", + "SearchAndDeleteTextResponse", + "SearchAndReplaceInput", + "SearchAndReplaceResponse", + "SearchAndReplaceWithImageInput", + "SearchAndReplaceWithImageResponse", + "SplitPdf2Input", + "SplitPdf2Response", + "SplitPdfInput", + "SplitPdfResponse", + "UrlToPdfInput", + "UrlToPdfResponse", + "XLStoCSVInput", + "XLStoCSVResponse", + "XLStoHTMLInput", + "XLStoHTMLResponse", + "XLStoJSONInput", + "XLStoJSONResponse", + "XLStoTXTInput", + "XLStoTXTResponse", + "XLStoXMLInput", + "XLStoXMLResponse", +] + # Type Definitions @@ -28,17 +138,18 @@ class HtmlToPdfInput: HTML to PDF """ - html: Optional[str] = None + html: str """Input HTML code to be converted.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Base file name for new PDF files.""" - margins: Optional[str] = None + margins: Optional[str] = dataclass_field(default=None, kw_only=True) """ Override default margins with custom values (the order is `top right bottom left`). You can als set all margins: `10px`, `5mm`, `5in` for all sides. """ - paper_size: Optional[str] = field( + paper_size: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "paperSize"}, ) """ @@ -47,18 +158,19 @@ class HtmlToPdfInput: or in (inches) with width and height separated by space like this: 200 300, 200px 300px, 200mm 300mm, 20cm 30cm or 6in 8in. """ - orientation: Optional[str] = None + orientation: Optional[str] = dataclass_field(default=None, kw_only=True) """PDF page orientation.""" - print_background: Optional[bool] = field( + print_background: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "printBackground"}, ) """Enable or disable printing of document background""" - header: Optional[str] = None + header: Optional[str] = dataclass_field(default=None, kw_only=True) """Set to HTML for header to be applied on every page at the header.""" - footer: Optional[str] = None + footer: Optional[str] = dataclass_field(default=None, kw_only=True) """Set to HTML for footer to be applied on every page at the bottom.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -66,15 +178,16 @@ class HtmlToPdfInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -91,30 +204,33 @@ class HtmlToPdfResponse: Response for HTML to PDF """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document URL.""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """Number of pages in the output document.""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether the operation is successful or not.""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """Status code for HTTP response""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """PDF.co credits used for this request""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """Request execution duration""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """PDF.co account remaining credits""" @@ -126,20 +242,21 @@ class UrlToPdfInput: URL to PDF """ - url: Optional[str] = None + url: str """ Link to input HTML file or website page to be converted. You can pass link to file from Google Drive, Dropbox or another online file service that can generate shareable links. """ - margins: Optional[str] = None + margins: Optional[str] = dataclass_field(default=None, kw_only=True) """ Margins to be used in output document. Set to css style margins like 10px, 5mm, 5in for all sides or 5px 5px 5px 5px (the order of margins is top, right, bottom, left). """ - paper_size: Optional[str] = field( + paper_size: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "paperSize"}, ) """ @@ -148,18 +265,19 @@ class UrlToPdfInput: mm or in (inches) with width and height separated by space like this: 200 300, 200px 300px, 200mm 300mm, 20cm 30cm or 6in 8in. """ - orientation: Optional[str] = None + orientation: Optional[str] = dataclass_field(default=None, kw_only=True) """Output page orientation""" - print_background: Optional[bool] = field( + print_background: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "printBackground"}, ) """Enable or disable printing of document background""" - header: Optional[str] = None + header: Optional[str] = dataclass_field(default=None, kw_only=True) """Set to HTML for header to be applied on every page at the header.""" - footer: Optional[str] = None + footer: Optional[str] = dataclass_field(default=None, kw_only=True) """Set to HTML for footer to be applied on every page at the bottom.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -167,15 +285,16 @@ class UrlToPdfInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -192,30 +311,33 @@ class UrlToPdfResponse: Response for URL to PDF """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document URL.""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """Number of pages in the output document.""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether the operation is successful or not.""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """Status code for HTTP response""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """PDF.co credits used for this request""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """Request execution duration""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """PDF.co account remaining credits""" @@ -227,10 +349,11 @@ class PdfFillerInput: Add Text, Images, Form Fields to PDF """ - url: Optional[str] = None + url: str """Url to the input PDF document""" - annotations_string: Optional[str] = field( + annotations_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "annotationsString"}, ) """ @@ -238,8 +361,9 @@ class PdfFillerInput: \"x;y;page;text\". Refer to PDF.co documentations for more advanced formats and examples. """ - images_string: Optional[str] = field( + images_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "imagesString"}, ) """ @@ -247,21 +371,22 @@ class PdfFillerInput: \"x;y;page;urltoimage;link;width;height\". Refer to PDF.co documentations for more advanced formats and examples. """ - fields_string: Optional[str] = field( + fields_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fieldsString"}, ) """ Fill PDF form fields. Format should be like \"page;fieldName;value\". Refer to PDF.co documentations for more advanced formats and examples. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Output PDF Name""" - inline: Optional[bool] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Determines whether to return output in response or link to output file. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -269,15 +394,16 @@ class PdfFillerInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -294,30 +420,33 @@ class PdfFillerResponse: Response for Add Text, Images, Form Fields to PDF """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document URL.""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """Number of pages in the output document.""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether the operation is successful or not.""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """Status code for HTTP response""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """PDF.co credits used for this request""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """Request execution duration""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """PDF.co account remaining credits""" @@ -329,7 +458,7 @@ class MergePdfSimplifiedInput: Merge PDF """ - url: Optional[str] = None + url: str """ The comma-separated list of links to PDFs files. Supports links to external sites, `filetoken://..` from PDF.co Files storage and links to G Drive, @@ -337,7 +466,7 @@ class MergePdfSimplifiedInput: For password protected PDF files, use PDF Security module first to unlock input pdf. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -345,14 +474,15 @@ class MergePdfSimplifiedInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -369,30 +499,33 @@ class MergePdfSimplifiedResponse: Response for Merge PDF """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document URL.""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """Number of pages in the output document.""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether the operation is successful or not.""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """Status code for HTTP response""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """PDF.co credits used for this request""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """Request execution duration""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """PDF.co account remaining credits""" @@ -404,7 +537,7 @@ class MergePdfInput: Merge PDF (Advanced) """ - url: Optional[str] = None + url: str """ The comma-separated list of links to PDFs, documents, spreadsheets, images. Supports links to external sites, `filetoken://..` from PDF.co Files @@ -412,7 +545,7 @@ class MergePdfInput: accessible without password. For password protected PDF files, use PDF Security module first to unlock input pdf. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -420,14 +553,15 @@ class MergePdfInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -444,30 +578,33 @@ class MergePdfResponse: Response for Merge PDF (Advanced) """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document URL.""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """Number of pages in the output document.""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether the operation is successful or not.""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """Status code for HTTP response""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """PDF.co credits used for this request""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """Request execution duration""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """PDF.co account remaining credits""" @@ -479,21 +616,21 @@ class SplitPdfInput: Split PDF """ - url: Optional[str] = None + url: str """Url to the source PDF document""" - pages: Optional[str] = None + pages: str """ Comma-separated list of page indices (or ranges) to split into. First page is 1 (one). Example: \"1,2-5,7-\". Special cases: to extract each page into separate PDF use to `*`. """ - inline: Optional[bool] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Determines whether to return output in response or link to output file. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Base file name for new PDF files""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -501,14 +638,15 @@ class SplitPdfInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """Creates a background processing job.""" @@ -520,32 +658,35 @@ class SplitPdfResponse: Response for Split PDF """ - urls: Optional[List[str]] = None + urls: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """urls""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document URL.""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """Number of pages in the output document.""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether the operation is successful or not.""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """Status code for HTTP response""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """PDF.co credits used for this request""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """Request execution duration""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """PDF.co account remaining credits""" @@ -557,10 +698,9 @@ class SplitPdf2Input: Split PDF (Advanced) """ - url: Optional[str] = None + url: str """Url to the source PDF document""" - search_string: Optional[str] = field( - default=None, + search_string: str = dataclass_field( metadata={"wire_name": "searchString"}, ) """ @@ -568,22 +708,25 @@ class SplitPdf2Input: visit https://developer.pdf.co/api/pdf-split/index.html?utm_source=api-docs#post-tag-pdf-split2 """ - exclude_key_pages: Optional[bool] = field( + exclude_key_pages: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "excludeKeyPages"}, ) """Set to true if you want to exclude pages where text was found""" - regex_search: Optional[bool] = field( + regex_search: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "regexSearch"}, ) """Set to true to enable regular expressions for the search string""" - case_sensitive: Optional[bool] = field( + case_sensitive: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "caseSensitive"}, ) """Set to true to enable case-sensitive search.""" - lang: Optional[str] = None + lang: Optional[str] = dataclass_field(default=None, kw_only=True) """ the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is \"eng\". Other @@ -593,13 +736,13 @@ class SplitPdf2Input: You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination). """ - inline: Optional[bool] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Determines whether to return output in response or link to output file. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Base file name for new PDF files""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -607,14 +750,15 @@ class SplitPdf2Input: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """Creates a background processing job.""" @@ -626,32 +770,35 @@ class SplitPdf2Response: Response for Split PDF (Advanced) """ - urls: Optional[List[str]] = None + urls: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """urls""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document URL.""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """Number of pages in the output document.""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether the operation is successful or not.""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """Status code for HTTP response""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """PDF.co credits used for this request""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """Request execution duration""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """PDF.co account remaining credits""" @@ -663,26 +810,26 @@ class PDFSearchTextInput: PDF Search Text """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - search_string: Optional[str] = field( - default=None, + search_string: str = dataclass_field( metadata={"wire_name": "searchString"}, ) """ Text to search can support regular expressions if you set the \"Regex Search\" parameter to true. """ - regex_search: Optional[bool] = field( + regex_search: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "regexSearch"}, ) - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at 0 (zero). To set a range use the dash -, for @@ -693,16 +840,18 @@ class PDFSearchTextInput: from the 8th (index = 7) page till the end of the document, The input must be in string format. """ - inline: Optional[bool] = None - word_matching_mode: Optional[str] = field( + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) + word_matching_mode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "wordMatchingMode"}, ) """Values can be either 'SmartMatch', 'ExactMatch', or 'None'.""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of the PDF file""" - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -711,7 +860,7 @@ class PDFSearchTextInput: status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase @@ -725,33 +874,36 @@ class PDFSearchTextResponse: Response for PDF Search Text """ - body: Optional[List[Dict[str, Any]]] = None + body: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """body""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -761,42 +913,42 @@ class DocumentParserInput: Document Parser """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. To upload files via API, Check out the Files Upload section at https://developer.pdf.co/api/file-upload/index.html """ - template_id: Optional[str] = field( + template_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "templateId"}, ) """ Set ID of document parser template to be used. View and manage your templates at https://app.pdf.co/document-parser """ - output_format: Optional[str] = field( - default=None, + output_format: str = dataclass_field( metadata={"wire_name": "outputFormat"}, ) """ Default is JSON. You can override the default output format to CSV or XML to generate CSV or XML output accordingly. """ - inline: Optional[bool] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Set to true to return results inside the response. Otherwise, the endpoint will return a link to the output file generated """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of PDF file""" - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase https://developer.pdf.co/api/profiles/index.html for profile examples, """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -804,8 +956,9 @@ class DocumentParserInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -822,28 +975,31 @@ class DocumentParserResponse: Response for Document Parser """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Output URL""" - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """body""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) - error: Optional[bool] = None - job_id: Optional[str] = field( + error: Optional[bool] = dataclass_field(default=None, kw_only=True) + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) - status: Optional[int] = None - name: Optional[str] = None - credits: Optional[int] = None - remaining_credits: Optional[int] = field( + status: Optional[int] = dataclass_field(default=None, kw_only=True) + name: Optional[str] = dataclass_field(default=None, kw_only=True) + credits: Optional[int] = dataclass_field(default=None, kw_only=True) + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) - duration: Optional[int] = None - message: Optional[str] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) + message: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -852,7 +1008,7 @@ class JobCheckInput: Background Jobs Check """ - jobid: Optional[str] = None + jobid: str """PDF.co background Job Id""" @@ -862,40 +1018,45 @@ class JobCheckResponse: Response for Background Jobs Check """ - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """message""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - job_duration: Optional[int] = field( + job_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobDuration"}, ) """jobDuration""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - error_code: Optional[int] = field( + error_code: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "errorCode"}, ) """errorCode""" @@ -907,27 +1068,29 @@ class BarcodeGeneratorInput: Barcode Generator """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Set async to true for long processes to run in the background, API will then return a jobId which you can use with /job/check endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - value: Optional[str] = None + value: str """Set the string value to encode inside the barcode.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Set the barcode type, QRCode By default.""" - decoration_image: Optional[str] = field( + decoration_image: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "decorationImage"}, ) """ Set this to the image that you want to be inserted the logo inside the QR-Code barcode. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -936,7 +1099,7 @@ class BarcodeGeneratorInput: status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -944,7 +1107,7 @@ class BarcodeGeneratorInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co Knowledgebase @@ -958,27 +1121,29 @@ class BarcodeGeneratorResponse: Response for Barcode Generator """ - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -988,12 +1153,12 @@ class BarcodeReaderInput: Barcode Reader """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - types: Optional[str] = None + types: str """ Set the barcode type, QRCode is default. You can also combine types by comma, example \"QRCode,Code128,Code39,Interleaved2of5,EAN13\". All @@ -1008,7 +1173,7 @@ class BarcodeReaderInput: QRCode, Rectangle, RoyalMail, RoyalMailKIX, Segment, Trioptic, UnderlinedField, UPCA, UPCE, UPU, VerticalLine. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-Separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at 0 (zero). To set a range use the dash -, for @@ -1018,16 +1183,17 @@ class BarcodeReaderInput: means the first page, then the 3rd page to the 6th page, and then the range from the 8th (index = 7) page till the end of the document. """ - encrypt: Optional[bool] = None + encrypt: Optional[bool] = dataclass_field(default=None, kw_only=True) """encrypt""" - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -1044,32 +1210,35 @@ class BarcodeReaderResponse: Response for Barcode Reader """ - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - barcodes: Optional[List[Dict[str, Any]]] = None + barcodes: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """barcodes""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -1079,13 +1248,14 @@ class PDFInfoReaderInput: PDF Info Reader """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -1094,9 +1264,9 @@ class PDFInfoReaderInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of the PDF file""" - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configuration for fine-tuning and extra options, Explore PDF.co knowledgebase @@ -1110,27 +1280,29 @@ class PDFInfoReaderResponse: Response for PDF Info Reader """ - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - info: Optional[Dict[str, Any]] = None + info: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """info""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -1140,13 +1312,14 @@ class PDFFormsInfoReaderInput: PDF Forms Info Reader """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -1155,9 +1328,9 @@ class PDFFormsInfoReaderInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of the PDF file""" - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configuration for fine-tuning and extra options, Explore PDF.co knowledgebase @@ -1171,27 +1344,29 @@ class PDFFormsInfoReaderResponse: Response for PDF Forms Info Reader """ - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - info: Optional[Dict[str, Any]] = None + info: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """info""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -1201,12 +1376,12 @@ class PDFFindTableInput: PDF Find Table """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at 0 (zero). To set a range use the dash -, for @@ -1216,16 +1391,16 @@ class PDFFindTableInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - inline: Optional[bool] = None - password: Optional[str] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of PDF file""" - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -1233,8 +1408,9 @@ class PDFFindTableInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -1251,34 +1427,37 @@ class PDFFindTableResponse: Response for PDF Find Table """ - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """body""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """Credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -1288,27 +1467,29 @@ class SearchAndReplaceInput: PDF Search and Replace Text """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - search_strings: Optional[List[str]] = field( - default=None, + search_strings: List[str] = dataclass_field( metadata={"wire_name": "searchStrings"}, ) """Search Strings""" - replace_strings: Optional[List[str]] = field( + replace_strings: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "replaceStrings"}, ) """Replacement Strings""" - case_sensitive: Optional[bool] = field( + case_sensitive: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "caseSensitive"}, ) - replacement_limit: Optional[int] = field( + replacement_limit: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "replacementLimit"}, ) """ @@ -1316,9 +1497,9 @@ class SearchAndReplaceInput: value is 0 which means unlimited searches and replacements so every found occurrence will be replaced. """ - regex: Optional[bool] = None + regex: Optional[bool] = dataclass_field(default=None, kw_only=True) """Set to true to use regular expression for a search string(s).""" - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -1328,11 +1509,11 @@ class SearchAndReplaceInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """The password of the PDF file""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -1340,8 +1521,9 @@ class SearchAndReplaceInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -1358,31 +1540,34 @@ class SearchAndReplaceResponse: Response for PDF Search and Replace Text """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1391,26 +1576,25 @@ class SearchAndReplaceWithImageInput: PDF Search and Replace Text with Image """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - case_sensitive: Optional[bool] = field( + case_sensitive: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "caseSensitive"}, ) - search_string: Optional[str] = field( - default=None, + search_string: str = dataclass_field( metadata={"wire_name": "searchString"}, ) """Single text replacement. Word or phrase to be replaced""" - replace_image: Optional[str] = field( - default=None, + replace_image: str = dataclass_field( metadata={"wire_name": "replaceImage"}, ) """Image URL to be inserted in the doc.""" - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -1420,8 +1604,9 @@ class SearchAndReplaceWithImageInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -1430,9 +1615,10 @@ class SearchAndReplaceWithImageInput: status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.. """ - regex: Optional[bool] = None - replacement_limit: Optional[int] = field( + regex: Optional[bool] = dataclass_field(default=None, kw_only=True) + replacement_limit: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "replacementLimit"}, ) """ @@ -1440,7 +1626,7 @@ class SearchAndReplaceWithImageInput: value is 0 which means unlimited searches and replacements so every found occurrence will be replaced. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -1448,7 +1634,7 @@ class SearchAndReplaceWithImageInput: The maximum duration for link expiration varies based on your current subscription plan. """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of the PDF file""" @@ -1458,32 +1644,35 @@ class SearchAndReplaceWithImageResponse: Response for PDF Search and Replace Text with Image """ - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -1493,24 +1682,25 @@ class SearchAndDeleteTextInput: PDF Search and Delete Text from PDF """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - search_strings: Optional[List[str]] = field( - default=None, + search_strings: List[str] = dataclass_field( metadata={"wire_name": "searchStrings"}, ) """searchStrings""" - case_sensitive: Optional[bool] = field( + case_sensitive: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "caseSensitive"}, ) - regex: Optional[bool] = None + regex: Optional[bool] = dataclass_field(default=None, kw_only=True) """Set to true to use regular expression for a search string(s).""" - replacement_limit: Optional[int] = field( + replacement_limit: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "replacementLimit"}, ) """ @@ -1518,7 +1708,7 @@ class SearchAndDeleteTextInput: value is 0 which means unlimited searches and replacements so every found occurrence will be replaced. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -1526,11 +1716,11 @@ class SearchAndDeleteTextInput: The maximum duration for link expiration varies based on your current subscription plan. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of the PDF file""" - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -1540,14 +1730,15 @@ class SearchAndDeleteTextInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -1564,32 +1755,35 @@ class SearchAndDeleteTextResponse: Response for PDF Search and Delete Text from PDF """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -1599,12 +1793,12 @@ class PDFSearchableInput: Make Scanned PDF to Text Searchable """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - lang: Optional[str] = None + lang: Optional[str] = dataclass_field(default=None, kw_only=True) """ the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is \"eng\". Other @@ -1614,7 +1808,7 @@ class PDFSearchableInput: You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination). """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -1624,10 +1818,11 @@ class PDFSearchableInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of PDF file""" - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -1636,7 +1831,7 @@ class PDFSearchableInput: status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase @@ -1650,32 +1845,35 @@ class PDFSearchableResponse: Response for Make Scanned PDF to Text Searchable """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -1685,12 +1883,12 @@ class PDFUnSearchableInput: PDF to Scanned PDF """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -1700,10 +1898,11 @@ class PDFUnSearchableInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of PDF file""" - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -1712,7 +1911,7 @@ class PDFUnSearchableInput: status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase @@ -1726,32 +1925,35 @@ class PDFUnSearchableResponse: Response for PDF to Scanned PDF """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -1761,12 +1963,12 @@ class PDFToCSVInput: PDF To CSV """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - lang: Optional[str] = None + lang: Optional[str] = dataclass_field(default=None, kw_only=True) """ Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is \"eng\". Other @@ -1776,13 +1978,13 @@ class PDFToCSVInput: You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination). """ - inline: Optional[bool] = None - unwrap: Optional[str] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) + unwrap: Optional[str] = dataclass_field(default=None, kw_only=True) """ Unwrap lines into a single line within table cells when lineGrouping is enabled. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -1792,14 +1994,15 @@ class PDFToCSVInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - rect: Optional[str] = None + rect: Optional[str] = dataclass_field(default=None, kw_only=True) """ Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -1808,16 +2011,17 @@ class PDFToCSVInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """password""" - line_grouping: Optional[str] = field( + line_grouping: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineGrouping"}, ) """Line grouping within table cells. Set to 1 to enable the grouping.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -1825,7 +2029,7 @@ class PDFToCSVInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase @@ -1840,29 +2044,31 @@ class PDFToCSVResponse: Response for PDF To CSV """ - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """body""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -1872,12 +2078,12 @@ class PDFToJSONInput: PDF To JSON """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - lang: Optional[str] = None + lang: Optional[str] = dataclass_field(default=None, kw_only=True) """ Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is \"eng\". Other @@ -1887,13 +2093,13 @@ class PDFToJSONInput: You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination). """ - inline: Optional[bool] = None - unwrap: Optional[str] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) + unwrap: Optional[str] = dataclass_field(default=None, kw_only=True) """ Unwrap lines into a single line within table cells when lineGrouping is enabled. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -1903,14 +2109,15 @@ class PDFToJSONInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - rect: Optional[str] = None + rect: Optional[str] = dataclass_field(default=None, kw_only=True) """ Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -1919,16 +2126,17 @@ class PDFToJSONInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """password""" - line_grouping: Optional[str] = field( + line_grouping: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineGrouping"}, ) """Line grouping within table cells. Set to 1 to enable the grouping.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -1936,7 +2144,7 @@ class PDFToJSONInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase @@ -1951,34 +2159,37 @@ class PDFToJSONResponse: Response for PDF To JSON """ - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """body""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -1988,12 +2199,12 @@ class PDFToJSONMetaInput: PDF To JSON (AI Powered) """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - lang: Optional[str] = None + lang: Optional[str] = dataclass_field(default=None, kw_only=True) """ Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is \"eng\". Other @@ -2003,13 +2214,13 @@ class PDFToJSONMetaInput: You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination). """ - inline: Optional[bool] = None - unwrap: Optional[str] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) + unwrap: Optional[str] = dataclass_field(default=None, kw_only=True) """ Unwrap lines into a single line within table cells when lineGrouping is enabled. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -2019,14 +2230,15 @@ class PDFToJSONMetaInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - rect: Optional[str] = None + rect: Optional[str] = dataclass_field(default=None, kw_only=True) """ Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -2035,16 +2247,17 @@ class PDFToJSONMetaInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """password""" - line_grouping: Optional[str] = field( + line_grouping: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineGrouping"}, ) """Line grouping within table cells. Set to 1 to enable the grouping.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -2052,7 +2265,7 @@ class PDFToJSONMetaInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase @@ -2067,34 +2280,37 @@ class PDFToJSONMetaResponse: Response for PDF To JSON (AI Powered) """ - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """body""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -2104,12 +2320,12 @@ class PDFToTextInput: PDF To Text (with layout and ocr) """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - lang: Optional[str] = None + lang: Optional[str] = dataclass_field(default=None, kw_only=True) """ Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is \"eng\". Other @@ -2119,13 +2335,13 @@ class PDFToTextInput: You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination). """ - inline: Optional[bool] = None - unwrap: Optional[str] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) + unwrap: Optional[str] = dataclass_field(default=None, kw_only=True) """ Unwrap lines into a single line within table cells when lineGrouping is enabled. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -2135,14 +2351,15 @@ class PDFToTextInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - rect: Optional[str] = None + rect: Optional[str] = dataclass_field(default=None, kw_only=True) """ Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -2151,16 +2368,17 @@ class PDFToTextInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """password""" - line_grouping: Optional[str] = field( + line_grouping: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineGrouping"}, ) """Line grouping within table cells. Set to 1 to enable the grouping.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -2168,7 +2386,7 @@ class PDFToTextInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase @@ -2183,34 +2401,37 @@ class PDFToTextResponse: Response for PDF To Text (with layout and ocr) """ - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """body""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -2220,13 +2441,13 @@ class PDFToTextSimpleInput: PDF To Text (without layout and ocr) """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - inline: Optional[bool] = None - pages: Optional[str] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -2236,8 +2457,9 @@ class PDFToTextSimpleInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -2246,11 +2468,11 @@ class PDFToTextSimpleInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """password""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -2266,34 +2488,37 @@ class PDFToTextSimpleResponse: Response for PDF To Text (without layout and ocr) """ - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """body""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -2303,12 +2528,12 @@ class PDFToXLSInput: PDF To XLS """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - lang: Optional[str] = None + lang: Optional[str] = dataclass_field(default=None, kw_only=True) """ Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is \"eng\". Other @@ -2318,12 +2543,12 @@ class PDFToXLSInput: You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination). """ - unwrap: Optional[str] = None + unwrap: Optional[str] = dataclass_field(default=None, kw_only=True) """ Unwrap lines into a single line within table cells when lineGrouping is enabled. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -2333,14 +2558,15 @@ class PDFToXLSInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - rect: Optional[str] = None + rect: Optional[str] = dataclass_field(default=None, kw_only=True) """ Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -2349,16 +2575,17 @@ class PDFToXLSInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """password""" - line_grouping: Optional[str] = field( + line_grouping: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineGrouping"}, ) """Line grouping within table cells. Set to 1 to enable the grouping.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -2366,7 +2593,7 @@ class PDFToXLSInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase @@ -2381,32 +2608,35 @@ class PDFToXLSResponse: Response for PDF To XLS """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -2416,12 +2646,12 @@ class PDFToXLSXInput: PDF To XLSX """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - lang: Optional[str] = None + lang: Optional[str] = dataclass_field(default=None, kw_only=True) """ Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is \"eng\". Other @@ -2431,12 +2661,12 @@ class PDFToXLSXInput: You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination). """ - unwrap: Optional[str] = None + unwrap: Optional[str] = dataclass_field(default=None, kw_only=True) """ Unwrap lines into a single line within table cells when lineGrouping is enabled. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -2446,14 +2676,15 @@ class PDFToXLSXInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - rect: Optional[str] = None + rect: Optional[str] = dataclass_field(default=None, kw_only=True) """ Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -2462,16 +2693,17 @@ class PDFToXLSXInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """password""" - line_grouping: Optional[str] = field( + line_grouping: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineGrouping"}, ) """Line grouping within table cells. Set to 1 to enable the grouping.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -2479,7 +2711,7 @@ class PDFToXLSXInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase @@ -2494,32 +2726,35 @@ class PDFToXLSXResponse: Response for PDF To XLSX """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -2529,13 +2764,13 @@ class PDFToXMLInput: PDF To XML """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - inline: Optional[bool] = None - lang: Optional[str] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) + lang: Optional[str] = dataclass_field(default=None, kw_only=True) """ Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is \"eng\". Other @@ -2545,12 +2780,12 @@ class PDFToXMLInput: You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination). """ - unwrap: Optional[str] = None + unwrap: Optional[str] = dataclass_field(default=None, kw_only=True) """ Unwrap lines into a single line within table cells when lineGrouping is enabled. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -2560,14 +2795,15 @@ class PDFToXMLInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - rect: Optional[str] = None + rect: Optional[str] = dataclass_field(default=None, kw_only=True) """ Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -2576,16 +2812,17 @@ class PDFToXMLInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """password""" - line_grouping: Optional[str] = field( + line_grouping: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineGrouping"}, ) """Line grouping within table cells. Set to 1 to enable the grouping.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -2593,7 +2830,7 @@ class PDFToXMLInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase @@ -2608,34 +2845,37 @@ class PDFToXMLResponse: Response for PDF To XML """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """body""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -2645,14 +2885,14 @@ class PDFToJPGInput: PDF to JPG """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - inline: Optional[bool] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) """inline""" - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -2662,13 +2902,13 @@ class PDFToJPGInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - rect: Optional[str] = None + rect: Optional[str] = dataclass_field(default=None, kw_only=True) """ Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -2676,8 +2916,9 @@ class PDFToJPGInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -2686,7 +2927,7 @@ class PDFToJPGInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -2700,32 +2941,35 @@ class PDFToJPGResponse: Response for PDF to JPG """ - urls: Optional[List[str]] = None + urls: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """urls""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -2735,14 +2979,14 @@ class PDFToPNGInput: PDF to PNG """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - inline: Optional[bool] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) """inline""" - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -2752,13 +2996,13 @@ class PDFToPNGInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - rect: Optional[str] = None + rect: Optional[str] = dataclass_field(default=None, kw_only=True) """ Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -2766,8 +3010,9 @@ class PDFToPNGInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -2776,7 +3021,7 @@ class PDFToPNGInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -2790,32 +3035,35 @@ class PDFToPNGResponse: Response for PDF to PNG """ - urls: Optional[List[str]] = None + urls: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """urls""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -2825,14 +3073,14 @@ class PDFToWEBPInput: PDF to WEBP """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - inline: Optional[bool] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) """inline""" - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -2842,13 +3090,13 @@ class PDFToWEBPInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - rect: Optional[str] = None + rect: Optional[str] = dataclass_field(default=None, kw_only=True) """ Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -2856,8 +3104,9 @@ class PDFToWEBPInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -2866,7 +3115,7 @@ class PDFToWEBPInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -2880,32 +3129,35 @@ class PDFToWEBPResponse: Response for PDF to WEBP """ - urls: Optional[List[str]] = None + urls: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """urls""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -2915,14 +3167,14 @@ class PDFToTIFFInput: PDF to TIFF """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - inline: Optional[bool] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) """inline""" - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -2932,13 +3184,13 @@ class PDFToTIFFInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - rect: Optional[str] = None + rect: Optional[str] = dataclass_field(default=None, kw_only=True) """ Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -2946,8 +3198,9 @@ class PDFToTIFFInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -2956,7 +3209,7 @@ class PDFToTIFFInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -2970,31 +3223,34 @@ class PDFToTIFFResponse: Response for PDF to TIFF """ - url: Optional[str] = None - job_id: Optional[str] = field( + url: Optional[str] = dataclass_field(default=None, kw_only=True) + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3004,12 +3260,12 @@ class PDFFromCSVInput: PDF from CSV """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -3019,9 +3275,9 @@ class PDFFromCSVInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -3029,8 +3285,9 @@ class PDFFromCSVInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -3039,7 +3296,7 @@ class PDFFromCSVInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -3053,31 +3310,34 @@ class PDFFromCSVResponse: Response for PDF from CSV """ - url: Optional[str] = None - job_id: Optional[str] = field( + url: Optional[str] = dataclass_field(default=None, kw_only=True) + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3087,12 +3347,12 @@ class PDFFromDocInput: PDF from Document (Doc, DocX, RTF, TXT, XPS) """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -3102,9 +3362,9 @@ class PDFFromDocInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -3112,8 +3372,9 @@ class PDFFromDocInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -3122,7 +3383,7 @@ class PDFFromDocInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -3136,31 +3397,34 @@ class PDFFromDocResponse: Response for PDF from Document (Doc, DocX, RTF, TXT, XPS) """ - url: Optional[str] = None - job_id: Optional[str] = field( + url: Optional[str] = dataclass_field(default=None, kw_only=True) + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3170,15 +3434,15 @@ class PDFFromImagesInput: PDF from Image """ - url: Optional[str] = None + url: str """ URL to the source file. Provide multiple URLS in comma separated format. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -3186,8 +3450,9 @@ class PDFFromImagesInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -3196,7 +3461,7 @@ class PDFFromImagesInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -3210,31 +3475,34 @@ class PDFFromImagesResponse: Response for PDF from Image """ - url: Optional[str] = None - job_id: Optional[str] = field( + url: Optional[str] = dataclass_field(default=None, kw_only=True) + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3244,13 +3512,14 @@ class PDFFromEmailInput: PDF from Email """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - embed_attachments: Optional[bool] = field( + embed_attachments: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "embedAttachments"}, ) """ @@ -3259,8 +3528,9 @@ class PDFFromEmailInput: don't want to embed attachments so it will convert only the body of the input email. """ - convert_attachments: Optional[bool] = field( + convert_attachments: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "convertAttachments"}, ) """ @@ -3271,13 +3541,14 @@ class PDFFromEmailInput: Non-supported file types are added as PDF attachments (Adobe Reader or another viewer may be required to view PDF attachments). """ - margins: Optional[str] = None + margins: Optional[str] = dataclass_field(default=None, kw_only=True) """ set to CSS style margins like 10px, 5mm, 5in for all sides or 5px 5px 5px 5px (the order of margins is top, right, bottom, left). """ - paper_size: Optional[str] = field( + paper_size: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "paperSize"}, ) """ @@ -3286,10 +3557,10 @@ class PDFFromEmailInput: mm or in (inches) with width and height separated by space like this: 200 300, 200px 300px, 200mm 300mm, 20cm 30cm or 6in 8in. """ - orientation: Optional[str] = None - name: Optional[str] = None + orientation: Optional[str] = dataclass_field(default=None, kw_only=True) + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -3297,8 +3568,9 @@ class PDFFromEmailInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -3307,7 +3579,7 @@ class PDFFromEmailInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -3321,31 +3593,34 @@ class PDFFromEmailResponse: Response for PDF from Email """ - url: Optional[str] = None - job_id: Optional[str] = field( + url: Optional[str] = dataclass_field(default=None, kw_only=True) + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3355,36 +3630,38 @@ class PDFAddSecurityInput: PDF Add Security """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - owner_password: Optional[str] = field( - default=None, + owner_password: str = dataclass_field( metadata={"wire_name": "ownerPassword"}, ) """ The main owner password that is used for document encryption and for setting/removing restrictions. """ - user_password: Optional[str] = field( + user_password: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userPassword"}, ) """ The optional user password will be asked for viewing and printing document. """ - encryption_algorithm: Optional[str] = field( + encryption_algorithm: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "encryptionAlgorithm"}, ) """ Encryption algorithm. Valid values: RC4_40bit, RC4_128bit, AES_128bit, AES_256bit. AES_128bit or higher is recommended """ - allow_accessibility_support: Optional[bool] = field( + allow_accessibility_support: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowAccessibilitySupport"}, ) """ @@ -3392,8 +3669,9 @@ class PDFAddSecurityInput: restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password. """ - allow_assembly_document: Optional[bool] = field( + allow_assembly_document: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowAssemblyDocument"}, ) """ @@ -3401,8 +3679,9 @@ class PDFAddSecurityInput: when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password. """ - allow_print_document: Optional[bool] = field( + allow_print_document: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowPrintDocument"}, ) """ @@ -3410,8 +3689,9 @@ class PDFAddSecurityInput: when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password. """ - allow_fill_forms: Optional[bool] = field( + allow_fill_forms: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowFillForms"}, ) """ @@ -3420,8 +3700,9 @@ class PDFAddSecurityInput: userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password. """ - allow_modify_document: Optional[bool] = field( + allow_modify_document: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowModifyDocument"}, ) """ @@ -3429,8 +3710,9 @@ class PDFAddSecurityInput: applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password. """ - allow_content_extraction: Optional[bool] = field( + allow_content_extraction: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowContentExtraction"}, ) """ @@ -3438,8 +3720,9 @@ class PDFAddSecurityInput: applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password. """ - allow_modify_annotations: Optional[bool] = field( + allow_modify_annotations: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowModifyAnnotations"}, ) """ @@ -3447,8 +3730,9 @@ class PDFAddSecurityInput: document. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password. """ - print_quality: Optional[str] = field( + print_quality: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "printQuality"}, ) """ @@ -3456,9 +3740,9 @@ class PDFAddSecurityInput: Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -3466,8 +3750,9 @@ class PDFAddSecurityInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -3476,7 +3761,7 @@ class PDFAddSecurityInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -3490,31 +3775,34 @@ class PDFAddSecurityResponse: Response for PDF Add Security """ - url: Optional[str] = None - job_id: Optional[str] = field( + url: Optional[str] = dataclass_field(default=None, kw_only=True) + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3524,16 +3812,16 @@ class PDFSecurityRemoveInput: PDF Remove Security """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - password: Optional[str] = None + password: str """The owner/user password to open files and remove security features.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -3541,8 +3829,9 @@ class PDFSecurityRemoveInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -3551,7 +3840,7 @@ class PDFSecurityRemoveInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -3565,31 +3854,34 @@ class PDFSecurityRemoveResponse: Response for PDF Remove Security """ - url: Optional[str] = None - job_id: Optional[str] = field( + url: Optional[str] = dataclass_field(default=None, kw_only=True) + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3599,19 +3891,20 @@ class PDFFromXLSXLSXInput: PDF From Spreadsheet """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - worksheet_index: Optional[str] = field( + worksheet_index: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "worksheetIndex"}, ) """Set the WorkSheet index (Default is 0).""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -3619,8 +3912,9 @@ class PDFFromXLSXLSXInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -3629,7 +3923,7 @@ class PDFFromXLSXLSXInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -3643,31 +3937,34 @@ class PDFFromXLSXLSXResponse: Response for PDF From Spreadsheet """ - url: Optional[str] = None - job_id: Optional[str] = field( + url: Optional[str] = dataclass_field(default=None, kw_only=True) + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3677,29 +3974,32 @@ class XLStoCSVInput: Spreadsheet to CSV """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - worksheet_index: Optional[str] = field( + worksheet_index: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "worksheetIndex"}, ) """Set the WorkSheet index (Default is 0).""" - quotation_symbol: Optional[str] = field( + quotation_symbol: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "quotationSymbol"}, ) """Set the CSV Quotation Symbol""" - separator_symbol: Optional[str] = field( + separator_symbol: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "separatorSymbol"}, ) """Set the CSV Separator Symbol""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -3707,8 +4007,9 @@ class XLStoCSVInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -3717,7 +4018,7 @@ class XLStoCSVInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -3731,27 +4032,29 @@ class XLStoCSVResponse: Response for Spreadsheet to CSV """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3761,19 +4064,20 @@ class XLStoJSONInput: Spreadsheet to JSON """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - worksheet_index: Optional[str] = field( + worksheet_index: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "worksheetIndex"}, ) """Set the WorkSheet index (Default is 0).""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -3781,8 +4085,9 @@ class XLStoJSONInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -3791,7 +4096,7 @@ class XLStoJSONInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -3805,27 +4110,29 @@ class XLStoJSONResponse: Response for Spreadsheet to JSON """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3835,19 +4142,20 @@ class XLStoHTMLInput: Spreadsheet to HTML """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - worksheet_index: Optional[str] = field( + worksheet_index: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "worksheetIndex"}, ) """Set the WorkSheet index (Default is 0).""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -3855,8 +4163,9 @@ class XLStoHTMLInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -3865,7 +4174,7 @@ class XLStoHTMLInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -3879,27 +4188,29 @@ class XLStoHTMLResponse: Response for Spreadsheet to HTML """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3909,19 +4220,20 @@ class XLStoTXTInput: Spreadsheet to TXT """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - worksheet_index: Optional[str] = field( + worksheet_index: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "worksheetIndex"}, ) """Set the WorkSheet index (Default is 0).""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -3929,8 +4241,9 @@ class XLStoTXTInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -3939,7 +4252,7 @@ class XLStoTXTInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -3953,27 +4266,29 @@ class XLStoTXTResponse: Response for Spreadsheet to TXT """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -3983,19 +4298,20 @@ class XLStoXMLInput: Spreadsheet to XML """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - worksheet_index: Optional[str] = field( + worksheet_index: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "worksheetIndex"}, ) """Set the WorkSheet index (Default is 0).""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output.""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -4003,8 +4319,9 @@ class XLStoXMLInput: The maximum duration for link expiration varies based on your current subscription plan. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -4013,7 +4330,7 @@ class XLStoXMLInput: of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase @@ -4027,27 +4344,29 @@ class XLStoXMLResponse: Response for Spreadsheet to XML """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -4057,14 +4376,14 @@ class PDFRotatePagesInput: Rotate PDF Pages """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - angle: Optional[int] = None + angle: Optional[int] = dataclass_field(default=None, kw_only=True) """Angle in degrees. Supported values 90, 180, and 270.""" - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -4074,7 +4393,7 @@ class PDFRotatePagesInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -4082,16 +4401,17 @@ class PDFRotatePagesInput: The maximum duration for link expiration varies based on your current subscription plan. """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of the PDF file""" - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -4108,32 +4428,35 @@ class PDFRotatePagesResponse: Response for Rotate PDF Pages """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -4143,12 +4466,12 @@ class PDFAutoRotatePagesInput: Rotate PDF Pages (Auto) """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - lang: Optional[str] = None + lang: Optional[str] = dataclass_field(default=None, kw_only=True) """ the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is \"eng\". Other @@ -4158,7 +4481,7 @@ class PDFAutoRotatePagesInput: You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination). """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -4166,16 +4489,17 @@ class PDFAutoRotatePagesInput: The maximum duration for link expiration varies based on your current subscription plan. """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of the PDF file""" - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -4192,32 +4516,35 @@ class PDFAutoRotatePagesResponse: Response for Rotate PDF Pages (Auto) """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -4227,12 +4554,12 @@ class PDFDeletePagesInput: PDF Delete Pages """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: @@ -4242,9 +4569,9 @@ class PDFDeletePagesInput: means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -4252,14 +4579,15 @@ class PDFDeletePagesInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -4276,32 +4604,35 @@ class PDFDeletePagesResponse: Response for PDF Delete Pages """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -4311,14 +4642,14 @@ class PDFCompressInput: PDF Compress and Optimize """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """File name for the generated output""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -4326,16 +4657,17 @@ class PDFCompressInput: The maximum duration for link expiration varies based on your current subscription plan. """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of the PDF file""" - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -4352,32 +4684,35 @@ class PDFCompressResponse: Response for PDF Compress and Optimize """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -4387,34 +4722,35 @@ class PDFClassifierInput: Document Classifier """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - rulescsv: Optional[str] = None + rulescsv: Optional[str] = dataclass_field(default=None, kw_only=True) """ Define custom classification rules in CSV format. Rules are in CSV format where each row contains: \"class name, logic (AND or OR (default)), and keywords\" separated by a comma. Each row is separated by the \\n symbol. """ - rulescsvurl: Optional[str] = None + rulescsvurl: Optional[str] = dataclass_field(default=None, kw_only=True) """ Instead of inline CSV you can use this parameter and set the URL to a CSV file with classification rules. This is useful if you have a separate developer working on CSV rules. """ - case_sensitive: Optional[bool] = field( + case_sensitive: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "caseSensitive"}, ) """Defines if keywords in rules are case-sensitive or not.""" - inline: Optional[bool] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Set to true to return results inside the response. Otherwise, the endpoint will return a link to the output file generated. """ - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -4422,16 +4758,17 @@ class PDFClassifierInput: The maximum duration for link expiration varies based on your current subscription plan. """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password of the PDF file""" - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -4448,34 +4785,37 @@ class PDFClassifierResponse: Response for Document Classifier """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """body""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """pageCount""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -4485,47 +4825,48 @@ class EmailSendInput: Send Email with Attachments """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - from_: Optional[str] = field(default=None, metadata={"wire_name": "from"}) + from_: str = dataclass_field(metadata={"wire_name": "from"}) """ The \"From\" field with sender name and email. Example: John Doe """ - to: Optional[str] = None + to: str """ The \"To\" field with receiver name and email. Example: Partner """ - subject: Optional[str] = None + subject: str """The subject for the outgoing email""" - bodytext: Optional[str] = None + bodytext: Optional[str] = dataclass_field(default=None, kw_only=True) """Plain text version of the outgoing email message.""" - bodyhtml: Optional[str] = None + bodyhtml: Optional[str] = dataclass_field(default=None, kw_only=True) """HTML version of the outgoing email message.""" - smtpserver: Optional[str] = None + smtpserver: str """SMTP server address""" - smtpport: Optional[str] = None + smtpport: str """SMTP port""" - smtpusername: Optional[str] = None + smtpusername: str """SMTP server username""" - smtppassword: Optional[str] = None + smtppassword: str """ SMTP server password, If you use Gmail then you need to generate an app-specific password as instructed at https://support.google.com/accounts/answer/185833. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -4542,23 +4883,25 @@ class EmailSendResponse: Response for Send Email with Attachments """ - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -4568,19 +4911,20 @@ class EmailDecodeInput: Email Information """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -4597,29 +4941,31 @@ class EmailDecodeResponse: Response for Email Information """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """body""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -4629,19 +4975,20 @@ class EmailAttachmentExtractionInput: Email Attachment Extraction """ - url: Optional[str] = None + url: str """ URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """ @@ -4658,29 +5005,31 @@ class EmailAttachmentExtractionResponse: Response for Email Attachment Extraction """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """url""" - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """body""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """error""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """status""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """credits""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """remainingCredits""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """duration""" @@ -4690,15 +5039,15 @@ class PDFAttachmentExtractionInput: PDF Attachment Extraction """ - url: Optional[str] = None + url: str """Url to the source PDF document""" - inline: Optional[bool] = None + inline: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Determines whether to return output in response or link to output file. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Base file name for new PDF files""" - expiration: Optional[int] = None + expiration: Optional[int] = dataclass_field(default=None, kw_only=True) """ Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output @@ -4706,14 +5055,15 @@ class PDFAttachmentExtractionInput: The maximum duration for link expiration varies based on your current subscription plan. """ - profiles: Optional[str] = None + profiles: Optional[str] = dataclass_field(default=None, kw_only=True) """ Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples. """ - async_: Optional[bool] = field( + async_: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "async"}, ) """Creates a background processing job.""" @@ -4725,32 +5075,35 @@ class PDFAttachmentExtractionResponse: Response for PDF Attachment Extraction """ - urls: Optional[List[str]] = None + urls: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """urls""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document URL.""" - job_id: Optional[str] = field( + job_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobId"}, ) """jobId""" - page_count: Optional[int] = field( + page_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageCount"}, ) """Number of pages in the output document.""" - error: Optional[bool] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether the operation is successful or not.""" - status: Optional[int] = None + status: Optional[int] = dataclass_field(default=None, kw_only=True) """Status code for HTTP response""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Output document name""" - credits: Optional[int] = None + credits: Optional[int] = dataclass_field(default=None, kw_only=True) """PDF.co credits used for this request""" - duration: Optional[int] = None + duration: Optional[int] = dataclass_field(default=None, kw_only=True) """Request execution duration""" - remaining_credits: Optional[int] = field( + remaining_credits: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "remainingCredits"}, ) """PDF.co account remaining credits""" @@ -4767,7 +5120,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -4784,8 +5137,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -4806,7 +5159,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -4821,9 +5174,9 @@ def __init__( def connector_name(self) -> str: return "pdfco" - async def html_to_pdf_async( + async def html_to_pdf( self, - input: HtmlToPdfInput, + input: HtmlToPdfInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4836,12 +5189,28 @@ async def html_to_pdf_async( Convert HTML code snippet into full featured PDF. Please see api documentation at https://developer.pdf.co/api/pdf-to-html/index.html for comprehensive guidelines. + + Swagger operation ID: `HtmlToPdf`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1/pdf/convert/from/html" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4855,6 +5224,7 @@ async def html_to_pdf_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4862,9 +5232,9 @@ async def html_to_pdf_async( return json.loads(response.text) - async def url_to_pdf_async( + async def url_to_pdf( self, - input: UrlToPdfInput, + input: UrlToPdfInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4877,10 +5247,26 @@ async def url_to_pdf_async( Create PDF from URL. Please see api documentation at https://developer.pdf.co/api/pdf-from-url/index.html for comprehensive guidelines. + + Swagger operation ID: `UrlToPdf`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/from/url" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4894,6 +5280,7 @@ async def url_to_pdf_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4901,9 +5288,9 @@ async def url_to_pdf_async( return json.loads(response.text) - async def pdf_filler_async( + async def pdf_filler( self, - input: PdfFillerInput, + input: PdfFillerInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4917,10 +5304,26 @@ async def pdf_filler_async( new pdf from templates. Please see api documentation at https://developer.pdf.co/api/pdf-add/index.html for comprehensive guidelines. + + Swagger operation ID: `PdfFiller`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/edit/add" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4934,6 +5337,7 @@ async def pdf_filler_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4941,9 +5345,9 @@ async def pdf_filler_async( return json.loads(response.text) - async def merge_pdf_simplified_async( + async def merge_pdf_simplified( self, - input: MergePdfSimplifiedInput, + input: MergePdfSimplifiedInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4956,10 +5360,26 @@ async def merge_pdf_simplified_async( Merge PDF from two or more PDF files into a new one. Please see api documentation at https://developer.pdf.co/api/pdf-merge/index.html for comprehensive guidelines. + + Swagger operation ID: `MergePdfSimplified`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/merge" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4973,6 +5393,7 @@ async def merge_pdf_simplified_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4980,9 +5401,9 @@ async def merge_pdf_simplified_async( return json.loads(response.text) - async def merge_pdf_async( + async def merge_pdf( self, - input: MergePdfInput, + input: MergePdfInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4997,10 +5418,26 @@ async def merge_pdf_async( xlsx, rtf, txt, png, jpg. Please see api documentation at https://developer.pdf.co/api/pdf-merge/index.html#post-tag-pdf-merge2 for comprehensive guidelines. + + Swagger operation ID: `MergePdf`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/merge2" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5014,6 +5451,7 @@ async def merge_pdf_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5021,9 +5459,9 @@ async def merge_pdf_async( return json.loads(response.text) - async def split_pdf_async( + async def split_pdf( self, - input: SplitPdfInput, + input: SplitPdfInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5037,10 +5475,26 @@ async def split_pdf_async( numbers and page ranges. Please see api documentation at https://developer.pdf.co/api/pdf-split/index.html for comprehensive guidelines. + + Swagger operation ID: `SplitPdf`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/split" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5054,6 +5508,7 @@ async def split_pdf_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5061,9 +5516,9 @@ async def split_pdf_async( return json.loads(response.text) - async def split_pdf2_async( + async def split_pdf2( self, - input: SplitPdf2Input, + input: SplitPdf2Input | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5077,10 +5532,26 @@ async def split_pdf2_async( expressions) or barcode. Please see api documentation at https://developer.pdf.co/api/pdf-split/index.html#post-tag-pdf-split2 for comprehensive guidelines. + + Swagger operation ID: `SplitPdf2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/split2" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5094,6 +5565,7 @@ async def split_pdf2_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5101,9 +5573,9 @@ async def split_pdf2_async( return json.loads(response.text) - async def pdf_search_text_async( + async def pdf_search_text( self, - input: PDFSearchTextInput, + input: PDFSearchTextInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5117,10 +5589,26 @@ async def pdf_search_text_async( Please see api documentation at https://developer.pdf.co/api/pdf-find/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFSearchText`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/find" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5134,6 +5622,7 @@ async def pdf_search_text_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5141,9 +5630,9 @@ async def pdf_search_text_async( return json.loads(response.text) - async def document_parser_async( + async def document_parser( self, - input: DocumentParserInput, + input: DocumentParserInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5159,10 +5648,26 @@ async def document_parser_async( documentation at https://developer.pdf.co/api/document-parser/index.html for comprehensive guidelines. + + Swagger operation ID: `DocumentParser`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/documentparser" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5176,6 +5681,7 @@ async def document_parser_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5183,9 +5689,9 @@ async def document_parser_async( return json.loads(response.text) - async def job_check_async( + async def job_check( self, - input: JobCheckInput, + input: JobCheckInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5199,10 +5705,26 @@ async def job_check_async( API. Please see api documentation at https://developer.pdf.co/api/background-job-check/index.html for comprehensive guidelines. + + Swagger operation ID: `JobCheck`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/job/check" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5216,6 +5738,7 @@ async def job_check_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5223,9 +5746,9 @@ async def job_check_async( return json.loads(response.text) - async def barcode_generator_async( + async def barcode_generator( self, - input: BarcodeGeneratorInput, + input: BarcodeGeneratorInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5240,10 +5763,26 @@ async def barcode_generator_async( documentation at https://developer.pdf.co/api/barcode-generator/index.html for comprehensive guidelines. + + Swagger operation ID: `BarcodeGenerator`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/barcode/generate" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5257,6 +5796,7 @@ async def barcode_generator_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5264,9 +5804,9 @@ async def barcode_generator_async( return json.loads(response.text) - async def barcode_reader_async( + async def barcode_reader( self, - input: BarcodeReaderInput, + input: BarcodeReaderInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5281,12 +5821,28 @@ async def barcode_reader_async( other barcodes. Please see api documentation at https://developer.pdf.co/api/barcode-reader/index.html for comprehensive guidelines. + + Swagger operation ID: `BarcodeReader`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1/barcode/read/from/url" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5300,6 +5856,7 @@ async def barcode_reader_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5307,9 +5864,9 @@ async def barcode_reader_async( return json.loads(response.text) - async def pdf_info_reader_async( + async def pdf_info_reader( self, - input: PDFInfoReaderInput, + input: PDFInfoReaderInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5323,10 +5880,26 @@ async def pdf_info_reader_async( security permissions. Please see api documentation at https://developer.pdf.co/api/pdf-info-reader/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFInfoReader`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/info" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5340,6 +5913,7 @@ async def pdf_info_reader_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5347,9 +5921,9 @@ async def pdf_info_reader_async( return json.loads(response.text) - async def pdf_forms_info_reader_async( + async def pdf_forms_info_reader( self, - input: PDFFormsInfoReaderInput, + input: PDFFormsInfoReaderInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5363,10 +5937,26 @@ async def pdf_forms_info_reader_async( api documentation at https://developer.pdf.co/api/pdf-forms-info-reader/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFFormsInfoReader`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/info/fields" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5380,6 +5970,7 @@ async def pdf_forms_info_reader_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5387,9 +5978,9 @@ async def pdf_forms_info_reader_async( return json.loads(response.text) - async def pdf_find_table_async( + async def pdf_find_table( self, - input: PDFFindTableInput, + input: PDFFindTableInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5404,10 +5995,26 @@ async def pdf_find_table_async( about columns detected in these tables. Please see api documentation at https://developer.pdf.co/api/pdf-find/index.html#post-tag-pdf-find-table for comprehensive guidelines. + + Swagger operation ID: `PDFFindTable`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/find/table" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5421,6 +6028,7 @@ async def pdf_find_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5428,9 +6036,9 @@ async def pdf_find_table_async( return json.loads(response.text) - async def search_and_replace_async( + async def search_and_replace( self, - input: SearchAndReplaceInput, + input: SearchAndReplaceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5444,12 +6052,28 @@ async def search_and_replace_async( new text. Please see api documentation at https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text for comprehensive guidelines. + + Swagger operation ID: `SearchAndReplace`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1/pdf/edit/replace-text" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5463,6 +6087,7 @@ async def search_and_replace_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5470,9 +6095,9 @@ async def search_and_replace_async( return json.loads(response.text) - async def search_and_replace_with_image_async( + async def search_and_replace_with_image( self, - input: SearchAndReplaceWithImageInput, + input: SearchAndReplaceWithImageInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5486,13 +6111,29 @@ async def search_and_replace_with_image_async( documentation at https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text-with-image for comprehensive guidelines. + + Swagger operation ID: `SearchAndReplaceWithImage`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1/pdf/edit/replace-text-with-image" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5506,6 +6147,7 @@ async def search_and_replace_with_image_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5513,9 +6155,9 @@ async def search_and_replace_with_image_async( return json.loads(response.text) - async def search_and_delete_text_async( + async def search_and_delete_text( self, - input: SearchAndDeleteTextInput, + input: SearchAndDeleteTextInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5529,10 +6171,26 @@ async def search_and_delete_text_async( documentation at https://developer.pdf.co/api/pdf-search-and-delete-text/index.html for comprehensive guidelines. + + Swagger operation ID: `SearchAndDeleteText`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/edit/delete-text" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5546,6 +6204,7 @@ async def search_and_delete_text_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5553,9 +6212,9 @@ async def search_and_delete_text_async( return json.loads(response.text) - async def pdf_searchable_async( + async def pdf_searchable( self, - input: PDFSearchableInput, + input: PDFSearchableInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5569,10 +6228,26 @@ async def pdf_searchable_async( see api documentation at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makesearchable for comprehensive guidelines. + + Swagger operation ID: `PDFSearchable`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/makesearchable" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5586,6 +6261,7 @@ async def pdf_searchable_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5593,9 +6269,9 @@ async def pdf_searchable_async( return json.loads(response.text) - async def pdf_unsearchable_async( + async def pdf_unsearchable( self, - input: PDFUnSearchableInput, + input: PDFUnSearchableInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5609,10 +6285,26 @@ async def pdf_unsearchable_async( then scanned your PDF. Please see api documentation at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makeunsearchable for comprehensive guidelines. + + Swagger operation ID: `PDFUnSearchable`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/makeunsearchable" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5626,6 +6318,7 @@ async def pdf_unsearchable_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5633,9 +6326,9 @@ async def pdf_unsearchable_async( return json.loads(response.text) - async def pdf_to_csv_async( + async def pdf_to_csv( self, - input: PDFToCSVInput, + input: PDFToCSVInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5649,10 +6342,26 @@ async def pdf_to_csv_async( columns, rows, and tables. Please see api documentation at https://developer.pdf.co/api/pdf-to-csv/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFToCSV`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/to/csv" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5666,6 +6375,7 @@ async def pdf_to_csv_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5673,9 +6383,9 @@ async def pdf_to_csv_async( return json.loads(response.text) - async def pdf_to_json_async( + async def pdf_to_json( self, - input: PDFToJSONInput, + input: PDFToJSONInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5689,10 +6399,26 @@ async def pdf_to_json_async( fonts, images, vectors, and formatting preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-json/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFToJSON`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/to/json2" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5706,6 +6432,7 @@ async def pdf_to_json_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5713,9 +6440,9 @@ async def pdf_to_json_async( return json.loads(response.text) - async def pdf_to_json_meta_async( + async def pdf_to_json_meta( self, - input: PDFToJSONMetaInput, + input: PDFToJSONMetaInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5730,12 +6457,28 @@ async def pdf_to_json_meta_async( documentation at https://developer.pdf.co/api/pdf-to-json/index.html#post-tag-pdf-convert-to-json-meta for comprehensive guidelines. + + Swagger operation ID: `PDFToJSONMeta`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1/pdf/convert/to/json-meta" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5749,6 +6492,7 @@ async def pdf_to_json_meta_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5756,9 +6500,9 @@ async def pdf_to_json_meta_async( return json.loads(response.text) - async def pdf_to_text_async( + async def pdf_to_text( self, - input: PDFToTextInput, + input: PDFToTextInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5772,10 +6516,26 @@ async def pdf_to_text_async( see api documentation at https://developer.pdf.co/api/pdf-to-text/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFToText`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/to/text" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5789,6 +6549,7 @@ async def pdf_to_text_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5796,9 +6557,9 @@ async def pdf_to_text_async( return json.loads(response.text) - async def pdf_to_text_simple_async( + async def pdf_to_text_simple( self, - input: PDFToTextSimpleInput, + input: PDFToTextSimpleInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5812,12 +6573,28 @@ async def pdf_to_text_simple_async( Please see api documentation at https://developer.pdf.co/api/pdf-to-text/index.html#post-tag-pdf-convert-to-text-simple for comprehensive guidelines. + + Swagger operation ID: `PDFToTextSimple`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1/pdf/convert/to/text-simple" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5831,6 +6608,7 @@ async def pdf_to_text_simple_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5838,9 +6616,9 @@ async def pdf_to_text_simple_async( return json.loads(response.text) - async def pdf_to_xls_async( + async def pdf_to_xls( self, - input: PDFToXLSInput, + input: PDFToXLSInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5854,10 +6632,26 @@ async def pdf_to_xls_async( preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xls for comprehensive guidelines. + + Swagger operation ID: `PDFToXLS`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/to/xls" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5871,6 +6665,7 @@ async def pdf_to_xls_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5878,9 +6673,9 @@ async def pdf_to_xls_async( return json.loads(response.text) - async def pdf_to_xlsx_async( + async def pdf_to_xlsx( self, - input: PDFToXLSXInput, + input: PDFToXLSXInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5894,10 +6689,26 @@ async def pdf_to_xlsx_async( preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xlsx for comprehensive guidelines. + + Swagger operation ID: `PDFToXLSX`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/to/xlsx" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5911,6 +6722,7 @@ async def pdf_to_xlsx_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5918,9 +6730,9 @@ async def pdf_to_xlsx_async( return json.loads(response.text) - async def pdf_to_xml_async( + async def pdf_to_xml( self, - input: PDFToXMLInput, + input: PDFToXMLInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5934,10 +6746,26 @@ async def pdf_to_xml_async( images, objects positions. Please see api documentation at https://developer.pdf.co/api/pdf-to-xml/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFToXML`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/to/xml" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5951,6 +6779,7 @@ async def pdf_to_xml_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5958,9 +6787,9 @@ async def pdf_to_xml_async( return json.loads(response.text) - async def pdf_to_jpg_async( + async def pdf_to_jpg( self, - input: PDFToJPGInput, + input: PDFToJPGInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -5974,10 +6803,26 @@ async def pdf_to_jpg_async( thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-jpg for comprehensive guidelines. + + Swagger operation ID: `PDFToJPG`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/to/jpg" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5991,6 +6836,7 @@ async def pdf_to_jpg_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5998,9 +6844,9 @@ async def pdf_to_jpg_async( return json.loads(response.text) - async def pdf_to_png_async( + async def pdf_to_png( self, - input: PDFToPNGInput, + input: PDFToPNGInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6014,10 +6860,26 @@ async def pdf_to_png_async( thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-png for comprehensive guidelines. + + Swagger operation ID: `PDFToPNG`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/to/png" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6031,6 +6893,7 @@ async def pdf_to_png_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6038,9 +6901,9 @@ async def pdf_to_png_async( return json.loads(response.text) - async def pdf_to_webp_async( + async def pdf_to_webp( self, - input: PDFToWEBPInput, + input: PDFToWEBPInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6054,10 +6917,26 @@ async def pdf_to_webp_async( thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-webp for comprehensive guidelines. + + Swagger operation ID: `PDFToWEBP`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/to/webp" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6071,6 +6950,7 @@ async def pdf_to_webp_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6078,9 +6958,9 @@ async def pdf_to_webp_async( return json.loads(response.text) - async def pdf_to_tiff_async( + async def pdf_to_tiff( self, - input: PDFToTIFFInput, + input: PDFToTIFFInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6095,10 +6975,26 @@ async def pdf_to_tiff_async( documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-tiff for comprehensive guidelines. + + Swagger operation ID: `PDFToTIFF`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/to/tiff" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6112,6 +7008,7 @@ async def pdf_to_tiff_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6119,9 +7016,9 @@ async def pdf_to_tiff_async( return json.loads(response.text) - async def pdf_from_csv_async( + async def pdf_from_csv( self, - input: PDFFromCSVInput, + input: PDFFromCSVInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6135,10 +7032,26 @@ async def pdf_from_csv_async( see api documentation at https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-csv for comprehensive guidelines. + + Swagger operation ID: `PDFFromCSV`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/from/csv" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6152,6 +7065,7 @@ async def pdf_from_csv_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6159,9 +7073,9 @@ async def pdf_from_csv_async( return json.loads(response.text) - async def pdf_from_doc_async( + async def pdf_from_doc( self, - input: PDFFromDocInput, + input: PDFFromDocInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6175,10 +7089,26 @@ async def pdf_from_doc_async( documentation at https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-doc for comprehensive guidelines. + + Swagger operation ID: `PDFFromDoc`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/convert/from/doc" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6192,6 +7122,7 @@ async def pdf_from_doc_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6199,9 +7130,9 @@ async def pdf_from_doc_async( return json.loads(response.text) - async def pdf_from_images_async( + async def pdf_from_images( self, - input: PDFFromImagesInput, + input: PDFFromImagesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6215,12 +7146,28 @@ async def pdf_from_images_async( api documentation at https://developer.pdf.co/api/pdf-from-image/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFFromImages`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1/pdf/convert/from/image" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6234,6 +7181,7 @@ async def pdf_from_images_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6241,9 +7189,9 @@ async def pdf_from_images_async( return json.loads(response.text) - async def pdf_from_email_async( + async def pdf_from_email( self, - input: PDFFromEmailInput, + input: PDFFromEmailInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6258,12 +7206,28 @@ async def pdf_from_email_async( Please see api documentation at https://developer.pdf.co/api/pdf-from-email/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFFromEmail`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1/pdf/convert/from/email" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6277,6 +7241,7 @@ async def pdf_from_email_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6284,9 +7249,9 @@ async def pdf_from_email_async( return json.loads(response.text) - async def pdf_add_security_async( + async def pdf_add_security( self, - input: PDFAddSecurityInput, + input: PDFAddSecurityInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6300,10 +7265,26 @@ async def pdf_add_security_async( documentation at https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-add for comprehensive guidelines. + + Swagger operation ID: `PDFAddSecurity`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/security/add" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6317,6 +7298,7 @@ async def pdf_add_security_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6324,9 +7306,9 @@ async def pdf_add_security_async( return json.loads(response.text) - async def pdf_security_remove_async( + async def pdf_security_remove( self, - input: PDFSecurityRemoveInput, + input: PDFSecurityRemoveInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6340,10 +7322,26 @@ async def pdf_security_remove_async( documentation at https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-remove for comprehensive guidelines. + + Swagger operation ID: `PDFSecurityRemove`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/security/remove" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6357,6 +7355,7 @@ async def pdf_security_remove_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6364,9 +7363,9 @@ async def pdf_security_remove_async( return json.loads(response.text) - async def pdf_from_xls_xlsx_async( + async def pdf_from_xls_xlsx( self, - input: PDFFromXLSXLSXInput, + input: PDFFromXLSXLSXInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6379,10 +7378,26 @@ async def pdf_from_xls_xlsx_async( Create PDF from XLS, XLSX spreadsheet. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-pdf for comprehensive guidelines. + + Swagger operation ID: `PDFFromXLSXLSX`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/xls/convert/to/pdf" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6396,6 +7411,7 @@ async def pdf_from_xls_xlsx_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6403,9 +7419,9 @@ async def pdf_from_xls_xlsx_async( return json.loads(response.text) - async def xls_to_csv_async( + async def xls_to_csv( self, - input: XLStoCSVInput, + input: XLStoCSVInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6419,10 +7435,26 @@ async def xls_to_csv_async( documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-csv for comprehensive guidelines. + + Swagger operation ID: `XLStoCSV`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/xls/convert/to/csv" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6436,6 +7468,7 @@ async def xls_to_csv_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6443,9 +7476,9 @@ async def xls_to_csv_async( return json.loads(response.text) - async def xls_to_json_async( + async def xls_to_json( self, - input: XLStoJSONInput, + input: XLStoJSONInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6458,10 +7491,26 @@ async def xls_to_json_async( Convert XLS/XLSX into JSON file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-json for comprehensive guidelines. + + Swagger operation ID: `XLStoJSON`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/xls/convert/to/json" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6475,6 +7524,7 @@ async def xls_to_json_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6482,9 +7532,9 @@ async def xls_to_json_async( return json.loads(response.text) - async def xls_to_html_async( + async def xls_to_html( self, - input: XLStoHTMLInput, + input: XLStoHTMLInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6497,10 +7547,26 @@ async def xls_to_html_async( Convert XLS/XLSX into HTML file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-html for comprehensive guidelines. + + Swagger operation ID: `XLStoHTML`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/xls/convert/to/html" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6514,6 +7580,7 @@ async def xls_to_html_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6521,9 +7588,9 @@ async def xls_to_html_async( return json.loads(response.text) - async def xls_to_txt_async( + async def xls_to_txt( self, - input: XLStoTXTInput, + input: XLStoTXTInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6536,10 +7603,26 @@ async def xls_to_txt_async( Convert XLS/XLSX or CSV into Text file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-txt for comprehensive guidelines. + + Swagger operation ID: `XLStoTXT`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/xls/convert/to/txt" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6553,6 +7636,7 @@ async def xls_to_txt_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6560,9 +7644,9 @@ async def xls_to_txt_async( return json.loads(response.text) - async def xls_to_xml_async( + async def xls_to_xml( self, - input: XLStoXMLInput, + input: XLStoXMLInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6575,10 +7659,26 @@ async def xls_to_xml_async( Convert XLS/XLSX or CSV into XML file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-xml for comprehensive guidelines. + + Swagger operation ID: `XLStoXML`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/xls/convert/to/xml" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6592,6 +7692,7 @@ async def xls_to_xml_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6599,9 +7700,9 @@ async def xls_to_xml_async( return json.loads(response.text) - async def pdf_rotate_pages_async( + async def pdf_rotate_pages( self, - input: PDFRotatePagesInput, + input: PDFRotatePagesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6614,10 +7715,26 @@ async def pdf_rotate_pages_async( Rotate PDF Pages. Please see api documentation at https://developer.pdf.co/api/pdf-rotate-pages/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFRotatePages`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/edit/rotate" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6631,6 +7748,7 @@ async def pdf_rotate_pages_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6638,9 +7756,9 @@ async def pdf_rotate_pages_async( return json.loads(response.text) - async def pdf_auto_rotate_pages_async( + async def pdf_auto_rotate_pages( self, - input: PDFAutoRotatePagesInput, + input: PDFAutoRotatePagesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6654,10 +7772,26 @@ async def pdf_auto_rotate_pages_async( based on text analysis. Please see api documentation at https://developer.pdf.co/api/pdf-rotate-pages/index.html#post-tag-pdf-edit-rotate-auto for comprehensive guidelines. + + Swagger operation ID: `PDFAutoRotatePages`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/edit/rotate/auto" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6671,6 +7805,7 @@ async def pdf_auto_rotate_pages_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6678,9 +7813,9 @@ async def pdf_auto_rotate_pages_async( return json.loads(response.text) - async def pdf_delete_pages_async( + async def pdf_delete_pages( self, - input: PDFDeletePagesInput, + input: PDFDeletePagesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6693,12 +7828,28 @@ async def pdf_delete_pages_async( Delete pages in PDF. Please see api documentation at https://developer.pdf.co/api/pdf-delete-pages/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFDeletePages`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1/pdf/edit/delete-pages" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6712,6 +7863,7 @@ async def pdf_delete_pages_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6719,9 +7871,9 @@ async def pdf_delete_pages_async( return json.loads(response.text) - async def pdf_compress_async( + async def pdf_compress( self, - input: PDFCompressInput, + input: PDFCompressInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6734,10 +7886,26 @@ async def pdf_compress_async( Optimize PDF document to reduce its size. Please see api documentation at https://developer.pdf.co/api/pdf-optimize/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFCompress`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/optimize" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6751,6 +7919,7 @@ async def pdf_compress_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6758,9 +7927,9 @@ async def pdf_compress_async( return json.loads(response.text) - async def pdf_classifier_async( + async def pdf_classifier( self, - input: PDFClassifierInput, + input: PDFClassifierInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6776,10 +7945,26 @@ async def pdf_classifier_async( api documentation at https://developer.pdf.co/api/document-classifier/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFClassifier`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/pdf/classifier" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6793,6 +7978,7 @@ async def pdf_classifier_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6800,9 +7986,9 @@ async def pdf_classifier_async( return json.loads(response.text) - async def email_send_async( + async def email_send( self, - input: EmailSendInput, + input: EmailSendInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6815,10 +8001,26 @@ async def email_send_async( Send Email with Attachments. Please see api documentation at https://developer.pdf.co/api/email-send-and-decode/index.html for comprehensive guidelines. + + Swagger operation ID: `EmailSend`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/email/send" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6832,6 +8034,7 @@ async def email_send_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6839,9 +8042,9 @@ async def email_send_async( return json.loads(response.text) - async def email_decode_async( + async def email_decode( self, - input: EmailDecodeInput, + input: EmailDecodeInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6855,10 +8058,26 @@ async def email_decode_async( Please see api documentation at https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-decode for comprehensive guidelines. + + Swagger operation ID: `EmailDecode`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/email/decode" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6872,6 +8091,7 @@ async def email_decode_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6879,9 +8099,9 @@ async def email_decode_async( return json.loads(response.text) - async def email_attachment_extraction_async( + async def email_attachment_extraction( self, - input: EmailAttachmentExtractionInput, + input: EmailAttachmentExtractionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6895,12 +8115,28 @@ async def email_attachment_extraction_async( documentation at https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-extract-attachments for comprehensive guidelines. + + Swagger operation ID: `EmailAttachmentExtraction`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1/email/extract-attachments" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6914,6 +8150,7 @@ async def email_attachment_extraction_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6921,9 +8158,9 @@ async def email_attachment_extraction_async( return json.loads(response.text) - async def pdf_attachment_extraction_async( + async def pdf_attachment_extraction( self, - input: PDFAttachmentExtractionInput, + input: PDFAttachmentExtractionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6937,12 +8174,28 @@ async def pdf_attachment_extraction_async( documentation at https://developer.pdf.co/api/extract-attachments/index.html for comprehensive guidelines. + + Swagger operation ID: `PDFAttachmentExtraction`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1/pdf/attachments/extract" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6956,6 +8209,7 @@ async def pdf_attachment_extraction_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/pipedrive.py b/src/azure/connectors/pipedrive.py index d5546d33..9a06f082 100644 --- a/src/azure/connectors/pipedrive.py +++ b/src/azure/connectors/pipedrive.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,12 +19,35 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "PipedriveClient", + "ActivityResponse", + "AddActivityRequest", + "AddDealRequest", + "DealResponse", + "DealResponseV2", + "ListActivityTypesResponse", + "ListCurrenciesResponse", + "ListDealsResponse", + "ListOrganizationsResponse", + "ListPersonsResponse", + "ListPipelinesResponse", + "ListStagesResponse", + "StageResponse", + "TrigNewActivityResponse", + "TrigNewDealResponse", + "UpdateDealStageRequest", + "UpdateDealStatusRequest", + "TRIGGER_OPERATIONS", +] + # Type Definitions -TrigNewActivityResponse = List["ActivityResponse"] +TrigNewActivityResponse = List["ActivityResponse | Mapping[str, Any]"] @dataclass @@ -32,81 +56,81 @@ class DealResponse: Response for Get deal by id """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the deal.""" - creator_user_id: Optional[Dict[str, Any]] = None - user_id: Optional[Dict[str, Any]] = None - person_id: Optional[Dict[str, Any]] = None - org_id: Optional[Dict[str, Any]] = None - status: Optional[str] = None + creator_user_id: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + user_id: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + person_id: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + org_id: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Open, won, lost or deleted.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the deal.""" - value: Optional[float] = None + value: Optional[float] = dataclass_field(default=None, kw_only=True) """Monetary value of the deal.""" - currency: Optional[str] = None + currency: Optional[str] = dataclass_field(default=None, kw_only=True) """Currency associated with the deal value.""" - add_time: Optional[str] = None + add_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - update_time: Optional[str] = None + update_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - stage_id: Optional[int] = None + stage_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ID of stage the deal is placed in a pipeline.""" - stage_name: Optional[str] = None + stage_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of stage the deal is placed in a pipeline""" - stage_change_time: Optional[str] = None + stage_change_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - active: Optional[bool] = None + active: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the deal is active.""" - deleted: Optional[bool] = None + deleted: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the deal has been deleted.""" - next_activity_date: Optional[str] = None + next_activity_date: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-dd""" - next_activity_time: Optional[str] = None + next_activity_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - next_activity_id: Optional[int] = None + next_activity_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the next activity.""" - last_activity_id: Optional[int] = None + last_activity_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the last activity.""" - last_activity_date: Optional[str] = None + last_activity_date: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-dd""" - lost_reason: Optional[str] = None + lost_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """Message about why the deal was lost (to be used when status=lost).""" - visible_to: Optional[str] = None + visible_to: Optional[str] = dataclass_field(default=None, kw_only=True) """Owner, followers or entire company.""" - close_time: Optional[str] = None + close_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - pipeline_id: Optional[int] = None + pipeline_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of pipeline the deal is associated with.""" - products_count: Optional[int] = None + products_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of products associated with the deal.""" - files_count: Optional[int] = None + files_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of files associated with the deal.""" - notes_count: Optional[int] = None + notes_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of notes associated with the deal.""" - followers_count: Optional[int] = None + followers_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of followers associated with the deal.""" - email_messages_count: Optional[int] = None + email_messages_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of email messages associated with the deal.""" - activities_count: Optional[int] = None + activities_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of activities associated with the deal.""" - done_activities_count: Optional[int] = None + done_activities_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of done activities associated with the deal.""" - undone_activities_count: Optional[int] = None + undone_activities_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of undone activities associated with the deals.""" - reference_activities_count: Optional[int] = None + reference_activities_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of referenced activities associated with the deal.""" - participants_count: Optional[int] = None + participants_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of participants associated with the deal.""" - expected_close_date: Optional[str] = None + expected_close_date: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-dd""" - next_activity_subject: Optional[str] = None + next_activity_subject: Optional[str] = dataclass_field(default=None, kw_only=True) """Subject of next activity associated with the deal.""" - next_activity_type: Optional[str] = None + next_activity_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of next activity associated with the deal.""" - next_activity_duration: Optional[str] = None + next_activity_duration: Optional[str] = dataclass_field(default=None, kw_only=True) """Duration of next activity associated with the deal.""" - next_activity_note: Optional[str] = None + next_activity_note: Optional[str] = dataclass_field(default=None, kw_only=True) """Notes for next activity associated with the deal""" @@ -116,51 +140,55 @@ class ActivityResponse: Response for Add activity """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique id of the activity.""" - user_id: Optional[int] = None + user_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the user whom the activity is assigned to.""" - done: Optional[bool] = None + done: Optional[bool] = dataclass_field(default=None, kw_only=True) """0 = Not done, 1 = Done""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type of the activity.""" - due_date: Optional[str] = None + due_date: Optional[str] = dataclass_field(default=None, kw_only=True) """YYYY-MM-DD""" - due_time: Optional[str] = None + due_time: Optional[str] = dataclass_field(default=None, kw_only=True) """HH:MM""" - duration: Optional[str] = None + duration: Optional[str] = dataclass_field(default=None, kw_only=True) """HH:MM""" - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """Subject of the activity.""" - deal_id: Optional[int] = None + deal_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of deal the activity is associated with.""" - deal_title: Optional[str] = None + deal_title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of deal the activity is associated with.""" - org_id: Optional[int] = None + org_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of organization the activity is associated with.""" - org_name: Optional[str] = None + org_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of organization the activity is associated with.""" - person_id: Optional[int] = None + person_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of person the activity is associated with.""" - person_name: Optional[str] = None + person_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of person the activity is associated with.""" - add_time: Optional[str] = None + add_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - update_time: Optional[str] = None + update_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - marked_as_done_time: Optional[str] = None + marked_as_done_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - gcal_event_id: Optional[str] = None + gcal_event_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the google calendar event.""" - google_calendar_id: Optional[str] = None + google_calendar_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the google calendar.""" - note: Optional[str] = None + note: Optional[str] = dataclass_field(default=None, kw_only=True) """Note of the activity (HTML format).""" - assigned_to_user_id: Optional[int] = None + assigned_to_user_id: Optional[int] = dataclass_field(default=None, kw_only=True) """User id of user whom the activity is assigned to.""" - created_by_user_id: Optional[int] = None + created_by_user_id: Optional[int] = dataclass_field(default=None, kw_only=True) """User id of user that created the activity.""" - owner_name: Optional[str] = None + owner_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the activity owner.""" @@ -170,9 +198,9 @@ class StageResponse: Response for Get stage by id """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Stage Id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Stage name""" @@ -182,83 +210,83 @@ class DealResponseV2: Response for Add deal (V2) """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the deal.""" - creator_user_id: Optional[Dict[str, Any]] = None - user_id: Optional[Dict[str, Any]] = None - person_id: Optional[Dict[str, Any]] = None - org_id: Optional[Dict[str, Any]] = None - status: Optional[str] = None + creator_user_id: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + user_id: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + person_id: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + org_id: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Open, won, lost or deleted.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the deal.""" - value: Optional[float] = None + value: Optional[float] = dataclass_field(default=None, kw_only=True) """Monetary value of the deal.""" - currency: Optional[str] = None + currency: Optional[str] = dataclass_field(default=None, kw_only=True) """Currency associated with the deal value.""" - add_time: Optional[str] = None + add_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - update_time: Optional[str] = None + update_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - stage_id: Optional[int] = None + stage_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ID of stage the deal is placed in a pipeline.""" - stage_change_time: Optional[str] = None + stage_change_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - active: Optional[bool] = None + active: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the deal is active.""" - deleted: Optional[bool] = None + deleted: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the deal has been deleted.""" - next_activity_date: Optional[str] = None + next_activity_date: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-dd""" - next_activity_time: Optional[str] = None + next_activity_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - next_activity_id: Optional[int] = None + next_activity_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the next activity.""" - last_activity_id: Optional[int] = None + last_activity_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the last activity.""" - last_activity_date: Optional[str] = None + last_activity_date: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-dd""" - lost_reason: Optional[str] = None + lost_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """Message about why the deal was lost (to be used when status=lost).""" - visible_to: Optional[str] = None + visible_to: Optional[str] = dataclass_field(default=None, kw_only=True) """Owner, followers or entire company.""" - close_time: Optional[str] = None + close_time: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-ddTHH:mm:ss.fffZ""" - pipeline_id: Optional[int] = None + pipeline_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of pipeline the deal is associated with.""" - products_count: Optional[int] = None + products_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of products associated with the deal.""" - files_count: Optional[int] = None + files_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of files associated with the deal.""" - notes_count: Optional[int] = None + notes_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of notes associated with the deal.""" - followers_count: Optional[int] = None + followers_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of followers associated with the deal.""" - email_messages_count: Optional[int] = None + email_messages_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of email messages associated with the deal.""" - activities_count: Optional[int] = None + activities_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of activities associated with the deal.""" - done_activities_count: Optional[int] = None + done_activities_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of done activities associated with the deal.""" - undone_activities_count: Optional[int] = None + undone_activities_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of undone activities associated with the deals.""" - reference_activities_count: Optional[int] = None + reference_activities_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of referenced activities associated with the deal.""" - participants_count: Optional[int] = None + participants_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of participants associated with the deal.""" - expected_close_date: Optional[str] = None + expected_close_date: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-dd""" - next_activity_subject: Optional[str] = None + next_activity_subject: Optional[str] = dataclass_field(default=None, kw_only=True) """Subject of next activity associated with the deal.""" - next_activity_type: Optional[str] = None + next_activity_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of next activity associated with the deal.""" - next_activity_duration: Optional[str] = None + next_activity_duration: Optional[str] = dataclass_field(default=None, kw_only=True) """Duration of next activity associated with the deal.""" - next_activity_note: Optional[str] = None + next_activity_note: Optional[str] = dataclass_field(default=None, kw_only=True) """Notes for next activity associated with the deal""" -TrigNewDealResponse = List["DealResponseV2"] +TrigNewDealResponse = List["DealResponseV2 | Mapping[str, Any]"] @dataclass @@ -267,7 +295,7 @@ class ListDealsResponse: Response for List deals """ - data: Optional[List[Dict[str, Any]]] = None + data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """data""" @@ -277,24 +305,24 @@ class AddActivityRequest: Definition: AddActivityRequest """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """Activity type.""" - subject: Optional[str] = None + subject: str """Subject of the activity.""" - due_date: Optional[str] = None + due_date: Optional[str] = dataclass_field(default=None, kw_only=True) """YYYY-MM-DD""" - due_time: Optional[str] = None + due_time: Optional[str] = dataclass_field(default=None, kw_only=True) """HH:MM""" - duration: Optional[str] = None + duration: Optional[str] = dataclass_field(default=None, kw_only=True) """HH:MM""" - note: Optional[str] = None - user_id: Optional[int] = None + note: Optional[str] = dataclass_field(default=None, kw_only=True) + user_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the user whom the activity will be assigned to.""" - deal_id: Optional[int] = None + deal_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ID of deal the activity will be associated with.""" - person_id: Optional[int] = None + person_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of person the activity will be associated with.""" - org_id: Optional[int] = None + org_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ID of the organization the activity will be associated with.""" @@ -304,25 +332,25 @@ class AddDealRequest: Definition: AddDealRequest """ - title: Optional[str] = None + title: str """Title of the deal.""" - pipeline_id: Optional[str] = None + pipeline_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the pipeline to fetch stages from.""" - stage_id: Optional[str] = None + stage_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Stage of the deal.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the deal.""" - value: Optional[int] = None + value: Optional[int] = dataclass_field(default=None, kw_only=True) """Monetary value of the deal.""" - currency: Optional[str] = None + currency: Optional[str] = dataclass_field(default=None, kw_only=True) """Currency of the deal.""" - person_id: Optional[str] = None + person_id: Optional[str] = dataclass_field(default=None, kw_only=True) """User id of person the deal is associated with.""" - org_id: Optional[str] = None + org_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the organization associated with the deal.""" - expected_close_date: Optional[str] = None + expected_close_date: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-dd""" - visible_to: Optional[str] = None + visible_to: Optional[str] = dataclass_field(default=None, kw_only=True) """Owner, followers or entire company.""" @@ -332,11 +360,11 @@ class UpdateDealStageRequest: Definition: UpdateDealStageRequest """ - pipeline_id: Optional[str] = None + pipeline_id: str """The id of the pipeline to fetch stages from.""" - stage_id: Optional[str] = None + stage_id: str """Stage of the deal.""" - expected_close_date: Optional[str] = None + expected_close_date: Optional[str] = dataclass_field(default=None, kw_only=True) """yyyy-MM-dd""" @@ -346,9 +374,9 @@ class UpdateDealStatusRequest: Definition: UpdateDealStatusRequest """ - status: Optional[str] = None + status: str """Status of the deal.""" - lost_reason: Optional[str] = None + lost_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """Message about why the deal was lost.""" @@ -358,9 +386,9 @@ class ListActivityTypesResponse: Definition: ListActivityTypesResponse """ - success: Optional[bool] = None + success: Optional[bool] = dataclass_field(default=None, kw_only=True) """success""" - data: Optional[List[Dict[str, Any]]] = None + data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """data""" @@ -370,7 +398,7 @@ class ListCurrenciesResponse: Definition: ListCurrenciesResponse """ - data: Optional[List[Dict[str, Any]]] = None + data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """data""" @@ -380,7 +408,7 @@ class ListPipelinesResponse: Definition: ListPipelinesResponse """ - data: Optional[List[Dict[str, Any]]] = None + data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """data""" @@ -390,7 +418,12 @@ class ListStagesResponse: Definition: ListStagesResponse """ - data: Optional[List[StageResponse]] = None + data: Optional[ + List[StageResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """data""" @@ -400,7 +433,7 @@ class ListPersonsResponse: Definition: ListPersonsResponse """ - data: Optional[List[Dict[str, Any]]] = None + data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """data""" @@ -410,7 +443,7 @@ class ListOrganizationsResponse: Definition: ListOrganizationsResponse """ - data: Optional[List[Dict[str, Any]]] = None + data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """data""" @@ -425,7 +458,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -442,8 +475,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -464,7 +497,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -479,7 +512,84 @@ def __init__( def connector_name(self) -> str: return "pipedrive" - async def get_deal_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def get_deal( self, deal_id: int, *, @@ -492,13 +602,28 @@ async def get_deal_async( Get deal by id This operation retrieves all details of an existing deal, given its id. + + Swagger operation ID: `GetDeal`. + + Args: + deal_id: Deal. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1/deals/{quote(str(deal_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -512,6 +637,7 @@ async def get_deal_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -519,9 +645,9 @@ async def get_deal_async( return json.loads(response.text) - async def update_deal_status_async( + async def update_deal_status( self, - input: UpdateDealStatusRequest, + input: UpdateDealStatusRequest | Mapping[str, Any], deal_id: int, *, timeout: Optional[float] = None, @@ -534,13 +660,30 @@ async def update_deal_status_async( This operation is used to update the status associated with a deal, given its id. + + Swagger operation ID: `UpdateDealStatus`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + deal_id: Deal. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/update_status_deal/v1/deals/{quote(str(deal_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -554,6 +697,7 @@ async def update_deal_status_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -561,9 +705,9 @@ async def update_deal_status_async( return json.loads(response.text) - async def add_activity_async( + async def add_activity( self, - input: AddActivityRequest, + input: AddActivityRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -575,10 +719,26 @@ async def add_activity_async( This operation is used to create a new activity for the authorized account. + + Swagger operation ID: `AddActivity`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/activities" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -592,6 +752,7 @@ async def add_activity_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -599,7 +760,7 @@ async def add_activity_async( return json.loads(response.text) - async def get_stage_async( + async def get_stage( self, stage_id: int, *, @@ -612,13 +773,28 @@ async def get_stage_async( Get stage by id This operation returns data about a specific stage. + + Swagger operation ID: `GetStage`. + + Args: + stage_id: Stage Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1/stages/{quote(str(stage_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -632,6 +808,7 @@ async def get_stage_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -639,9 +816,9 @@ async def get_stage_async( return json.loads(response.text) - async def add_deal_async( + async def add_deal( self, - input: AddDealRequest, + input: AddDealRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -652,10 +829,26 @@ async def add_deal_async( Add deal This operation creates a new deal for the authorized account. + + Swagger operation ID: `AddDealV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/connector-v2/v1/deals" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -669,6 +862,7 @@ async def add_deal_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -676,9 +870,9 @@ async def add_deal_async( return json.loads(response.text) - async def update_deal_stage_async( + async def update_deal_stage( self, - input: UpdateDealStageRequest, + input: UpdateDealStageRequest | Mapping[str, Any], deal_id: int, *, timeout: Optional[float] = None, @@ -691,6 +885,23 @@ async def update_deal_stage_async( This operation is used to update the stage associated with a deal, given its id. + + Swagger operation ID: `UpdateDealStageV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + deal_id: Deal. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -701,7 +912,7 @@ async def update_deal_stage_async( f"/{quote(str(deal_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -715,6 +926,7 @@ async def update_deal_stage_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -722,41 +934,79 @@ async def update_deal_stage_async( return json.loads(response.text) - async def list_deals_async( + def list_deals( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List deals List deals + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListDeals`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/deals" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("data", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/planner.py b/src/azure/connectors/planner.py index a64e9bc2..43c641a0 100644 --- a/src/azure/connectors/planner.py +++ b/src/azure/connectors/planner.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,32 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "PlannerClient", + "AppliedCategories", + "AssignUsersInput", + "CreateBucketInput", + "CreateBucketResponse", + "CreateTaskRequest", + "ErrorResponse", + "GetPlanDetailsResponse", + "GetTaskDetailsResponse", + "GetTaskResponse", + "GetTaskResponseV2", + "GetTaskResponseV3", + "ListBucketsResponse", + "ListGroupsResponse", + "ListMyPlansResponse", + "ListTasksResponse", + "UnassignUsersInput", + "UpdateTaskDetailsRequest", + "UpdateTaskRequest", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +54,7 @@ class UnassignUsersInput: Remove assignees from a task """ - assignments: Optional[str] = None + assignments: str """ Semi-colon separated ids or email addresses of users who should be unassigned to this task. @@ -42,65 +67,77 @@ class GetTaskResponseV2: Response for Remove assignees from a task """ - created_by: Optional[Dict[str, Any]] = field( + created_by: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) - plan_id: Optional[str] = field( + plan_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "planId"}, ) """The id of the plan this task belongs to.""" - bucket_id: Optional[str] = field( + bucket_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "bucketId"}, ) """The id of the bucket this task belongs to.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the task.""" - percent_complete: Optional[int] = field( + percent_complete: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "percentComplete"}, ) """The completion percentage of the task.""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """The start datetime of the task.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The datetime the task was created.""" - due_date_time: Optional[str] = field( + due_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDateTime"}, ) """The datetime the task is due.""" - has_description: Optional[bool] = field( + has_description: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasDescription"}, ) """Set to true if the task has a description.""" - completed_date_time: Optional[str] = field( + completed_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completedDateTime"}, ) """The datetime the task was completed.""" - reference_count: Optional[int] = field( + reference_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referenceCount"}, ) """The number of external references that exist on the task.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the task.""" - applied_categories: Optional[AppliedCategories] = field( + applied_categories: Optional[AppliedCategories | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "appliedCategories"}, ) - assignments: Optional[List[Dict[str, Any]]] = field( + assignments: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_assignments"}, ) @@ -111,7 +148,7 @@ class AssignUsersInput: Add assignees to a task """ - assignments: Optional[str] = None + assignments: str """ Semi-colon separated ids or email addresses of users who should be assigned to this task. @@ -124,7 +161,7 @@ class ListMyPlansResponse: Response for List plans for a group """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -133,11 +170,12 @@ class GetPlanDetailsResponse: Response for Get plan details """ - category_descriptions: Optional[Dict[str, Any]] = field( + category_descriptions: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "categoryDescriptions"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the plan details""" @@ -147,17 +185,11 @@ class CreateBucketInput: Create a bucket """ - name: Optional[str] = None + name: str """Name of the bucket""" - group_id: Optional[str] = field( - default=None, - metadata={"wire_name": "groupId"}, - ) + group_id: str = dataclass_field(metadata={"wire_name": "groupId"}) """The group to retrieve the plan.""" - plan_id: Optional[str] = field( - default=None, - metadata={"wire_name": "planId"}, - ) + plan_id: str = dataclass_field(metadata={"wire_name": "planId"}) """The plan for the new bucket.""" @@ -167,19 +199,21 @@ class CreateBucketResponse: Response for Create a bucket """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the bucket""" - plan_id: Optional[str] = field( + plan_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "planId"}, ) """Plan ID to which the bucket belongs""" - order_hint: Optional[str] = field( + order_hint: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "orderHint"}, ) """Hint used to order items of this type in a list view""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID of the bucket""" @@ -189,64 +223,75 @@ class GetTaskResponseV3: Response for Create a task """ - created_by: Optional[Dict[str, Any]] = field( + created_by: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) - plan_id: Optional[str] = field( + plan_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "planId"}, ) """The id of the plan this task belongs to.""" - bucket_id: Optional[str] = field( + bucket_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "bucketId"}, ) """The id of the bucket this task belongs to.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the task.""" - percent_complete: Optional[int] = field( + percent_complete: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "percentComplete"}, ) """The completion percentage of the task.""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """The start datetime of the task.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The datetime the task was created.""" - due_date_time: Optional[str] = field( + due_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDateTime"}, ) """The datetime the task is due.""" - has_description: Optional[bool] = field( + has_description: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasDescription"}, ) """Set to true if the task has a description.""" - completed_date_time: Optional[str] = field( + completed_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completedDateTime"}, ) """The datetime the task was completed.""" - reference_count: Optional[int] = field( + reference_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referenceCount"}, ) """The number of external references that exist on the task.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the task.""" - applied_categories: Optional[AppliedCategories] = field( + applied_categories: Optional[AppliedCategories | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "appliedCategories"}, ) - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """ Priority of the task. Valid range of values is between 0 and 10 (inclusive), with increasing value being lower priority (0 has the highest @@ -256,8 +301,9 @@ class GetTaskResponseV3: value 1 for \"urgent\", 3 for \"important\", 5 for \"medium\", and 9 for \"low\". """ - assignments: Optional[List[Dict[str, Any]]] = field( + assignments: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_assignments"}, ) @@ -268,13 +314,13 @@ class GetTaskDetailsResponse: Response for Get task details """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the task.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the task.""" - references: Optional[List[Dict[str, Any]]] = None + references: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """The collection of references on the task""" - checklist: Optional[List[Dict[str, Any]]] = None + checklist: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """The collection of checklist items on the task.""" @@ -284,7 +330,7 @@ class ListBucketsResponse: Response for List buckets """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -293,9 +339,15 @@ class ListTasksResponse: Response for List my tasks """ - value: Optional[List[GetTaskResponseV2]] = None - next_link: Optional[str] = field( + value: Optional[ + List[GetTaskResponseV2 | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, + ) + next_link: Optional[str] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """Link to get next page of results""" @@ -307,7 +359,7 @@ class ListGroupsResponse: Response for List groups that I am member of """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """value""" @@ -317,11 +369,11 @@ class UpdateTaskDetailsRequest: Definition: UpdateTaskDetails_Request """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the task.""" - references: Optional[List[Dict[str, Any]]] = None + references: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """The collection of references on the task""" - checklist: Optional[List[Dict[str, Any]]] = None + checklist: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """The collection of checklist items on the task""" @@ -331,30 +383,35 @@ class UpdateTaskRequest: Definition: UpdateTask_Request """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the plan (maximum of 255 chars).""" - due_date_time: Optional[str] = field( + due_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDateTime"}, ) """The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').""" - percent_complete: Optional[int] = field( + percent_complete: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "percentComplete"}, ) """The completion percentage of the task.""" - bucket_id: Optional[str] = field( + bucket_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "bucketId"}, ) """The bucket to place this task in.""" - applied_categories: Optional[AppliedCategories] = field( + applied_categories: Optional[AppliedCategories | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "appliedCategories"}, ) @@ -365,43 +422,41 @@ class CreateTaskRequest: Definition: CreateTask_Request """ - group_id: Optional[str] = field( - default=None, - metadata={"wire_name": "groupId"}, - ) + group_id: str = dataclass_field(metadata={"wire_name": "groupId"}) """The group to retrieve the plan.""" - plan_id: Optional[str] = field( - default=None, - metadata={"wire_name": "planId"}, - ) + plan_id: str = dataclass_field(metadata={"wire_name": "planId"}) """The plan for the new task.""" - title: Optional[str] = None + title: str """The title of the new task (maximum of 255 chars).""" - bucket_id: Optional[str] = field( + bucket_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "bucketId"}, ) """The bucket to place this task in.""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').""" - due_date_time: Optional[str] = field( + due_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDateTime"}, ) """The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').""" - assignments: Optional[str] = None + assignments: Optional[str] = dataclass_field(default=None, kw_only=True) """ Semi-colon separated ids or email addresses of users to assign this task to. """ - applied_categories: Optional[AppliedCategories] = field( + applied_categories: Optional[AppliedCategories | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "appliedCategories"}, ) - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """ Priority of the task. Valid range of values is between 0 and 10 (inclusive), with increasing value being lower priority (0 has the highest @@ -419,55 +474,55 @@ class AppliedCategories: Definition: AppliedCategories """ - category1: Optional[bool] = None + category1: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Pink category.""" - category2: Optional[bool] = None + category2: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Red category.""" - category3: Optional[bool] = None + category3: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Yellow category.""" - category4: Optional[bool] = None + category4: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Green category.""" - category5: Optional[bool] = None + category5: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Blue category.""" - category6: Optional[bool] = None + category6: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Purple category.""" - category7: Optional[bool] = None + category7: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Bronze category.""" - category8: Optional[bool] = None + category8: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Lime category.""" - category9: Optional[bool] = None + category9: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Aqua category.""" - category10: Optional[bool] = None + category10: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Gray category.""" - category11: Optional[bool] = None + category11: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Silver category.""" - category12: Optional[bool] = None + category12: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Brown category.""" - category13: Optional[bool] = None + category13: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Cranberry category.""" - category14: Optional[bool] = None + category14: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Orange category.""" - category15: Optional[bool] = None + category15: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Peach category.""" - category16: Optional[bool] = None + category16: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Marigold category.""" - category17: Optional[bool] = None + category17: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Light green category.""" - category18: Optional[bool] = None + category18: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Dark green category.""" - category19: Optional[bool] = None + category19: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Teal category.""" - category20: Optional[bool] = None + category20: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Light blue category.""" - category21: Optional[bool] = None + category21: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Dark blue category.""" - category22: Optional[bool] = None + category22: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Lavender category.""" - category23: Optional[bool] = None + category23: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Plum category.""" - category24: Optional[bool] = None + category24: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Light gray category.""" - category25: Optional[bool] = None + category25: Optional[bool] = dataclass_field(default=None, kw_only=True) """True if the task has the Dark gray category.""" @@ -477,58 +532,68 @@ class GetTaskResponse: Definition: GetTask_Response """ - created_by: Optional[Dict[str, Any]] = field( + created_by: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) - plan_id: Optional[str] = field( + plan_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "planId"}, ) """The id of the plan this task belongs to.""" - bucket_id: Optional[str] = field( + bucket_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "bucketId"}, ) """The id of the bucket this task belongs to.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the task.""" - percent_complete: Optional[int] = field( + percent_complete: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "percentComplete"}, ) """The completion percentage of the task.""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """The start datetime of the task.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The datetime the task was created.""" - due_date_time: Optional[str] = field( + due_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDateTime"}, ) """The datetime the task is due.""" - has_description: Optional[bool] = field( + has_description: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasDescription"}, ) """Set to true if the task has a description.""" - completed_date_time: Optional[str] = field( + completed_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completedDateTime"}, ) """The datetime the task was completed.""" - reference_count: Optional[int] = field( + reference_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referenceCount"}, ) """The number of external references that exist on the task.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the task.""" @@ -538,8 +603,8 @@ class ErrorResponse: Definition: ErrorResponse """ - code: Optional[str] = None - message: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) + message: Optional[str] = dataclass_field(default=None, kw_only=True) # Client Class @@ -553,7 +618,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -570,8 +635,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -592,7 +657,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -608,15 +673,49 @@ def connector_name(self) -> str: return "planner" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -633,7 +732,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -646,7 +749,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def delete_task_async( + async def delete_task( self, id: str, *, @@ -659,13 +762,28 @@ async def delete_task_async( Delete a task Deletes an existing Planner task. + + Swagger operation ID: `DeleteTask`. + + Args: + id: The unique identifier of the task to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/planner/tasks/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -679,11 +797,12 @@ async def delete_task_async( request_url, response.status, response.text, + response=response, ) - async def unassign_users_async( + async def unassign_users( self, - input: UnassignUsersInput, + input: UnassignUsersInput | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -695,13 +814,30 @@ async def unassign_users_async( Remove assignees from a task Remove assignees from an existing Planner task. + + Swagger operation ID: `UnassignUsers`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: The unique identifier of the task to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/planner/tasks/{quote(str(id), safe='')}/unassignusers" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -715,6 +851,7 @@ async def unassign_users_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -722,9 +859,9 @@ async def unassign_users_async( return json.loads(response.text) - async def assign_users_async( + async def assign_users( self, - input: AssignUsersInput, + input: AssignUsersInput | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -736,13 +873,30 @@ async def assign_users_async( Add assignees to a task Add assignees to an existing Planner task. + + Swagger operation ID: `AssignUsers`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: The unique identifier of the task to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/planner/tasks/{quote(str(id), safe='')}/assignusers" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -756,6 +910,7 @@ async def assign_users_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -763,7 +918,7 @@ async def assign_users_async( return json.loads(response.text) - async def list_group_plans_async( + def list_group_plans( self, group_id: str, *, @@ -771,39 +926,78 @@ async def list_group_plans_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List plans for a group List plans owned by the group specified. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListGroupPlans`. + + Args: + group_id: Id of the group. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/groups/{quote(str(group_id), safe='')}/planner/plans" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_plan_details_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_plan_details( self, id: str, *, @@ -816,13 +1010,28 @@ async def get_plan_details_async( Get plan details Get plan details where the task belongs to + + Swagger operation ID: `GetPlanDetails`. + + Args: + id: The unique plan id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/planner/plans/{quote(str(id), safe='')}/details" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -836,6 +1045,7 @@ async def get_plan_details_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -843,9 +1053,9 @@ async def get_plan_details_async( return json.loads(response.text) - async def create_bucket_async( + async def create_bucket( self, - input: CreateBucketInput, + input: CreateBucketInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -856,10 +1066,26 @@ async def create_bucket_async( Create a bucket Create a bucket in Planner for the specified plan and group. + + Swagger operation ID: `CreateBucket_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/v1.0/planner/buckets" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -873,6 +1099,7 @@ async def create_bucket_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -880,9 +1107,9 @@ async def create_bucket_async( return json.loads(response.text) - async def create_task_async( + async def create_task( self, - input: CreateTaskRequest, + input: CreateTaskRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -893,10 +1120,26 @@ async def create_task_async( Create a task Create a new task in Planner. + + Swagger operation ID: `CreateTask_V4`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/beta/planner/tasks" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -910,6 +1153,7 @@ async def create_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -917,7 +1161,7 @@ async def create_task_async( return json.loads(response.text) - async def get_task_async( + async def get_task( self, id: str, *, @@ -930,13 +1174,28 @@ async def get_task_async( Get a task Get an existing Planner task. + + Swagger operation ID: `GetTask_V2`. + + Args: + id: The unique identifier of the task to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/planner/tasks/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -950,6 +1209,7 @@ async def get_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -957,7 +1217,7 @@ async def get_task_async( return json.loads(response.text) - async def get_task_details_async( + async def get_task_details( self, id: str, *, @@ -970,13 +1230,28 @@ async def get_task_details_async( Get task details Get the task details for an existing task. + + Swagger operation ID: `GetTaskDetails_V2`. + + Args: + id: The unique identifier of the task to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/planner/tasks/{quote(str(id), safe='')}/details" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -990,6 +1265,7 @@ async def get_task_details_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -997,7 +1273,7 @@ async def get_task_details_async( return json.loads(response.text) - async def list_buckets_async( + def list_buckets( self, id: str, group_id: str, @@ -1006,11 +1282,30 @@ async def list_buckets_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List buckets List the buckets in a plan. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListBuckets_V3`. + + Args: + id: The unique identifier of the plan. + group_id: The group to retrieve the plan. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1023,50 +1318,93 @@ async def list_buckets_async( query_params.append(f"groupId={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def list_my_tasks_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_my_tasks( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List my tasks List the tasks assigned to me. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListMyTasks_V2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/me/planner/tasks" + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1079,23 +1417,32 @@ async def list_my_tasks_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def list_tasks_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_tasks( self, id: str, group_id: str, @@ -1104,14 +1451,31 @@ async def list_tasks_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List tasks List the tasks in a plan. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListTasks_V3`. + + Args: + id: The unique identifier of the plan. + group_id: The group to retrieve the plan. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1124,11 +1488,18 @@ async def list_tasks_async( query_params.append(f"groupId={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1141,25 +1512,34 @@ async def list_tasks_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def update_task_async( + return AsyncItemPaged(get_next, extract_data) + + async def update_task( self, - input: UpdateTaskRequest, + input: UpdateTaskRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -1171,13 +1551,30 @@ async def update_task_async( Update a task Update an existing Planner task. + + Swagger operation ID: `UpdateTask_V3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: The unique identifier of the task to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v2/v1.0/planner/tasks/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1191,6 +1588,7 @@ async def update_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1198,9 +1596,9 @@ async def update_task_async( return json.loads(response.text) - async def update_task_details_async( + async def update_task_details( self, - input: UpdateTaskDetailsRequest, + input: UpdateTaskDetailsRequest | Mapping[str, Any], id: str, *, timeout: Optional[float] = None, @@ -1212,13 +1610,30 @@ async def update_task_details_async( Update task details Update the task details for an existing task. + + Swagger operation ID: `UpdateTaskDetails_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: The unique identifier of the task to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/planner/tasks/{quote(str(id), safe='')}/details" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1232,6 +1647,7 @@ async def update_task_details_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1239,41 +1655,79 @@ async def update_task_details_async( return json.loads(response.text) - async def list_groups_async( + def list_groups( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List groups that I am member of Get groups that the user is a direct member of. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListGroups`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/me/memberOf" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/plivo.py b/src/azure/connectors/plivo.py index 7706552c..7ab9c1db 100644 --- a/src/azure/connectors/plivo.py +++ b/src/azure/connectors/plivo.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,19 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "PlivoClient", + "Call", + "GetMessageResponse", + "ListMessagesResponse", + "MakeCallResponse", + "SMS", + "SendSMSResponse", +] + # Type Definitions @@ -29,11 +41,11 @@ class MakeCallResponse: Response for Make a call """ - api_id: Optional[str] = None + api_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the API request.""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """Response obtained when the call was made.""" - request_uuid: Optional[str] = None + request_uuid: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the call.""" @@ -43,11 +55,11 @@ class ListMessagesResponse: Response for List all messages """ - api_id: Optional[str] = None + api_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the API request.""" - meta: Optional[Dict[str, Any]] = None + meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Meta information about the response.""" - objects: Optional[List[Dict[str, Any]]] = None + objects: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Details of all messages.""" @@ -57,11 +69,11 @@ class SendSMSResponse: Response for Send SMS """ - api_id: Optional[str] = None + api_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the API request.""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """Response of the sent message.""" - message_uuid: Optional[List[str]] = None + message_uuid: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Unique ID of the message.""" @@ -71,34 +83,34 @@ class GetMessageResponse: Response for Get message """ - api_id: Optional[str] = None + api_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the API request.""" - error_code: Optional[str] = None + error_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Delivery error code if the message isn't delivered.""" - from_number: Optional[str] = None + from_number: Optional[str] = dataclass_field(default=None, kw_only=True) """Number from which the message was sent.""" - message_direction: Optional[str] = None + message_direction: Optional[str] = dataclass_field(default=None, kw_only=True) """Direction of the message (inbound/outbound).""" - message_state: Optional[str] = None + message_state: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the message (queued/sent/delivered/failed).""" - message_time: Optional[str] = None + message_time: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp at which the message was sent or received (yyyy-MM-dd HH:mm:ss UTC). """ - message_type: Optional[str] = None + message_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of the message.""" - message_uuid: Optional[str] = None + message_uuid: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the message.""" - resource_uri: Optional[str] = None + resource_uri: Optional[str] = dataclass_field(default=None, kw_only=True) """URI to get details of this single message.""" - to_number: Optional[str] = None + to_number: Optional[str] = dataclass_field(default=None, kw_only=True) """Number to which the message was sent.""" - total_amount: Optional[str] = None + total_amount: Optional[str] = dataclass_field(default=None, kw_only=True) """Amount charged for the message.""" - total_rate: Optional[str] = None + total_rate: Optional[str] = dataclass_field(default=None, kw_only=True) """Rate per unit of the message.""" - units: Optional[int] = None + units: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of units the message was split into.""" @@ -108,11 +120,11 @@ class SMS: Definition: SMS """ - src: Optional[str] = None + src: str """Plivo number from which the message is to be sent.""" - dst: Optional[str] = None + dst: str """Phone number to which the message is to be sent.""" - text: Optional[str] = None + text: str """Text of the message to be sent.""" @@ -122,13 +134,13 @@ class Call: Definition: Call """ - from_: Optional[str] = field(default=None, metadata={"wire_name": "from"}) + from_: str = dataclass_field(metadata={"wire_name": "from"}) """Plivo number to be used to make the call.""" - to: Optional[str] = None + to: str """The phone number to call.""" - answer_url: Optional[str] = None + answer_url: str """URL to be called when the call is made.""" - answer_method: Optional[str] = None + answer_method: Optional[str] = dataclass_field(default=None, kw_only=True) """HTTP Method (GET/POST) that should be used to call the Answer URL.""" @@ -143,7 +155,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -160,8 +172,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -182,7 +194,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -197,9 +209,86 @@ def __init__( def connector_name(self) -> str: return "plivo" - async def make_call_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def make_call( self, - input: Call, + input: Call | Mapping[str, Any], auth_id: str, *, timeout: Optional[float] = None, @@ -211,13 +300,30 @@ async def make_call_async( Make a call This operation is used to make a call. + + Swagger operation ID: `MakeCall`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + auth_id: Auth ID of your Plivo account. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1/Account/{quote(str(auth_id), safe='')}/Call/" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -231,6 +337,7 @@ async def make_call_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -238,7 +345,7 @@ async def make_call_async( return json.loads(response.text) - async def list_messages_async( + def list_messages( self, auth_id: str, *, @@ -246,42 +353,81 @@ async def list_messages_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all messages This operation returns a list of all messages associated with your Plivo account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListMessages`. + + Args: + auth_id: Auth ID of your Plivo account. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1/Account/{quote(str(auth_id), safe='')}/Message/" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("objects", []): + yield item + + return None, items() - async def send_sms_async( + return AsyncItemPaged(get_next, extract_data) + + async def send_sms( self, - input: SMS, + input: SMS | Mapping[str, Any], auth_id: str, *, timeout: Optional[float] = None, @@ -293,13 +439,30 @@ async def send_sms_async( Send SMS This operation is used to send a text message. + + Swagger operation ID: `SendSMS`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + auth_id: Auth ID of your Plivo account. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1/Account/{quote(str(auth_id), safe='')}/Message/" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -313,6 +476,7 @@ async def send_sms_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -320,7 +484,7 @@ async def send_sms_async( return json.loads(response.text) - async def get_message_async( + async def get_message( self, auth_id: str, message_uuid: str, @@ -335,6 +499,23 @@ async def get_message_async( This operation is used to fetch the details of a message, given the message ID. + + Swagger operation ID: `GetMessage`. + + Args: + auth_id: Auth ID of your Plivo account. + message_uuid: UUID of the message for which the details need to be + fetched. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -345,7 +526,7 @@ async def get_message_async( f"/{quote(str(message_uuid), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -359,6 +540,7 @@ async def get_message_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/plumsail.py b/src/azure/connectors/plumsail.py index dd21963c..67e07797 100644 --- a/src/azure/connectors/plumsail.py +++ b/src/azure/connectors/plumsail.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Any, Mapping from urllib.parse import quote import json +from azure.core.polling import AsyncLROPoller from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,74 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorPollingMethod, ) +__all__ = [ + "PlumsailClient", + "AddPowerAutomateWebhookData", + "Any2PdfRequest", + "ApplyDocxTemplateRequest", + "ApplyHtmlFlowTemplateRequest", + "ApplyHtmlTemplateResponse", + "ApplyPptxTemplateRequest", + "ApplyXlsxTemplateRequest", + "BooleanResultResponse", + "CompressPdfRequest", + "CreateArchiveRequest", + "Csv2XlsxColumnMapping", + "Csv2XlsxRequest", + "Doc2DocxRequest", + "DocumentContentWithFilenameResponse", + "DocumentProcessingResponse", + "DocumentsArrayResponse", + "DocumentsWithFilenamesResponse", + "Docx2PdfRequest", + "Email2PdfRequest", + "ExtractArchiveRequest", + "FileData", + "FillInPdfFormRequest", + "FlowDocumentsJobsAddWatermarkToPdfInput", + "FlowDocumentsJobsGetPdfFormPostResponse", + "FlowDocumentsJobsSplitPdfInput", + "FlowProcessesFlowJobsExecuteProcessInput", + "GetPdfFormRequest", + "GetPdfProtectionInfoResponse", + "Html2DocxFlowRequest", + "Html2PdfFlowRequest", + "Image2PdfRequest", + "Json2CsvRequest", + "Json2XlsxColumnMapping", + "Json2XlsxRequest", + "LicenseInfo", + "MergeAny2PdfFileData", + "MergeAny2PdfRequest", + "MergeDocxRequest", + "MergeFieldsTemplateRequest", + "MergePdfRequest", + "MergeXlsxRequest", + "ParseCsvFlowRequest", + "ParseCsvSchemaResponse", + "Pdf2ImageRequest", + "Pdf2TextRequest", + "PdfProtectionInfoRequest", + "Ppt2PptxRequest", + "Pptx2PdfRequest", + "ProcessJsonData", + "ProcessSchemaDynamicType", + "ProfileInfo", + "ProtectPdfRequest", + "RegExpMatchRequest", + "RegExpMatchSchemaResponseClass", + "RegExpReplaceRequest", + "RegExpTestRequest", + "SplitPdfRequest", + "StringResultResponse", + "Xls2XlsxRequest", + "Xlsx2PdfRequest", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,22 +96,26 @@ class ProfileInfo: Response for Get Profile Info """ - name: Optional[str] = None - email: Optional[str] = None - license_status: Optional[str] = field( + name: Optional[str] = dataclass_field(default=None, kw_only=True) + email: Optional[str] = dataclass_field(default=None, kw_only=True) + license_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "licenseStatus"}, ) - team_name: Optional[str] = field( + team_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamName"}, ) - license_info: Optional[LicenseInfo] = field( + license_info: Optional[LicenseInfo | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "licenseInfo"}, ) - short_user_id: Optional[str] = field( + short_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortUserId"}, ) @@ -55,8 +126,9 @@ class DocumentProcessingResponse: Response for Create document from PPTX template """ - file_content: Optional[str] = field( + file_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fileContent"}, ) """The result as a file""" @@ -68,8 +140,9 @@ class ApplyHtmlTemplateResponse: Response for Create HTML from template """ - html_result: Optional[str] = field( + html_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "htmlResult"}, ) """Raw HTML result""" @@ -81,7 +154,7 @@ class FlowDocumentsJobsSplitPdfInput: Split PDF """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -94,8 +167,11 @@ class DocumentsWithFilenamesResponse: Response for Split PDF """ - result_files: Optional[List[DocumentContentWithFilenameResponse]] = field( + result_files: Optional[ + List[DocumentContentWithFilenameResponse | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resultFiles"}, ) """Array of raw contents of result files with their filenames""" @@ -107,7 +183,7 @@ class FlowDocumentsJobsGetPdfFormPostResponse: Response for Get Form from PDF """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -120,8 +196,9 @@ class GetPdfProtectionInfoResponse: Response for Get information about PDF protection """ - is_password_protected: Optional[bool] = field( + is_password_protected: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isPasswordProtected"}, ) @@ -132,7 +209,7 @@ class FlowDocumentsJobsAddWatermarkToPdfInput: Add a watermark to PDF """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -145,7 +222,7 @@ class ParseCsvSchemaResponse: Response for Parse CSV """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -158,7 +235,7 @@ class RegExpMatchSchemaResponseClass: Response for Regular Expression Match """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -171,7 +248,7 @@ class StringResultResponse: Response for Regular Expression Replace """ - result: Optional[str] = None + result: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -180,8 +257,9 @@ class BooleanResultResponse: Response for Regular Expression Test """ - is_success: Optional[bool] = field( + is_success: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isSuccess"}, ) @@ -192,10 +270,11 @@ class DocumentContentWithFilenameResponse: Response for Create Archive """ - filename: Optional[str] = None + filename: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the file""" - file_content: Optional[str] = field( + file_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fileContent"}, ) """File content""" @@ -207,7 +286,7 @@ class FlowProcessesFlowJobsExecuteProcessInput: Start document generation process with json """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -220,15 +299,9 @@ class AddPowerAutomateWebhookData: Definition: AddPowerAutomateWebhookData """ - process_id: Optional[str] = field( - default=None, - metadata={"wire_name": "processId"}, - ) + process_id: str = dataclass_field(metadata={"wire_name": "processId"}) """Name of the process that, when finished, will trigger the flow""" - hook_url: Optional[str] = field( - default=None, - metadata={"wire_name": "hookUrl"}, - ) + hook_url: str = dataclass_field(metadata={"wire_name": "hookUrl"}) """HookUrl""" @@ -238,8 +311,7 @@ class Any2PdfRequest: Definition: Any2PdfRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Content of document that should be converted""" @@ -251,23 +323,19 @@ class ApplyDocxTemplateRequest: Definition: ApplyDocxTemplateRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Content of the template""" - data: Optional[Dict[str, Any]] = None + data: Dict[str, Any] """JSON data that should be applied to the template""" - output_type: Optional[str] = field( - default=None, - metadata={"wire_name": "outputType"}, - ) + output_type: str = dataclass_field(metadata={"wire_name": "outputType"}) """The required document type""" - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale that will be applyed to the document""" - timezone: Optional[str] = None + timezone: Optional[str] = dataclass_field(default=None, kw_only=True) """The time zone of the document""" - engine: Optional[str] = None + engine: Optional[str] = dataclass_field(default=None, kw_only=True) """The engine that will process the template""" @@ -277,13 +345,13 @@ class ApplyHtmlFlowTemplateRequest: Definition: ApplyHtmlFlowTemplateRequest """ - html: Optional[str] = None + html: str """Text HTML template or HTML file template""" - data: Optional[Dict[str, Any]] = None + data: Dict[str, Any] """JSON data that should be applied to the template""" - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale that will be applyed to the document""" - timezone: Optional[str] = None + timezone: Optional[str] = dataclass_field(default=None, kw_only=True) """The time zone of the document""" @@ -293,21 +361,17 @@ class ApplyPptxTemplateRequest: Definition: ApplyPptxTemplateRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Content of the template""" - data: Optional[Dict[str, Any]] = None + data: Dict[str, Any] """JSON data that should be applied to the template""" - output_type: Optional[str] = field( - default=None, - metadata={"wire_name": "outputType"}, - ) + output_type: str = dataclass_field(metadata={"wire_name": "outputType"}) """The required document type""" - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale that will be applyed to the document""" - timezone: Optional[str] = None + timezone: Optional[str] = dataclass_field(default=None, kw_only=True) """The time zone of the document""" @@ -317,21 +381,17 @@ class ApplyXlsxTemplateRequest: Definition: ApplyXlsxTemplateRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Content of the template""" - data: Optional[Dict[str, Any]] = None + data: Dict[str, Any] """JSON data that should be applied to the template""" - output_type: Optional[str] = field( - default=None, - metadata={"wire_name": "outputType"}, - ) + output_type: str = dataclass_field(metadata={"wire_name": "outputType"}) """The required document type""" - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale that will be applyed to the document""" - timezone: Optional[str] = None + timezone: Optional[str] = dataclass_field(default=None, kw_only=True) """The time zone of the document""" @@ -341,20 +401,20 @@ class CompressPdfRequest: Definition: CompressPdfRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Raw content of PDF document""" - lossless_mode: Optional[str] = field( + lossless_mode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "losslessMode"}, ) """ When disabled, compresses the PDF file more effectively, but with a slight loss of image quality. """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password to open PDF file""" @@ -364,14 +424,11 @@ class CreateArchiveRequest: Definition: CreateArchiveRequest """ - file_name: Optional[str] = field( - default=None, - metadata={"wire_name": "fileName"}, - ) + file_name: str = dataclass_field(metadata={"wire_name": "fileName"}) """Name of the archive without the file extension""" - data: Optional[List[FileData]] = None + data: List[FileData | Mapping[str, Any]] """Array of documents to add to the archive""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Archive password""" @@ -381,18 +438,19 @@ class Csv2XlsxColumnMapping: Definition: Csv2XlsxColumnMapping """ - csv_column_index_or_name: Optional[str] = field( - default=None, + csv_column_index_or_name: str = dataclass_field( metadata={"wire_name": "csvColumnIndexOrName"}, ) """CSV column name or column index (1, 2, etc.)""" - xlsx_column_type: Optional[str] = field( + xlsx_column_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "xlsxColumnType"}, ) """Optional. Column type (ShortDateTime, TwoDecimal, etc.)""" - xlsx_column_name: Optional[str] = field( + xlsx_column_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "xlsxColumnName"}, ) """Optional. Rename CSV column to this name""" @@ -404,20 +462,26 @@ class Csv2XlsxRequest: Definition: Csv2XlsxRequest """ - content: Optional[str] = None + content: str """Content of CSV document""" - delimiter: Optional[str] = None + delimiter: Optional[str] = dataclass_field(default=None, kw_only=True) """Delimiter of columns (by default it is just comma)""" - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale that will be applyed to the document""" - limit: Optional[int] = None + limit: Optional[int] = dataclass_field(default=None, kw_only=True) """Returns the first \"n\" rows""" - has_header_records: Optional[bool] = field( + has_header_records: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasHeaderRecords"}, ) """If set to \"Yes\" then headers will be read from the first line.""" - mappings: Optional[List[Csv2XlsxColumnMapping]] = None + mappings: Optional[ + List[Csv2XlsxColumnMapping | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Rename headers and specify types for columns.""" @@ -427,8 +491,7 @@ class Doc2DocxRequest: Definition: Doc2DocxRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Content of document that should be converted""" @@ -440,8 +503,9 @@ class DocumentsArrayResponse: Definition: DocumentsArrayResponse """ - result_files_contents: Optional[List[str]] = field( + result_files_contents: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resultFilesContents"}, ) """The array of raw content of result files""" @@ -453,8 +517,7 @@ class Docx2PdfRequest: Definition: Docx2PdfRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Content of document that should be converted""" @@ -466,13 +529,11 @@ class Email2PdfRequest: Definition: Email2PdfRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Content of the email that should be converted""" - merge_attachments: Optional[bool] = field( - default=None, + merge_attachments: bool = dataclass_field( metadata={"wire_name": "mergeAttachments"}, ) """ @@ -487,17 +548,19 @@ class ExtractArchiveRequest: Definition: ExtractArchiveRequest """ - file_content: Optional[str] = field( + file_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fileContent"}, ) """Content of archive file""" - include_folders: Optional[bool] = field( + include_folders: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "includeFolders"}, ) """If 'true' files contained in the folders will be extracted""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Archive password""" @@ -507,12 +570,13 @@ class FileData: Definition: FileData """ - file_name: Optional[str] = field( + file_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fileName"}, ) """File name including the file extension""" - content: Optional[str] = None + content: Optional[str] = dataclass_field(default=None, kw_only=True) """Content of the document""" @@ -522,22 +586,21 @@ class FillInPdfFormRequest: Definition: FillInPdfFormRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Raw content of PDF document""" - json_data: Optional[Dict[str, Any]] = field( - default=None, + json_data: Dict[str, Any] = dataclass_field( metadata={"wire_name": "jsonData"}, ) """The data that will be used to fill out the form""" - lock_form_fields: Optional[bool] = field( + lock_form_fields: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lockFormFields"}, ) """Disable fields editing after filling them""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password to open PDF file""" @@ -547,12 +610,11 @@ class GetPdfFormRequest: Definition: GetPdfFormRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Raw content of PDF document""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password to decrypt document""" @@ -562,34 +624,39 @@ class Html2DocxFlowRequest: Definition: Html2DocxFlowRequest """ - file_content: Optional[str] = field( + file_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fileContent"}, ) """Binary content of the HTML file to convert to DOCX""" - raw_html: Optional[str] = field( + raw_html: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "rawHtml"}, ) """HTML Data to convert to DOCX""" - html_url: Optional[str] = field( + html_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "htmlUrl"}, ) """URL to the web page to convert to DOCX""" - paper_size: Optional[str] = field( + paper_size: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "paperSize"}, ) """Can be A4,A5 etc...""" - orientation: Optional[str] = None + orientation: Optional[str] = dataclass_field(default=None, kw_only=True) """Portrait or Landscape""" - decode_html: Optional[bool] = field( + decode_html: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "decodeHtml"}, ) """Whether HTML should be decoded prior to conversion""" - margins: Optional[str] = None + margins: Optional[str] = dataclass_field(default=None, kw_only=True) """ Page margins in pt. The syntax is the same as in CSS. Example: 25 50 75 100. @@ -602,25 +669,27 @@ class Html2PdfFlowRequest: Definition: Html2PdfFlowRequest """ - html: Optional[str] = None + html: str """HTML markup that should be converted to PDF""" - engine: Optional[str] = None + engine: Optional[str] = dataclass_field(default=None, kw_only=True) """Conversion engine""" - size: Optional[str] = None + size: Optional[str] = dataclass_field(default=None, kw_only=True) """Can be A4,A5 etc...""" - orientation: Optional[str] = None + orientation: Optional[str] = dataclass_field(default=None, kw_only=True) """Portrait or Landscape""" - margins: Optional[str] = None + margins: Optional[str] = dataclass_field(default=None, kw_only=True) """ The page margins. The syntax is the same as in CSS. Example: 25 50 75 100. """ - header_html: Optional[str] = field( + header_html: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "headerHtml"}, ) """HTML markup that should be added as a header""" - footer_html: Optional[str] = field( + footer_html: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "footerHtml"}, ) """HTML markup that should be added as a footer""" @@ -632,16 +701,16 @@ class Image2PdfRequest: Definition: Image2PdfRequest """ - image_per_page: Optional[bool] = field( + image_per_page: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "imagePerPage"}, ) """ Select \"No\" if you don't want each image to be on a separate page. Default is \"Yes\" """ - image_content: Optional[List[str]] = field( - default=None, + image_content: List[str] = dataclass_field( metadata={"wire_name": "imageContent"}, ) """Raw content of the image""" @@ -653,24 +722,26 @@ class Json2CsvRequest: Definition: Json2CsvRequest """ - content: Optional[str] = None + content: Optional[str] = dataclass_field(default=None, kw_only=True) """Optional. Content of the JSON file""" - json_data: Optional[str] = field( + json_data: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jsonData"}, ) """Optional. JSON data to process""" - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale that will be applyed to the document""" - path_to_json_array: Optional[str] = field( + path_to_json_array: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pathToJsonArray"}, ) """ Dot separated path to array in JSON. E.g.: \"data\" or \"prop1.prop2.prop3\" """ - delimiter: Optional[str] = None + delimiter: Optional[str] = dataclass_field(default=None, kw_only=True) """Delimiter of columns in CSV. Default is comma""" @@ -680,18 +751,19 @@ class Json2XlsxColumnMapping: Definition: Json2XlsxColumnMapping """ - json_property: Optional[str] = field( - default=None, + json_property: str = dataclass_field( metadata={"wire_name": "jsonProperty"}, ) """Name of the JSON property""" - xlsx_column_type: Optional[str] = field( + xlsx_column_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "xlsxColumnType"}, ) """Optional. Column type (ShortDateTime, TwoDecimal, etc.)""" - xlsx_column_name: Optional[str] = field( + xlsx_column_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "xlsxColumnName"}, ) """Optional. Rename JSON property to this name""" @@ -703,24 +775,31 @@ class Json2XlsxRequest: Definition: Json2XlsxRequest """ - content: Optional[str] = None + content: Optional[str] = dataclass_field(default=None, kw_only=True) """Optional. Content of the JSON file""" - json_data: Optional[str] = field( + json_data: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jsonData"}, ) """Optional. JSON data to process""" - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale that will be applyed to the document""" - path_to_json_array: Optional[str] = field( + path_to_json_array: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pathToJsonArray"}, ) """ Dot separated path to array in JSON. E.g.: \"data\" or \"prop1.prop2.prop3\" """ - mappings: Optional[List[Json2XlsxColumnMapping]] = None + mappings: Optional[ + List[Json2XlsxColumnMapping | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Rename headers and specify types for columns.""" @@ -730,14 +809,20 @@ class LicenseInfo: Definition: LicenseInfo """ - type_: Optional[int] = field(default=None, metadata={"wire_name": "type"}) - credits: Optional[int] = None - additional_credits: Optional[int] = field( + type_: Optional[int] = dataclass_field( default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) + credits: Optional[int] = dataclass_field(default=None, kw_only=True) + additional_credits: Optional[int] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "additionalCredits"}, ) - expiration_date: Optional[str] = field( + expiration_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "expirationDate"}, ) @@ -748,12 +833,9 @@ class MergeAny2PdfFileData: Definition: MergeAny2PdfFileData """ - file_name: Optional[str] = field( - default=None, - metadata={"wire_name": "fileName"}, - ) + file_name: str = dataclass_field(metadata={"wire_name": "fileName"}) """Name of the file, including extension""" - content: Optional[str] = None + content: str """Content of the file""" @@ -763,18 +845,19 @@ class MergeAny2PdfRequest: Definition: MergeAny2PdfRequest """ - documents_contents: Optional[List[str]] = field( - default=None, + documents_contents: List[str] = dataclass_field( metadata={"wire_name": "documentsContents"}, ) """The array of raw contents of files to merge""" - generate_bookmarks: Optional[bool] = field( + generate_bookmarks: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "generateBookmarks"}, ) """Generate a bookmark for each merged file""" - preserve_bookmarks: Optional[bool] = field( + preserve_bookmarks: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "preserveBookmarks"}, ) """Preserve bookmarks from each merged PDF""" @@ -786,21 +869,20 @@ class MergeDocxRequest: Definition: MergeDocxRequest """ - documents_contents: Optional[List[str]] = field( - default=None, + documents_contents: List[str] = dataclass_field( metadata={"wire_name": "documentsContents"}, ) """The array of raw content of Docx documents""" - apply_header_and_footer: Optional[bool] = field( - default=None, + apply_header_and_footer: bool = dataclass_field( metadata={"wire_name": "applyHeaderAndFooter"}, ) """ Applies the header and footer from the first document to all the others. Ignored when \"Add page break\" is No (forces Yes). """ - add_page_break: Optional[bool] = field( + add_page_break: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "addPageBreak"}, ) """Adds page breaks between merged documents.""" @@ -812,15 +894,14 @@ class MergeFieldsTemplateRequest: Definition: MergeFieldsTemplateRequest """ - docx_document: Optional[str] = field( - default=None, + docx_document: str = dataclass_field( metadata={"wire_name": "docxDocument"}, ) """ Raw content of docx document template. MergeField names should be the same as keys in template data """ - data: Optional[Dict[str, Any]] = None + data: Dict[str, Any] """JSON data that should be applied to the template""" @@ -830,8 +911,7 @@ class MergePdfRequest: Definition: MergePdfRequest """ - documents_contents: Optional[List[str]] = field( - default=None, + documents_contents: List[str] = dataclass_field( metadata={"wire_name": "documentsContents"}, ) """The array of raw content of PDF documents""" @@ -843,8 +923,7 @@ class MergeXlsxRequest: Definition: MergeXlsxRequest """ - documents_contents: Optional[List[str]] = field( - default=None, + documents_contents: List[str] = dataclass_field( metadata={"wire_name": "documentsContents"}, ) """The array of raw content of Xlsx documents""" @@ -856,18 +935,19 @@ class ParseCsvFlowRequest: Definition: ParseCsvFlowRequest """ - content: Optional[str] = None + content: str """Content of CSV document""" - delimiter: Optional[str] = None + delimiter: Optional[str] = dataclass_field(default=None, kw_only=True) """Delimiter of columns (by default it is just comma)""" - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale that will be applyed to the document""" - limit: Optional[int] = None + limit: Optional[int] = dataclass_field(default=None, kw_only=True) """Returns the first \"n\" rows""" - headers: Optional[str] = None + headers: str """Comma separated list of headers in the same order as CSV columns""" - skip_first_line: Optional[bool] = field( + skip_first_line: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "skipFirstLine"}, ) """Select \"Yes\" if your CSV has headers as a first line.""" @@ -879,39 +959,41 @@ class Pdf2ImageRequest: Definition: Pdf2ImageRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Raw content of PDF document""" - filename_prefix: Optional[str] = field( + filename_prefix: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filenamePrefix"}, ) """ Optional. Output files will have this prefix followed by an index number for name """ - start_page: Optional[int] = field( + start_page: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startPage"}, ) """The first page to start extraction (1 based)""" - end_page: Optional[int] = field( + end_page: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endPage"}, ) """The last page to extract (inclusive)""" - pages: Optional[str] = None + pages: Optional[str] = dataclass_field(default=None, kw_only=True) """ Page numbers for extraction separated by ';' (only this pages will be extracted) """ - format: Optional[str] = None + format: Optional[str] = dataclass_field(default=None, kw_only=True) """The format of the result image""" - dpi: Optional[int] = None + dpi: Optional[int] = dataclass_field(default=None, kw_only=True) """The resolution of the result image""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password to decrypt document""" @@ -921,27 +1003,29 @@ class Pdf2TextRequest: Definition: Pdf2TextRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Raw content of PDF document""" - start_page: Optional[int] = field( + start_page: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startPage"}, ) """The first page to start extraction (1 based)""" - end_page: Optional[int] = field( + end_page: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endPage"}, ) """The last page to extract (inclusive)""" - result_type: Optional[str] = field( + result_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resultType"}, ) """Raw or HTML""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password to decrypt document""" @@ -951,8 +1035,7 @@ class PdfProtectionInfoRequest: Definition: PdfProtectionInfoRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Raw content of PDF document""" @@ -964,8 +1047,7 @@ class Ppt2PptxRequest: Definition: Ppt2PptxRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Content of document that should be converted""" @@ -977,8 +1059,7 @@ class Pptx2PdfRequest: Definition: Pptx2PdfRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Content of document that should be converted""" @@ -990,8 +1071,7 @@ class ProcessJsonData: Definition: ProcessJsonData """ - json_content: Optional[Dict[str, Any]] = field( - default=None, + json_content: Dict[str, Any] = dataclass_field( metadata={"wire_name": "jsonContent"}, ) """JSON data that should be applied to the template""" @@ -1003,7 +1083,7 @@ class ProcessSchemaDynamicType: Definition: ProcessSchemaDynamicType """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1016,43 +1096,40 @@ class ProtectPdfRequest: Definition: ProtectPdfRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Raw content of PDF document""" - allow_printing: Optional[bool] = field( - default=None, + allow_printing: bool = dataclass_field( metadata={"wire_name": "allowPrinting"}, ) """Protect the PDF file from being printed out""" - allow_modification: Optional[bool] = field( - default=None, + allow_modification: bool = dataclass_field( metadata={"wire_name": "allowModification"}, ) """Protect the PDF file from being edited""" - allow_extract: Optional[bool] = field( - default=None, + allow_extract: bool = dataclass_field( metadata={"wire_name": "allowExtract"}, ) """Allows extraction of text, images, and other media from the PDF file""" - allow_annotate: Optional[bool] = field( - default=None, + allow_annotate: bool = dataclass_field( metadata={"wire_name": "allowAnnotate"}, ) """ Allows annotation (e.g. comments, form fill-in, signing) of the PDF file """ - new_owner_password: Optional[str] = field( + new_owner_password: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newOwnerPassword"}, ) """ Enter an optional owner password here. This password can be used to disable document restrictions """ - new_user_password: Optional[str] = field( + new_user_password: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newUserPassword"}, ) """ @@ -1060,7 +1137,7 @@ class ProtectPdfRequest: will be asked for this password. If you do not want a password prompt then leave this field blank """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password to decrypt document""" @@ -1070,9 +1147,9 @@ class RegExpMatchRequest: Definition: RegExpMatchRequest """ - pattern: Optional[str] = None + pattern: str """Regular expression pattern""" - text: Optional[str] = None + text: str """String to search for matches""" @@ -1082,11 +1159,11 @@ class RegExpReplaceRequest: Definition: RegExpReplaceRequest """ - pattern: Optional[str] = None + pattern: str """Regular expression pattern""" - text: Optional[str] = None + text: str """String to search for matches""" - replacement: Optional[str] = None + replacement: Optional[str] = dataclass_field(default=None, kw_only=True) """Replacement string""" @@ -1096,9 +1173,9 @@ class RegExpTestRequest: Definition: RegExpTestRequest """ - pattern: Optional[str] = None + pattern: str """Regular expression pattern""" - text: Optional[str] = None + text: str """String to search for matches""" @@ -1108,27 +1185,29 @@ class SplitPdfRequest: Definition: SplitPdfRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Raw content of PDF document""" - start_page: Optional[int] = field( + start_page: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startPage"}, ) """The first page to start split (1 based)""" - end_page: Optional[int] = field( + end_page: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endPage"}, ) """The last page to split (inclusive)""" - split_at_page: Optional[int] = field( + split_at_page: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "splitAtPage"}, ) """Number of pages per partition""" - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password to decrypt document""" @@ -1138,8 +1217,7 @@ class Xls2XlsxRequest: Definition: Xls2XlsxRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Content of document that should be converted""" @@ -1151,8 +1229,7 @@ class Xlsx2PdfRequest: Definition: Xlsx2PdfRequest """ - document_content: Optional[str] = field( - default=None, + document_content: str = dataclass_field( metadata={"wire_name": "documentContent"}, ) """Content of document that should be converted""" @@ -1169,7 +1246,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1186,8 +1263,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1208,7 +1285,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1223,7 +1300,7 @@ def __init__( def connector_name(self) -> str: return "plumsail" - async def profiles_me_get_async( + async def profiles_me_get( self, *, timeout: Optional[float] = None, @@ -1235,10 +1312,24 @@ async def profiles_me_get_async( Get Profile Info Get Profile Info returns information about current user and license. + + Swagger operation ID: `ProfilesMeGet`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/profiles/me" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1252,6 +1343,7 @@ async def profiles_me_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1259,27 +1351,46 @@ async def profiles_me_get_async( return json.loads(response.text) - async def flow_v1_documents_jobs_apply_docx_template_async( + async def begin_flow_v1_documents_jobs_apply_docx_template( self, - input: ApplyDocxTemplateRequest, + input: ApplyDocxTemplateRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Create document from DOCX template Create document from DOCX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/docx/index.html + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsApplyDocxTemplatePost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/ApplyDocxTemplate" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1293,31 +1404,64 @@ async def flow_v1_documents_jobs_apply_docx_template_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_apply_xlsx_template_async( + async def begin_flow_v1_documents_jobs_apply_xlsx_template( self, - input: ApplyXlsxTemplateRequest, + input: ApplyXlsxTemplateRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Create document from XLSX template Create document from XLSX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/xlsx/index.html + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsApplyXlsxTemplatePost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/ApplyXlsxTemplate" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1331,30 +1475,63 @@ async def flow_v1_documents_jobs_apply_xlsx_template_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_apply_pptx_async( + async def begin_flow_v1_documents_jobs_apply_pptx( self, - input: ApplyPptxTemplateRequest, + input: ApplyPptxTemplateRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Create document from PPTX template Create document from PPTX template. More information: https://plumsail.com/docs/documents/v1.x/document-generation/pptx/index.html + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsApplyPptxPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/ApplyPptx" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1368,22 +1545,37 @@ async def flow_v1_documents_jobs_apply_pptx_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_apply_docx_async( + async def begin_flow_v1_documents_jobs_apply_docx( self, - input: MergeFieldsTemplateRequest, + input: MergeFieldsTemplateRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Fill merge fields in DOCX document @@ -1392,12 +1584,31 @@ async def flow_v1_documents_jobs_apply_docx_async( should be the same as names of MergeFields (Express block) in document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-merge-fields-in-docx-document + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsApplyDocxPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/ApplyDocx" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1411,22 +1622,37 @@ async def flow_v1_documents_jobs_apply_docx_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_apply_html_async( + async def begin_flow_v1_documents_jobs_apply_html( self, - input: ApplyHtmlFlowTemplateRequest, + input: ApplyHtmlFlowTemplateRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Create HTML from template @@ -1435,12 +1661,31 @@ async def flow_v1_documents_jobs_apply_html_async( templates internally. More information about templates in Mustache docs: http://mustache.github.io/mustache.5.html. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#create-html-from-template + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsApplyHtmlPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/ApplyHtml" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1454,34 +1699,68 @@ async def flow_v1_documents_jobs_apply_html_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_html2_pdf_async( + async def begin_flow_v1_documents_jobs_html2_pdf( self, - input: Html2PdfFlowRequest, + input: Html2PdfFlowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Convert HTML to PDF Convert HTML to PDF file. This action takes HTML markup, renders it and converts to PDF document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-pdf + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsHtml2PdfPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Html2Pdf" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1495,34 +1774,68 @@ async def flow_v1_documents_jobs_html2_pdf_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_html2_docx_async( + async def begin_flow_v1_documents_jobs_html2_docx( self, - input: Html2DocxFlowRequest, + input: Html2DocxFlowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Convert HTML to DOCX Convert HTML to DOCX document. This action takes HTML markup, renders it and converts to DOCX document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-html-to-docx + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsHtml2DocxPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Html2Docx" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1536,34 +1849,68 @@ async def flow_v1_documents_jobs_html2_docx_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_docx2_pdf_async( + async def begin_flow_v1_documents_jobs_docx2_pdf( self, - input: Docx2PdfRequest, + input: Docx2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Convert DOCX to PDF Convert DOCX to PDF files. This action takes DOCX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-docx-to-pdf + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsDocx2PdfPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Docx2Pdf" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1577,34 +1924,68 @@ async def flow_v1_documents_jobs_docx2_pdf_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_xslx2_pdf_async( + async def begin_flow_v1_documents_jobs_xslx2_pdf( self, - input: Xlsx2PdfRequest, + input: Xlsx2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Convert XLSX to PDF Convert XLSX to PDF files. This action takes XLSX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xlsx-to-pdf + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsXslx2PdfPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Xslx2Pdf" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1618,31 +1999,64 @@ async def flow_v1_documents_jobs_xslx2_pdf_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_pptx2_pdf_async( + async def begin_flow_v1_documents_jobs_pptx2_pdf( self, - input: Pptx2PdfRequest, + input: Pptx2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Convert PPTX to PDF Convert PPTX to PDF files. This action takes PPTX document and converts it to PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pptx-to-pdf + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsPptx2PdfPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Pptx2Pdf" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1656,30 +2070,63 @@ async def flow_v1_documents_jobs_pptx2_pdf_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_any2_pdf_v2_async( + async def begin_flow_v1_documents_jobs_any2_pdf_v2( self, - input: Any2PdfRequest, + input: Any2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Convert to PDF Convert provided file to PDF file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-to-pdf + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsAny2PdfV2Post`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Any2PdfV2" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1693,30 +2140,63 @@ async def flow_v1_documents_jobs_any2_pdf_v2_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_email2_pdf_async( + async def begin_flow_v1_documents_jobs_email2_pdf( self, - input: Email2PdfRequest, + input: Email2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Convert Email to PDF Convert provided Email to PDF file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-email-to-pdf + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsEmail2PdfPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Email2Pdf" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1730,31 +2210,64 @@ async def flow_v1_documents_jobs_email2_pdf_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_doc2_docx_async( + async def begin_flow_v1_documents_jobs_doc2_docx( self, - input: Doc2DocxRequest, + input: Doc2DocxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Convert DOC to DOCX Convert DOC to DOCX files. This action takes DOC document and converts it to DOCX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-doc-to-docx + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsDoc2DocxPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Doc2Docx" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1768,31 +2281,64 @@ async def flow_v1_documents_jobs_doc2_docx_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_xls2_xlsx_async( + async def begin_flow_v1_documents_jobs_xls2_xlsx( self, - input: Xls2XlsxRequest, + input: Xls2XlsxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Convert XLS to XLSX Convert XLS to XLSX files. This action takes XLS document and converts it to XLSX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-xls-to-xlsx + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsXls2XlsxPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Xls2Xlsx" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1806,31 +2352,64 @@ async def flow_v1_documents_jobs_xls2_xlsx_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_ppt2_pptx_async( + async def begin_flow_v1_documents_jobs_ppt2_pptx( self, - input: Ppt2PptxRequest, + input: Ppt2PptxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Convert PPT to PPTX Convert PPT to PPTX files. This action takes PPT document and converts it to PPTX. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-ppt-to-pptx + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsPpt2PptxPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Ppt2Pptx" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1844,25 +2423,59 @@ async def flow_v1_documents_jobs_ppt2_pptx_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_split_pdf_v2_async( + async def begin_flow_v1_documents_jobs_split_pdf_v2( self, - input: FlowDocumentsJobsSplitPdfInput, + input: FlowDocumentsJobsSplitPdfInput | Mapping[str, Any], type_: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Split PDF Split PDF takes PDF document and splits it. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#split-pdf + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsSplitPdfV2Post`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + type_: How to split the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/SplitPdfV2" @@ -1875,7 +2488,7 @@ async def flow_v1_documents_jobs_split_pdf_v2_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1889,35 +2502,69 @@ async def flow_v1_documents_jobs_split_pdf_v2_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_merge_any_to_pdf_v2_async( + async def begin_flow_v1_documents_jobs_merge_any_to_pdf_v2( self, - input: MergeAny2PdfRequest, + input: MergeAny2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Merge any files into PDF Convert and merge multiple files into a single PDF document. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-any-files-into-pdf + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsMergeAnyToPdfV2Post`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/MergeAnyToPdfV2" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1931,32 +2578,65 @@ async def flow_v1_documents_jobs_merge_any_to_pdf_v2_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_extract_text_from_pdf_async( + async def begin_flow_v1_documents_jobs_extract_text_from_pdf( self, - input: Pdf2TextRequest, + input: Pdf2TextRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Extract text from PDF document Extract text from PDF takes PDF document and extracts text to Raw or HTML format. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#extract-text-from-pdf-document + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsExtractTextFromPdfPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/ExtractTextFromPdf" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1970,35 +2650,69 @@ async def flow_v1_documents_jobs_extract_text_from_pdf_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_pdf2_image_v2_async( + async def begin_flow_v1_documents_jobs_pdf2_image_v2( self, - input: Pdf2ImageRequest, + input: Pdf2ImageRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Convert PDF to Image Convert PDF to image. This action takes PDF document and converts it to Image (jpeg, png, gif, bmp, etc). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#convert-pdf-to-image + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsPdf2ImageV2Post`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/Pdf2ImageV2" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2012,32 +2726,66 @@ async def flow_v1_documents_jobs_pdf2_image_v2_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_image2_pdf_async( + async def begin_flow_v1_documents_jobs_image2_pdf( self, - input: Image2PdfRequest, + input: Image2PdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Convert Images to PDF It takes images and converts them to a PDF document + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsImage2PdfPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Image2Pdf" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2051,31 +2799,64 @@ async def flow_v1_documents_jobs_image2_pdf_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_fill_in_pdf_form_async( + async def begin_flow_v1_documents_jobs_fill_in_pdf_form( self, - input: FillInPdfFormRequest, + input: FillInPdfFormRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Fill in PDF Form Fill in PDF Form fills out PDF from by provided data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#fill-in-pdf-form + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsFillInPdfFormPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/FillInPdfForm" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2089,34 +2870,68 @@ async def flow_v1_documents_jobs_fill_in_pdf_form_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_get_pdf_form_async( + async def begin_flow_v1_documents_jobs_get_pdf_form( self, - input: GetPdfFormRequest, + input: GetPdfFormRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Get Form from PDF Get Form from PDF returns fillable form data from PDF as JSON. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-form-from-pdf + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsGetPdfFormPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/GetPdfForm" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2130,34 +2945,68 @@ async def flow_v1_documents_jobs_get_pdf_form_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_protect_pdf_async( + async def begin_flow_v1_documents_jobs_protect_pdf( self, - input: ProtectPdfRequest, + input: ProtectPdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Protect PDF document Protect PDF document adds passwords, copy, printing, and other protections to PDF files. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#protect-pdf-document + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsProtectPdfPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/ProtectPdf" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2171,35 +3020,69 @@ async def flow_v1_documents_jobs_protect_pdf_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_get_pdf_protection_info_async( + async def begin_flow_v1_documents_jobs_get_pdf_protection_info( self, - input: PdfProtectionInfoRequest, + input: PdfProtectionInfoRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Get information about PDF protection Get information about PDF protection returns information whether the document is password protected. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#get-pdf-protection-information + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsGetPdfProtectionInfoPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/GetPdfProtectionInfo" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2213,34 +3096,68 @@ async def flow_v1_documents_jobs_get_pdf_protection_info_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_compress_pdf_async( + async def begin_flow_v1_documents_jobs_compress_pdf( self, - input: CompressPdfRequest, + input: CompressPdfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Compress PDF document Compress PDF document size if possible and optimize it. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#compress-pdf-document + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsCompressPdfPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/CompressPdf" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2254,25 +3171,59 @@ async def flow_v1_documents_jobs_compress_pdf_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_add_watermark_to_pdf_async( + async def begin_flow_v1_documents_jobs_add_watermark_to_pdf( self, - input: FlowDocumentsJobsAddWatermarkToPdfInput, + input: FlowDocumentsJobsAddWatermarkToPdfInput | Mapping[str, Any], type_: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Add a watermark to PDF Add a watermark to PDF as text, an image, HTML, or PDF. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#add-watermark-to-pdf + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsAddWatermarkToPdfPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + type_: The type of the watermark. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2286,7 +3237,7 @@ async def flow_v1_documents_jobs_add_watermark_to_pdf_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2300,34 +3251,68 @@ async def flow_v1_documents_jobs_add_watermark_to_pdf_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_merge_docx_async( + async def begin_flow_v1_documents_jobs_merge_docx( self, - input: MergeDocxRequest, + input: MergeDocxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Merge DOCX files Merge DOCX files takes an array of Docx documents and merge it into single file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-docx-files + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsMergeDocxPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/MergeDocx" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2341,33 +3326,67 @@ async def flow_v1_documents_jobs_merge_docx_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_parse_csv_async( + async def begin_flow_v1_documents_jobs_parse_csv( self, - input: ParseCsvFlowRequest, + input: ParseCsvFlowRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Parse CSV Parse CSV works like Parse JSON but for CSV files. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#parse-csv + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsParseCsvPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/ParseCsv" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2381,33 +3400,67 @@ async def flow_v1_documents_jobs_parse_csv_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_csv2_xlsx_async( + async def begin_flow_v1_documents_jobs_csv2_xlsx( self, - input: Csv2XlsxRequest, + input: Csv2XlsxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Convert CSV to Excel Convert CSV to Excel file (XLSX). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#csv-to-excel + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsCsv2XlsxPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Csv2Xlsx" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2421,30 +3474,63 @@ async def flow_v1_documents_jobs_csv2_xlsx_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_json2_xlsx_async( + async def begin_flow_v1_documents_jobs_json2_xlsx( self, - input: Json2XlsxRequest, + input: Json2XlsxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Convert JSON to Excel Convert JSON to Excel file (XLSX). Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#json-to-excel + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsJson2XlsxPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Json2Xlsx" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2458,30 +3544,63 @@ async def flow_v1_documents_jobs_json2_xlsx_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_json2_csv_async( + async def begin_flow_v1_documents_jobs_json2_csv( self, - input: Json2CsvRequest, + input: Json2CsvRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Convert JSON to CSV Convert JSON to CSV file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#json-to-csv + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsJson2CsvPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/Json2Csv" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2495,19 +3614,33 @@ async def flow_v1_documents_jobs_json2_csv_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_reg_exp_match_async( + async def begin_flow_v1_documents_jobs_reg_exp_match( self, - input: RegExpMatchRequest, + input: RegExpMatchRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Regular Expression Match @@ -2516,13 +3649,32 @@ async def flow_v1_documents_jobs_reg_exp_match_async( would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-match + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsRegExpMatchPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/RegExpMatch" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2536,22 +3688,37 @@ async def flow_v1_documents_jobs_reg_exp_match_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_reg_exp_replace_async( + async def begin_flow_v1_documents_jobs_reg_exp_replace( self, - input: RegExpReplaceRequest, + input: RegExpReplaceRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Regular Expression Replace @@ -2560,13 +3727,32 @@ async def flow_v1_documents_jobs_reg_exp_replace_async( input string. We would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-replace + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsRegExpReplacePost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/RegExpReplace" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2580,22 +3766,37 @@ async def flow_v1_documents_jobs_reg_exp_replace_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_reg_exp_test_async( + async def begin_flow_v1_documents_jobs_reg_exp_test( self, - input: RegExpTestRequest, + input: RegExpTestRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Regular Expression Test @@ -2604,12 +3805,31 @@ async def flow_v1_documents_jobs_reg_exp_test_async( string. We would recommend to use Regex Hero to test your expressions. It supports the same syntax as actions. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#regular-expression-test + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsRegExpTestPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/RegExpTest" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2623,33 +3843,67 @@ async def flow_v1_documents_jobs_reg_exp_test_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_create_archive_async( + async def begin_flow_v1_documents_jobs_create_archive( self, - input: CreateArchiveRequest, + input: CreateArchiveRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Create Archive Compresses and adds files to a ZIP archive. + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsCreateArchivePost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/CreateArchive" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2663,33 +3917,67 @@ async def flow_v1_documents_jobs_create_archive_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_extract_archive_async( + async def begin_flow_v1_documents_jobs_extract_archive( self, - input: ExtractArchiveRequest, + input: ExtractArchiveRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Extract Archive Extract files from archive. + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsExtractArchivePost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/Documents/jobs/ExtractArchive" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2703,34 +3991,68 @@ async def flow_v1_documents_jobs_extract_archive_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_jobs_merge_xlsx_async( + async def begin_flow_v1_documents_jobs_merge_xlsx( self, - input: MergeXlsxRequest, + input: MergeXlsxRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncLROPoller[dict[str, Any] | None]: """ Merge XLSX files Merge XLSX files takes an array of Xlsx documents and merge it into single file. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#merge-xlsx-files + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1DocumentsJobsMergeXlsxPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[dict[str, Any] | None]: An Azure Core poller for the + connector operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/flow/v1/Documents/jobs/MergeXlsx" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2744,23 +4066,38 @@ async def flow_v1_documents_jobs_merge_xlsx_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return None - - return json.loads(response.text) + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: ( + json.loads(polling_response.text) + if polling_response.text + else None + ), + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_processes_flow_jobs_execute_process_async( + async def begin_flow_v1_processes_flow_jobs_execute_process( self, - input: FlowProcessesFlowJobsExecuteProcessInput, + input: FlowProcessesFlowJobsExecuteProcessInput | Mapping[str, Any], process_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Start document generation process with json @@ -2768,6 +4105,26 @@ async def flow_v1_processes_flow_jobs_execute_process_async( template related to the selected process with the JSON data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html##start-process-json + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: `FlowV1ProcessesFlowJobsExecuteProcessPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + process_id: The name of process to be started. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2781,7 +4138,7 @@ async def flow_v1_processes_flow_jobs_execute_process_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2795,20 +4152,34 @@ async def flow_v1_processes_flow_jobs_execute_process_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_processes_flow_jobs_execute_process_with_generated_data_async( + async def begin_flow_v1_processes_flow_jobs_execute_process_with_generated_data( self, - input: ProcessJsonData, + input: ProcessJsonData | Mapping[str, Any], process_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> bytes: + ) -> AsyncLROPoller[bytes]: """ Start document generation process @@ -2816,6 +4187,27 @@ async def flow_v1_processes_flow_jobs_execute_process_with_generated_data_async( template related to the selected process with the JSON data. Documentation - https://plumsail.com/docs/documents/v1.x/flow/actions/document-processing.html#start-document-generation-process + + Returns an Azure Core async poller for the connector operation. + + Swagger operation ID: + `FlowV1ProcessesFlowJobsExecuteProcessWithGeneratedDataPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + process_id: The name of process to be started. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncLROPoller[bytes]: An Azure Core poller for the connector + operation. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2829,7 +4221,7 @@ async def flow_v1_processes_flow_jobs_execute_process_with_generated_data_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2843,11 +4235,25 @@ async def flow_v1_processes_flow_jobs_execute_process_with_generated_data_async( request_url, response.status, response.text, + response=response, ) - return response.content + return AsyncLROPoller( + client=self, + initial_response=response, + deserialization_callback=lambda polling_response: polling_response.content, + polling_method=ConnectorPollingMethod( + http_client=self.http_client, + request_url=request_url, + polling_header_name="Location", + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ), + ) - async def flow_v1_documents_flow_schema_split_pdf_async( + async def flow_v1_documents_flow_schema_split_pdf( self, type_: str, *, @@ -2860,6 +4266,21 @@ async def flow_v1_documents_flow_schema_split_pdf_async( SplitPdfSchema System + + Swagger operation ID: `FlowV1DocumentsFlowSchemaSplitPdfPost`. + + Args: + type_: How to split the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2873,7 +4294,7 @@ async def flow_v1_documents_flow_schema_split_pdf_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2887,9 +4308,10 @@ async def flow_v1_documents_flow_schema_split_pdf_async( request_url, response.status, response.text, + response=response, ) - async def flow_v1_documents_flow_schema_add_watermark_to_pdf_async( + async def flow_v1_documents_flow_schema_add_watermark_to_pdf( self, type_: str, *, @@ -2902,6 +4324,21 @@ async def flow_v1_documents_flow_schema_add_watermark_to_pdf_async( AddWatermarkToPdfSchema System + + Swagger operation ID: `FlowV1DocumentsFlowSchemaAddWatermarkToPdfPost`. + + Args: + type_: The type of the watermark. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2915,7 +4352,7 @@ async def flow_v1_documents_flow_schema_add_watermark_to_pdf_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2929,9 +4366,10 @@ async def flow_v1_documents_flow_schema_add_watermark_to_pdf_async( request_url, response.status, response.text, + response=response, ) - async def flow_v1_processes_flow_schema_get_processes_async( + async def flow_v1_processes_flow_schema_get_processes( self, *, timeout: Optional[float] = None, @@ -2943,13 +4381,27 @@ async def flow_v1_processes_flow_schema_get_processes_async( GetProcessesSchema System + + Swagger operation ID: `FlowV1ProcessesFlowSchemaGetProcessesPost`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/flow/v1/ProcessesFlow/Schema/GetProcesses" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2963,9 +4415,10 @@ async def flow_v1_processes_flow_schema_get_processes_async( request_url, response.status, response.text, + response=response, ) - async def flow_v1_documents_flow_schema_parse_csv_async( + async def flow_v1_documents_flow_schema_parse_csv( self, headers_parameter: str, *, @@ -2978,6 +4431,21 @@ async def flow_v1_documents_flow_schema_parse_csv_async( ParseCsv System + + Swagger operation ID: `FlowV1DocumentsFlowSchemaParseCsvPost`. + + Args: + headers_parameter: headers. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2991,7 +4459,7 @@ async def flow_v1_documents_flow_schema_parse_csv_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -3005,9 +4473,10 @@ async def flow_v1_documents_flow_schema_parse_csv_async( request_url, response.status, response.text, + response=response, ) - async def flow_v1_processes_flow_schema_get_json_data_async( + async def flow_v1_processes_flow_schema_get_json_data( self, process_id: str, *, @@ -3020,6 +4489,21 @@ async def flow_v1_processes_flow_schema_get_json_data_async( GetJsonSchema System + + Swagger operation ID: `FlowV1ProcessesFlowSchemaGetJsonDataPost`. + + Args: + process_id: The name of process to be started. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3033,7 +4517,7 @@ async def flow_v1_processes_flow_schema_get_json_data_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -3047,9 +4531,10 @@ async def flow_v1_processes_flow_schema_get_json_data_async( request_url, response.status, response.text, + response=response, ) - async def flow_v1_processes_flow_triggers_by_process_id_schema_get_async( + async def flow_v1_processes_flow_triggers_by_process_id_schema_get( self, process_id: str, *, @@ -3062,6 +4547,22 @@ async def flow_v1_processes_flow_triggers_by_process_id_schema_get_async( Get schema of a process Returns schema of a process + + Swagger operation ID: + `FlowV1ProcessesFlowTriggersByProcessIdSchemaGet`. + + Args: + process_id: processId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3073,7 +4574,7 @@ async def flow_v1_processes_flow_triggers_by_process_id_schema_get_async( f"/schema" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3087,9 +4588,10 @@ async def flow_v1_processes_flow_triggers_by_process_id_schema_get_async( request_url, response.status, response.text, + response=response, ) - async def flow_v1_documents_flow_schema_reg_exp_match_async( + async def flow_v1_documents_flow_schema_reg_exp_match( self, pattern: str, *, @@ -3102,6 +4604,21 @@ async def flow_v1_documents_flow_schema_reg_exp_match_async( RegexMatchSchema System + + Swagger operation ID: `FlowV1DocumentsFlowSchemaRegExpMatchPost`. + + Args: + pattern: pattern. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3115,7 +4632,7 @@ async def flow_v1_documents_flow_schema_reg_exp_match_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -3129,6 +4646,7 @@ async def flow_v1_documents_flow_schema_reg_exp_match_async( request_url, response.status, response.text, + response=response, ) diff --git a/src/azure/connectors/powerbi.py b/src/azure/connectors/powerbi.py index 5653313d..76cf0e33 100644 --- a/src/azure/connectors/powerbi.py +++ b/src/azure/connectors/powerbi.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,58 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "PowerbiClient", + "Alert", + "Columns", + "CreateGoalRequest", + "CreateGoalResponse", + "CreateScorecardRequest", + "CreatedScorecard", + "Datasets", + "DynamicPowerBiButtonClickedTriggerResult", + "EffectiveIdentity", + "EvaluatedAlert", + "ExecuteDatasetQueriesJsonInput", + "ExecuteDatasetQueriesJsonResponse", + "ExportFilter", + "ExportPayloadPaginatedReport", + "ExportPayloadPowerBIReport", + "ExportReportPage", + "ExportReportSettings", + "FetchedGoal", + "FetchedGoals", + "GetGoalCheckinResponse", + "GetGoalCheckinsResponse", + "GoalChanged", + "GoalNotes", + "GoalRefreshIssue", + "GoalRefreshIssues", + "GoalStatusChanged", + "GoalValueChanged", + "GoalValueCheckinNoteInput", + "GoalValueCheckinRequest", + "GoalValueCheckinUpdateRequest", + "GoalValueOrNoteUpserted", + "GoalsAssigned", + "Groups", + "IdentityBlob", + "ListedScorecard", + "ListedScorecards", + "PageBookmark", + "Payload", + "PowerBiButtonClickedOutputs", + "QueryExecutionResults", + "QuerySpecification", + "Reports", + "Tables", + "UpdateGoalRequest", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +80,12 @@ class ListedScorecards: Response for Get scorecards """ - value: Optional[List[ListedScorecard]] = None + value: Optional[ + List[ListedScorecard | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of scorecards.""" @@ -39,7 +95,7 @@ class CreatedScorecard: Response for Create a scorecard """ - id: Optional[str] = None + id: str """The unique identifier of the scorecard.""" @@ -49,7 +105,12 @@ class FetchedGoals: Response for Get multiple goals """ - value: Optional[List[FetchedGoal]] = None + value: Optional[ + List[FetchedGoal | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of the goals.""" @@ -59,7 +120,7 @@ class CreateGoalResponse: Response for Create a goal """ - id: Optional[str] = None + id: str """The unique identifier of the goal.""" @@ -69,58 +130,67 @@ class FetchedGoal: Response for Get a goal """ - id: Optional[str] = None + id: str """The unique identifier of the goal.""" - name: Optional[str] = None + name: str """The name of the goal.""" - owner: Optional[str] = None + owner: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address of the goal's owner.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """The start date for the goal. Example: 2021-07-15.""" - completion_date: Optional[str] = field( + completion_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completionDate"}, ) """The due date for the goal to be completed by. Example: 2021-07-29.""" - parent_id: Optional[str] = field( + parent_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentId"}, ) """If this goal is a subgoal, the unique id of its parent goal.""" - current_value: Optional[float] = field( + current_value: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "currentValue"}, ) """The current value of the goal being tracked.""" - current_value_timestamp: Optional[str] = field( + current_value_timestamp: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "currentValueTimestamp"}, ) """The timestamp when the current value of the goal was set.""" - target_value: Optional[float] = field( + target_value: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetValue"}, ) """The target value of the goal.""" - target_value_timestamp: Optional[str] = field( + target_value_timestamp: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetValueTimestamp"}, ) """The timestamp when the target value of the goal was set.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status of the goal.""" - status_timestamp: Optional[str] = field( + status_timestamp: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusTimestamp"}, ) """The timestamp when the status of the goal was set.""" - cycle: Optional[str] = None + cycle: Optional[str] = dataclass_field(default=None, kw_only=True) """Tracking cycle frequency interval shown on this goal's visuals.""" - cycle_period: Optional[str] = field( + cycle_period: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "cyclePeriod"}, ) """Date to find out extra properties of tracking cycle.""" @@ -132,8 +202,7 @@ class GoalsAssigned: Response for When someone assigns a new owner to a goal """ - assigned_goals: Optional[List[Dict[str, Any]]] = field( - default=None, + assigned_goals: List[Dict[str, Any]] = dataclass_field( metadata={"wire_name": "assignedGoals"}, ) """The list of goals that were assigned to the new owner.""" @@ -145,110 +214,131 @@ class GoalChanged: Response for When a goal changes """ - id: Optional[str] = None + id: str """The unique identifier of the goal.""" - old_name: Optional[str] = field( + old_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldName"}, ) """The name of the goal.""" - old_owner: Optional[str] = field( + old_owner: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldOwner"}, ) """The email address of the goal's owner.""" - old_start_date: Optional[str] = field( + old_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldStartDate"}, ) """The start date for the goal. Example: 2021-07-15.""" - old_completion_date: Optional[str] = field( + old_completion_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldCompletionDate"}, ) """The due date for the goal to be completed by. Example: 2021-07-29.""" - old_parent_id: Optional[str] = field( + old_parent_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldParentId"}, ) """If this goal is a subgoal, the unique id of its parent goal.""" - old_current_value: Optional[float] = field( + old_current_value: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldCurrentValue"}, ) """The current value of the goal being tracked.""" - old_target_value: Optional[float] = field( + old_target_value: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldTargetValue"}, ) """The target value of the goal.""" - old_status: Optional[str] = field( + old_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldStatus"}, ) """The status of the goal.""" - old_cycle: Optional[str] = field( + old_cycle: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldCycle"}, ) """Old tracking cycle frequency interval shown on this goal's visuals.""" - old_cycle_period: Optional[str] = field( + old_cycle_period: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldCyclePeriod"}, ) """Old date to find out extra properties of tracking cycle.""" - new_name: Optional[str] = field( + new_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newName"}, ) """The name of the goal.""" - new_owner: Optional[str] = field( + new_owner: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newOwner"}, ) """The email address of the goal's owner.""" - new_start_date: Optional[str] = field( + new_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newStartDate"}, ) """The start date for the goal.""" - new_completion_date: Optional[str] = field( + new_completion_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newCompletionDate"}, ) """The due date for the goal to be completed by.""" - new_parent_id: Optional[str] = field( + new_parent_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newParentId"}, ) """If this goal is a subgoal, the unique id of its parent goal.""" - new_current_value: Optional[float] = field( + new_current_value: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newCurrentValue"}, ) """The current value of the goal being tracked.""" - new_target_value: Optional[float] = field( + new_target_value: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newTargetValue"}, ) """The target value of the goal.""" - new_status: Optional[str] = field( + new_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newStatus"}, ) """The status of the goal.""" - new_cycle: Optional[str] = field( + new_cycle: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newCycle"}, ) """New tracking cycle interval shown on this goal's visuals.""" - new_cycle_period: Optional[str] = field( + new_cycle_period: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newCyclePeriod"}, ) """New date to find out extra properties of tracking cycle.""" - change_list: Optional[str] = field( + change_list: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "changeList"}, ) """Comma separated list of changes. Example: 'status,currentValue'.""" @@ -260,15 +350,17 @@ class GoalStatusChanged: Response for When status of a goal changes """ - id: Optional[str] = None + id: str """The unique identifier of the goal.""" - old_status: Optional[str] = field( + old_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldStatus"}, ) """The status of the goal.""" - new_status: Optional[str] = field( + new_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newStatus"}, ) """The status of the goal.""" @@ -280,15 +372,17 @@ class GoalValueChanged: Response for When current value of a goal changes """ - id: Optional[str] = None + id: str """The unique identifier of the goal.""" - old_current_value: Optional[float] = field( + old_current_value: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "oldCurrentValue"}, ) """The current value of the goal being tracked.""" - new_current_value: Optional[float] = field( + new_current_value: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newCurrentValue"}, ) """The current value of the goal being tracked.""" @@ -300,7 +394,7 @@ class GoalRefreshIssues: Response for When a data refresh for a goal fails """ - issues: Optional[List[GoalRefreshIssue]] = None + issues: List[GoalRefreshIssue | Mapping[str, Any]] """Goal refresh issues.""" @@ -310,9 +404,9 @@ class GoalValueOrNoteUpserted: Response for When someone adds or edits a goal check-in """ - values: Optional[List[Dict[str, Any]]] = None + values: List[Dict[str, Any]] """Added or updated check-ins.""" - notes: Optional[List[Dict[str, Any]]] = None + notes: List[Dict[str, Any]] """Added or changed notes.""" @@ -322,31 +416,36 @@ class EvaluatedAlert: Response for When a data driven alert is triggered """ - alert_title: Optional[str] = field( + alert_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "alertTitle"}, ) """The title of the alert.""" - alert_threshold: Optional[float] = field( + alert_threshold: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "alertThreshold"}, ) """The threshold at which the alert is triggered.""" - is_alert_triggered: Optional[bool] = field( + is_alert_triggered: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAlertTriggered"}, ) """ A boolean value (true, false) determining Whether or not the alert was triggered. """ - tile_url: Optional[str] = field( + tile_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tileUrl"}, ) """URL linking to the dashboard tile where the alert is set up.""" - tile_value: Optional[Any] = field( + tile_value: Optional[Any] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tileValue"}, ) """The value of the tile.""" @@ -358,8 +457,9 @@ class QueryExecutionResults: Response for Run a query against a dataset """ - first_table_rows: Optional[List[Dict[str, Any]]] = field( + first_table_rows: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstTableRows"}, ) """Query results as an array of rows.""" @@ -371,7 +471,7 @@ class ExecuteDatasetQueriesJsonInput: Run a json query against a dataset """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -384,7 +484,7 @@ class ExecuteDatasetQueriesJsonResponse: Response for Run a json query against a dataset """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -400,7 +500,7 @@ class GetGoalCheckinsResponse: Response for Get goal check-ins """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of check-ins.""" @@ -410,13 +510,13 @@ class GetGoalCheckinResponse: Response for Get a goal check-in """ - timestamp: Optional[str] = None + timestamp: Optional[str] = dataclass_field(default=None, kw_only=True) """The date that the check-in was made.""" - value: Optional[float] = None + value: Optional[float] = dataclass_field(default=None, kw_only=True) """The value at the time of check in, if set.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The goal status at the time of check in.""" - notes: Optional[GoalNotes] = None + notes: Optional[GoalNotes] = dataclass_field(default=None, kw_only=True) @dataclass @@ -425,7 +525,7 @@ class Groups: Response for ListGroups """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -434,18 +534,21 @@ class Alert: Response for Get alerts from Power BI """ - alert_id: Optional[str] = field( + alert_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "alertId"}, ) """The ID of the alert.""" - alert_title: Optional[str] = field( + alert_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "alertTitle"}, ) """The title of the alert.""" - group_id: Optional[str] = field( + group_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "groupId"}, ) """The ID of the group.""" @@ -457,7 +560,7 @@ class Datasets: Response for ListDatasets """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -466,7 +569,7 @@ class Tables: Response for ListTables """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -475,12 +578,13 @@ class Reports: Response for Get Reports in Group """ - odata_context: Optional[str] = field( + odata_context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "odata.context"}, ) """OData context""" - value: Optional[List[Any]] = None + value: Optional[List[Any]] = dataclass_field(default=None, kw_only=True) """The report collection""" @@ -490,7 +594,7 @@ class Columns: Response for GetColumns """ - schema: Optional[Dict[str, Any]] = None + schema: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -499,14 +603,16 @@ class QuerySpecification: Definition: QuerySpecification """ - query: Optional[str] = None + query: str """The text of the query. Can be multiline text.""" - serializer_settings: Optional[Dict[str, Any]] = field( + serializer_settings: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serializerSettings"}, ) - impersonated_user_name: Optional[str] = field( + impersonated_user_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "impersonatedUserName"}, ) """A user identity in UPN format to run the query as another user.""" @@ -518,9 +624,9 @@ class CreateScorecardRequest: Definition: CreateScorecardRequest """ - name: Optional[str] = None + name: str """Scorecard name""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Scorecard description""" @@ -530,11 +636,11 @@ class ListedScorecard: Definition: ListedScorecard """ - id: Optional[str] = None + id: str """The unique identifier of the scorecard.""" - name: Optional[str] = None + name: str """The name of the scorecard.""" - contact: Optional[str] = None + contact: Optional[str] = dataclass_field(default=None, kw_only=True) """Contact information for the scorecard.""" @@ -544,33 +650,36 @@ class CreateGoalRequest: Definition: CreateGoalRequest """ - name: Optional[str] = None + name: str """The name of the goal.""" - owner: Optional[str] = None + owner: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address of the goal's owner. Example: foo@bar.com""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """The current value of the goal being tracked.""" - target: Optional[str] = None + target: Optional[str] = dataclass_field(default=None, kw_only=True) """The target value of the goal.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The current status the goal.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """The start date for the goal. Example: 2021-07-15.""" - completion_date: Optional[str] = field( + completion_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completionDate"}, ) """The date for the goal to be completed by. Example: 2021-07-29.""" - note: Optional[str] = None + note: Optional[str] = dataclass_field(default=None, kw_only=True) """ Note to attach to the initial check-in on goal creation. Can be multiline text """ - parent_id: Optional[str] = field( + parent_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentId"}, ) """If this goal is a subgoal, the unique id of its parent goal.""" @@ -582,23 +691,25 @@ class UpdateGoalRequest: Definition: UpdateGoalRequest """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """If provided, the new name of the goal.""" - owner: Optional[str] = None + owner: Optional[str] = dataclass_field(default=None, kw_only=True) """If provided, the email address of the new goal owner.""" - value: Optional[float] = None + value: Optional[float] = dataclass_field(default=None, kw_only=True) """If provided, sets the new value of the goal.""" - target: Optional[float] = None + target: Optional[float] = dataclass_field(default=None, kw_only=True) """If provided, sets the new goal target.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """If provided, sets the new status of the goal.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDate"}, ) """If provided, the new start date for the goal. Example: 2021-07-15.""" - completion_date: Optional[str] = field( + completion_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completionDate"}, ) """ @@ -613,14 +724,15 @@ class GoalRefreshIssue: Definition: GoalRefreshIssue """ - connection_type: Optional[str] = field( + connection_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "connectionType"}, ) """The connection type, either Current or Target.""" - timestamp: Optional[str] = None + timestamp: Optional[str] = dataclass_field(default=None, kw_only=True) """The timestamp of when the failed refresh happened.""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the error.""" @@ -630,12 +742,12 @@ class GoalValueCheckinRequest: Definition: GoalValueCheckinRequest """ - timestamp: Optional[str] = None + timestamp: str """Check-in date. Example: 2021-07-21""" - value: Optional[float] = None - status: Optional[str] = None + value: Optional[float] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the goal.""" - note: Optional[str] = None + note: Optional[str] = dataclass_field(default=None, kw_only=True) """Can be multiline text""" @@ -645,8 +757,8 @@ class GoalValueCheckinUpdateRequest: Definition: GoalValueCheckinUpdateRequest """ - value: Optional[float] = None - status: Optional[str] = None + value: Optional[float] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the goal.""" @@ -659,7 +771,7 @@ class Payload: Definition: Payload """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -672,13 +784,14 @@ class ExportPayloadPowerBIReport: Definition: ExportPayloadPowerBIReport """ - format: Optional[str] = None + format: str """ The export format for the Power BI report. The supported formats are: PPTX (PowerPoint), PDF, and PNG """ - power_b_i_report_export_configuration: Optional[Dict[str, Any]] = field( + power_b_i_report_export_configuration: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PowerBIReportExportConfiguration"}, ) """Power BI report Export to file configuration""" @@ -690,14 +803,15 @@ class ExportPayloadPaginatedReport: Definition: ExportPayloadPaginatedReport """ - format: Optional[str] = None + format: str """ The export format for the paginated report. The supported formats are: PPTX (PowerPoint), PDF, ACCESSIBLEPDF (Accessible PDF), XLSX (Excel), DOCX (Word), CSV, XML, MHTML, and Image (BMP, EMF, GIF, JPEG, PNG, or TIFF). """ - paginated_report_configuration: Optional[Dict[str, Any]] = field( + paginated_report_configuration: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "paginatedReportConfiguration"}, ) """paginatedReportConfiguration""" @@ -709,10 +823,11 @@ class ExportReportSettings: Definition: ExportReportSettings """ - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale to apply""" - include_hidden_pages: Optional[bool] = field( + include_hidden_pages: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "includeHiddenPages"}, ) """ @@ -728,9 +843,9 @@ class PageBookmark: Definition: PageBookmark """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The bookmark name""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The bookmark state""" @@ -740,7 +855,7 @@ class ExportFilter: Definition: ExportFilter """ - filter: Optional[str] = None + filter: Optional[str] = dataclass_field(default=None, kw_only=True) """The filter to apply""" @@ -750,17 +865,24 @@ class ExportReportPage: Definition: ExportReportPage """ - page_name: Optional[str] = field( + page_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageName"}, ) """The page name""" - visual_name: Optional[str] = field( + visual_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "visualName"}, ) """(Optional) Visual name to be exported""" - bookmark: Optional[PageBookmark] = None + bookmark: Optional[ + PageBookmark | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) """(Optional) The bookmark to be applied on the page""" @@ -770,7 +892,7 @@ class EffectiveIdentity: Definition: EffectiveIdentity """ - username: Optional[str] = None + username: str """ The effective username reflected by a token for applying RLS rules (For OnPrem model, username can be composed of alpha-numerical characters or any @@ -778,31 +900,33 @@ class EffectiveIdentity: also username cannot contain spaces. For Cloud model, username can be composed of all ASCII characters. username must be up to 256 characters) """ - datasets: Optional[List[str]] = None + datasets: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """An array of datasets for which this identity applies""" - roles: Optional[List[str]] = None + roles: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ An array of RLS roles reflected by a token when applying RLS rules (identity can contain up to 50 roles, role can be composed of any character besides ',' and must be up to 50 characters) """ - custom_data: Optional[str] = field( + custom_data: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customData"}, ) """ The value of customdata to be used for applying RLS rules. Only supported for live connections to Azure Analysis Services. """ - identity_blob: Optional[IdentityBlob] = field( + identity_blob: Optional[IdentityBlob | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "identityBlob"}, ) """ A blob for specifying the identity. Only supported for datasets with Direct Query connection to SQL Azure """ - reports: Optional[List[str]] = None + reports: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ An array of reports for which this identity applies, Only supported for paginated reports @@ -815,7 +939,7 @@ class IdentityBlob: Definition: IdentityBlob """ - value: Optional[str] = None + value: str """OAuth2 access token for SQL Azure""" @@ -825,7 +949,7 @@ class DynamicPowerBiButtonClickedTriggerResult: Definition: DynamicPowerBiButtonClickedTriggerResult """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -838,8 +962,9 @@ class PowerBiButtonClickedOutputs: Definition: PowerBiButtonClickedOutputs """ - power_bi_inputs: Optional[Dict[str, Any]] = field( + power_bi_inputs: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PowerBiInputs"}, ) @@ -855,7 +980,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -872,8 +997,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -894,7 +1019,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -909,7 +1034,84 @@ def __init__( def connector_name(self) -> str: return "powerbi" - async def get_scorecards_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_scorecards( self, groupid: str, *, @@ -917,11 +1119,29 @@ async def get_scorecards_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get scorecards Gets a list of Power BI scorecards in the specified workspace. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetScorecards`. + + Args: + groupid: The unique identifier of the workspace. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -935,31 +1155,52 @@ async def get_scorecards_async( query_params.append("pbi_source=" + quote("powerAutomate", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def create_scorecard_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_scorecard( self, - input: CreateScorecardRequest, + input: CreateScorecardRequest | Mapping[str, Any], groupid: str, *, timeout: Optional[float] = None, @@ -971,6 +1212,23 @@ async def create_scorecard_async( Create a scorecard Creates a scorecard for Power BI goals. + + Swagger operation ID: `CreateScorecard`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + groupid: The unique identifier of the workspace. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -985,7 +1243,7 @@ async def create_scorecard_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -999,6 +1257,7 @@ async def create_scorecard_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1006,7 +1265,7 @@ async def create_scorecard_async( return json.loads(response.text) - async def get_multiple_goals_async( + def list_multiple_goals( self, groupid: str, scorecard_id: str, @@ -1015,11 +1274,30 @@ async def get_multiple_goals_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get multiple goals Get a list of Power BI goals in the specified scorecard. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMultipleGoals`. + + Args: + groupid: The unique identifier of the workspace. + scorecard_id: The unique identifier of the scorecard. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1035,31 +1313,52 @@ async def get_multiple_goals_async( query_params.append("pbi_source=" + quote("powerAutomate", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def create_goal_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_goal( self, - input: CreateGoalRequest, + input: CreateGoalRequest | Mapping[str, Any], groupid: str, scorecard_id: str, *, @@ -1072,6 +1371,24 @@ async def create_goal_async( Create a goal Creates a Power BI goal on the specified scorecard. + + Swagger operation ID: `CreateGoal`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + groupid: The unique identifier of the workspace. + scorecard_id: The unique identifier of the scorecard. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1087,7 +1404,7 @@ async def create_goal_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1101,6 +1418,7 @@ async def create_goal_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1108,7 +1426,7 @@ async def create_goal_async( return json.loads(response.text) - async def get_goal_async( + async def get_goal( self, groupid: str, scorecard_id: str, @@ -1123,6 +1441,23 @@ async def get_goal_async( Get a goal Gets the specified Power BI goal on a scorecard. + + Swagger operation ID: `GetGoal`. + + Args: + groupid: The unique identifier of the workspace. + scorecard_id: The unique identifier of the scorecard. + goal_id: The unique identifier of the goal. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1139,7 +1474,7 @@ async def get_goal_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1153,6 +1488,7 @@ async def get_goal_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1160,9 +1496,9 @@ async def get_goal_async( return json.loads(response.text) - async def update_goal_async( + async def update_goal( self, - input: UpdateGoalRequest, + input: UpdateGoalRequest | Mapping[str, Any], groupid: str, scorecard_id: str, goal_id: str, @@ -1176,6 +1512,25 @@ async def update_goal_async( Update a goal Updates the Power BI goal's state. + + Swagger operation ID: `UpdateGoal`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + groupid: The unique identifier of the workspace. + scorecard_id: The unique identifier of the scorecard. + goal_id: The unique identifier of the goal. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1191,7 +1546,7 @@ async def update_goal_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1205,11 +1560,12 @@ async def update_goal_async( request_url, response.status, response.text, + response=response, ) - async def execute_dataset_query_async( + async def execute_dataset_query( self, - input: QuerySpecification, + input: QuerySpecification | Mapping[str, Any], groupid: str, datasetid: str, *, @@ -1222,6 +1578,24 @@ async def execute_dataset_query_async( Run a query against a dataset Use the Power BI REST API to run a query. + + Swagger operation ID: `ExecuteDatasetQuery`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + groupid: The unique identifier of the workspace. + datasetid: The unique identifier of the dataset. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1238,7 +1612,7 @@ async def execute_dataset_query_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1252,6 +1626,7 @@ async def execute_dataset_query_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1259,9 +1634,9 @@ async def execute_dataset_query_async( return json.loads(response.text) - async def execute_dataset_queries_json_async( + async def execute_dataset_queries_json( self, - input: ExecuteDatasetQueriesJsonInput, + input: ExecuteDatasetQueriesJsonInput | Mapping[str, Any], groupid: str, datasetid: str, *, @@ -1274,6 +1649,24 @@ async def execute_dataset_queries_json_async( Run a json query against a dataset Use the Power BI REST API to run a query in json format. + + Swagger operation ID: `ExecuteDatasetQueriesJson`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + groupid: The unique identifier of the workspace. + datasetid: The unique identifier of the dataset. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1291,7 +1684,7 @@ async def execute_dataset_queries_json_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1305,6 +1698,7 @@ async def execute_dataset_queries_json_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1312,9 +1706,9 @@ async def execute_dataset_queries_json_async( return json.loads(response.text) - async def add_rows_async( + async def add_rows( self, - input: Payload, + input: Payload | Mapping[str, Any], groupid: str, datasetid: str, tablename: str, @@ -1328,6 +1722,25 @@ async def add_rows_async( Add rows to a dataset Use Power BI REST API to add rows to a dataset. + + Swagger operation ID: `AddRows`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + groupid: The unique identifier of the workspace. + datasetid: The unique identifier of the dataset. + tablename: The name of the table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1346,7 +1759,7 @@ async def add_rows_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1360,9 +1773,10 @@ async def add_rows_async( request_url, response.status, response.text, + response=response, ) - async def goal_value_checkin_note_async( + async def goal_value_checkin_note( self, input: GoalValueCheckinNoteInput, groupid: str, @@ -1379,6 +1793,25 @@ async def goal_value_checkin_note_async( Add a note to a check-in Appends a new note to a check-in of a Power BI goal. + + Swagger operation ID: `GoalValueCheckinNote`. + + Args: + input: The request body. + groupid: The unique identifier of the workspace. + scorecard_id: The unique identifier of the scorecard. + goal_id: The unique identifier of the goal. + goal_checkin: Example: 2021-07-21. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1396,7 +1829,7 @@ async def goal_value_checkin_note_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1410,11 +1843,12 @@ async def goal_value_checkin_note_async( request_url, response.status, response.text, + response=response, ) - async def goal_value_checkin_async( + async def goal_value_checkin( self, - input: GoalValueCheckinRequest, + input: GoalValueCheckinRequest | Mapping[str, Any], groupid: str, scorecard_id: str, goal_id: str, @@ -1428,6 +1862,25 @@ async def goal_value_checkin_async( Create a check-in Creates a Power BI goal check-in. + + Swagger operation ID: `GoalValueCheckin`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + groupid: The unique identifier of the workspace. + scorecard_id: The unique identifier of the scorecard. + goal_id: The unique identifier of the goal. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1444,7 +1897,7 @@ async def goal_value_checkin_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1458,9 +1911,10 @@ async def goal_value_checkin_async( request_url, response.status, response.text, + response=response, ) - async def get_goal_checkins_async( + def list_goal_checkins( self, groupid: str, scorecard_id: str, @@ -1470,11 +1924,31 @@ async def get_goal_checkins_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get goal check-ins Get all check-ins on a Power BI goal. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetGoalCheckins`. + + Args: + groupid: The unique identifier of the workspace. + scorecard_id: The unique identifier of the scorecard. + goal_id: The unique identifier of the goal. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1491,31 +1965,52 @@ async def get_goal_checkins_async( query_params.append("$expand=" + quote("notes", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def update_goal_checkin_async( + return AsyncItemPaged(get_next, extract_data) + + async def update_goal_checkin( self, - input: GoalValueCheckinUpdateRequest, + input: GoalValueCheckinUpdateRequest | Mapping[str, Any], groupid: str, scorecard_id: str, goal_id: str, @@ -1530,6 +2025,26 @@ async def update_goal_checkin_async( Update a check-in Updates a Power BI goal check-in. + + Swagger operation ID: `UpdateGoalCheckin`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + groupid: The unique identifier of the workspace. + scorecard_id: The unique identifier of the scorecard. + goal_id: The unique identifier of the goal. + goal_checkin: Example: 2021-07-21. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1546,7 +2061,7 @@ async def update_goal_checkin_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1560,9 +2075,10 @@ async def update_goal_checkin_async( request_url, response.status, response.text, + response=response, ) - async def get_goal_checkin_async( + async def get_goal_checkin( self, groupid: str, scorecard_id: str, @@ -1578,6 +2094,24 @@ async def get_goal_checkin_async( Get a goal check-in Get a check-in on a Power BI goal. + + Swagger operation ID: `GetGoalCheckin`. + + Args: + groupid: The unique identifier of the workspace. + scorecard_id: The unique identifier of the scorecard. + goal_id: The unique identifier of the goal. + goal_checkin: Example: 2021-07-21. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1595,7 +2129,7 @@ async def get_goal_checkin_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1609,6 +2143,7 @@ async def get_goal_checkin_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1616,7 +2151,7 @@ async def get_goal_checkin_async( return json.loads(response.text) - async def refresh_dataset_async( + async def refresh_dataset( self, groupid: str, datasetid: str, @@ -1630,6 +2165,22 @@ async def refresh_dataset_async( Refresh a dataset Use Power BI REST API to refresh a powerbi dataset. + + Swagger operation ID: `RefreshDataset`. + + Args: + groupid: The unique identifier of the workspace. + datasetid: The unique identifier of the dataset. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1646,7 +2197,7 @@ async def refresh_dataset_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1660,11 +2211,12 @@ async def refresh_dataset_async( request_url, response.status, response.text, + response=response, ) - async def initiate_export_to_file_for_pbi_reports_async( + async def initiate_export_to_file_for_pbi_reports( self, - input: ExportPayloadPowerBIReport, + input: ExportPayloadPowerBIReport | Mapping[str, Any], groupid: str, reportid: str, *, @@ -1677,6 +2229,24 @@ async def initiate_export_to_file_for_pbi_reports_async( Export To File for Power BI Reports Use Power BI Rest API to inititate export for Power BI reports + + Swagger operation ID: `InitiateExportToFileForPbiReports`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + groupid: The unique identifier of the workspace. + reportid: The unique identifier of a pbi report. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1689,7 +2259,7 @@ async def initiate_export_to_file_for_pbi_reports_async( f"/ExportTo" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1703,13 +2273,14 @@ async def initiate_export_to_file_for_pbi_reports_async( request_url, response.status, response.text, + response=response, ) return response.content - async def initiate_export_to_file_for_paginated_reports_async( + async def initiate_export_to_file_for_paginated_reports( self, - input: ExportPayloadPaginatedReport, + input: ExportPayloadPaginatedReport | Mapping[str, Any], groupid: str, reportid: str, *, @@ -1722,6 +2293,24 @@ async def initiate_export_to_file_for_paginated_reports_async( Export To File for Paginated Reports Use Power BI Rest API to inititate export for paginated reports + + Swagger operation ID: `InitiateExportToFileForPaginatedReports`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + groupid: The unique identifier of the workspace. + reportid: The unique identifier of a paginated report. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1734,7 +2323,7 @@ async def initiate_export_to_file_for_paginated_reports_async( f"/ExportToPaginatedReports" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1748,91 +2337,168 @@ async def initiate_export_to_file_for_paginated_reports_async( request_url, response.status, response.text, + response=response, ) return response.content - async def list_groups_async( + def list_groups( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ ListGroups Get Groups for Power BI. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListGroups`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/myorg/groups" query_params = [] query_params.append("pbi_source=" + quote("powerAutomate", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_alerts_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_alerts( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get alerts from Power BI Return a list of alerts for a signed in user. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAlerts`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/metadata/v201606/alerts" query_params = [] query_params.append("pbi_source=" + quote("powerAutomate", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_datasets_async( + def list_datasets( self, groupid: str, *, @@ -1840,11 +2506,29 @@ async def list_datasets_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ ListDatasets Get datasets for Power BI group. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListDatasets`. + + Args: + groupid: The unique identifier of the workspace. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1854,29 +2538,50 @@ async def list_datasets_async( query_params.append("pbi_source=" + quote("powerAutomate", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_tables_async( + def list_tables( self, groupid: str, datasetid: str, @@ -1885,11 +2590,30 @@ async def list_tables_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ ListTables Get tables for Power BI dataset. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListTables`. + + Args: + groupid: The unique identifier of the workspace. + datasetid: The unique identifier of the dataset. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1905,29 +2629,50 @@ async def list_tables_async( query_params.append("pbi_source=" + quote("powerAutomate", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_reports_in_group_async( + def list_reports_in_group( self, groupid: str, *, @@ -1935,39 +2680,78 @@ async def get_reports_in_group_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Reports in Group Returns a list of reports from the specified workspace. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetReportsInGroup`. + + Args: + groupid: The unique identifier of the workspace. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/myorg/groups/{quote(str(groupid), safe='')}/reports" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_columns_async( + async def get_columns( self, groupid: str, datasetid: str, @@ -1982,6 +2766,23 @@ async def get_columns_async( GetColumns Get columns for Power BI dataset table. + + Swagger operation ID: `GetColumns`. + + Args: + groupid: The unique identifier of the workspace. + datasetid: The unique identifier of the dataset. + tablename: The name of the table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2000,7 +2801,7 @@ async def get_columns_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2014,6 +2815,7 @@ async def get_columns_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/projectplace.py b/src/azure/connectors/projectplace.py index 2c236984..5fa917b4 100644 --- a/src/azure/connectors/projectplace.py +++ b/src/azure/connectors/projectplace.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass -from typing import Optional, Dict, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,21 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "ProjectplaceClient", + "CreateCardInput", + "CreateCardResponse", + "MoveCardInput", + "MoveCardResponse", + "SetWebhookCardCreateInput", + "SetWebhookCardDueDateInput", + "SetWebhookPropertiesChangeInput", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,11 +43,11 @@ class SetWebhookCardCreateInput: When a card is created """ - card_create: Optional[bool] = None + card_create: bool """Triggers when a card is created on the defined board""" - webhook: Optional[str] = None + webhook: str """webhook""" - board_id: Optional[int] = None + board_id: int """The id of the Board that the card belongs to""" @@ -43,24 +57,24 @@ class SetWebhookPropertiesChangeInput: When a card's properties are changed """ - card_blocked: Optional[bool] = None + card_blocked: bool """Triggers when a card is blocked""" - card_unblock: Optional[bool] = None + card_unblock: bool """Triggers when a card block is removed""" - status_change: Optional[bool] = None + status_change: bool """Triggers when a card is moved to another column on the""" - card_done: Optional[bool] = None + card_done: bool """ Triggers when a card is set to done by moving it to the rightmost column on the board """ - description_changed: Optional[bool] = None + description_changed: bool """Triggers when the description of a card changes""" - due_date_changed: Optional[bool] = None + due_date_changed: bool """Triggers when the due date of a card changes""" - webhook: Optional[str] = None + webhook: str """webhook""" - board_id: Optional[int] = None + board_id: int """The id of the Board that the card belongs to""" @@ -70,11 +84,11 @@ class SetWebhookCardDueDateInput: When a card is due """ - due_today: Optional[bool] = None + due_today: bool """Triggers on the date that the card is due""" - webhook: Optional[str] = None + webhook: str """webhook""" - board_id: Optional[int] = None + board_id: int """The id of the Board that the card belongs to""" @@ -84,19 +98,19 @@ class CreateCardInput: Create Card """ - column_id: Optional[int] = None + column_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The column where the card should be created""" - title: Optional[str] = None + title: str """The title of the created card""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the created card""" - assignee_email: Optional[str] = None + assignee_email: Optional[str] = dataclass_field(default=None, kw_only=True) """The person that will be assigned to the created card""" - planlet_id: Optional[int] = None + planlet_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The activity the Card should be associated with""" - due_date: Optional[str] = None + due_date: Optional[str] = dataclass_field(default=None, kw_only=True) """The due date of the created card""" - label_id: Optional[int] = None + label_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The label of the created card""" @@ -106,39 +120,39 @@ class CreateCardResponse: Response for Create Card """ - access: Optional[str] = None + access: Optional[str] = dataclass_field(default=None, kw_only=True) """Access rights""" - assignee: Optional[Dict[str, Any]] = None + assignee: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The person who is assigned to the card""" - assignee_id: Optional[int] = None + assignee_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The id of the person who is assigned the card""" - board_id: Optional[int] = None + board_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The ID of the board""" - board_name: Optional[str] = None + board_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the board""" - direct_url: Optional[str] = None + direct_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The card's direct URL""" - due_date: Optional[str] = None + due_date: Optional[str] = dataclass_field(default=None, kw_only=True) """The due date of the card""" - estimated_time: Optional[str] = None + estimated_time: Optional[str] = dataclass_field(default=None, kw_only=True) """Estimated time for completion""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The ID of the card""" - is_blocked: Optional[bool] = None + is_blocked: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is the card is""" - is_blocked_reason: Optional[str] = None + is_blocked_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """The blocking reason - if blocked""" - is_done: Optional[bool] = None + is_done: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is the card done""" - is_template: Optional[bool] = None + is_template: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is a template card""" - label_id: Optional[int] = None + label_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The id of the label""" - planlet_id: Optional[int] = None + planlet_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The id of the activity""" - reported_time: Optional[str] = None + reported_time: Optional[str] = dataclass_field(default=None, kw_only=True) """How much time was reported for the card""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The card's title""" @@ -148,11 +162,11 @@ class MoveCardInput: Move card to another column """ - card_id: Optional[int] = None + card_id: int """The card to be moved""" - card_title: Optional[str] = None + card_title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the card to be moved""" - column_id: Optional[int] = None + column_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The column where the card should be moved to""" @@ -162,45 +176,45 @@ class MoveCardResponse: Response for Move card to another column """ - access: Optional[str] = None + access: Optional[str] = dataclass_field(default=None, kw_only=True) """Access rights""" - assignee_id: Optional[int] = None + assignee_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The ID of the person the card assigned to""" - board_id: Optional[int] = None + board_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The ID of the board""" - board_name: Optional[str] = None + board_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the board""" - column_id: Optional[int] = None + column_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The id of the column the card is on""" - column_name: Optional[str] = None + column_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the column""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The description on the card""" - direct_url: Optional[str] = None + direct_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The direct URL of the card""" - due_date: Optional[str] = None + due_date: Optional[str] = dataclass_field(default=None, kw_only=True) """The due date of the card""" - estimated_time: Optional[str] = None + estimated_time: Optional[str] = dataclass_field(default=None, kw_only=True) """The estimated time of the card""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The id of the card""" - is_blocked: Optional[bool] = None + is_blocked: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is the card blocked""" - is_blocked_reason: Optional[str] = None + is_blocked_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """The reason the card is blocked""" - is_done: Optional[bool] = None + is_done: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is the card done""" - is_template: Optional[bool] = None + is_template: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is a template card""" - label_id: Optional[int] = None + label_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The id of the card's label""" - label_name: Optional[str] = None + label_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the label""" - planlet_id: Optional[int] = None + planlet_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The id of the activity""" - reported_time: Optional[str] = None + reported_time: Optional[str] = dataclass_field(default=None, kw_only=True) """The time reported for this card""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the card""" @@ -215,7 +229,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -232,8 +246,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -254,7 +268,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -269,9 +283,86 @@ def __init__( def connector_name(self) -> str: return "projectplace" - async def create_card_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def create_card( self, - input: CreateCardInput, + input: CreateCardInput | Mapping[str, Any], board_id: int, *, timeout: Optional[float] = None, @@ -283,6 +374,23 @@ async def create_card_async( Create Card Creates a new card with the parameters provided + + Swagger operation ID: `create_card`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + board_id: The id of the Board where the card should be created. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -292,7 +400,7 @@ async def create_card_async( f"/create_card" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -306,6 +414,7 @@ async def create_card_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -313,9 +422,9 @@ async def create_card_async( return json.loads(response.text) - async def move_card_async( + async def move_card( self, - input: MoveCardInput, + input: MoveCardInput | Mapping[str, Any], board_id: int, *, timeout: Optional[float] = None, @@ -327,6 +436,23 @@ async def move_card_async( Move card to another column Move a card on the selected board + + Swagger operation ID: `move_card`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + board_id: The id of the Board where the card should be created. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -336,7 +462,7 @@ async def move_card_async( f"/move_card" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -350,6 +476,7 @@ async def move_card_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -357,44 +484,82 @@ async def move_card_async( return json.loads(response.text) - async def list_boards_async( + def list_boards( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Lists the boards the user have access to Lists the boards that are part of the projects the user have access to + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `list_boards`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1/external_notifications/lists/list_boards" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/replicon.py b/src/azure/connectors/replicon.py index b6028c57..670fb74c 100644 --- a/src/azure/connectors/replicon.py +++ b/src/azure/connectors/replicon.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Any, Mapping from urllib.parse import quote import json @@ -20,6 +20,35 @@ ConnectorResponseHook, ) +__all__ = [ + "RepliconClient", + "BulkGetProjectDetails3Input", + "BulkGetTimeEnteredSummaryInput", + "BulkGetTimeEnteredSummaryResponse", + "CreateProjectOrApplyModificationsInput", + "CreateProjectOrApplyModificationsResponse", + "CreateTaskHierarchyOrApplyModificationsInput", + "CreateTaskHierarchyOrApplyModificationsResponse", + "Date", + "Duration", + "GetDescendantTaskDetailsInput", + "GetDescendantTaskDetailsResponse", + "GetTimesheetSummaryInput", + "GetTimesheetSummaryResponse", + "MoveTaskInput", + "ProjectDetailsResponse", + "PutProjectTeamMemberAssignmentsInput", + "PutResourceAssignmentsInput", + "TaskListServiceGetDataInput", + "TaskListServiceGetDataResponse", + "TenantEndpointDetails", + "UserListServiceGetDataInput", + "UserListServiceGetDataResponse", + "WebhookSubscriptionResponse", + "WebhookSubscriptionsRestAPIInput", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +58,7 @@ class BulkGetProjectDetails3Input: Get Project Details """ - projects: Optional[List[Dict[str, Any]]] = None + projects: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """projects""" @@ -39,7 +68,7 @@ class ProjectDetailsResponse: Response for Get Project Details """ - d: Optional[List[Dict[str, Any]]] = None + d: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """d""" @@ -49,17 +78,19 @@ class CreateProjectOrApplyModificationsInput: Create Project Or Apply Modifications """ - target: Optional[Dict[str, Any]] = None + target: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """project target""" - modifications: Optional[Dict[str, Any]] = None + modifications: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """modifications""" - project_modification_option_uri: Optional[str] = field( + project_modification_option_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectModificationOptionUri"}, ) """project modification option uri""" - unit_of_work_id: Optional[str] = field( + unit_of_work_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unitOfWorkId"}, ) """unit of work id""" @@ -71,7 +102,7 @@ class CreateProjectOrApplyModificationsResponse: Response for Create Project Or Apply Modifications """ - d: Optional[Dict[str, Any]] = None + d: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """d""" @@ -81,19 +112,21 @@ class UserListServiceGetDataInput: Get User List """ - page: Optional[str] = None + page: Optional[str] = dataclass_field(default=None, kw_only=True) """page""" - pagesize: Optional[str] = None + pagesize: Optional[str] = dataclass_field(default=None, kw_only=True) """page size""" - column_uris: Optional[List[str]] = field( + column_uris: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnUris"}, ) """column uris""" - sort: Optional[List[Any]] = None + sort: Optional[List[Any]] = dataclass_field(default=None, kw_only=True) """sort""" - filter_expression: Optional[Dict[str, Any]] = field( + filter_expression: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterExpression"}, ) """filter expression""" @@ -105,7 +138,7 @@ class UserListServiceGetDataResponse: Response for Get User List """ - d: Optional[Dict[str, Any]] = None + d: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """d""" @@ -115,8 +148,9 @@ class GetDescendantTaskDetailsInput: Get Descendant Task Details """ - parent_uri: Optional[str] = field( + parent_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentUri"}, ) """parent uri""" @@ -128,7 +162,7 @@ class GetDescendantTaskDetailsResponse: Response for Get Descendant Task Details """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -141,20 +175,23 @@ class CreateTaskHierarchyOrApplyModificationsInput: Create Task Hierarchy Or Apply Modifications """ - project: Optional[Dict[str, Any]] = None + project: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """project""" - task_hierarchy: Optional[List[Dict[str, Any]]] = field( + task_hierarchy: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "taskHierarchy"}, ) """task hierarchy""" - task_modification_option_uri: Optional[str] = field( + task_modification_option_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "taskModificationOptionUri"}, ) """task modification option uri""" - unit_of_work_id: Optional[str] = field( + unit_of_work_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unitOfWorkId"}, ) """unit of work id""" @@ -166,7 +203,7 @@ class CreateTaskHierarchyOrApplyModificationsResponse: Response for Create Task Hierarchy Or Apply Modifications """ - d: Optional[List[Dict[str, Any]]] = None + d: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """d""" @@ -176,18 +213,21 @@ class MoveTaskInput: Move Task """ - task_uri: Optional[str] = field( + task_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "taskUri"}, ) """task uri""" - target_uri: Optional[str] = field( + target_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetUri"}, ) """target uri""" - move_task_method_uri: Optional[str] = field( + move_task_method_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "moveTaskMethodUri"}, ) """move task method uri""" @@ -199,19 +239,21 @@ class TaskListServiceGetDataInput: Task List Service Get Data """ - page: Optional[str] = None + page: Optional[str] = dataclass_field(default=None, kw_only=True) """page""" - pagesize: Optional[str] = None + pagesize: Optional[str] = dataclass_field(default=None, kw_only=True) """page size""" - column_uris: Optional[List[str]] = field( + column_uris: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnUris"}, ) """column uris""" - sort: Optional[List[Any]] = None + sort: Optional[List[Any]] = dataclass_field(default=None, kw_only=True) """sort""" - filter_expression: Optional[Dict[str, Any]] = field( + filter_expression: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterExpression"}, ) """filter expression""" @@ -223,7 +265,7 @@ class TaskListServiceGetDataResponse: Response for Task List Service Get Data """ - d: Optional[Dict[str, Any]] = None + d: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """d""" @@ -233,8 +275,9 @@ class GetTimesheetSummaryInput: Get Timesheet Summary """ - timesheet_uri: Optional[str] = field( + timesheet_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timesheetUri"}, ) """timesheet uri""" @@ -246,7 +289,7 @@ class GetTimesheetSummaryResponse: Response for Get Timesheet Summary """ - d: Optional[Dict[str, Any]] = None + d: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """d""" @@ -256,8 +299,9 @@ class BulkGetTimeEnteredSummaryInput: Get Time Entered Summary """ - task_uris: Optional[List[str]] = field( + task_uris: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "taskUris"}, ) """task uris""" @@ -269,7 +313,7 @@ class BulkGetTimeEnteredSummaryResponse: Response for Get Time Entered Summary """ - d: Optional[List[Dict[str, Any]]] = None + d: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """d""" @@ -279,15 +323,13 @@ class WebhookSubscriptionsRestAPIInput: Subscribe to Event triggers """ - event_type: Optional[str] = field( + event_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventType"}, ) """Event type to subscribe to""" - target_url: Optional[str] = field( - default=None, - metadata={"wire_name": "targetUrl"}, - ) + target_url: str = dataclass_field(metadata={"wire_name": "targetUrl"}) """target url""" @@ -297,35 +339,41 @@ class WebhookSubscriptionResponse: Response for Subscribe to Event triggers """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """identity of the webhook event""" - created_timestamp: Optional[str] = field( + created_timestamp: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdTimestamp"}, ) """created time stamp of the webhook event""" - updated_timestamp: Optional[str] = field( + updated_timestamp: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "updatedTimestamp"}, ) """updated time stamp of the webhook event""" - event_type: Optional[str] = field( + event_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventType"}, ) """event Type of the webhook event""" - target_url: Optional[str] = field( + target_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetUrl"}, ) """target Url of the webhook event""" - shared_secret: Optional[str] = field( + shared_secret: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sharedSecret"}, ) """shared Secret of the webhook event""" - auth_type: Optional[str] = field( + auth_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "authType"}, ) """auth Type of the webhook event""" @@ -337,13 +385,15 @@ class PutProjectTeamMemberAssignmentsInput: Put Project Team Member Assignments """ - project_uri: Optional[str] = field( + project_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectUri"}, ) """project uri""" - resource_uris: Optional[List[str]] = field( + resource_uris: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceUris"}, ) """resource uris""" @@ -355,13 +405,15 @@ class PutResourceAssignmentsInput: Rewrite Resource Assignment of a task """ - task_uri: Optional[str] = field( + task_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "taskUri"}, ) """task uri""" - resource_uris: Optional[List[str]] = field( + resource_uris: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceUris"}, ) """resource uris""" @@ -373,7 +425,7 @@ class TenantEndpointDetails: Response for Get Tenant End Point Details """ - d: Optional[Dict[str, Any]] = None + d: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """d""" @@ -383,11 +435,11 @@ class Date: Definition: Date """ - day: Optional[int] = None + day: Optional[int] = dataclass_field(default=None, kw_only=True) """day""" - month: Optional[int] = None + month: Optional[int] = dataclass_field(default=None, kw_only=True) """month""" - year: Optional[int] = None + year: Optional[int] = dataclass_field(default=None, kw_only=True) """year""" @@ -397,15 +449,15 @@ class Duration: Definition: Duration """ - hours: Optional[int] = None + hours: Optional[int] = dataclass_field(default=None, kw_only=True) """hours""" - microseconds: Optional[int] = None + microseconds: Optional[int] = dataclass_field(default=None, kw_only=True) """microseconds""" - milliseconds: Optional[int] = None + milliseconds: Optional[int] = dataclass_field(default=None, kw_only=True) """milliseconds""" - minutes: Optional[int] = None + minutes: Optional[int] = dataclass_field(default=None, kw_only=True) """minutes""" - seconds: Optional[int] = None + seconds: Optional[int] = dataclass_field(default=None, kw_only=True) """seconds""" @@ -420,7 +472,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -437,8 +489,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -459,7 +511,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -474,9 +526,9 @@ def __init__( def connector_name(self) -> str: return "replicon" - async def bulk_get_project_details3_async( + async def bulk_get_project_details3( self, - input: BulkGetProjectDetails3Input, + input: BulkGetProjectDetails3Input | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, @@ -488,6 +540,23 @@ async def bulk_get_project_details3_async( Get Project Details Get the project details from Replicon + + Swagger operation ID: `BulkGetProjectDetails3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + host_url: Replicon Host Url. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -501,7 +570,7 @@ async def bulk_get_project_details3_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -515,6 +584,7 @@ async def bulk_get_project_details3_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -522,9 +592,9 @@ async def bulk_get_project_details3_async( return json.loads(response.text) - async def create_project_or_apply_modifications_async( + async def create_project_or_apply_modifications( self, - input: CreateProjectOrApplyModificationsInput, + input: CreateProjectOrApplyModificationsInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, @@ -536,6 +606,23 @@ async def create_project_or_apply_modifications_async( Create Project Or Apply Modifications Create Project Or Apply Modifications in Replicon + + Swagger operation ID: `CreateProjectOrApplyModifications`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + host_url: Replicon Host Url. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -549,7 +636,7 @@ async def create_project_or_apply_modifications_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -563,6 +650,7 @@ async def create_project_or_apply_modifications_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -570,9 +658,9 @@ async def create_project_or_apply_modifications_async( return json.loads(response.text) - async def user_list_service_get_data_async( + async def user_list_service_get_data( self, - input: UserListServiceGetDataInput, + input: UserListServiceGetDataInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, @@ -584,6 +672,23 @@ async def user_list_service_get_data_async( Get User List Get User List Data from Replicon + + Swagger operation ID: `UserListServiceGetData`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + host_url: Replicon Host Url. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -597,7 +702,7 @@ async def user_list_service_get_data_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -611,6 +716,7 @@ async def user_list_service_get_data_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -618,9 +724,9 @@ async def user_list_service_get_data_async( return json.loads(response.text) - async def get_descendant_task_details_async( + async def get_descendant_task_details( self, - input: GetDescendantTaskDetailsInput, + input: GetDescendantTaskDetailsInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, @@ -632,6 +738,23 @@ async def get_descendant_task_details_async( Get Descendant Task Details Get Hierarchial Task Details from Replicon + + Swagger operation ID: `GetDescendantTaskDetails`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + host_url: Replicon Host Url. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -645,7 +768,7 @@ async def get_descendant_task_details_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -659,6 +782,7 @@ async def get_descendant_task_details_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -666,9 +790,9 @@ async def get_descendant_task_details_async( return json.loads(response.text) - async def create_task_hierarchy_or_apply_modifications_async( + async def create_task_hierarchy_or_apply_modifications( self, - input: CreateTaskHierarchyOrApplyModificationsInput, + input: CreateTaskHierarchyOrApplyModificationsInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, @@ -680,6 +804,23 @@ async def create_task_hierarchy_or_apply_modifications_async( Create Task Hierarchy Or Apply Modifications Create Task Hierarchy Or Apply Modifications to a Replicon Task + + Swagger operation ID: `CreateTaskHierarchyOrApplyModifications`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + host_url: Replicon Host Url. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -695,7 +836,7 @@ async def create_task_hierarchy_or_apply_modifications_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -709,6 +850,7 @@ async def create_task_hierarchy_or_apply_modifications_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -716,9 +858,9 @@ async def create_task_hierarchy_or_apply_modifications_async( return json.loads(response.text) - async def move_task_async( + async def move_task( self, - input: MoveTaskInput, + input: MoveTaskInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, @@ -730,6 +872,23 @@ async def move_task_async( Move Task Move Task to a new Parent + + Swagger operation ID: `MoveTask`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + host_url: Replicon Host Url. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -743,7 +902,7 @@ async def move_task_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -757,11 +916,12 @@ async def move_task_async( request_url, response.status, response.text, + response=response, ) - async def task_list_service_get_data_async( + async def task_list_service_get_data( self, - input: TaskListServiceGetDataInput, + input: TaskListServiceGetDataInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, @@ -773,6 +933,23 @@ async def task_list_service_get_data_async( Task List Service Get Data Get Task List Service Data From Replicon + + Swagger operation ID: `TaskListServiceGetData`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + host_url: Replicon Host Url. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -786,7 +963,7 @@ async def task_list_service_get_data_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -800,6 +977,7 @@ async def task_list_service_get_data_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -807,9 +985,9 @@ async def task_list_service_get_data_async( return json.loads(response.text) - async def get_timesheet_summary_async( + async def get_timesheet_summary( self, - input: GetTimesheetSummaryInput, + input: GetTimesheetSummaryInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, @@ -821,6 +999,23 @@ async def get_timesheet_summary_async( Get Timesheet Summary Get Timesheet Summary from Replicon + + Swagger operation ID: `GetTimesheetSummary`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + host_url: Replicon Host Url. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -834,7 +1029,7 @@ async def get_timesheet_summary_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -848,6 +1043,7 @@ async def get_timesheet_summary_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -855,9 +1051,9 @@ async def get_timesheet_summary_async( return json.loads(response.text) - async def bulk_get_time_entered_summary_async( + async def bulk_get_time_entered_summary( self, - input: BulkGetTimeEnteredSummaryInput, + input: BulkGetTimeEnteredSummaryInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, @@ -869,6 +1065,23 @@ async def bulk_get_time_entered_summary_async( Get Time Entered Summary Get Time Entered by Task Uri from Replicon + + Swagger operation ID: `BulkGetTimeEnteredSummary`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + host_url: Replicon Host Url. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -882,7 +1095,7 @@ async def bulk_get_time_entered_summary_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -896,6 +1109,7 @@ async def bulk_get_time_entered_summary_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -903,9 +1117,9 @@ async def bulk_get_time_entered_summary_async( return json.loads(response.text) - async def put_project_team_member_assignments_async( + async def put_project_team_member_assignments( self, - input: PutProjectTeamMemberAssignmentsInput, + input: PutProjectTeamMemberAssignmentsInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, @@ -917,6 +1131,23 @@ async def put_project_team_member_assignments_async( Put Project Team Member Assignments Rewrite Team Member assignment of Project + + Swagger operation ID: `PutProjectTeamMemberAssignments`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + host_url: Replicon Host Url. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -930,7 +1161,7 @@ async def put_project_team_member_assignments_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -944,11 +1175,12 @@ async def put_project_team_member_assignments_async( request_url, response.status, response.text, + response=response, ) - async def put_resource_assignments_async( + async def put_resource_assignments( self, - input: PutResourceAssignmentsInput, + input: PutResourceAssignmentsInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, @@ -960,6 +1192,23 @@ async def put_resource_assignments_async( Rewrite Resource Assignment of a task Update the Resource assignment to a specified task + + Swagger operation ID: `PutResourceAssignments`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + host_url: Replicon Host Url. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -973,7 +1222,7 @@ async def put_resource_assignments_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -987,9 +1236,10 @@ async def put_resource_assignments_async( request_url, response.status, response.text, + response=response, ) - async def get_my_tenant_endpoint_details_async( + async def get_my_tenant_endpoint_details( self, *, timeout: Optional[float] = None, @@ -1001,13 +1251,27 @@ async def get_my_tenant_endpoint_details_async( Get Tenant End Point Details Get End Point Details of the Tenant + + Swagger operation ID: `GetMyTenantEndpointDetails`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/DiscoveryService1.svc/GetMyTenantEndpointDetails" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1021,6 +1285,7 @@ async def get_my_tenant_endpoint_details_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/revai.py b/src/azure/connectors/revai.py index 9050c6e0..352dd27e 100644 --- a/src/azure/connectors/revai.py +++ b/src/azure/connectors/revai.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,37 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "RevaiClient", + "AccountGetResponse", + "AlignmentGetResponse", + "AlignmentInput", + "AlignmentPostResponse", + "AlignmentTranscriptGetResponse", + "AnalysisGetResponse", + "AnalysisInput", + "AnalysisPostResponse", + "AnalysisResultGetResponse", + "ExtractionGetResponse", + "ExtractionInput", + "ExtractionPostResponse", + "ExtractionResultGetResponse", + "IdentificationGetResponse", + "IdentificationInput", + "IdentificationPostResponse", + "IdentificationResultGetResponse", + "TranscriptGetResponse", + "TranscriptionGetResponse", + "TranscriptionInput", + "TranscriptionPostResponse", + "VocabularyGetResponse", + "VocabularyInput", + "VocabularyPostResponse", +] + # Type Definitions @@ -29,15 +59,15 @@ class TranscriptionGetResponse: Response for Get transcription job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - transcriber: Optional[str] = None + transcriber: Optional[str] = dataclass_field(default=None, kw_only=True) """The transcriber.""" @@ -47,42 +77,57 @@ class TranscriptionInput: Submit transcription job """ - source_config: Optional[Dict[str, Any]] = None - metadata: Optional[str] = None + source_config: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + metadata: Optional[str] = dataclass_field(default=None, kw_only=True) """The metadata.""" - notification_config: Optional[Dict[str, Any]] = None - delete_after_seconds: Optional[int] = None + notification_config: Dict[str, Any] + delete_after_seconds: Optional[int] = dataclass_field(default=None, kw_only=True) """The delete after seconds.""" - transcriber: Optional[str] = None + transcriber: Optional[str] = dataclass_field(default=None, kw_only=True) """The transcriber.""" - verbatim: Optional[bool] = None + verbatim: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether verbatim.""" - rush: Optional[bool] = None + rush: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to rush.""" - test_mode: Optional[bool] = None + test_mode: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether test mode.""" - segments_to_transcribe: Optional[List[Dict[str, Any]]] = None - speakers_names: Optional[List[Dict[str, Any]]] = None - skip_diarization: Optional[bool] = None + segments_to_transcribe: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + speakers_names: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + skip_diarization: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to skip diarization.""" - skip_postprocessing: Optional[bool] = None + skip_postprocessing: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to skip postprocessing.""" - skip_punctuation: Optional[bool] = None + skip_punctuation: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to skip punctuations.""" - remove_disfluencies: Optional[bool] = None + remove_disfluencies: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to remove disfluencies.""" - remove_atmospherics: Optional[bool] = None + remove_atmospherics: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to remove atmospherics.""" - filter_profanity: Optional[bool] = None + filter_profanity: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether to filter profanity.""" - speaker_channels_count: Optional[int] = None + speaker_channels_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The speaker channels count.""" - speakers_count: Optional[int] = None + speakers_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The speakers count.""" - custom_vocabulary_id: Optional[str] = None + custom_vocabulary_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The custom vocabulary identifier.""" - custom_vocabularies: Optional[List[Dict[str, Any]]] = None - language: Optional[str] = None + custom_vocabularies: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language.""" @@ -92,15 +137,15 @@ class TranscriptionPostResponse: Response for Submit transcription job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - transcriber: Optional[str] = None + transcriber: Optional[str] = dataclass_field(default=None, kw_only=True) """The transcriber.""" @@ -110,7 +155,7 @@ class TranscriptGetResponse: Response for Get transcript """ - monologues: Optional[List[Dict[str, Any]]] = None + monologues: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -119,19 +164,19 @@ class AccountGetResponse: Response for Get account """ - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address.""" - free_balance: Optional[float] = None + free_balance: Optional[float] = dataclass_field(default=None, kw_only=True) """The free balance.""" - purchased_balance: Optional[float] = None + purchased_balance: Optional[float] = dataclass_field(default=None, kw_only=True) """The purchased balance.""" - total_balance: Optional[int] = None + total_balance: Optional[int] = dataclass_field(default=None, kw_only=True) """The total balance.""" - invoiced_balance: Optional[float] = None + invoiced_balance: Optional[float] = dataclass_field(default=None, kw_only=True) """The invoiced balance.""" - balance_seconds: Optional[int] = None + balance_seconds: Optional[int] = dataclass_field(default=None, kw_only=True) """The balance seconds.""" - hipaa_enabled: Optional[bool] = None + hipaa_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether HIPAA is enabled.""" @@ -141,10 +186,15 @@ class VocabularyInput: Submit custom vocabulary """ - metadata: Optional[str] = None + metadata: Optional[str] = dataclass_field(default=None, kw_only=True) """The metadata.""" - notification_config: Optional[Dict[str, Any]] = None - custom_vocabularies: Optional[List[Dict[str, Any]]] = None + notification_config: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + custom_vocabularies: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -153,13 +203,13 @@ class VocabularyPostResponse: Response for Submit custom vocabulary """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - callback_url: Optional[str] = None + callback_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The callback URL address.""" @@ -169,13 +219,13 @@ class VocabularyGetResponse: Response for Get vocabulary """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - callback_url: Optional[str] = None + callback_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The callback URL address.""" @@ -185,14 +235,14 @@ class ExtractionInput: Submit topic extraction job """ - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language.""" - metadata: Optional[str] = None + metadata: Optional[str] = dataclass_field(default=None, kw_only=True) """The metadata.""" - notification_config: Optional[Dict[str, Any]] = None - delete_after_seconds: Optional[int] = None + notification_config: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + delete_after_seconds: Optional[int] = dataclass_field(default=None, kw_only=True) """The delete after seconds.""" - json: Optional[Dict[str, Any]] = None + json: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -201,15 +251,19 @@ class ExtractionPostResponse: Response for Submit topic extraction job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" @@ -219,15 +273,19 @@ class ExtractionGetResponse: Response for Get topic extraction job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" @@ -237,7 +295,7 @@ class ExtractionResultGetResponse: Response for Get topic extraction result """ - topics: Optional[List[Dict[str, Any]]] = None + topics: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -246,14 +304,14 @@ class AnalysisInput: Submit sentiment analysis job """ - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language.""" - metadata: Optional[str] = None + metadata: Optional[str] = dataclass_field(default=None, kw_only=True) """The metadata.""" - notification_config: Optional[Dict[str, Any]] = None - delete_after_seconds: Optional[int] = None + notification_config: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + delete_after_seconds: Optional[int] = dataclass_field(default=None, kw_only=True) """The delete after seconds.""" - json: Optional[Dict[str, Any]] = None + json: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -262,17 +320,21 @@ class AnalysisPostResponse: Response for Submit sentiment analysis job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - callback_url: Optional[str] = None + callback_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The callback URL address.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" @@ -282,17 +344,21 @@ class AnalysisGetResponse: Response for Get sentiment analysis job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - callback_url: Optional[str] = None + callback_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The callback URL address.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" @@ -302,7 +368,7 @@ class AnalysisResultGetResponse: Response for Get sentiment analysis result """ - messages: Optional[List[Dict[str, Any]]] = None + messages: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -311,12 +377,12 @@ class IdentificationInput: Submit language identification job """ - metadata: Optional[str] = None + metadata: Optional[str] = dataclass_field(default=None, kw_only=True) """The metadata.""" - notification_config: Optional[Dict[str, Any]] = None - delete_after_seconds: Optional[int] = None + notification_config: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + delete_after_seconds: Optional[int] = dataclass_field(default=None, kw_only=True) """The delete after seconds.""" - source_config: Optional[Dict[str, Any]] = None + source_config: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -325,13 +391,17 @@ class IdentificationPostResponse: Response for Submit language identification job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" @@ -341,13 +411,17 @@ class IdentificationGetResponse: Response for Get language identification job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" @@ -357,9 +431,14 @@ class IdentificationResultGetResponse: Response for Get language identification result """ - top_language: Optional[str] = None + top_language: Optional[str] = dataclass_field(default=None, kw_only=True) """The top language.""" - language_confidences: Optional[List[Dict[str, Any]]] = None + language_confidences: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -368,15 +447,15 @@ class AlignmentInput: Submit forced alignment job """ - metadata: Optional[str] = None + metadata: Optional[str] = dataclass_field(default=None, kw_only=True) """The metadata.""" - notification_config: Optional[Dict[str, Any]] = None - delete_after_seconds: Optional[int] = None + notification_config: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + delete_after_seconds: Optional[int] = dataclass_field(default=None, kw_only=True) """The delete after seconds.""" - source_config: Optional[Dict[str, Any]] = None - transcript_text: Optional[str] = None + source_config: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + transcript_text: Optional[str] = dataclass_field(default=None, kw_only=True) """The transcript text.""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The language.""" @@ -386,13 +465,17 @@ class AlignmentPostResponse: Response for Submit forced alignment job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" @@ -402,13 +485,17 @@ class AlignmentGetResponse: Response for Get forced alignment job """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """When created on.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" @@ -418,7 +505,7 @@ class AlignmentTranscriptGetResponse: Response for Get forced alignment transcript """ - monologues: Optional[List[Dict[str, Any]]] = None + monologues: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) # Client Class @@ -432,7 +519,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -449,8 +536,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -471,7 +558,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -486,7 +573,84 @@ def __init__( def connector_name(self) -> str: return "revai" - async def transcription_get_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def transcription_get( self, id: str, *, @@ -499,13 +663,28 @@ async def transcription_get_async( Get transcription job Returns information about a transcription job. + + Swagger operation ID: `TranscriptionGet`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/speechtotext/v1/jobs/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -519,6 +698,7 @@ async def transcription_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -526,7 +706,7 @@ async def transcription_get_async( return json.loads(response.text) - async def transcription_delete_async( + async def transcription_delete( self, id: str, *, @@ -541,13 +721,28 @@ async def transcription_delete_async( Deletes a transcription job. All data related to the job, such as input media and transcript, will be permanently deleted. A job can only be deleted once it's completed (either with success or failure). + + Swagger operation ID: `TranscriptionDelete`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/speechtotext/v1/jobs/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -561,6 +756,7 @@ async def transcription_delete_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -568,21 +764,40 @@ async def transcription_delete_async( return json.loads(response.text) - async def transcriptions_get_async( + def list_transcriptions_get( self, + *, limit: Optional[int] = None, starting_after: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get transcription job list Retrieve a list of transcription jobs submitted within the last 30 days. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `TranscriptionsGet`. + + Args: + limit: The limit. + starting_after: The starting after. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/speechtotext/v1/jobs" query_params = [] @@ -598,31 +813,52 @@ async def transcriptions_get_async( query_params.append(f"starting_after={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def transcription_async( + return AsyncItemPaged(get_next, extract_data) + + async def transcription( self, - input: TranscriptionInput, + input: TranscriptionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -634,10 +870,26 @@ async def transcription_async( Starts an asynchronous job to transcribe speech-to-text for a media file. + + Swagger operation ID: `TranscriptionPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/speechtotext/v1/jobs" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -651,6 +903,7 @@ async def transcription_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -658,7 +911,7 @@ async def transcription_async( return json.loads(response.text) - async def transcript_get_async( + def list_transcript_get( self, id: str, *, @@ -666,39 +919,78 @@ async def transcript_get_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get transcript Returns the transcript for a completed transcription job. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `TranscriptGet`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/speechtotext/v1/jobs/{quote(str(id), safe='')}/transcript" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("monologues", []): + yield item + + return None, items() - async def captions_get_async( + return AsyncItemPaged(get_next, extract_data) + + async def captions_get( self, id: str, *, @@ -712,13 +1004,28 @@ async def captions_get_async( Returns the caption output for a transcription job. We currently support the SubRip (SRT) format. + + Swagger operation ID: `CaptionsGet`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/speechtotext/v1/jobs/{quote(str(id), safe='')}/captions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -732,6 +1039,7 @@ async def captions_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -739,7 +1047,7 @@ async def captions_get_async( return json.loads(response.text) - async def account_get_async( + async def account_get( self, *, timeout: Optional[float] = None, @@ -751,10 +1059,24 @@ async def account_get_async( Get account Get the developer's account information. + + Swagger operation ID: `AccountGet`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/speechtotext/v1/account" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -768,6 +1090,7 @@ async def account_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -775,20 +1098,38 @@ async def account_get_async( return json.loads(response.text) - async def vocabularies_get_async( + def list_vocabularies_get( self, - limit: Optional[int] = None, *, + limit: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get list of vocabularies Retrieves a list of most recent custom vocabularies' processing information. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `VocabulariesGet`. + + Args: + limit: The limit. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/speechtotext/v1/vocabularies" @@ -801,31 +1142,52 @@ async def vocabularies_get_async( query_params.append(f"limit={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def vocabulary_async( + return AsyncItemPaged(get_next, extract_data) + + async def vocabulary( self, - input: VocabularyInput, + input: VocabularyInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -836,12 +1198,28 @@ async def vocabulary_async( Submit custom vocabulary Submits a Custom Vocabulary for asynchronous processing. + + Swagger operation ID: `VocabularyPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/speechtotext/v1/vocabularies" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -855,6 +1233,7 @@ async def vocabulary_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -862,7 +1241,7 @@ async def vocabulary_async( return json.loads(response.text) - async def vocabulary_get_async( + async def vocabulary_get( self, id: str, *, @@ -875,13 +1254,28 @@ async def vocabulary_get_async( Get vocabulary Retrieve a custom vocabulary processing information. + + Swagger operation ID: `VocabularyGet`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/speechtotext/v1/vocabularies/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -895,6 +1289,7 @@ async def vocabulary_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -902,7 +1297,7 @@ async def vocabulary_get_async( return json.loads(response.text) - async def vocabulary_delete_async( + async def vocabulary_delete( self, id: str, *, @@ -916,13 +1311,28 @@ async def vocabulary_delete_async( Deletes a custom vocabulary. All data related to the custom vocabulary, such as webhooks and metadata, will be permanently deleted. + + Swagger operation ID: `VocabularyDelete`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/speechtotext/v1/vocabularies/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -936,6 +1346,7 @@ async def vocabulary_delete_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -943,21 +1354,40 @@ async def vocabulary_delete_async( return json.loads(response.text) - async def extractions_get_async( + def list_extractions_get( self, + *, limit: Optional[int] = None, starting_after: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get topic extraction jobs Retrieves a list of topic extraction jobs submitted within the last 30 days in reverse chronological order. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ExtractionsGet`. + + Args: + limit: The limit. + starting_after: The starting after. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/topic_extraction/v1/jobs" @@ -975,31 +1405,52 @@ async def extractions_get_async( query_params.append(f"starting_after={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def extraction_async( + return AsyncItemPaged(get_next, extract_data) + + async def extraction( self, - input: ExtractionInput, + input: ExtractionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1010,12 +1461,28 @@ async def extraction_async( Submit topic extraction job Starts an asynchronous job to extract topics from a transcript. + + Swagger operation ID: `ExtractionPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/topic_extraction/v1/jobs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1029,6 +1496,7 @@ async def extraction_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1036,7 +1504,7 @@ async def extraction_async( return json.loads(response.text) - async def extraction_get_async( + async def extraction_get( self, id: str, *, @@ -1049,13 +1517,28 @@ async def extraction_get_async( Get topic extraction job Returns information about a topic extraction job. + + Swagger operation ID: `ExtractionGet`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/topic_extraction/v1/jobs/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1069,6 +1552,7 @@ async def extraction_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1076,7 +1560,7 @@ async def extraction_get_async( return json.loads(response.text) - async def extraction_delete_async( + async def extraction_delete( self, id: str, *, @@ -1090,13 +1574,28 @@ async def extraction_delete_async( Deletes a topic extraction job. All data related to the job will be permanently deleted. + + Swagger operation ID: `ExtractionDelete`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/topic_extraction/v1/jobs/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1110,6 +1609,7 @@ async def extraction_delete_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1117,20 +1617,39 @@ async def extraction_delete_async( return json.loads(response.text) - async def extraction_result_get_async( + def list_extraction_result_get( self, id: str, - threshold: Optional[float] = None, *, + threshold: Optional[float] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get topic extraction result Returns the results for a completed topic extraction job. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ExtractionResultGet`. + + Args: + id: The identifier. + threshold: The threshold. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1144,33 +1663,54 @@ async def extraction_result_get_async( query_params.append(f"threshold={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("topics", []): + yield item + + return None, items() - async def analysises_get_async( + return AsyncItemPaged(get_next, extract_data) + + async def analysises_get( self, + *, limit: Optional[int] = None, starting_after: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1181,6 +1721,22 @@ async def analysises_get_async( Gets a list of sentiment analysis jobs submitted within the last 30 days in reverse chronological order. + + Swagger operation ID: `AnalysisesGet`. + + Args: + limit: The limit. + starting_after: The starting after. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/sentiment_analysis/v1/jobs" @@ -1199,7 +1755,7 @@ async def analysises_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1213,11 +1769,12 @@ async def analysises_get_async( request_url, response.status, response.text, + response=response, ) - async def analysis_async( + async def analysis( self, - input: AnalysisInput, + input: AnalysisInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1228,12 +1785,28 @@ async def analysis_async( Submit sentiment analysis job Starts an asynchronous job to analyze sentiments in a transcript. + + Swagger operation ID: `AnalysisPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/sentiment_analysis/v1/jobs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1247,6 +1820,7 @@ async def analysis_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1254,7 +1828,7 @@ async def analysis_async( return json.loads(response.text) - async def analysis_get_async( + async def analysis_get( self, id: str, *, @@ -1267,13 +1841,28 @@ async def analysis_get_async( Get sentiment analysis job Returns information about a sentiment analysis job. + + Swagger operation ID: `AnalysisGet`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/sentiment_analysis/v1/jobs/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1287,6 +1876,7 @@ async def analysis_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1294,7 +1884,7 @@ async def analysis_get_async( return json.loads(response.text) - async def analysis_delete_async( + async def analysis_delete( self, id: str, *, @@ -1308,13 +1898,28 @@ async def analysis_delete_async( Deletes a sentiment analysis job. All data related to the job will be permanently deleted. + + Swagger operation ID: `AnalysisDelete`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/sentiment_analysis/v1/jobs/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1328,6 +1933,7 @@ async def analysis_delete_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1335,20 +1941,39 @@ async def analysis_delete_async( return json.loads(response.text) - async def analysis_result_get_async( + def list_analysis_result_get( self, id: str, - filter_for: Optional[str] = None, *, + filter_for: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get sentiment analysis result Returns the results for a completed sentiment analysis job. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `AnalysisResultGet`. + + Args: + id: The identifier. + filter_for: The filter for. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1362,43 +1987,83 @@ async def analysis_result_get_async( query_params.append(f"filter_for={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("messages", []): + yield item - async def identifications_get_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_identifications_get( self, + *, limit: Optional[int] = None, starting_after: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get language identification jobs Retrieves a list of language identification jobs submitted within the last 30 days in reverse chronological order. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `IdentificationsGet`. + + Args: + limit: The limit. + starting_after: The starting after. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/languageid/v1/jobs" query_params = [] @@ -1414,31 +2079,52 @@ async def identifications_get_async( query_params.append(f"starting_after={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def identification_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def identification( self, - input: IdentificationInput, + input: IdentificationInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1450,10 +2136,26 @@ async def identification_async( Starts an asynchronous job to identify the most probable language in the audio. + + Swagger operation ID: `IdentificationPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/languageid/v1/jobs" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1467,6 +2169,7 @@ async def identification_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1474,7 +2177,7 @@ async def identification_async( return json.loads(response.text) - async def identification_get_async( + async def identification_get( self, id: str, *, @@ -1487,13 +2190,28 @@ async def identification_get_async( Get language identification job Returns information about a language identification job. + + Swagger operation ID: `IdentificationGet`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/languageid/v1/jobs/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1507,6 +2225,7 @@ async def identification_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1514,7 +2233,7 @@ async def identification_get_async( return json.loads(response.text) - async def identification_delete_async( + async def identification_delete( self, id: str, *, @@ -1528,13 +2247,28 @@ async def identification_delete_async( Deletes a language identification job. All data related to the job will be permanently deleted. + + Swagger operation ID: `IdentificationDelete`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/languageid/v1/jobs/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1548,6 +2282,7 @@ async def identification_delete_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1555,7 +2290,7 @@ async def identification_delete_async( return json.loads(response.text) - async def identification_result_get_async( + async def identification_result_get( self, id: str, *, @@ -1568,13 +2303,28 @@ async def identification_result_get_async( Get language identification result Returns the results for a completed language identification job. + + Swagger operation ID: `IdentificationResultGet`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/languageid/v1/jobs/{quote(str(id), safe='')}/result" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1588,6 +2338,7 @@ async def identification_result_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1595,21 +2346,40 @@ async def identification_result_get_async( return json.loads(response.text) - async def alignments_get_async( + def list_alignments_get( self, + *, limit: Optional[int] = None, starting_after: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get forced alignment jobs Retrieve a list of alignment jobs submitted within the last 30 days in reverse chronological order. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `AlignmentsGet`. + + Args: + limit: The limit. + starting_after: The starting after. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/alignment/v1/jobs" query_params = [] @@ -1625,31 +2395,52 @@ async def alignments_get_async( query_params.append(f"starting_after={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def alignment_async( + return AsyncItemPaged(get_next, extract_data) + + async def alignment( self, - input: AlignmentInput, + input: AlignmentInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1661,10 +2452,26 @@ async def alignment_async( Starts an asynchronous job to obtain precise word timings for an audio file and text transcript. + + Swagger operation ID: `AlignmentPost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/alignment/v1/jobs" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1678,6 +2485,7 @@ async def alignment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1685,7 +2493,7 @@ async def alignment_async( return json.loads(response.text) - async def alignment_get_async( + async def alignment_get( self, id: str, *, @@ -1698,13 +2506,28 @@ async def alignment_get_async( Get forced alignment job Returns information about a forced alignment job. + + Swagger operation ID: `AlignmentGet`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/alignment/v1/jobs/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1718,6 +2541,7 @@ async def alignment_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1725,7 +2549,7 @@ async def alignment_get_async( return json.loads(response.text) - async def alignment_delete_async( + async def alignment_delete( self, id: str, *, @@ -1739,13 +2563,28 @@ async def alignment_delete_async( Deletes a forced alignment job. All data related to the job will be permanently deleted. + + Swagger operation ID: `AlignmentDelete`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/alignment/v1/jobs/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1759,6 +2598,7 @@ async def alignment_delete_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1766,7 +2606,7 @@ async def alignment_delete_async( return json.loads(response.text) - async def alignment_transcript_get_async( + def list_alignment_transcript_get( self, id: str, *, @@ -1774,34 +2614,73 @@ async def alignment_transcript_get_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get forced alignment transcript Returns the results for a completed forced alignment job. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `AlignmentTranscriptGet`. + + Args: + id: The identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/alignment/v1/jobs/{quote(str(id), safe='')}/transcript" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("monologues", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/rss.py b/src/azure/connectors/rss.py index 06bcf434..80420ca9 100644 --- a/src/azure/connectors/rss.py +++ b/src/azure/connectors/rss.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,16 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "RssClient", + "FeedItem", + "TriggerBatchResponseFeedItem", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +38,12 @@ class TriggerBatchResponseFeedItem: Response for When a feed item is published """ - value: Optional[List[FeedItem]] = None + value: Optional[ + List[FeedItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of the response objects""" @@ -39,32 +53,35 @@ class FeedItem: Response for List all RSS feed items """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Feed ID""" - title: Optional[str] = None + title: str """Feed title""" - primary_link: Optional[str] = field( + primary_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "primaryLink"}, ) """Primary feed link""" - links: Optional[List[str]] = None + links: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Feed links""" - updated_on: Optional[str] = field( + updated_on: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "updatedOn"}, ) """Feed updated on""" - publish_date: Optional[str] = field( + publish_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "publishDate"}, ) """Feed published date""" - summary: Optional[str] = None + summary: Optional[str] = dataclass_field(default=None, kw_only=True) """Feed item summary""" - copyright: Optional[str] = None + copyright: Optional[str] = dataclass_field(default=None, kw_only=True) """Copyright information""" - categories: Optional[List[str]] = None + categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Feed item categories""" @@ -79,7 +96,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -96,8 +113,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -118,7 +135,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -133,21 +150,120 @@ def __init__( def connector_name(self) -> str: return "rss" - async def list_feed_items_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_feed_items( self, feed_url: str, + *, since: Optional[str] = None, since_property: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all RSS feed items This operation retrieves all items from an RSS feed. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListFeedItems`. + + Args: + feed_url: The RSS feed URL (Example: + http://rss.cnn.com/rss/cnn_topstories.rss). + since: The date since when RSS feed should be retrieved (Example: + 2018-12-29 10:24:05Z). + since_property: Chosen property will be used for trigger state. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/ListFeedItems" query_params = [] @@ -167,27 +283,48 @@ async def list_feed_items_async( query_params.append(f"sinceProperty={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) + + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - return json.loads(response.text) + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/salesforce.py b/src/azure/connectors/salesforce.py index 24491305..61c41963 100644 --- a/src/azure/connectors/salesforce.py +++ b/src/azure/connectors/salesforce.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,56 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "SalesforceClient", + "BlobDataSetsMetadata", + "CheckJobResponse", + "CloseJobRequest", + "CreateJobParameters", + "CreateJobRequest", + "CreateJobResponse", + "DataSet", + "DataSetsList", + "DataSetsMetadata", + "ExecuteSoqlQueryParameters", + "ExternalIdField", + "ExternalIdFieldsList", + "GetAllJobsResponse", + "GetCurrentUserInfoResponse", + "GetItemByExternalIdResponse", + "GetItemResponse", + "InstanceUrlResponse", + "Item", + "ItemsList", + "JobInfo", + "MCPQueryRequest", + "MCPQueryResponse", + "ObjectEntity", + "ObjectWithoutType", + "PassThroughNativeQuery", + "PatchItemByExternalIdInput", + "PatchItemByExternalIdResponse", + "PatchItemInput", + "PatchItemResponse", + "PostItemInput", + "PostItemResponse", + "Procedure", + "SOSLSearchQueryResponse", + "SearchRecordObject", + "Table", + "TableCapabilitiesMetadata", + "TableFilterRestrictionsMetadata", + "TableMetadata", + "TableSelectRestrictionsMetadata", + "TableSortRestrictionsMetadata", + "TablesList", + "TabularDataSetsMetadata", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,10 +78,16 @@ class TablesList: Response for Get object types """ - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Tables""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -44,7 +99,7 @@ class GetItemByExternalIdResponse: Response for Get a Record by External ID """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -57,10 +112,16 @@ class ItemsList: Response for Get records """ - value: Optional[List[Item]] = None + value: Optional[ + List[Item | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -72,7 +133,7 @@ class ObjectEntity: Response for Execute a SOQL query """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -85,11 +146,17 @@ class GetAllJobsResponse: Response for Get all jobs """ - done: Optional[bool] = None + done: Optional[bool] = dataclass_field(default=None, kw_only=True) """Done""" - records: Optional[List[JobInfo]] = None - next_record_url: Optional[str] = field( + records: Optional[ + List[JobInfo | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, + ) + next_record_url: Optional[str] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "nextRecordUrl"}, ) """Next Record URL""" @@ -101,82 +168,96 @@ class CheckJobResponse: Response for Get job info """ - apex_processing_time: Optional[float] = field( + apex_processing_time: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "apexProcessingTime"}, ) """APEX Processing Time""" - api_active_processing_time: Optional[float] = field( + api_active_processing_time: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "apiActiveProcessingTime"}, ) """API Active Processing Time""" - api_version: Optional[float] = field( + api_version: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "apiVersion"}, ) """API Version""" - column_delimiter: Optional[str] = field( + column_delimiter: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnDelimiter"}, ) """Column Delimiter""" - concurrency_mode: Optional[str] = field( + concurrency_mode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "concurrencyMode"}, ) """Concurrency Mode""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """Content Type""" - content_url: Optional[str] = field( + content_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentUrl"}, ) """Content URL""" - created_by_id: Optional[str] = field( + created_by_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdById"}, ) """Created By ID""" - created_date: Optional[str] = field( + created_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDate"}, ) """Created Date""" - external_field_name: Optional[str] = field( + external_field_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "externalFieldName"}, ) """External Field Name""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID""" - job_type: Optional[str] = field( + job_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobType"}, ) """Job Type""" - line_ending: Optional[str] = field( + line_ending: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineEnding"}, ) """Line Ending""" - object: Optional[str] = None + object: Optional[str] = dataclass_field(default=None, kw_only=True) """Object""" - operation: Optional[str] = None + operation: Optional[str] = dataclass_field(default=None, kw_only=True) """Operation""" - retries: Optional[float] = None + retries: Optional[float] = dataclass_field(default=None, kw_only=True) """Retries""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """State""" - system_mod_stamp: Optional[str] = field( + system_mod_stamp: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "systemModStamp"}, ) - total_processing_time: Optional[float] = field( + total_processing_time: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "totalProcessingTime"}, ) """Total Processing Time""" @@ -188,66 +269,77 @@ class JobInfo: Response for Close or abort a job """ - api_version: Optional[float] = field( + api_version: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "apiVersion"}, ) """API Version""" - column_delimiter: Optional[str] = field( + column_delimiter: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnDelimiter"}, ) """Column Delimiter""" - concurrency_mode: Optional[str] = field( + concurrency_mode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "concurrencyMode"}, ) """Concurrency Mode""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """Content Type""" - content_url: Optional[str] = field( + content_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentUrl"}, ) """Content URL""" - created_by_id: Optional[str] = field( + created_by_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdById"}, ) """Created By ID""" - created_date: Optional[str] = field( + created_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDate"}, ) """Created Date""" - external_id_field_name: Optional[str] = field( + external_id_field_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "externalIdFieldName"}, ) """External ID Field Name""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID""" - job_type: Optional[str] = field( + job_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobType"}, ) """Job Type""" - line_ending: Optional[str] = field( + line_ending: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineEnding"}, ) """Line Ending""" - object: Optional[str] = None + object: Optional[str] = dataclass_field(default=None, kw_only=True) """Object""" - operation: Optional[str] = None + operation: Optional[str] = dataclass_field(default=None, kw_only=True) """Operation""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """State""" - system_modstamp: Optional[str] = field( + system_modstamp: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "systemModstamp"}, ) """System Mod Stamp""" @@ -259,12 +351,13 @@ class SOSLSearchQueryResponse: Response for Execute SOSL search query """ - search_records: Optional[List[SearchRecordObject]] = field( + search_records: Optional[List[SearchRecordObject | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "searchRecords"}, ) """A list of search records returned by an SOSL search query""" - metadata: Optional[Dict[str, Any]] = None + metadata: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Metadata of the result returned from the query""" @@ -274,7 +367,7 @@ class ObjectWithoutType: Response for Send an HTTP request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -287,12 +380,12 @@ class MCPQueryResponse: Response for MCP server for Salesforce """ - jsonrpc: Optional[str] = None - id: Optional[str] = None - method: Optional[str] = None - params: Optional[Dict[str, Any]] = None - result: Optional[Dict[str, Any]] = None - error: Optional[Dict[str, Any]] = None + jsonrpc: Optional[str] = dataclass_field(default=None, kw_only=True) + id: Optional[str] = dataclass_field(default=None, kw_only=True) + method: Optional[str] = dataclass_field(default=None, kw_only=True) + params: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + result: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + error: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -301,72 +394,83 @@ class CreateJobResponse: Response for Create a job """ - object: Optional[str] = None + object: Optional[str] = dataclass_field(default=None, kw_only=True) """The object type for the data being processed.""" - operation: Optional[str] = None + operation: Optional[str] = dataclass_field(default=None, kw_only=True) """The processing operation for the job.""" - column_delimiter: Optional[str] = field( + column_delimiter: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnDelimiter"}, ) """The column delimiter used for CSV job data.""" - external_id_field_name: Optional[str] = field( + external_id_field_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "externalIdFieldName"}, ) """ The external ID field in the object being updated. Only needed for upsert operations. Field values must also exist in CSV job data. """ - line_ending: Optional[str] = field( + line_ending: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineEnding"}, ) """The line ending used for CSV job data, marking the end of a data row.""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """The content type for the job.""" - api_version: Optional[float] = field( + api_version: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "apiVersion"}, ) """The API version that the job was created in.""" - concurrency_mode: Optional[str] = field( + concurrency_mode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "concurrencyMode"}, ) """The concurrency mode for the job.""" - content_url: Optional[str] = field( + content_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentUrl"}, ) """ The URL to use for Upload Job Data requests for this job. Only valid if the job is in 'Open' state. """ - created_by_id: Optional[str] = field( + created_by_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdById"}, ) """The ID of the user who created the job.""" - created_date: Optional[str] = field( + created_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDate"}, ) """The date and time in the UTC time zone when the job was created.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID for this job.""" - job_type: Optional[str] = field( + job_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "jobType"}, ) """The job's type.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The current state of processing for the job.""" - system_modstamp: Optional[str] = field( + system_modstamp: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "systemModstamp"}, ) """Date and time in the UTC time zone when the job finished.""" @@ -378,7 +482,7 @@ class GetItemResponse: Response for Get record """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -391,7 +495,7 @@ class PatchItemInput: Update record """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -404,7 +508,7 @@ class PatchItemResponse: Response for Update record """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -417,7 +521,7 @@ class PatchItemByExternalIdInput: Insert or Update (Upsert) a Record by External ID """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -430,7 +534,7 @@ class PatchItemByExternalIdResponse: Response for Insert or Update (Upsert) a Record by External ID """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -443,7 +547,7 @@ class PostItemInput: Create record """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -456,7 +560,7 @@ class PostItemResponse: Response for Create record """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -469,7 +573,12 @@ class ExternalIdFieldsList: Response for Get External ID Fields """ - value: Optional[List[ExternalIdField]] = None + value: Optional[ + List[ExternalIdField | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of external ID fields.""" @@ -479,26 +588,30 @@ class TableMetadata: Response for GetMetadataForGetItem """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Table name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Table title""" - x_ms_permission: Optional[str] = field( + x_ms_permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-permission"}, ) """Table permission""" - x_ms_capabilities: Optional[TableCapabilitiesMetadata] = field( + x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-capabilities"}, ) - schema: Optional[ObjectEntity] = None - referenced_entities: Optional[ObjectEntity] = field( + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referencedEntities"}, ) - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """URL link""" @@ -510,15 +623,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -530,30 +645,34 @@ class CreateJobParameters: Definition: CreateJobParameters """ - object: Optional[str] = None + object: str """The object type for the data being processed.""" - operation: Optional[str] = None + operation: str """The processing operation for the job.""" - column_delimiter: Optional[str] = field( + column_delimiter: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnDelimiter"}, ) """The column delimiter used for CSV job data.""" - external_id_field_name: Optional[str] = field( + external_id_field_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "externalIdFieldName"}, ) """ The external ID field in the object being updated. Only needed for upsert operations. Field values must also exist in CSV job data. """ - line_ending: Optional[str] = field( + line_ending: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineEnding"}, ) """The line ending used for CSV job data, marking the end of a data row.""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentType"}, ) """The content type for the job.""" @@ -565,14 +684,24 @@ class DataSet: Definition: DataSet """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Dataset name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Dataset display name""" - query: Optional[List[PassThroughNativeQuery]] = None + query: Optional[ + List[PassThroughNativeQuery | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Pass-through Native Queries""" @@ -582,7 +711,12 @@ class DataSetsList: Definition: DataSetsList """ - value: Optional[List[DataSet]] = None + value: Optional[ + List[DataSet | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of datasets""" @@ -592,8 +726,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -602,12 +746,12 @@ class ExecuteSoqlQueryParameters: Definition: ExecuteSoqlQueryParameters """ - query: Optional[str] = None + query: str """ SOQL Query text. Dynamic parameters can be specified using '@paramName' syntax. """ - parameters: Optional[Dict[str, str]] = None + parameters: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True) """ SOQL Query dynamic parameters. Key is parameter name (without '@' at sign), value is parameter value. @@ -620,10 +764,15 @@ class ExternalIdField: Definition: ExternalIdField """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Name of the external ID field, used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Display name of the external ID field.""" @@ -635,8 +784,9 @@ class Item: Definition: Item """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -647,8 +797,9 @@ class PassThroughNativeQuery: Definition: PassThroughNativeQuery """ - language: Optional[str] = field( + language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Language"}, ) """Query language""" @@ -660,10 +811,15 @@ class Procedure: Definition: Procedure """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Procedure name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Procedure display name""" @@ -675,15 +831,21 @@ class Table: Definition: Table """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the table. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the table.""" - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """Additional table properties provided by the connector to the clients.""" @@ -695,30 +857,42 @@ class TableCapabilitiesMetadata: Definition: TableCapabilitiesMetadata """ - sort_restrictions: Optional[TableSortRestrictionsMetadata] = field( + sort_restrictions: Optional[ + TableSortRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortRestrictions"}, ) - filter_restrictions: Optional[TableFilterRestrictionsMetadata] = field( + filter_restrictions: Optional[ + TableFilterRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterRestrictions"}, ) - select_restrictions: Optional[TableSelectRestrictionsMetadata] = field( + select_restrictions: Optional[ + TableSelectRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectRestrictions"}, ) - is_only_server_pagable: Optional[bool] = field( + is_only_server_pagable: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOnlyServerPagable"}, ) """Server paging restrictions""" - filter_function_support: Optional[List[str]] = field( + filter_function_support: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterFunctionSupport"}, ) """List of supported filter capabilities""" - server_paging_options: Optional[List[str]] = field( + server_paging_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serverPagingOptions"}, ) """List of supported server-driven paging capabilities""" @@ -730,15 +904,17 @@ class TableFilterRestrictionsMetadata: Definition: TableFilterRestrictionsMetadata """ - filterable: Optional[bool] = None + filterable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has filterable columns""" - non_filterable_properties: Optional[List[str]] = field( + non_filterable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nonFilterableProperties"}, ) """List of non filterable properties""" - required_properties: Optional[List[str]] = field( + required_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredProperties"}, ) """List of required properties""" @@ -750,7 +926,7 @@ class TableSelectRestrictionsMetadata: Definition: TableSelectRestrictionsMetadata """ - selectable: Optional[bool] = None + selectable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has selectable columns""" @@ -760,15 +936,17 @@ class TableSortRestrictionsMetadata: Definition: TableSortRestrictionsMetadata """ - sortable: Optional[bool] = None + sortable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has sortable columns""" - unsortable_properties: Optional[List[str]] = field( + unsortable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unsortableProperties"}, ) """List of unsortable properties""" - ascending_only_properties: Optional[List[str]] = field( + ascending_only_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ascendingOnlyProperties"}, ) """List of properties which support ascending order only""" @@ -780,25 +958,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -810,24 +992,27 @@ class CreateJobRequest: Definition: CreateJobRequest """ - column_delimiter: Optional[str] = field( + column_delimiter: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "columnDelimiter"}, ) """Column Delimiter""" - external_id_field_name: Optional[str] = field( + external_id_field_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "externalIdFieldName"}, ) """External ID Field Name""" - line_ending: Optional[str] = field( + line_ending: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lineEnding"}, ) """Line Ending""" - object: Optional[str] = None + object: str """Object""" - operation: Optional[str] = None + operation: str """Operation""" @@ -837,8 +1022,9 @@ class InstanceUrlResponse: Definition: InstanceUrlResponse """ - instance_url: Optional[str] = field( + instance_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "instanceUrl"}, ) """Instance Url""" @@ -850,7 +1036,7 @@ class GetCurrentUserInfoResponse: Definition: GetCurrentUserInfoResponse """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -863,9 +1049,13 @@ class SearchRecordObject: Definition: SearchRecordObject """ - attributes: Optional[Dict[str, Any]] = None + attributes: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Attributes of a search record""" - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Unique identifier of the record""" @@ -875,7 +1065,7 @@ class CloseJobRequest: Definition: CloseJobRequest """ - state: Optional[str] = None + state: str """state""" @@ -885,14 +1075,15 @@ class MCPQueryRequest: Definition: MCPQueryRequest """ - jsonrpc: Optional[str] = None - id: Optional[str] = None - method: Optional[str] = None - params: Optional[Dict[str, Any]] = None - result: Optional[Dict[str, Any]] = None - error: Optional[Dict[str, Any]] = None - callback_endpoint: Optional[str] = field( + jsonrpc: Optional[str] = dataclass_field(default=None, kw_only=True) + id: Optional[str] = dataclass_field(default=None, kw_only=True) + method: Optional[str] = dataclass_field(default=None, kw_only=True) + params: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + result: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + error: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + callback_endpoint: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callbackEndpoint"}, ) @@ -908,7 +1099,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -925,8 +1116,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -947,7 +1138,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -963,15 +1154,49 @@ def connector_name(self) -> str: return "salesforce" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -988,7 +1213,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -1001,28 +1230,50 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def get_tables_async( + def list_tables( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get object types This operation lists the available Salesforce object types. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetTables`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/datasets/default/tables" + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1035,23 +1286,32 @@ async def get_tables_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_item_by_external_id_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_item_by_external_id( self, table: str, external_id_field: str, @@ -1066,6 +1326,24 @@ async def get_item_by_external_id_async( Get a Record by External ID This operation retrieves a record using an external ID. + + Swagger operation ID: `GetItemByExternalId`. + + Args: + table: The Salesforce object type like 'Leads'. + external_id_field: Field marked as external ID field on Salesforce + object. + external_id: External ID of the record to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1078,7 +1356,7 @@ async def get_item_by_external_id_async( f"/{quote(quote(str(external_id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1092,6 +1370,7 @@ async def get_item_by_external_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1099,28 +1378,51 @@ async def get_item_by_external_id_async( return json.loads(response.text) - async def get_items_async( + def list_items( self, table: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get records This operation gets records of a certain Salesforce object type like 'Leads'. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems`. + + Args: + table: The Salesforce object type like 'Leads'. + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + select: Specific fields to retrieve from entries (default = all). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1158,11 +1460,18 @@ async def get_items_async( query_params.append(f"$select={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1175,42 +1484,73 @@ async def get_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_items_table_account_async( + return AsyncItemPaged(get_next, extract_data) + + def list_items_table_account( self, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Account records from Salesforce This operation gets Account records from Salesforce. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems_table_account`. + + Args: + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + select: Specific fields to retrieve from entries (default = all). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1244,11 +1584,18 @@ async def get_items_table_account_async( query_params.append(f"$select={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1261,42 +1608,73 @@ async def get_items_table_account_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_items_table_user_async( + def list_items_table_user( self, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get User records from Salesforce This operation gets User records from Salesforce. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems_table_user`. + + Args: + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + select: Specific fields to retrieve from entries (default = all). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1330,11 +1708,18 @@ async def get_items_table_user_async( query_params.append(f"$select={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1347,42 +1732,73 @@ async def get_items_table_user_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_items_table_case_async( + def list_items_table_case( self, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Case records from Salesforce This operation gets Case records from Salesforce. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems_table_case`. + + Args: + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + select: Specific fields to retrieve from entries (default = all). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1416,11 +1832,18 @@ async def get_items_table_case_async( query_params.append(f"$select={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1433,42 +1856,73 @@ async def get_items_table_case_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_items_table_opportunity_async( + return AsyncItemPaged(get_next, extract_data) + + def list_items_table_opportunity( self, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Opportunity records from Salesforce This operation gets Opportunity records from Salesforce. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems_table_opportunity`. + + Args: + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + select: Specific fields to retrieve from entries (default = all). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1502,11 +1956,18 @@ async def get_items_table_opportunity_async( query_params.append(f"$select={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1519,42 +1980,73 @@ async def get_items_table_opportunity_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_items_table_product2_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_items_table_product2( self, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Product records from Salesforce This operation gets Product records from Salesforce. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems_table_product2`. + + Args: + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + select: Specific fields to retrieve from entries (default = all). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1588,11 +2080,18 @@ async def get_items_table_product2_async( query_params.append(f"$select={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1605,42 +2104,73 @@ async def get_items_table_product2_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_items_table_contact_async( + return AsyncItemPaged(get_next, extract_data) + + def list_items_table_contact( self, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Contact records from Salesforce This operation gets Contact records from Salesforce. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems_table_contact`. + + Args: + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + skip: The number of entries to skip (default = 0). + select: Specific fields to retrieve from entries (default = all). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1674,11 +2204,18 @@ async def get_items_table_contact_async( query_params.append(f"$select={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1691,23 +2228,32 @@ async def get_items_table_contact_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def delete_item_async( + async def delete_item( self, table: str, id: str, @@ -1721,6 +2267,22 @@ async def delete_item_async( Delete record This operation deletes a record. + + Swagger operation ID: `DeleteItem`. + + Args: + table: The Salesforce object type like 'Leads'. + id: The unique identifier of record to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1732,7 +2294,7 @@ async def delete_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1746,11 +2308,12 @@ async def delete_item_async( request_url, response.status, response.text, + response=response, ) - async def execute_soql_query_async( + async def execute_soql_query( self, - input: ExecuteSoqlQueryParameters, + input: ExecuteSoqlQueryParameters | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1761,10 +2324,26 @@ async def execute_soql_query_async( Execute a SOQL query Execute a SOQL query. + + Swagger operation ID: `ExecuteSoqlQuery`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/soql/executesoqlquery" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1778,6 +2357,7 @@ async def execute_soql_query_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1785,22 +2365,43 @@ async def execute_soql_query_async( return json.loads(response.text) - async def get_all_jobs_async( + def list_all_jobs( self, + *, concurreny_mode: Optional[str] = None, is_pk_chunking_enabled: Optional[bool] = None, job_type: Optional[str] = None, query_locator: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all jobs Get a list of all jobs + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllJobs`. + + Args: + concurreny_mode: Concurrency Mode. + is_pk_chunking_enabled: Is PK Chunking Enabled. + job_type: Job Type. + query_locator: Query Locator. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/codeless/jobs/ingest" query_params = [] @@ -1826,29 +2427,50 @@ async def get_all_jobs_async( query_params.append(f"queryLocator={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def upload_job_data_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("records", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def upload_job_data( self, input: bytes, job_id: str, @@ -1862,13 +2484,29 @@ async def upload_job_data_async( Upload job data Uploads data for a job using CSV data. + + Swagger operation ID: `UploadJobData`. + + Args: + input: The binary request body. + job_id: Job ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/codeless/jobs/ingest/{quote(str(job_id), safe='')}/batches" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, @@ -1885,9 +2523,10 @@ async def upload_job_data_async( request_url, response.status, response.text, + response=response, ) - async def get_job_info_async( + async def get_job_info( self, job_id: str, *, @@ -1900,13 +2539,28 @@ async def get_job_info_async( Get job info Retrieves detailed information about a job. + + Swagger operation ID: `GetJobInfo`. + + Args: + job_id: Job ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/codeless/jobs/ingest/{quote(str(job_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1920,6 +2574,7 @@ async def get_job_info_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1927,9 +2582,9 @@ async def get_job_info_async( return json.loads(response.text) - async def close_job_async( + async def close_job( self, - input: CloseJobRequest, + input: CloseJobRequest | Mapping[str, Any], job_id: str, *, timeout: Optional[float] = None, @@ -1944,13 +2599,30 @@ async def close_job_async( to abort a job. If you close a job, Salesforce queues the job and uploaded data for processing, and you can't add any additional job data. If you abort a job, the job does not get queued or processed. + + Swagger operation ID: `CloseJob`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + job_id: Job ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/codeless/jobs/ingest/{quote(str(job_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1964,6 +2636,7 @@ async def close_job_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1971,7 +2644,7 @@ async def close_job_async( return json.loads(response.text) - async def delete_job_async( + async def delete_job( self, job_id: str, *, @@ -1985,13 +2658,28 @@ async def delete_job_async( Deletes a job. To be deleted, a job must have a state of UploadComplete, JobComplete, Aborted, or Failed. + + Swagger operation ID: `DeleteJob`. + + Args: + job_id: Job ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/codeless/jobs/ingest/{quote(str(job_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2005,9 +2693,10 @@ async def delete_job_async( request_url, response.status, response.text, + response=response, ) - async def get_job_record_results_async( + async def get_job_record_results( self, job_id: str, result_type: str, @@ -2022,6 +2711,22 @@ async def get_job_record_results_async( Retrieves a list of records based on the result type for a completed job. + + Swagger operation ID: `GetJobRecordResults`. + + Args: + job_id: Job ID. + result_type: Result Type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2035,7 +2740,7 @@ async def get_job_record_results_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2049,6 +2754,7 @@ async def get_job_record_results_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2056,7 +2762,7 @@ async def get_job_record_results_async( return json.loads(response.text) - async def execute_sosl_query_async( + async def execute_sosl_query( self, q: str, *, @@ -2069,6 +2775,21 @@ async def execute_sosl_query_async( Execute SOSL search query Execute the specified SOSL search qyery + + Swagger operation ID: `ExecuteSOSLQuery`. + + Args: + q: SOSL search string. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/codeless/search" query_params = [] @@ -2079,7 +2800,7 @@ async def execute_sosl_query_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2093,6 +2814,7 @@ async def execute_sosl_query_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2100,7 +2822,7 @@ async def execute_sosl_query_async( return json.loads(response.text) - async def http_request_async( + async def http_request( self, input: bytes, *, @@ -2113,10 +2835,25 @@ async def http_request_async( Send an HTTP request Construct a Salesforce REST API request to invoke + + Swagger operation ID: `HttpRequest`. + + Args: + input: The binary request body. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/codeless/httprequest" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -2133,6 +2870,7 @@ async def http_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2140,11 +2878,11 @@ async def http_request_async( return json.loads(response.text) - async def mcp_salesforce_management_async( + async def mcp_salesforce_management( self, - input: MCPQueryRequest, - session_id: Optional[str] = None, + input: MCPQueryRequest | Mapping[str, Any], *, + session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2154,6 +2892,23 @@ async def mcp_salesforce_management_async( MCP server for Salesforce MCP server for Salesforce + + Swagger operation ID: `mcp_SalesforceManagement`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + session_id: sessionId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/mcp/SalesforceManagement" @@ -2167,7 +2922,7 @@ async def mcp_salesforce_management_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2181,6 +2936,7 @@ async def mcp_salesforce_management_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2188,9 +2944,9 @@ async def mcp_salesforce_management_async( return json.loads(response.text) - async def create_job_async( + async def create_job( self, - input: CreateJobParameters, + input: CreateJobParameters | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -2203,10 +2959,26 @@ async def create_job_async( Creates a job, which represents a bulk operation (and associated data) that is sent to Salesforce for asynchronous processing. Provide job data via an Upload Job Data request. + + Swagger operation ID: `CreateJobV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/bulk/createjob" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2220,6 +2992,7 @@ async def create_job_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2227,12 +3000,12 @@ async def create_job_async( return json.loads(response.text) - async def get_item_async( + async def get_item( self, table: str, id: str, - select: Optional[str] = None, *, + select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2242,6 +3015,23 @@ async def get_item_async( Get record This operation gets a record. + + Swagger operation ID: `GetItem_V2`. + + Args: + table: table name. + id: item key. + select: Specific fields to retrieve from entries (default = all). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2262,7 +3052,7 @@ async def get_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2276,6 +3066,7 @@ async def get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2283,13 +3074,13 @@ async def get_item_async( return json.loads(response.text) - async def patch_item_async( + async def patch_item( self, - input: PatchItemInput, + input: PatchItemInput | Mapping[str, Any], table: str, id: str, - select: Optional[str] = None, *, + select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2299,6 +3090,25 @@ async def patch_item_async( Update record This operation updates a record and allows null values. + + Swagger operation ID: `PatchItem_V3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + table: table name. + id: item key. + select: Specific fields to retrieve from entries (default = all). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2319,7 +3129,7 @@ async def patch_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -2333,6 +3143,7 @@ async def patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2340,9 +3151,9 @@ async def patch_item_async( return json.loads(response.text) - async def patch_item_by_external_id_async( + async def patch_item_by_external_id( self, - input: PatchItemByExternalIdInput, + input: PatchItemByExternalIdInput | Mapping[str, Any], table: str, external_id_field: str, external_id: str, @@ -2357,6 +3168,26 @@ async def patch_item_by_external_id_async( This operation inserts or updates (upserts) a record using an external ID. + + Swagger operation ID: `PatchItemByExternalIdV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + table: The Salesforce object type like 'Leads'. + external_id_field: Field marked as external ID field on Salesforce + object. + external_id: External ID of the record to upsert. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2370,7 +3201,7 @@ async def patch_item_by_external_id_async( f"/{quote(quote(str(external_id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -2384,6 +3215,7 @@ async def patch_item_by_external_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2391,9 +3223,9 @@ async def patch_item_by_external_id_async( return json.loads(response.text) - async def post_item_async( + async def post_item( self, - input: PostItemInput, + input: PostItemInput | Mapping[str, Any], table: str, *, timeout: Optional[float] = None, @@ -2405,6 +3237,23 @@ async def post_item_async( Create record This operation creates a record and allows null values. + + Swagger operation ID: `PostItem_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + table: table name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2416,7 +3265,7 @@ async def post_item_async( f"/items" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2430,6 +3279,7 @@ async def post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2437,7 +3287,7 @@ async def post_item_async( return json.loads(response.text) - async def get_external_id_fields_async( + def list_external_id_fields( self, table: str, *, @@ -2445,11 +3295,29 @@ async def get_external_id_fields_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get External ID Fields This operation retrieves external ID fields of Salesforce object type. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetExternalIdFields`. + + Args: + table: The Salesforce object type like 'Leads'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2459,29 +3327,50 @@ async def get_external_id_fields_async( f"/{quote(quote(str(table), safe=''), safe='')}" f"/externalIdFields" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def get_metadata_for_get_item_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_metadata_for_get_item( self, table: str, *, @@ -2492,6 +3381,21 @@ async def get_metadata_for_get_item_async( ) -> dict[str, Any] | None: """ GetMetadataForGetItem + + Swagger operation ID: `GetMetadataForGetItem`. + + Args: + table: table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2503,7 +3407,7 @@ async def get_metadata_for_get_item_async( f"/getitem" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2517,6 +3421,7 @@ async def get_metadata_for_get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2524,7 +3429,7 @@ async def get_metadata_for_get_item_async( return json.loads(response.text) - async def get_metadata_for_patch_item_async( + async def get_metadata_for_patch_item( self, table: str, *, @@ -2535,6 +3440,21 @@ async def get_metadata_for_patch_item_async( ) -> dict[str, Any] | None: """ GetMetadataForPatchItem + + Swagger operation ID: `GetMetadataForPatchItem`. + + Args: + table: table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2546,7 +3466,7 @@ async def get_metadata_for_patch_item_async( f"/patchitem" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2560,6 +3480,7 @@ async def get_metadata_for_patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2567,7 +3488,7 @@ async def get_metadata_for_patch_item_async( return json.loads(response.text) - async def get_metadata_for_post_item_async( + async def get_metadata_for_post_item( self, table: str, *, @@ -2578,6 +3499,21 @@ async def get_metadata_for_post_item_async( ) -> dict[str, Any] | None: """ GetMetadataForPostItem + + Swagger operation ID: `GetMetadataForPostItem`. + + Args: + table: table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2589,7 +3525,7 @@ async def get_metadata_for_post_item_async( f"/postitem" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2603,6 +3539,7 @@ async def get_metadata_for_post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2610,7 +3547,7 @@ async def get_metadata_for_post_item_async( return json.loads(response.text) - async def get_table_async( + async def get_table( self, table: str, *, @@ -2623,6 +3560,21 @@ async def get_table_async( Get object metadata This operation gets the object metadata for a Salesforce object type. + + Swagger operation ID: `GetTable`. + + Args: + table: Salesforce object type like 'Leads'. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2633,7 +3585,7 @@ async def get_table_async( f"/{quote(quote(str(table), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2647,6 +3599,7 @@ async def get_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/sdk/__init__.py b/src/azure/connectors/sdk/__init__.py index 3080b9c8..d96fd587 100644 --- a/src/azure/connectors/sdk/__init__.py +++ b/src/azure/connectors/sdk/__init__.py @@ -1,7 +1,7 @@ # Copyright (c) Microsoft Corporation. All rights reserved. """ -Azure Connectors SDK for Python. +Asynchronous Azure Connectors SDK for Python. This package provides infrastructure for calling Azure Connectors from Python applications, including authentication, HTTP clients, @@ -11,6 +11,7 @@ from .client_base import ConnectorClientBase from .exceptions import ConnectorException from .http_client import ConnectorHttpClient, ConnectorResponse +from .polling import ConnectorPollingMethod from .response import ConnectorResponseHook, ConnectorResponseSnapshot from .trigger_payload import TriggerCallbackPayload, TriggerCallbackBody @@ -20,6 +21,7 @@ "ConnectorClientBase", "ConnectorException", "ConnectorHttpClient", + "ConnectorPollingMethod", "ConnectorResponse", "ConnectorResponseHook", "ConnectorResponseSnapshot", diff --git a/src/azure/connectors/sdk/_polling.py b/src/azure/connectors/sdk/_polling.py new file mode 100644 index 00000000..42f94e97 --- /dev/null +++ b/src/azure/connectors/sdk/_polling.py @@ -0,0 +1,150 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. + +"""Shared helpers for connector long-running operation polling.""" + +import math +from datetime import datetime, timezone +from email.utils import parsedate_to_datetime +from typing import Mapping, Optional +from urllib.parse import SplitResult, urljoin, urlsplit + +from .response import ConnectorResponseSnapshot + +DEFAULT_POLLING_INTERVAL_SECONDS = 1.0 + + +def get_header(headers: Mapping[str, str], name: str) -> Optional[str]: + """Return a response header using HTTP case-insensitive matching.""" + normalized_name = name.casefold() + return next( + ( + value + for header_name, value in headers.items() + if header_name.casefold() == normalized_name + ), + None, + ) + + +def get_location(response: ConnectorResponseSnapshot) -> Optional[str]: + """Return the Location polling URL from a connector response.""" + return get_header(response.headers, "Location") + + +def _split_safe_url(value: str) -> SplitResult: + """Reject URL spellings that HTTP transports can interpret differently.""" + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 for character in value + ): + raise ValueError( + "Polling URLs must not contain backslashes or control characters." + ) + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if ( + parsed.scheme not in ("http", "https") + or not parsed.hostname + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError( + "Polling URLs must use an unambiguous HTTP authority without userinfo." + ) + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Polling URLs must use an unambiguous HTTP authority.") + return parsed + + +def resolve_polling_url( + polling_url: str, + connection_runtime_url: str, + current_polling_url: Optional[str] = None, +) -> str: + """Route a connector polling URL through the authenticated runtime origin.""" + parsed_connection = _split_safe_url(connection_runtime_url) + parsed_polling_url = _split_safe_url(polling_url) + if parsed_connection.hostname is None: + raise ValueError("Polling URLs must include a hostname.") + if polling_url.startswith("/"): + return f"{connection_runtime_url}{polling_url}" + + if not parsed_polling_url.scheme and not parsed_polling_url.netloc: + base_url = current_polling_url or f"{connection_runtime_url.rstrip('/')}/" + if _split_safe_url(base_url).hostname is None: + raise ValueError("Polling URLs must include a hostname.") + return resolve_polling_url( + urljoin(base_url, polling_url), connection_runtime_url + ) + + polling_hostname = parsed_polling_url.hostname + connection_hostname = parsed_connection.hostname + if polling_hostname is None or connection_hostname is None: + raise ValueError("Polling URLs must include a hostname.") + + polling_port = parsed_polling_url.port or ( + 443 if parsed_polling_url.scheme == "https" else 80 + ) + connection_port = parsed_connection.port or ( + 443 if parsed_connection.scheme == "https" else 80 + ) + if polling_hostname.casefold() == connection_hostname.casefold(): + if ( + parsed_polling_url.scheme == parsed_connection.scheme + and polling_port == connection_port + ): + return parsed_connection._replace( + path=parsed_polling_url.path, + query=parsed_polling_url.query, + fragment=parsed_polling_url.fragment, + ).geturl() + raise ValueError( + "Polling URL origin must use the connection runtime scheme and port." + ) + + suffix = parsed_polling_url.path + if parsed_polling_url.query: + suffix += f"?{parsed_polling_url.query}" + return f"{connection_runtime_url}{suffix}" + + +def get_retry_after_seconds(response: ConnectorResponseSnapshot) -> float: + """Return the server-requested delay or the default polling interval.""" + retry_after = get_header(response.headers, "Retry-After") + if retry_after is None: + return DEFAULT_POLLING_INTERVAL_SECONDS + + try: + delay = float(retry_after) + return ( + max(0.0, delay) + if math.isfinite(delay) + else DEFAULT_POLLING_INTERVAL_SECONDS + ) + except ValueError: + try: + retry_at = parsedate_to_datetime(retry_after) + except (TypeError, ValueError): + return DEFAULT_POLLING_INTERVAL_SECONDS + + if retry_at.tzinfo is None: + retry_at = retry_at.replace(tzinfo=timezone.utc) + return max( + 0.0, + (retry_at - datetime.now(timezone.utc)).total_seconds(), + ) + + +def get_polling_status(response: Optional[ConnectorResponseSnapshot]) -> str: + """Map an HTTP response to an Azure Core polling status string.""" + if response is None: + return "NotStarted" + if response.status == 202: + return "InProgress" + if 200 <= response.status < 300: + return "Succeeded" + return "Failed" diff --git a/src/azure/connectors/sdk/client_base.py b/src/azure/connectors/sdk/client_base.py index 97d6455d..c8b049c3 100644 --- a/src/azure/connectors/sdk/client_base.py +++ b/src/azure/connectors/sdk/client_base.py @@ -20,7 +20,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -34,7 +34,7 @@ def __init__( Args: credential: Caller-owned Azure Core credential. - timeout_seconds: Total network timeout for each request, including + timeout: Total network timeout for each request, including retries, response loading, and body reads. Nonpositive values disable SDK and transport deadlines. transport: Optional Azure Core async HTTP transport closed by the @@ -46,7 +46,7 @@ def __init__( self._http_client = ConnectorHttpClient( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout_seconds=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, diff --git a/src/azure/connectors/sdk/exceptions.py b/src/azure/connectors/sdk/exceptions.py index c86c7a14..12a9c336 100644 --- a/src/azure/connectors/sdk/exceptions.py +++ b/src/azure/connectors/sdk/exceptions.py @@ -2,8 +2,48 @@ """Exception types for connector operations.""" +from http import HTTPStatus +from typing import Optional -class ConnectorException(Exception): +from azure.core.exceptions import HttpResponseError +from azure.core.pipeline.transport import HttpRequest, HttpResponse + +from .response import ConnectorResponseSnapshot + + +class _ConnectorHttpResponse(HttpResponse): + """Adapt an immutable connector response to the Azure Core response API.""" + + def __init__( + self, + method: str, + path: str, + response: ConnectorResponseSnapshot, + ) -> None: + """Initialize the response adapter.""" + super().__init__(HttpRequest(method, path), internal_response=None) + self.status_code = response.status + self.headers = dict(response.headers) + try: + self.reason = HTTPStatus(response.status).phrase + except ValueError: + self.reason = None + self.content_type = next( + ( + value + for name, value in response.headers.items() + if name.lower() == "content-type" + ), + None, + ) + self._content = response.content + + def body(self) -> bytes: + """Return the buffered response body.""" + return self._content + + +class ConnectorException(HttpResponseError): """Exception raised when connector operations fail.""" MAX_RESPONSE_BODY_LENGTH = 2000 @@ -14,7 +54,9 @@ def __init__( path: str, status_code: int, response_body: str, - ): + *, + response: Optional[ConnectorResponseSnapshot] = None, + ) -> None: """ Initialize a ConnectorException. @@ -23,6 +65,7 @@ def __init__( path: The API path that was called (e.g., "/v2/Mail"). status_code: The HTTP status code. response_body: The response body from the failed request. + response: The completed connector response, when available. """ self.method = method self.path = path @@ -32,7 +75,20 @@ def __init__( truncated_body = self._truncate_body(response_body) message = f"{self.operation} failed with status {status_code}: " message += truncated_body - super().__init__(message) + if response is None: + response = ConnectorResponseSnapshot( + status=status_code, + headers={}, + text=response_body, + content=response_body.encode("utf-8"), + ) + super().__init__( + message=message, + response=_ConnectorHttpResponse(method, path, response), + ) + self.message = message + self.args = (message,) + self.status_code = status_code @classmethod def _truncate_body(cls, body: str) -> str: diff --git a/src/azure/connectors/sdk/http_client.py b/src/azure/connectors/sdk/http_client.py index d0e4cbbc..199a5e90 100644 --- a/src/azure/connectors/sdk/http_client.py +++ b/src/azure/connectors/sdk/http_client.py @@ -114,7 +114,7 @@ def __init__( self._credential = credential self._timeout_seconds = timeout_seconds self._retry_unsafe_http_methods = retry_unsafe_http_methods - self._transport = transport or AioHttpTransport() + self._transport = transport or AioHttpTransport(**kwargs) policy_options = dict(kwargs) per_call_policies = self._as_policy_list( policy_options.pop("per_call_policies", []) @@ -306,7 +306,7 @@ async def close(self) -> None: """Close the HTTP transport without closing the caller credential.""" await self._pipeline.__aexit__(None, None, None) - async def send_async( + async def send( self, method: str, url: str, @@ -417,28 +417,30 @@ async def send_request() -> ConnectorResponseSnapshot: error=ex, ) from ex - async def get_async(self, request_uri: str) -> Any: + async def get(self, request_uri: str) -> Any: """Send a GET request.""" - response = await self.send_async("GET", request_uri) + response = await self.send("GET", request_uri) if not 200 <= response.status < 300: raise ConnectorException( "GET", request_uri, response.status, response.text, + response=response, ) return json.loads(response.text) if response.text else None - async def post_async(self, request_uri: str, body: Any) -> Any: + async def post(self, request_uri: str, body: Any) -> Any: """Send a POST request with a JSON body.""" - response = await self.send_async("POST", request_uri, body) + response = await self.send("POST", request_uri, body) if not 200 <= response.status < 300: raise ConnectorException( "POST", request_uri, response.status, response.text, + response=response, ) return json.loads(response.text) if response.text else None diff --git a/src/azure/connectors/sdk/polling.py b/src/azure/connectors/sdk/polling.py new file mode 100644 index 00000000..5e6ce20e --- /dev/null +++ b/src/azure/connectors/sdk/polling.py @@ -0,0 +1,142 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. + +"""Asynchronous Azure Core polling for connector operations.""" + +import asyncio +from typing import Any, Callable, Generic, Mapping, Optional, TypeVar + +from azure.core.polling import AsyncPollingMethod + +from ._polling import ( + get_location, + get_polling_status, + get_retry_after_seconds, + resolve_polling_url, +) +from .exceptions import ConnectorException +from .response import ConnectorResponseHook, ConnectorResponseSnapshot + +PollingResultT = TypeVar("PollingResultT") + + +class ConnectorPollingMethod( + AsyncPollingMethod[PollingResultT], Generic[PollingResultT] +): + """Poll a connector operation until it returns a terminal HTTP response.""" + + def __init__( + self, + http_client: Any, + polling_header_name: str, + *, + request_url: Optional[str] = None, + timeout: Optional[float] = None, + headers: Optional[Mapping[str, str]] = None, + client_request_id: Optional[str] = None, + response_hook: Optional[ConnectorResponseHook] = None, + ) -> None: + """Initialize polling with the initiating request URI as the relative base. + + Args: + http_client: HTTP client used for polling requests. + polling_header_name: Supported Location response header name. + request_url: Initiating operation URI for the first relative Location. + timeout: Timeout for each polling request. + headers: Additional polling request headers. + client_request_id: Caller-provided request identifier. + response_hook: Callback invoked after a polling response. + """ + if polling_header_name.casefold() != "location": + raise ValueError("Only the 'Location' polling header is supported.") + + self._http_client = http_client + self._request_url = request_url + self._timeout = timeout + self._headers = headers + self._client_request_id = client_request_id + self._response_hook = response_hook + self._response: Optional[ConnectorResponseSnapshot] = None + self._polling_url: Optional[str] = None + self._connection_runtime_url: Optional[str] = None + self._deserialization_callback: Optional[ + Callable[[ConnectorResponseSnapshot], PollingResultT] + ] = None + + def initialize( + self, + client: Any, + initial_response: ConnectorResponseSnapshot, + deserialization_callback: Callable[ + [ConnectorResponseSnapshot], PollingResultT + ], + ) -> None: + """Initialize polling from the operation's first response.""" + self._response = initial_response + self._polling_url = self._request_url + self._connection_runtime_url = client._connection_runtime_url + self._deserialization_callback = deserialization_callback + if initial_response.status == 202: + self._update_polling_url(require_url=True) + + async def run(self) -> None: + """Poll until the connector returns a terminal response.""" + while not self.finished(): + if self._response is None or self._polling_url is None: + raise RuntimeError("Connector polling was not initialized.") + await asyncio.sleep(get_retry_after_seconds(self._response)) + request_url = self._polling_url + self._response = await self._http_client.send( + "GET", + request_url, + body=None, + timeout=self._timeout, + headers=self._headers, + client_request_id=self._client_request_id, + response_hook=self._response_hook, + ) + if self._response.status == 202: + self._update_polling_url(require_url=False) + elif not 200 <= self._response.status < 300: + raise ConnectorException( + "GET", + request_url, + self._response.status, + self._response.text, + response=self._response, + ) + + def status(self) -> str: + """Return the current Azure Core polling status.""" + return get_polling_status(self._response) + + def finished(self) -> bool: + """Return whether the connector has produced a terminal response.""" + return self._response is not None and self._response.status != 202 + + def resource(self) -> PollingResultT: + """Deserialize the terminal connector response.""" + if self._response is None or self._deserialization_callback is None: + raise RuntimeError("Connector polling was not initialized.") + if not self.finished(): + raise RuntimeError("Connector polling has not completed.") + return self._deserialization_callback(self._response) + + def _update_polling_url(self, *, require_url: bool) -> None: + """Update and validate the polling URL from the current response.""" + if self._response is None or self._connection_runtime_url is None: + raise RuntimeError("Connector polling was not initialized.") + location = get_location(self._response) + if location is None: + if require_url: + raise ValueError( + "An HTTP 202 response must include a 'Location' polling URL." + ) + return + self._polling_url = resolve_polling_url( + location, + self._connection_runtime_url, + self._polling_url, + ) + + +__all__ = ["ConnectorPollingMethod"] diff --git a/src/azure/connectors/sdk/serialization.py b/src/azure/connectors/sdk/serialization.py index 875c0d13..d0515421 100644 --- a/src/azure/connectors/sdk/serialization.py +++ b/src/azure/connectors/sdk/serialization.py @@ -13,6 +13,7 @@ from __future__ import annotations +from collections.abc import Mapping from dataclasses import fields, is_dataclass from typing import Any @@ -28,8 +29,8 @@ def to_wire(value: Any) -> Any: name). ``None`` dataclass fields and ``None`` map values are omitted. ``additional_properties`` are merged into the containing object, mirroring the .NET ``[JsonExtensionData]`` behavior. Lists and tuples are converted - element-by-element, and dictionaries are converted value-by-value with - their keys preserved. Raw ``bytes`` and ``bytearray`` are returned + element-by-element, and mappings are converted value-by-value with their + keys preserved. Raw ``bytes`` and ``bytearray`` are returned unchanged so binary payloads are never JSON-encoded. All other scalar values pass through unchanged. @@ -45,7 +46,7 @@ def to_wire(value: Any) -> Any: if is_dataclass(value) and not isinstance(value, type): return _dataclass_to_wire(value) - if isinstance(value, dict): + if isinstance(value, Mapping): return { key: to_wire(item) for key, item in value.items() diff --git a/src/azure/connectors/seismicplanner.py b/src/azure/connectors/seismicplanner.py index 90c272f0..1d987f6b 100644 --- a/src/azure/connectors/seismicplanner.py +++ b/src/azure/connectors/seismicplanner.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,51 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "SeismicplannerClient", + "Association", + "AssociationReq", + "AsyncOperationResponse", + "Comment", + "CommentQueryResponse", + "ContentRef", + "CreateCommentModel", + "CreateProject", + "CreateRequest", + "CreateTask", + "CustomProperty", + "CustomPropertyDataDisplay", + "CustomPropertyValues", + "CustomPropertyValuesInput", + "CustomPropertyValuesValues", + "DeleteRequest", + "Follower", + "Meta", + "MetaQueryInfo", + "PlannerProject", + "PlannerProjectQueryResponse", + "PlannerRequest", + "PlannerRequestQueryResponse", + "PlannerSubTask", + "PlannerTask", + "PlannerTaskQueryResponse", + "PossibleValuesItem", + "ProblemDetails", + "ProjectAssociatedNodes", + "RequestFormCustomProperties", + "ScopeSettingsItemDefinition", + "StatusSchema", + "StatusSchemaQueryResponse", + "UpdateCommentModel", + "UpdateProject", + "UpdateRequest", + "UpdateTask", + "ValueSchemaPropertyDefinition", +] + # Type Definitions @@ -29,15 +73,20 @@ class CommentQueryResponse: Response for Get comments """ - count: Optional[int] = None + count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of records returned""" - cursor: Optional[str] = None + cursor: Optional[str] = dataclass_field(default=None, kw_only=True) """Cursor used for pagination""" - items: Optional[List[Comment]] = None + items: Optional[ + List[Comment | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of items in the response""" - limit: Optional[int] = None + limit: Optional[int] = dataclass_field(default=None, kw_only=True) """Number to limit records""" - meta: Optional[Meta] = None + meta: Optional[Meta | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -46,67 +95,80 @@ class Comment: Response for Create comment """ - annotation_payload: Optional[str] = field( + annotation_payload: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "annotationPayload"}, ) - annotation_type: Optional[str] = field( + annotation_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "annotationType"}, ) - comment_content: Optional[str] = field( + comment_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "commentContent"}, ) - created_at: Optional[str] = field( + created_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdAt"}, ) """Date string of date created""" - creator_id: Optional[str] = field( + creator_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creatorId"}, ) """User ID of the creator""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Comment ID""" - is_resolved: Optional[bool] = field( + is_resolved: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isResolved"}, ) """True/false on whether the comment is resolved""" - node_id: Optional[str] = field( + node_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nodeId"}, ) """Node ID""" - node_type: Optional[str] = field( + node_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nodeType"}, ) """Node type of the comment""" - page_index: Optional[str] = field( + page_index: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pageIndex"}, ) """Number page index""" - parent_id: Optional[str] = field( + parent_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentId"}, ) """Parent comment ID""" - reply_count: Optional[int] = field( + reply_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "replyCount"}, ) """Number of replies""" - space_id: Optional[str] = field( + space_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spaceId"}, ) """Space ID""" - updated_at: Optional[str] = field( + updated_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "updatedAt"}, ) """Date string of updated date""" @@ -118,15 +180,20 @@ class PlannerProjectQueryResponse: Response for Get projects """ - count: Optional[int] = None + count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of records returned""" - cursor: Optional[str] = None + cursor: Optional[str] = dataclass_field(default=None, kw_only=True) """Cursor used for pagination""" - items: Optional[List[PlannerProject]] = None + items: Optional[ + List[PlannerProject | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of project items in the response""" - limit: Optional[int] = None + limit: Optional[int] = dataclass_field(default=None, kw_only=True) """Number to limit records""" - meta: Optional[Meta] = None + meta: Optional[Meta | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -135,8 +202,9 @@ class AsyncOperationResponse: Response for Delete projects """ - async_operation_ids: Optional[List[str]] = field( + async_operation_ids: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "asyncOperationIds"}, ) """List of async action IDs""" @@ -148,110 +216,148 @@ class PlannerProject: Response for Create project """ - actual_duration: Optional[int] = field( + actual_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actualDuration"}, ) """Calculated actual duration in days""" - actual_end_date: Optional[str] = field( + actual_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actualEndDate"}, ) """Calculated end date from when the project actually ended""" - actual_start_date: Optional[str] = field( + actual_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actualStartDate"}, ) """Calculated start date from when the project actually started""" - associated_nodes: Optional[List[ProjectAssociatedNodes]] = field( + associated_nodes: Optional[ + List[ProjectAssociatedNodes | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "associatedNodes"}, ) """List of association data""" - associations: Optional[List[Association]] = None + associations: Optional[ + List[Association | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of associations (Library content)""" - copy_from: Optional[str] = field( + copy_from: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "copyFrom"}, ) """Project ID the project is copied from""" - created_at: Optional[str] = field( + created_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdAt"}, ) """Date string of created date""" - creator_id: Optional[str] = field( + creator_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creatorId"}, ) """User ID of creator""" - custom_properties: Optional[List[CustomPropertyValues]] = field( + custom_properties: Optional[ + List[CustomPropertyValues | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """List of custom properties""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of project""" - followers: Optional[List[Follower]] = None + followers: Optional[ + List[Follower | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of followers""" - id: Optional[str] = None - is_active: Optional[bool] = field( + id: Optional[str] = dataclass_field(default=None, kw_only=True) + is_active: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isActive"}, ) """Indicator on if a project is active or not""" - is_template: Optional[bool] = field( + is_template: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isTemplate"}, ) """Indicator on if the project is a template or not""" - manager_id: Optional[str] = field( + manager_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerId"}, ) """User ID of project manager""" - max_rank: Optional[str] = field( + max_rank: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "maxRank"}, ) """Maximum rank number""" - min_rank: Optional[str] = field( + min_rank: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "minRank"}, ) """Minimum rank number""" - planned_duration: Optional[int] = field( + planned_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedDuration"}, ) """Planned duration in days""" - planned_end_date: Optional[str] = field( + planned_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedEndDate"}, ) """Date string of planned end date""" - planned_start_date: Optional[str] = field( + planned_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedStartDate"}, ) """Date string of planned start date""" - space_id: Optional[str] = field( + space_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spaceId"}, ) - template_id: Optional[str] = field( + template_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "templateId"}, ) """Template ID the the project was created from""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of project""" - updated_at: Optional[str] = field( + updated_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "updatedAt"}, ) """Date project was last updated""" - works: Optional[List[PlannerTask]] = None + works: Optional[ + List[PlannerTask | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of tasks and requests""" @@ -261,15 +367,20 @@ class PlannerRequestQueryResponse: Response for Get requests """ - count: Optional[int] = None + count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of records returned""" - cursor: Optional[str] = None + cursor: Optional[str] = dataclass_field(default=None, kw_only=True) """Cursor used for pagination""" - items: Optional[List[PlannerRequest]] = None + items: Optional[ + List[PlannerRequest | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of request objects in the response""" - limit: Optional[int] = None + limit: Optional[int] = dataclass_field(default=None, kw_only=True) """Number to limit records""" - meta: Optional[Meta] = None + meta: Optional[Meta | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -278,93 +389,123 @@ class PlannerRequest: Response for Create request """ - assignee_id: Optional[str] = field( + assignee_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assigneeId"}, ) """User ID of the assignee""" - assigner_id: Optional[str] = field( + assigner_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignerId"}, ) """User ID of the assigner""" - associations: Optional[List[Association]] = None + associations: Optional[ + List[Association | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of associations (Library content)""" - content_refs: Optional[List[ContentRef]] = field( + content_refs: Optional[List[ContentRef | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentRefs"}, ) """List of content references (WorkSpace and DocCenter content)""" - created_at: Optional[str] = field( + created_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdAt"}, ) """Date string for created date""" - creator_id: Optional[str] = field( + creator_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creatorId"}, ) """User ID of the creator""" - custom_properties: Optional[List[CustomPropertyValues]] = field( + custom_properties: Optional[ + List[CustomPropertyValues | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """List of custom properties""" - followers: Optional[List[Follower]] = None + followers: Optional[ + List[Follower | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of followers""" - form_ref: Optional[Any] = field( + form_ref: Optional[Any] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "formRef"}, ) """Form reference object""" - id: Optional[str] = None - note: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + note: Optional[str] = dataclass_field(default=None, kw_only=True) """Note for notifications on status changes""" - planned_duration: Optional[int] = field( + planned_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedDuration"}, ) """Planned duration in days""" - planned_end_date: Optional[str] = field( + planned_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedEndDate"}, ) """Date string of planned end date""" - planned_start_date: Optional[str] = field( + planned_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedStartDate"}, ) """Date string of planned start date""" - priority: Optional[str] = None + priority: Optional[str] = dataclass_field(default=None, kw_only=True) """Priority value""" - project_id: Optional[str] = field( + project_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectId"}, ) """Project ID of the project the request is associated with""" - rank: Optional[str] = None + rank: Optional[str] = dataclass_field(default=None, kw_only=True) """Rank of request in request list""" - request_form_custom_property_option: Optional[RequestFormCustomProperties] = field( + request_form_custom_property_option: Optional[ + RequestFormCustomProperties | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requestFormCustomPropertyOption"}, ) - space_id: Optional[str] = field( + space_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spaceId"}, ) - status_schema_id: Optional[str] = field( + status_schema_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusSchemaId"}, ) - step_id: Optional[int] = field( + step_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "stepId"}, ) """Step ID indicating the status value""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the request""" - updated_at: Optional[str] = field( + updated_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "updatedAt"}, ) """Date the request was last updated""" @@ -376,15 +517,20 @@ class StatusSchemaQueryResponse: Response for Get status schemas """ - count: Optional[int] = None + count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of records returned""" - cursor: Optional[str] = None + cursor: Optional[str] = dataclass_field(default=None, kw_only=True) """Cursor used for pagination""" - items: Optional[List[StatusSchema]] = None + items: Optional[ + List[StatusSchema | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of status schema objects in the response""" - limit: Optional[int] = None + limit: Optional[int] = dataclass_field(default=None, kw_only=True) """Number to limit records""" - meta: Optional[Meta] = None + meta: Optional[Meta | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -393,36 +539,45 @@ class StatusSchema: Response for Get status schema """ - created_at: Optional[str] = field( + created_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdAt"}, ) """Date string of created date""" - creator_id: Optional[str] = field( + creator_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creatorId"}, ) """User ID of creator""" - id: Optional[str] = None - is_default: Optional[bool] = field( + id: Optional[str] = dataclass_field(default=None, kw_only=True) + is_default: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isDefault"}, ) """Indicator on if the status schema is the default schema""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of status schema""" - space_id: Optional[str] = field( + space_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spaceId"}, ) - steps: Optional[List[str]] = None + steps: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """List of steps and their values""" - transitions: Optional[List[List[int]]] = None + transitions: Optional[List[List[int]]] = dataclass_field(default=None, kw_only=True) """List of transition rules""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Node type the status schema can be used for""" - updated_at: Optional[str] = field( + updated_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "updatedAt"}, ) """Date the status schema was last updated""" @@ -434,15 +589,20 @@ class PlannerTaskQueryResponse: Response for Get tasks """ - count: Optional[int] = None + count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of records returned""" - cursor: Optional[str] = None + cursor: Optional[str] = dataclass_field(default=None, kw_only=True) """Cursor used for pagination""" - items: Optional[List[PlannerTask]] = None + items: Optional[ + List[PlannerTask | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of task objects in the response""" - limit: Optional[int] = None + limit: Optional[int] = dataclass_field(default=None, kw_only=True) """Number to limit records""" - meta: Optional[Meta] = None + meta: Optional[Meta | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -451,136 +611,176 @@ class PlannerTask: Response for Create task """ - actual_duration: Optional[int] = field( + actual_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actualDuration"}, ) """Calculated actual duration in days""" - actual_end_date: Optional[str] = field( + actual_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actualEndDate"}, ) """Date when work on the task was completed""" - actual_start_date: Optional[str] = field( + actual_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actualStartDate"}, ) """Date when work on the task started""" - assignee_id: Optional[str] = field( + assignee_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assigneeId"}, ) """User ID of assignee""" - assigner_id: Optional[str] = field( + assigner_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignerId"}, ) """User ID of the last user to add an assignee""" - associations: Optional[List[Association]] = None + associations: Optional[ + List[Association | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of associations on a task""" - copy_from: Optional[str] = field( + copy_from: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "copyFrom"}, ) """Task ID that task was copied from""" - created_at: Optional[str] = field( + created_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdAt"}, ) """Date the task was created""" - creator_id: Optional[str] = field( + creator_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creatorId"}, ) """User ID of creator""" - custom_properties: Optional[List[CustomPropertyValues]] = field( + custom_properties: Optional[ + List[CustomPropertyValues | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """List of custom properties on a task""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of task""" - followers: Optional[List[Follower]] = None + followers: Optional[ + List[Follower | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of followers on a task""" - id: Optional[str] = None - is_template: Optional[bool] = field( + id: Optional[str] = dataclass_field(default=None, kw_only=True) + is_template: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isTemplate"}, ) """Indicates if a task is part of a template""" - max_rank: Optional[str] = field( + max_rank: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "maxRank"}, ) """Maximum rank""" - min_rank: Optional[str] = field( + min_rank: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "minRank"}, ) """Minimum rank""" - parent_id: Optional[str] = field( + parent_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentId"}, ) """Task ID of parent if task is a subtask""" - planned_duration: Optional[int] = field( + planned_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedDuration"}, ) """Planned duration in days""" - planned_end_date: Optional[str] = field( + planned_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedEndDate"}, ) """Date string of planned end date (due date)""" - planned_start_date: Optional[str] = field( + planned_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedStartDate"}, ) """Date string of planned start date""" - priority: Optional[str] = None + priority: Optional[str] = dataclass_field(default=None, kw_only=True) """Priority value""" - project_id: Optional[str] = field( + project_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectId"}, ) """Project ID the task belongs to""" - rank: Optional[str] = None + rank: Optional[str] = dataclass_field(default=None, kw_only=True) """Rank of task in a task list""" - space_id: Optional[str] = field( + space_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spaceId"}, ) - status_schema_id: Optional[str] = field( + status_schema_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusSchemaId"}, ) - step_id: Optional[int] = field( + step_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "stepId"}, ) """Id of step in status schema""" - sub_task_ids: Optional[List[str]] = field( + sub_task_ids: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subTaskIds"}, ) """List of subtask IDs""" - sub_tasks: Optional[List[PlannerSubTask]] = field( + sub_tasks: Optional[List[PlannerSubTask | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subTasks"}, ) """List of subtasks on the task""" - template_id: Optional[str] = field( + template_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "templateId"}, ) """Template ID of the template the task belongs to""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of task""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type of task""" - updated_at: Optional[str] = field( + updated_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "updatedAt"}, ) """Date the task was last updated""" @@ -592,32 +792,37 @@ class Association: Definition: Association """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of association""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of association""" - node_guid: Optional[str] = field( + node_guid: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nodeGuid"}, ) """Longer GUID format""" - node_id: Optional[str] = field( + node_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nodeId"}, ) """Node ID""" - node_type: Optional[str] = field( + node_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nodeType"}, ) """Node type of the association""" - space_guid: Optional[str] = field( + space_guid: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spaceGuid"}, ) """Longer GUID format""" - space_id: Optional[str] = field( + space_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spaceId"}, ) """Space ID""" @@ -629,18 +834,21 @@ class AssociationReq: Definition: AssociationReq """ - node_id: Optional[str] = field( + node_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nodeId"}, ) """Node ID""" - node_type: Optional[str] = field( + node_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nodeType"}, ) """Node type of the association""" - space_id: Optional[str] = field( + space_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spaceId"}, ) """Space ID""" @@ -652,60 +860,71 @@ class ContentRef: Definition: ContentRef """ - content_id: Optional[str] = field( + content_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentId"}, ) """Content ID""" - doc_center_full_path: Optional[str] = field( + doc_center_full_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "docCenterFullPath"}, ) """Full location path of where content exists in DocCenter""" - major_version: Optional[int] = field( + major_version: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "majorVersion"}, ) """Number of major version""" - minor_version: Optional[int] = field( + minor_version: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "minorVersion"}, ) """Number of minor version""" - modified_date: Optional[str] = field( + modified_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "modifiedDate"}, ) """Date the content reference was last updated""" - order_no: Optional[int] = field( + order_no: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "orderNo"}, ) """Number to indicate order""" - profile_id: Optional[str] = field( + profile_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "profileId"}, ) """Profile ID""" - profile_version_id: Optional[str] = field( + profile_version_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "profileVersionId"}, ) """Version ID of profile""" - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Source of content""" - team_site_id: Optional[str] = field( + team_site_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamSiteId"}, ) """TeamSite ID""" - thumbnail_id: Optional[str] = field( + thumbnail_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "thumbnailId"}, ) """ID for image thumbnail""" - version_id: Optional[str] = field( + version_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "versionId"}, ) """Version ID of content""" @@ -717,22 +936,26 @@ class CreateCommentModel: Definition: CreateCommentModel """ - annotation_payload: Optional[str] = field( + annotation_payload: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "annotationPayload"}, ) - annotation_type: Optional[str] = field( + annotation_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "annotationType"}, ) """Annotation type""" - comment_content: Optional[str] = field( + comment_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "commentContent"}, ) """Content of the comment""" - is_resolved: Optional[bool] = field( + is_resolved: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isResolved"}, ) """True/false on whether the comment is resolved""" @@ -744,36 +967,48 @@ class CreateProject: Definition: CreateProject """ - associations: Optional[List[AssociationReq]] = None + associations: Optional[ + List[AssociationReq | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of association objects""" - custom_properties: Optional[List[CustomPropertyValuesInput]] = field( + custom_properties: Optional[ + List[CustomPropertyValuesInput | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """List of custom properties""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of description""" - manager_id: Optional[str] = field( + manager_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerId"}, ) """User ID of manager""" - planned_duration: Optional[int] = field( + planned_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedDuration"}, ) """Planned duration in days""" - planned_end_date: Optional[str] = field( + planned_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedEndDate"}, ) """Date string of end date""" - planned_start_date: Optional[str] = field( + planned_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedStartDate"}, ) """Date string of start date""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of project""" @@ -783,55 +1018,71 @@ class CreateRequest: Definition: CreateRequest """ - assignee_id: Optional[str] = field( + assignee_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assigneeId"}, ) """User ID of assignee""" - associations: Optional[List[AssociationReq]] = None + associations: Optional[ + List[AssociationReq | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of associations (Library content)""" - content_refs: Optional[List[ContentRef]] = field( + content_refs: Optional[List[ContentRef | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentRefs"}, ) """List of content references (DocCenter and Workspace associations)""" - custom_properties: Optional[List[CustomPropertyValuesInput]] = field( + custom_properties: Optional[ + List[CustomPropertyValuesInput | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """List of custom properties""" - form_ref: Optional[Any] = field( + form_ref: Optional[Any] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "formRef"}, ) """Form reference object""" - planned_duration: Optional[int] = field( + planned_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedDuration"}, ) """Planned duration in days""" - planned_end_date: Optional[str] = field( + planned_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedEndDate"}, ) """Date string of end date""" - planned_start_date: Optional[str] = field( + planned_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedStartDate"}, ) """Date string of start date""" - priority: Optional[str] = None + priority: Optional[str] = dataclass_field(default=None, kw_only=True) """Priority value""" - project_id: Optional[str] = field( + project_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectId"}, ) """ID of project the request belongs to""" - status_schema_id: Optional[str] = field( + status_schema_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusSchemaId"}, ) - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of request""" @@ -841,48 +1092,62 @@ class CreateTask: Definition: CreateTask """ - assignee_id: Optional[str] = field( + assignee_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assigneeId"}, ) """User ID of assignee""" - associations: Optional[List[AssociationReq]] = None + associations: Optional[ + List[AssociationReq | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of associations (Library content)""" - custom_properties: Optional[List[CustomPropertyValuesInput]] = field( + custom_properties: Optional[ + List[CustomPropertyValuesInput | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """List of custom properties""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of task""" - parent_id: Optional[str] = field( + parent_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentId"}, ) """Task ID of parent""" - planned_duration: Optional[int] = field( + planned_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedDuration"}, ) """Planned duration in days""" - planned_end_date: Optional[str] = field( + planned_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedEndDate"}, ) """Date string of end date""" - planned_start_date: Optional[str] = field( + planned_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedStartDate"}, ) """Date string of start date""" - priority: Optional[str] = None + priority: Optional[str] = dataclass_field(default=None, kw_only=True) """Priority values""" - project_id: Optional[str] = field( + project_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectId"}, ) """ID of project the task is associated with""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of task""" @@ -892,73 +1157,88 @@ class CustomProperty: Definition: CustomProperty """ - allow_multiple_values: Optional[bool] = field( + allow_multiple_values: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowMultipleValues"}, ) """Indicates if custom property allows for multiple values""" - created_by_id: Optional[str] = field( + created_by_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdById"}, ) """User ID of the creator""" - has_domain_of_values: Optional[bool] = field( + has_domain_of_values: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasDomainOfValues"}, ) """Indicates if custom property has possible values""" - hint: Optional[str] = None + hint: Optional[str] = dataclass_field(default=None, kw_only=True) """ Value that describes the hint displayed under the custom property name """ - id: Optional[str] = None - is_required: Optional[bool] = field( + id: Optional[str] = dataclass_field(default=None, kw_only=True) + is_required: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isRequired"}, ) """Indicates whether the custom property is required or not""" - last_modified_by_id: Optional[str] = field( + last_modified_by_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedById"}, ) """User ID of the user that last updated the custom property""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of custom property""" - operation_setting: Optional[str] = field( + operation_setting: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "operationSetting"}, ) """ Object that describes settings for different operations on a custom property """ - order: Optional[int] = None + order: Optional[int] = dataclass_field(default=None, kw_only=True) """Number indicating order within custom property list""" - possible_values: Optional[List[PossibleValuesItem]] = field( + possible_values: Optional[List[PossibleValuesItem | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "possibleValues"}, ) """List of possible values for the custom property (if applicable)""" - scope_settings: Optional[List[ScopeSettingsItemDefinition]] = field( + scope_settings: Optional[ + List[ScopeSettingsItemDefinition | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "scopeSettings"}, ) """ Object that describes settings for different scopes on a custom property """ - scopes: Optional[List[str]] = None + scopes: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """List of scopes""" - value_schema_name: Optional[str] = field( + value_schema_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "valueSchemaName"}, ) """Name of custom property value schema""" - value_schema_property: Optional[ValueSchemaPropertyDefinition] = field( + value_schema_property: Optional[ + ValueSchemaPropertyDefinition | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "valueSchemaProperty"}, ) - value_type: Optional[str] = field( + value_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "valueType"}, ) """Type of custom property value""" @@ -970,7 +1250,7 @@ class CustomPropertyDataDisplay: Definition: CustomPropertyDataDisplay """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of custom property""" @@ -980,17 +1260,28 @@ class CustomPropertyValues: Definition: CustomPropertyValues """ - id: Optional[str] = None - localizations: Optional[Dict[str, CustomPropertyDataDisplay]] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + localizations: Optional[ + Dict[str, CustomPropertyDataDisplay | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Localization object""" - multiple_value: Optional[bool] = field( + multiple_value: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "multipleValue"}, ) """Indicate if the custom property allows multiple values""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of custom property""" - values: Optional[List[CustomPropertyValuesValues]] = None + values: Optional[ + List[CustomPropertyValuesValues | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of custom property values""" @@ -1000,8 +1291,13 @@ class CustomPropertyValuesInput: Definition: CustomPropertyValuesInput """ - id: Optional[str] = None - values: Optional[List[CustomPropertyValuesValues]] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + values: Optional[ + List[CustomPropertyValuesValues | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of custom property values""" @@ -1011,8 +1307,8 @@ class CustomPropertyValuesValues: Definition: CustomPropertyValuesValues """ - id: Optional[str] = None - value: Optional[Any] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + value: Optional[Any] = dataclass_field(default=None, kw_only=True) """Value data for custom property value""" @@ -1022,7 +1318,7 @@ class DeleteRequest: Definition: DeleteRequest """ - ids: Optional[List[str]] = None + ids: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """List of Request IDs to delete""" @@ -1032,9 +1328,13 @@ class Follower: Definition: Follower """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """User/User group ID of follower""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Either user or user group follower type""" @@ -1044,9 +1344,14 @@ class Meta: Definition: Meta """ - count: Optional[int] = None + count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of records returned""" - query: Optional[List[MetaQueryInfo]] = None + query: Optional[ + List[MetaQueryInfo | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Query object""" @@ -1056,7 +1361,7 @@ class MetaQueryInfo: Definition: MetaQueryInfo """ - sort: Optional[List[str]] = None + sort: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Sort query""" @@ -1066,126 +1371,164 @@ class PlannerSubTask: Definition: PlannerSubTask """ - actual_duration: Optional[int] = field( + actual_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actualDuration"}, ) """Calculated actual duration in days""" - actual_end_date: Optional[str] = field( + actual_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actualEndDate"}, ) """Date when work on the task was completed""" - actual_start_date: Optional[str] = field( + actual_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actualStartDate"}, ) """Date when work on the task started""" - assignee_id: Optional[str] = field( + assignee_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assigneeId"}, ) """User ID of assignee""" - assigner_id: Optional[str] = field( + assigner_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignerId"}, ) """User ID of the last user to add an assignee""" - associations: Optional[List[Association]] = None + associations: Optional[ + List[Association | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of associations on a task""" - copy_from: Optional[str] = field( + copy_from: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "copyFrom"}, ) """Task ID that task was copied from""" - created_at: Optional[str] = field( + created_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdAt"}, ) """Date the task was created""" - creator_id: Optional[str] = field( + creator_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creatorId"}, ) """User ID of creator""" - custom_properties: Optional[List[CustomPropertyValues]] = field( + custom_properties: Optional[ + List[CustomPropertyValues | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """List of custom properties on a task""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of task""" - followers: Optional[List[Follower]] = None + followers: Optional[ + List[Follower | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of followers on a task""" - id: Optional[str] = None - is_template: Optional[bool] = field( + id: Optional[str] = dataclass_field(default=None, kw_only=True) + is_template: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isTemplate"}, ) """Indicates if a task is part of a template""" - max_rank: Optional[str] = field( + max_rank: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "maxRank"}, ) """Maximum rank""" - min_rank: Optional[str] = field( + min_rank: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "minRank"}, ) """Minimum rank""" - parent_id: Optional[str] = field( + parent_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentId"}, ) """Task ID of parent if task is a subtask""" - planned_duration: Optional[int] = field( + planned_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedDuration"}, ) """Planned duration in days""" - planned_end_date: Optional[str] = field( + planned_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedEndDate"}, ) """Date string of end date (due date)""" - planned_start_date: Optional[str] = field( + planned_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedStartDate"}, ) """Date string of start date""" - priority: Optional[str] = None + priority: Optional[str] = dataclass_field(default=None, kw_only=True) """Priority value""" - project_id: Optional[str] = field( + project_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectId"}, ) """Project ID the task belongs to""" - rank: Optional[str] = None + rank: Optional[str] = dataclass_field(default=None, kw_only=True) """Rank of task in a task list""" - space_id: Optional[str] = field( + space_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spaceId"}, ) - status_schema_id: Optional[str] = field( + status_schema_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusSchemaId"}, ) - step_id: Optional[int] = field( + step_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "stepId"}, ) """Id of step in status schema""" - template_id: Optional[str] = field( + template_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "templateId"}, ) """Template ID of the template the task belongs to""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of task""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type of task""" - updated_at: Optional[str] = field( + updated_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "updatedAt"}, ) """Date the task was last updated""" @@ -1197,10 +1540,10 @@ class PossibleValuesItem: Definition: PossibleValuesItem """ - id: Optional[str] = None - order: Optional[int] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + order: Optional[int] = dataclass_field(default=None, kw_only=True) """Number to indicate order""" - value: Optional[Any] = None + value: Optional[Any] = dataclass_field(default=None, kw_only=True) """Actual value data""" @@ -1210,11 +1553,15 @@ class ProblemDetails: Definition: ProblemDetails """ - detail: Optional[str] = None - instance: Optional[str] = None - status: Optional[int] = None - title: Optional[str] = None - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + detail: Optional[str] = dataclass_field(default=None, kw_only=True) + instance: Optional[str] = dataclass_field(default=None, kw_only=True) + status: Optional[int] = dataclass_field(default=None, kw_only=True) + title: Optional[str] = dataclass_field(default=None, kw_only=True) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) @dataclass @@ -1223,17 +1570,20 @@ class ProjectAssociatedNodes: Definition: ProjectAssociatedNodes """ - node_id: Optional[str] = field( + node_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nodeId"}, ) - node_type: Optional[str] = field( + node_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nodeType"}, ) """Node type of the association""" - space_id: Optional[str] = field( + space_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "spaceId"}, ) @@ -1244,13 +1594,15 @@ class RequestFormCustomProperties: Definition: RequestFormCustomProperties """ - created_at: Optional[str] = field( + created_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdAt"}, ) """Date string of created date""" - custom_properties: Optional[List[CustomProperty]] = field( + custom_properties: Optional[List[CustomProperty | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """List of custom properties""" @@ -1262,12 +1614,13 @@ class ScopeSettingsItemDefinition: Definition: ScopeSettingsItemDefinition """ - is_required: Optional[bool] = field( + is_required: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isRequired"}, ) """Indicator on whether a field is required or not""" - scope: Optional[str] = None + scope: Optional[str] = dataclass_field(default=None, kw_only=True) """ Type list of node types that the custom property definition belongs to """ @@ -1279,21 +1632,25 @@ class UpdateCommentModel: Definition: UpdateCommentModel """ - annotation_payload: Optional[str] = field( + annotation_payload: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "annotationPayload"}, ) - annotation_type: Optional[str] = field( + annotation_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "annotationType"}, ) - comment_content: Optional[str] = field( + comment_content: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "commentContent"}, ) """Content of the comment""" - is_resolved: Optional[bool] = field( + is_resolved: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isResolved"}, ) """True/false on whether the comment is resolved""" @@ -1305,49 +1662,59 @@ class UpdateProject: Definition: UpdateProject """ - custom_properties: Optional[List[CustomPropertyValues]] = field( + custom_properties: Optional[ + List[CustomPropertyValues | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """List of custom properties""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of project""" - is_active: Optional[bool] = field( + is_active: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isActive"}, ) """Indicator on whether a project is active?""" - manager_id: Optional[str] = field( + manager_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerId"}, ) """User ID of project manager""" - max_rank: Optional[str] = field( + max_rank: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "maxRank"}, ) """Maximum rank number""" - min_rank: Optional[str] = field( + min_rank: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "minRank"}, ) """Minimum rank number""" - planned_duration: Optional[int] = field( + planned_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedDuration"}, ) """Planned duration in days""" - planned_end_date: Optional[str] = field( + planned_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedEndDate"}, ) """Date string of planned end date""" - planned_start_date: Optional[str] = field( + planned_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedStartDate"}, ) """Date string of planned start date""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of project""" @@ -1357,56 +1724,67 @@ class UpdateRequest: Definition: UpdateRequest """ - assignee_id: Optional[str] = field( + assignee_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assigneeId"}, ) """User ID of the assignee""" - content_refs: Optional[List[ContentRef]] = field( + content_refs: Optional[List[ContentRef | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentRefs"}, ) """List of content references (WorkSpace and DocCenter content)""" - custom_properties: Optional[List[CustomPropertyValuesInput]] = field( + custom_properties: Optional[ + List[CustomPropertyValuesInput | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """List of custom properties""" - form_ref: Optional[Any] = field( + form_ref: Optional[Any] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "formRef"}, ) """Form reference object""" - note: Optional[str] = None + note: Optional[str] = dataclass_field(default=None, kw_only=True) """Note used for notifications on status changes""" - planned_duration: Optional[int] = field( + planned_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedDuration"}, ) """Planned duration in days""" - planned_end_date: Optional[str] = field( + planned_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedEndDate"}, ) """Date string of planned end date (due date)""" - planned_start_date: Optional[str] = field( + planned_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedStartDate"}, ) """Date string of planned start date""" - priority: Optional[str] = None + priority: Optional[str] = dataclass_field(default=None, kw_only=True) """Priority value""" - project_id: Optional[str] = field( + project_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectId"}, ) """Project ID of the project the request belongs to""" - step_id: Optional[int] = field( + step_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "stepId"}, ) """Step ID indicating status""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the request""" @@ -1416,51 +1794,61 @@ class UpdateTask: Definition: UpdateTask """ - assignee_id: Optional[str] = field( + assignee_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assigneeId"}, ) """User ID of the assignee""" - custom_properties: Optional[List[CustomPropertyValuesInput]] = field( + custom_properties: Optional[ + List[CustomPropertyValuesInput | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "customProperties"}, ) """List of custom properties""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of task""" - parent_id: Optional[str] = field( + parent_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentId"}, ) """Task ID of parent task""" - planned_duration: Optional[int] = field( + planned_duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedDuration"}, ) """Planned duration in days""" - planned_end_date: Optional[str] = field( + planned_end_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedEndDate"}, ) """Date string of planned end date""" - planned_start_date: Optional[str] = field( + planned_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "plannedStartDate"}, ) """Date string of planned start date""" - priority: Optional[str] = None + priority: Optional[str] = dataclass_field(default=None, kw_only=True) """Priority value""" - project_id: Optional[str] = field( + project_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "projectId"}, ) """Project ID that the task belongs to""" - step_id: Optional[int] = field( + step_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "stepId"}, ) """Step ID indicating the task status""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of task""" @@ -1470,8 +1858,8 @@ class ValueSchemaPropertyDefinition: Definition: ValueSchemaPropertyDefinition """ - max: Optional[str] = None - min: Optional[str] = None + max: Optional[str] = dataclass_field(default=None, kw_only=True) + min: Optional[str] = dataclass_field(default=None, kw_only=True) # Client Class @@ -1485,7 +1873,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1502,8 +1890,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1524,7 +1912,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1539,25 +1927,125 @@ def __init__( def connector_name(self) -> str: return "seismicplanner" - async def get_comments_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_comments( self, space_id: str, node_id: str, + *, creator_ids: Optional[List[str]] = None, cursor: Optional[str] = None, limit: Optional[int] = None, sort: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get comments Get all comments for a given project, task, or request. Requires node (project, task, or request) ID. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetComments`. + + Args: + space_id: Space ID. + node_id: Node ID. + creator_ids: List of user IDs to query by creator. + cursor: Cursor used for pagination. + limit: Number to limit records. + sort: Sort by query. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1613,31 +2101,52 @@ async def get_comments_async( query_params.append(f"sort={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item - async def create_comment_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_comment( self, - input: CreateCommentModel, + input: CreateCommentModel | Mapping[str, Any], space_id: str, node_id: str, *, @@ -1651,6 +2160,24 @@ async def create_comment_async( Create a comment on a given project, task, or request. Requires node (project, task, or request) ID. + + Swagger operation ID: `CreateComment`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + space_id: Space ID. + node_id: Node ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1663,7 +2190,7 @@ async def create_comment_async( f"/comments" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1677,6 +2204,7 @@ async def create_comment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1684,7 +2212,7 @@ async def create_comment_async( return json.loads(response.text) - async def get_comment_async( + async def get_comment( self, space_id: str, node_id: str, @@ -1700,6 +2228,23 @@ async def get_comment_async( Get a single comment. Requires node (project, task, or request) and comment ID. + + Swagger operation ID: `GetComment`. + + Args: + space_id: Space ID. + node_id: Node ID. + comment_id: Comment ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1713,7 +2258,7 @@ async def get_comment_async( f"/{quote(str(comment_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1727,6 +2272,7 @@ async def get_comment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1734,7 +2280,7 @@ async def get_comment_async( return json.loads(response.text) - async def delete_comment_async( + async def delete_comment( self, space_id: str, node_id: str, @@ -1750,6 +2296,23 @@ async def delete_comment_async( Delete a comment. Requires node (project, task, or request) and comment ID. + + Swagger operation ID: `DeleteComment`. + + Args: + space_id: Space ID. + node_id: Node ID. + comment_id: Comment ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1763,7 +2326,7 @@ async def delete_comment_async( f"/{quote(str(comment_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1777,11 +2340,12 @@ async def delete_comment_async( request_url, response.status, response.text, + response=response, ) - async def update_comment_async( + async def update_comment( self, - input: UpdateCommentModel, + input: UpdateCommentModel | Mapping[str, Any], space_id: str, node_id: str, comment_id: str, @@ -1796,6 +2360,25 @@ async def update_comment_async( Update an existing comment. Requires node (project, task, or request) and comment ID. + + Swagger operation ID: `UpdateComment`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + space_id: Space ID. + node_id: Node ID. + comment_id: Comment ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1809,7 +2392,7 @@ async def update_comment_async( f"/{quote(str(comment_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1823,6 +2406,7 @@ async def update_comment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1830,9 +2414,10 @@ async def update_comment_async( return json.loads(response.text) - async def get_projects_async( + def list_projects( self, space_id: str, + *, planned_end_date_from: Optional[str] = None, planned_end_date_to: Optional[str] = None, planned_start_date_from: Optional[str] = None, @@ -1848,16 +2433,49 @@ async def get_projects_async( custom_properties: Optional[str] = None, follower_ids: Optional[List[str]] = None, include_associations: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get projects Get a list of projects with their attributes and associations. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetProjects`. + + Args: + space_id: Space ID. + planned_end_date_from: Filter from a planned end date. + planned_end_date_to: Filter to a planned end date. + planned_start_date_from: Filter from a planned start date. + planned_start_date_to: Filter to a planned start date. + ids: List of project IDs to query by. + title: Project title to query by. + manager_ids: List of user IDs to query by manager. + creator_ids: List of user IDs to query by creator. + associated_node_ids: List of association IDs to query by. + cursor: Cursor used for pagination. + limit: Number to limit records returned. + sort: Sort query. + custom_properties: List of custom properties to query by. + follower_ids: List of user IDs to query by follower. + include_associations: Indicator to allow for inclusion of + association data. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2002,34 +2620,55 @@ async def get_projects_async( query_params.append(f"includeAssociations={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def delete_projects_async( + async def delete_projects( self, space_id: str, ids: List[str], - delete_tasks: Optional[bool] = None, *, + delete_tasks: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2039,6 +2678,23 @@ async def delete_projects_async( Delete projects Delete one or more projects. + + Swagger operation ID: `DeleteProjects`. + + Args: + space_id: Space ID. + ids: List of project IDs. + delete_tasks: Also delete associated tasks. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2068,7 +2724,7 @@ async def delete_projects_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2082,6 +2738,7 @@ async def delete_projects_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2089,9 +2746,9 @@ async def delete_projects_async( return json.loads(response.text) - async def create_project_async( + async def create_project( self, - input: CreateProject, + input: CreateProject | Mapping[str, Any], space_id: str, *, timeout: Optional[float] = None, @@ -2103,13 +2760,30 @@ async def create_project_async( Create project Create a project. + + Swagger operation ID: `CreateProject`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + space_id: Space ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/planner/v2/spaces/{quote(str(space_id), safe='')}/projects" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2123,6 +2797,7 @@ async def create_project_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2130,13 +2805,13 @@ async def create_project_async( return json.loads(response.text) - async def get_project_async( + async def get_project( self, space_id: str, project_id: str, + *, associated_nodes_depth: Optional[int] = None, include_works: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2146,6 +2821,25 @@ async def get_project_async( Get project Get a single project by ID. Return tasks if desired. + + Swagger operation ID: `GetProject`. + + Args: + space_id: Space ID. + project_id: Project ID. + associated_nodes_depth: Number to indicate depth of associated node + data returned. + include_works: Indicator to include associated tasks data. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2170,7 +2864,7 @@ async def get_project_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2184,6 +2878,7 @@ async def get_project_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2191,12 +2886,12 @@ async def get_project_async( return json.loads(response.text) - async def delete_project_async( + async def delete_project( self, space_id: str, project_id: str, - delete_tasks: Optional[bool] = None, *, + delete_tasks: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2206,6 +2901,23 @@ async def delete_project_async( Delete project Delete a project. + + Swagger operation ID: `DeleteProject`. + + Args: + space_id: Space ID. + project_id: Project ID. + delete_tasks: Also delete associated tasks. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2225,7 +2937,7 @@ async def delete_project_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2239,6 +2951,7 @@ async def delete_project_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2246,9 +2959,9 @@ async def delete_project_async( return json.loads(response.text) - async def update_project_async( + async def update_project( self, - input: UpdateProject, + input: UpdateProject | Mapping[str, Any], space_id: str, project_id: str, *, @@ -2261,6 +2974,24 @@ async def update_project_async( Update a project Update and return a project. + + Swagger operation ID: `UpdateProject`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + space_id: Space ID. + project_id: Project ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2272,7 +3003,7 @@ async def update_project_async( f"/{quote(str(project_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2286,6 +3017,7 @@ async def update_project_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2293,9 +3025,10 @@ async def update_project_async( return json.loads(response.text) - async def get_requests_async( + def list_requests( self, space_id: str, + *, planned_end_date_from: Optional[str] = None, planned_end_date_to: Optional[str] = None, planned_start_date_from: Optional[str] = None, @@ -2323,16 +3056,62 @@ async def get_requests_async( associated_node_ids: Optional[List[str]] = None, content_refs: Optional[List[str]] = None, include_request_form_custom_properties: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get requests Get a list of requests. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetRequests`. + + Args: + space_id: Space ID. + planned_end_date_from: filter by request due date (inclusive). + planned_end_date_to: filter by request due date (exclusive). + planned_start_date_from: filter by request start date (inclusive). + planned_start_date_to: filter by request start date (exclusive). + created_at_from: filter by request created date (inclusive). + created_at_to: filter by request created date (exclusive). + updated_at_from: filter by request updated date (inclusive). + updated_at_to: filter by request updated date (exclusive). + ids: A list of request IDs. + title: Keyword values to search for on request titles. + assignee_ids: A list of assignees' user IDs to filter by. + priorities: A list of priority values, Available values : critical, + high, medium, low. + keywords: Keyword values to search. + assigner_ids: A list of assigner' user Ids to filter by. + creator_ids: A list of creators' user IDs to filter by. + step_ids: A list of step IDs to filter by. + status_schema_id: Status schema ID to filter by. + cursor: A token used to guide the next page window. + limit: Number of items to return per page, default: 50. + sort: Sort by requests. + project_id: The project ID a request is associated to. + has_project: Filter by if requests are associated with a project. + custom_properties: Filter by custom properties. + follower_ids: A list of followers' user id. + associated_node_ids: A list of Associated node IDs to filter by. + content_refs: List of content reference objects. + include_request_form_custom_properties: whether to include request + form custom properties, default false. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2577,31 +3356,52 @@ async def get_requests_async( query_params.append(f"includeRequestFormCustomProperties={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def delete_requests_async( + async def delete_requests( self, - input: DeleteRequest, + input: DeleteRequest | Mapping[str, Any], space_id: str, *, timeout: Optional[float] = None, @@ -2613,13 +3413,30 @@ async def delete_requests_async( Delete requests Bulk delete requests. + + Swagger operation ID: `DeleteRequests`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + space_id: Space ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/planner/v2/spaces/{quote(str(space_id), safe='')}/requests" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=input, timeout=timeout, headers=headers, @@ -2633,6 +3450,7 @@ async def delete_requests_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2640,9 +3458,9 @@ async def delete_requests_async( return json.loads(response.text) - async def create_request_async( + async def create_request( self, - input: CreateRequest, + input: CreateRequest | Mapping[str, Any], space_id: str, *, timeout: Optional[float] = None, @@ -2654,13 +3472,30 @@ async def create_request_async( Create request Create a request. + + Swagger operation ID: `CreateRequest`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + space_id: Space ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/planner/v2/spaces/{quote(str(space_id), safe='')}/requests" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2674,6 +3509,7 @@ async def create_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2681,7 +3517,7 @@ async def create_request_async( return json.loads(response.text) - async def get_request_async( + async def get_request( self, space_id: str, request_id: str, @@ -2695,6 +3531,22 @@ async def get_request_async( Get request Get a single request. + + Swagger operation ID: `GetRequest`. + + Args: + space_id: Space ID. + request_id: Request ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2706,7 +3558,7 @@ async def get_request_async( f"/{quote(str(request_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2720,6 +3572,7 @@ async def get_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2727,7 +3580,7 @@ async def get_request_async( return json.loads(response.text) - async def delete_request_async( + async def delete_request( self, space_id: str, request_id: str, @@ -2741,6 +3594,22 @@ async def delete_request_async( Delete request Delete a request. + + Swagger operation ID: `DeleteRequest`. + + Args: + space_id: Space ID. + request_id: Request ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2752,7 +3621,7 @@ async def delete_request_async( f"/{quote(str(request_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2766,11 +3635,12 @@ async def delete_request_async( request_url, response.status, response.text, + response=response, ) - async def update_request_async( + async def update_request( self, - input: UpdateRequest, + input: UpdateRequest | Mapping[str, Any], space_id: str, request_id: str, *, @@ -2783,6 +3653,24 @@ async def update_request_async( Update request Update a request. + + Swagger operation ID: `UpdateRequest`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + space_id: Space ID. + request_id: Request ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2794,7 +3682,7 @@ async def update_request_async( f"/{quote(str(request_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2808,6 +3696,7 @@ async def update_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2815,27 +3704,51 @@ async def update_request_async( return json.loads(response.text) - async def get_status_schemas_async( + def list_status_schemas( self, space_id: str, + *, is_default: Optional[bool] = None, type_: Optional[str] = None, ids: Optional[List[str]] = None, creator_ids: Optional[List[str]] = None, cursor: Optional[str] = None, limit: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get status schemas Get a list of task/request status schemas. These schemas hold the data for set statuses for specific work. Example: `(Not started, In progress, Complete)` + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetStatusSchemas`. + + Args: + space_id: Space ID. + is_default: Get default status schema. + type_: Query by node type. + ids: List of status schemas IDs. + creator_ids: List of user IDs to query by creator. + cursor: Cursor used for pagination. + limit: Number to limit returned records. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2895,29 +3808,50 @@ async def get_status_schemas_async( query_params.append(f"limit={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item - async def get_status_schema_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_status_schema( self, space_id: str, status_schema_id: str, @@ -2933,6 +3867,22 @@ async def get_status_schema_async( Get a single status schema by ID. These schemas hold the data for set statuses for specific work. Example: `(Not started, In progress, Complete)` + + Swagger operation ID: `GetStatusSchema`. + + Args: + space_id: Space ID. + status_schema_id: Status schema ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2944,7 +3894,7 @@ async def get_status_schema_async( f"/{quote(str(status_schema_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2958,6 +3908,7 @@ async def get_status_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2965,9 +3916,10 @@ async def get_status_schema_async( return json.loads(response.text) - async def get_tasks_async( + def list_tasks( self, space_id: str, + *, planned_end_date_from: Optional[str] = None, planned_end_date_to: Optional[str] = None, planned_start_date_from: Optional[str] = None, @@ -2997,16 +3949,63 @@ async def get_tasks_async( creator_ids: Optional[List[str]] = None, include_associations: Optional[bool] = None, parent_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get tasks Get a list of tasks. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTasks`. + + Args: + space_id: Space ID. + planned_end_date_from: Filter by task due date (inclusive). + planned_end_date_to: Filter by task due date (exclusive). + planned_start_date_from: Filter by task start date (inclusive). + planned_start_date_to: Filter by task start date (exclusive). + created_at_from: Filter by task created date (inclusive). + created_at_to: Filter by task created date (exclusive). + updated_at_from: Filter by task updated date (inclusive). + updated_at_to: Filter by task updated date (exclusive). + ids: Filter by a list of task IDs. + title: Filter by task title. + description: Filter by task description. + assignee_ids: List of user IDs to filter by assignee. + priorities: Filter by list of priorities. + keywords: Filter by keywords. + assigner_ids: List of user IDs to filter by user that assigned the + task. + step_ids: Filter by status value IDs. + status_schema_id: Filter by status schema IDs. + cursor: Cursor used for pagination. + limit: Number to limit returned records. + sort: Sort by query. + recursive: Include subtasks within the returned list. + project_id: Filter by project ID. + has_project: Filter by tasks that are associated with a project. + custom_properties: Filter by custom property values. + follower_ids: List of user IDs to filter by followers. + associated_node_ids: List of association IDs to filter by. + creator_ids: List of user IDs to filter by creator. + include_associations: Include association data in the response. + parent_id: List of task IDs to filter by. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3251,31 +4250,52 @@ async def get_tasks_async( query_params.append(f"parentId={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() - async def create_task_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_task( self, - input: CreateTask, + input: CreateTask | Mapping[str, Any], space_id: str, *, timeout: Optional[float] = None, @@ -3287,13 +4307,30 @@ async def create_task_async( Create task Create a task. + + Swagger operation ID: `CreateTask`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + space_id: Space ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/planner/v2/spaces/{quote(str(space_id), safe='')}/tasks" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3307,6 +4344,7 @@ async def create_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3314,7 +4352,7 @@ async def create_task_async( return json.loads(response.text) - async def get_task_async( + async def get_task( self, space_id: str, task_id: str, @@ -3328,6 +4366,22 @@ async def get_task_async( Get task Get a single task by ID. + + Swagger operation ID: `GetTask`. + + Args: + space_id: Space ID. + task_id: Task ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3339,7 +4393,7 @@ async def get_task_async( f"/{quote(str(task_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3353,6 +4407,7 @@ async def get_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3360,7 +4415,7 @@ async def get_task_async( return json.loads(response.text) - async def delete_task_async( + async def delete_task( self, space_id: str, task_id: str, @@ -3374,6 +4429,22 @@ async def delete_task_async( Delete task Delete a task. + + Swagger operation ID: `DeleteTask`. + + Args: + space_id: Space ID. + task_id: Task ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3385,7 +4456,7 @@ async def delete_task_async( f"/{quote(str(task_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -3399,6 +4470,7 @@ async def delete_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3406,9 +4478,9 @@ async def delete_task_async( return json.loads(response.text) - async def update_task_async( + async def update_task( self, - input: UpdateTask, + input: UpdateTask | Mapping[str, Any], space_id: str, task_id: str, *, @@ -3421,6 +4493,24 @@ async def update_task_async( Update task Update an existing task. + + Swagger operation ID: `UpdateTask`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + space_id: Space ID. + task_id: Task ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3432,7 +4522,7 @@ async def update_task_async( f"/{quote(str(task_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -3446,6 +4536,7 @@ async def update_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/sendgrid.py b/src/azure/connectors/sendgrid.py index 29b27d3c..9e16629b 100644 --- a/src/azure/connectors/sendgrid.py +++ b/src/azure/connectors/sendgrid.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,28 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "SendgridClient", + "AddGlobalSuppressRequestAndResponse", + "Bounce", + "Bounces", + "EmailAttachment", + "EmailIsUnsubscribedResponse", + "EmailRequest", + "EmailResponse", + "GetGlobalSuppressEmptyResponse", + "GetGlobalSuppressResponse", + "ObjectEntity", + "Recipient", + "RecipientList", + "RecipientLists", + "Recipients", + "ScopeList", +] + # Type Definitions @@ -29,7 +50,7 @@ class AddGlobalSuppressRequestAndResponse: Response for Add a global suppression """ - recipient_emails: Optional[List[str]] = None + recipient_emails: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Recipient email""" @@ -39,7 +60,7 @@ class GetGlobalSuppressResponse: Response for Get the global suppression """ - recipient_email: Optional[str] = None + recipient_email: Optional[str] = dataclass_field(default=None, kw_only=True) """Recipient email""" @@ -49,14 +70,14 @@ class ObjectEntity: Response for Add recipient to list """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) """ -Bounces = List["Bounce"] +Bounces = List["Bounce | Mapping[str, Any]"] @dataclass @@ -65,8 +86,9 @@ class EmailIsUnsubscribedResponse: Response for Check if email is in unsubscribed email list """ - is_unsubscribed: Optional[bool] = field( + is_unsubscribed: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isUnsubscribed"}, ) """Is Email Unsubscribed""" @@ -78,7 +100,12 @@ class RecipientLists: Response for List Recipient Lists """ - lists: Optional[List[RecipientList]] = None + lists: Optional[ + List[RecipientList | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of recipient lists""" @@ -88,7 +115,12 @@ class Recipients: Response for List Recipients """ - recipients: Optional[List[Recipient]] = None + recipients: Optional[ + List[Recipient | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of recipients""" @@ -98,7 +130,7 @@ class EmailResponse: Definition: EmailResponse """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """Status message from send email response""" @@ -108,7 +140,7 @@ class GetGlobalSuppressEmptyResponse: Definition: GetGlobalSuppressEmptyResponse """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -121,36 +153,41 @@ class EmailRequest: Definition: EmailRequest """ - attachments: Optional[List[EmailAttachment]] = None + attachments: Optional[ + List[EmailAttachment | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Attachments""" - from_: Optional[str] = field(default=None, metadata={"wire_name": "from"}) + from_: str = dataclass_field(metadata={"wire_name": "from"}) """ Origination address of your email. Must be a valid email address from your domain """ - fromname: Optional[str] = None + fromname: Optional[str] = dataclass_field(default=None, kw_only=True) """Origination name of your email""" - to: Optional[str] = None + to: str """Valid email addresses separated by a semicolon or comma""" - toname: Optional[str] = None + toname: Optional[str] = dataclass_field(default=None, kw_only=True) """ A display name for each email address separated by a semicolon or comma """ - subject: Optional[str] = None + subject: str """Subject of your email""" - text: Optional[str] = None + text: str """Content of your email""" - ishtml: Optional[bool] = None + ishtml: bool """Specify whether the content of the email is HTML or plain text""" - cc: Optional[str] = None + cc: Optional[str] = dataclass_field(default=None, kw_only=True) """Valid email addresses separated by a semicolon or comma""" - ccname: Optional[str] = None + ccname: Optional[str] = dataclass_field(default=None, kw_only=True) """ A display name for each CC email address separated by a semicolon or comma """ - bcc: Optional[str] = None + bcc: Optional[str] = dataclass_field(default=None, kw_only=True) """Valid email addresses separated by a semicolon or comma""" - bccname: Optional[str] = None + bccname: Optional[str] = dataclass_field(default=None, kw_only=True) """ A display name for each BCC email address separated by a semicolon or comma """ @@ -162,11 +199,11 @@ class EmailAttachment: Definition: EmailAttachment """ - content: Optional[str] = None + content: Optional[str] = dataclass_field(default=None, kw_only=True) """Attachment file content""" - filename: Optional[str] = None + filename: Optional[str] = dataclass_field(default=None, kw_only=True) """Attachment file name""" - contenttype: Optional[str] = None + contenttype: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of content in the attachment.""" @@ -176,11 +213,11 @@ class RecipientList: Definition: RecipientList """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique list id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name""" - recipient_count: Optional[int] = None + recipient_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Recipient count""" @@ -190,13 +227,13 @@ class Recipient: Definition: Recipient """ - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address""" - last_name: Optional[str] = None + last_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Last name""" - first_name: Optional[str] = None + first_name: Optional[str] = dataclass_field(default=None, kw_only=True) """First name""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique recipient id""" @@ -206,7 +243,7 @@ class ScopeList: Definition: ScopeList """ - scopes: Optional[List[str]] = None + scopes: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """List of scopes""" @@ -216,13 +253,13 @@ class Bounce: Definition: Bounce """ - created: Optional[int] = None + created: Optional[int] = dataclass_field(default=None, kw_only=True) """Created""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email""" - reason: Optional[str] = None + reason: Optional[str] = dataclass_field(default=None, kw_only=True) """Reason""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status""" @@ -237,7 +274,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -254,8 +291,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -276,7 +313,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -291,9 +328,86 @@ def __init__( def connector_name(self) -> str: return "sendgrid" - async def add_global_suppression_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def add_global_suppression( self, - input: AddGlobalSuppressRequestAndResponse, + input: AddGlobalSuppressRequestAndResponse | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -304,10 +418,26 @@ async def add_global_suppression_async( Add a global suppression Add a global suppression + + Swagger operation ID: `AddGlobalSuppression`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/suppressions/global" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -321,6 +451,7 @@ async def add_global_suppression_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -328,7 +459,7 @@ async def add_global_suppression_async( return json.loads(response.text) - async def get_global_suppression_async( + async def get_global_suppression( self, email: str, *, @@ -341,13 +472,28 @@ async def get_global_suppression_async( Get the global suppression Get the global suppression + + Swagger operation ID: `GetGlobalSuppression`. + + Args: + email: The email to check. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/suppressions/global/{quote(str(email), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -361,6 +507,7 @@ async def get_global_suppression_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -368,7 +515,7 @@ async def get_global_suppression_async( return json.loads(response.text) - async def delete_global_suppression_async( + async def delete_global_suppression( self, email: str, *, @@ -381,13 +528,28 @@ async def delete_global_suppression_async( Delete the global suppression Delete the global suppression + + Swagger operation ID: `DeleteGlobalSuppression`. + + Args: + email: The email to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/suppressions/global/{quote(str(email), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -401,9 +563,10 @@ async def delete_global_suppression_async( request_url, response.status, response.text, + response=response, ) - async def add_recipient_to_list_async( + async def add_recipient_to_list( self, list_id: str, recipient_id: str, @@ -417,6 +580,22 @@ async def add_recipient_to_list_async( Add recipient to list Add an individual recipient to a recipient list. + + Swagger operation ID: `AddRecipientToList`. + + Args: + list_id: Unique id of the recipient list. + recipient_id: Unique id of the recipient. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -428,7 +607,7 @@ async def add_recipient_to_list_async( f"/{quote(str(recipient_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -442,6 +621,7 @@ async def add_recipient_to_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -449,7 +629,7 @@ async def add_recipient_to_list_async( return json.loads(response.text) - async def get_bounce_async( + def list_bounce( self, email: str, *, @@ -457,39 +637,78 @@ async def get_bounce_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get bounce for an email Get a specific bounce for a given email address. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetBounce`. + + Args: + email: The email to check. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/suppression/bounces/{quote(str(email), safe='')}" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def delete_bounce_async( + return AsyncItemPaged(get_next, extract_data) + + async def delete_bounce( self, email: str, *, @@ -502,13 +721,28 @@ async def delete_bounce_async( Delete an email from bounce list Delete an email address from your bounce list. + + Swagger operation ID: `DeleteBounce`. + + Args: + email: The email to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/suppression/bounces/{quote(str(email), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -522,9 +756,10 @@ async def delete_bounce_async( request_url, response.status, response.text, + response=response, ) - async def check_email_is_in_unsubscribes_list_async( + async def check_email_is_in_unsubscribes_list( self, email: str, *, @@ -537,13 +772,28 @@ async def check_email_is_in_unsubscribes_list_async( Check if email is in unsubscribed email list Check if email is in unsubscribed email list. + + Swagger operation ID: `CheckEmailIsInUnsubscribesList`. + + Args: + email: The email to check. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/unsubscribes/{quote(str(email), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -557,6 +807,7 @@ async def check_email_is_in_unsubscribes_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -564,9 +815,9 @@ async def check_email_is_in_unsubscribes_list_async( return json.loads(response.text) - async def send_email_async( + async def send_email( self, - input: EmailRequest, + input: EmailRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -577,10 +828,26 @@ async def send_email_async( Send email Sends an email (V4). Limited to 1000 recipients. + + Swagger operation ID: `SendEmailV4`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v4/mail/send" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -594,6 +861,7 @@ async def send_email_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -601,74 +869,150 @@ async def send_email_async( return json.loads(response.text) - async def list_recipient_lists_async( + def list_recipient_lists( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Recipient Lists Retrieves all the recipient lists. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRecipientLists`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v3/contactdb/lists" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("lists", []): + yield item + + return None, items() - async def list_recipients_async( + return AsyncItemPaged(get_next, extract_data) + + def list_recipients( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List Recipients Retrieves all registered recipients. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRecipients`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v3/contactdb/recipients" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("recipients", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/servicebus.py b/src/azure/connectors/servicebus.py index 9a3c3eb3..0fda4062 100644 --- a/src/azure/connectors/servicebus.py +++ b/src/azure/connectors/servicebus.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,12 +19,26 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "ServicebusClient", + "CreateTopicSubscriptionInput", + "ObjectEntity", + "SendMessagesInput", + "ServiceBusEntity", + "ServiceBusMessage", + "Subscription", + "SubscriptionCorrelationFilter", + "SubscriptionFilter", + "TRIGGER_OPERATIONS", +] + # Type Definitions -SendMessagesInput = List["ServiceBusMessage"] +SendMessagesInput = List["ServiceBusMessage | Mapping[str, Any]"] @dataclass @@ -32,70 +47,90 @@ class ServiceBusMessage: Response for When a message is received in a queue (auto-complete) """ - content_data: Optional[str] = field( + content_data: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentData"}, ) """Content of the message""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentType"}, ) """Content type of the message content""" - properties: Optional[Dict[str, str]] = field( + properties: Optional[Dict[str, str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Key-value pairs for each brokered property""" - message_id: Optional[str] = field( + message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageId"}, ) """ This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled. """ - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """Send to address""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """Address of the queue to reply to""" - reply_to_session_id: Optional[str] = field( + reply_to_session_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyToSessionId"}, ) """Identifier of the session to reply to""" - label: Optional[str] = field(default=None, metadata={"wire_name": "Label"}) + label: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Label"}, + ) """Application specific label""" - scheduled_enqueue_time_utc: Optional[str] = field( + scheduled_enqueue_time_utc: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ScheduledEnqueueTimeUtc"}, ) """Date and time, in UTC, when the message will be added to the queue""" - session_id: Optional[str] = field( + session_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SessionId"}, ) """Identifier of the session""" - correlation_id: Optional[str] = field( + correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CorrelationId"}, ) """Identifier of the correlation""" - sequence_number: Optional[int] = field( + sequence_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SequenceNumber"}, ) """Identifier of the sequence number""" - lock_token: Optional[str] = field( + lock_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LockToken"}, ) """The lock token of the message as a string.""" - time_to_live: Optional[str] = field( + time_to_live: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeToLive"}, ) """ @@ -110,7 +145,7 @@ class CreateTopicSubscriptionInput: Create a topic subscription """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -123,8 +158,9 @@ class Subscription: Response for Create a topic subscription """ - subscription_name: Optional[str] = field( + subscription_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SubscriptionName"}, ) """Subscription name.""" @@ -136,10 +172,15 @@ class ServiceBusEntity: Response for Get all entities """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The entity name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name for the entity""" @@ -151,7 +192,7 @@ class ObjectEntity: Response for Get metadata of a filter """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -164,8 +205,11 @@ class SubscriptionFilter: Definition: SubscriptionFilter """ - correlation_filter: Optional[SubscriptionCorrelationFilter] = field( + correlation_filter: Optional[ + SubscriptionCorrelationFilter | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CorrelationFilter"}, ) @@ -176,45 +220,60 @@ class SubscriptionCorrelationFilter: Definition: SubscriptionCorrelationFilter """ - correlation_id: Optional[str] = field( + correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CorrelationId"}, ) """Identifier of the correlation""" - label: Optional[str] = field(default=None, metadata={"wire_name": "Label"}) + label: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Label"}, + ) """Application specific label""" - message_id: Optional[str] = field( + message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MessageId"}, ) """ This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled. """ - properties: Optional[Dict[str, str]] = field( + properties: Optional[Dict[str, str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Properties"}, ) """Key-value pairs for each brokered property""" - reply_to: Optional[str] = field( + reply_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyTo"}, ) """Address of the queue to reply to""" - reply_to_session_id: Optional[str] = field( + reply_to_session_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReplyToSessionId"}, ) """Identifier of the session to reply to""" - session_id: Optional[str] = field( + session_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SessionId"}, ) """Identifier of the session""" - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """Send to address""" - content_type: Optional[str] = field( + content_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentType"}, ) """Content type of the message content""" @@ -231,7 +290,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -248,8 +307,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -270,7 +329,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -285,12 +344,89 @@ def __init__( def connector_name(self) -> str: return "servicebus" - async def send_message_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def send_message( self, - input: ServiceBusMessage, + input: ServiceBusMessage | Mapping[str, Any], entity_name: str, - system_properties: Optional[str] = None, *, + system_properties: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -300,6 +436,26 @@ async def send_message_async( Send message This operation sends a message to a queue or topic. + + Swagger operation ID: `SendMessage`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + entity_name: Name of the queue or topic. + system_properties: System properties - None or Run Details. Run + Details will add run metadata property details as custom + properties in the message. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -314,7 +470,7 @@ async def send_message_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -328,14 +484,15 @@ async def send_message_async( request_url, response.status, response.text, + response=response, ) - async def send_messages_async( + async def send_messages( self, input: SendMessagesInput, entity_name: str, - system_properties: Optional[str] = None, *, + system_properties: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -345,6 +502,25 @@ async def send_messages_async( Send one or more messages This operation sends one or more messages to a queue or topic. + + Swagger operation ID: `SendMessages`. + + Args: + input: The request body. + entity_name: Name of the queue or topic. + system_properties: System properties - None or Run Details. Run + Details will add run metadata property details as custom + properties in the message. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -361,7 +537,7 @@ async def send_messages_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -375,15 +551,16 @@ async def send_messages_async( request_url, response.status, response.text, + response=response, ) - async def complete_message_in_queue_async( + async def complete_message_in_queue( self, queue_name: str, lock_token: str, + *, queue_type: Optional[str] = None, session_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -393,6 +570,24 @@ async def complete_message_in_queue_async( Complete the message in a queue The operation completes a message in a queue. + + Swagger operation ID: `CompleteMessageInQueue`. + + Args: + queue_name: Name of the queue. + lock_token: Lock token of the message to complete. + queue_type: Queue type - Main or DeadLetter. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -418,7 +613,7 @@ async def complete_message_in_queue_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -432,15 +627,16 @@ async def complete_message_in_queue_async( request_url, response.status, response.text, + response=response, ) - async def abandon_message_in_queue_async( + async def abandon_message_in_queue( self, queue_name: str, lock_token: str, + *, queue_type: Optional[str] = None, session_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -450,6 +646,24 @@ async def abandon_message_in_queue_async( Abandon the message in a queue The operation abandons a message in a queue. + + Swagger operation ID: `AbandonMessageInQueue`. + + Args: + queue_name: Name of the queue. + lock_token: Lock token of the message to abandon. + queue_type: Queue type - Main or DeadLetter. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -475,7 +689,7 @@ async def abandon_message_in_queue_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -489,15 +703,16 @@ async def abandon_message_in_queue_async( request_url, response.status, response.text, + response=response, ) - async def get_deferred_message_from_queue_async( + async def get_deferred_message_from_queue( self, queue_name: str, sequence_number: int, + *, queue_type: Optional[str] = None, session_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -507,6 +722,24 @@ async def get_deferred_message_from_queue_async( Get deferred message from a queue The operation gets a deferred message from a queue. + + Swagger operation ID: `GetDeferredMessageFromQueue`. + + Args: + queue_name: Name of the queue. + sequence_number: Sequence number of message. + queue_type: Queue type - Main or DeadLetter. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -532,7 +765,7 @@ async def get_deferred_message_from_queue_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -546,6 +779,7 @@ async def get_deferred_message_from_queue_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -553,13 +787,13 @@ async def get_deferred_message_from_queue_async( return json.loads(response.text) - async def defer_message_in_queue_async( + async def defer_message_in_queue( self, queue_name: str, lock_token: str, + *, queue_type: Optional[str] = None, session_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -569,6 +803,24 @@ async def defer_message_in_queue_async( Defer the message in a queue The operation defers a message in a queue. + + Swagger operation ID: `DeferMessageInQueue`. + + Args: + queue_name: Name of the queue. + lock_token: Lock token of the message to defer. + queue_type: Queue type - Main or DeadLetter. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -594,7 +846,7 @@ async def defer_message_in_queue_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -608,16 +860,17 @@ async def defer_message_in_queue_async( request_url, response.status, response.text, + response=response, ) - async def dead_letter_message_in_queue_async( + async def dead_letter_message_in_queue( self, queue_name: str, lock_token: str, + *, session_id: Optional[str] = None, dead_letter_reason: Optional[str] = None, dead_letter_error_description: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -627,6 +880,25 @@ async def dead_letter_message_in_queue_async( Dead-letter the message in a queue The operation moves the message to the Dead-Letter Queue. + + Swagger operation ID: `DeadLetterMessageInQueue`. + + Args: + queue_name: Name of the queue. + lock_token: Lock token of the message to dead-letter. + session_id: Session id. + dead_letter_reason: Dead letter reason. + dead_letter_error_description: Dead letter error description. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -657,7 +929,7 @@ async def dead_letter_message_in_queue_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -671,14 +943,15 @@ async def dead_letter_message_in_queue_async( request_url, response.status, response.text, + response=response, ) - async def renew_lock_on_message_in_queue_async( + async def renew_lock_on_message_in_queue( self, queue_name: str, lock_token: str, - queue_type: Optional[str] = None, *, + queue_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -688,6 +961,23 @@ async def renew_lock_on_message_in_queue_async( Renew lock on the message in a queue The operation renews lock on a message in a queue. + + Swagger operation ID: `RenewLockOnMessageInQueue`. + + Args: + queue_name: Name of the queue. + lock_token: Lock token of the message to renew lock. + queue_type: Queue type - Main or DeadLetter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -708,7 +998,7 @@ async def renew_lock_on_message_in_queue_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -722,25 +1012,48 @@ async def renew_lock_on_message_in_queue_async( request_url, response.status, response.text, + response=response, ) - async def get_messages_from_queue_with_peek_lock_async( + def list_messages_from_queue_with_peek_lock( self, queue_name: str, + *, max_message_count: Optional[int] = None, queue_type: Optional[str] = None, session_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get messages from a queue (peek-lock) The operation receives messages from a queue with peek-lock. If maximum message count is not provided, it reads 20 messages. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMessagesFromQueueWithPeekLock`. + + Args: + queue_name: Name of the queue. + max_message_count: The maximum number of messages to return in the + batch. + queue_type: Queue type - Main or DeadLetter. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -767,29 +1080,50 @@ async def get_messages_from_queue_with_peek_lock_async( query_params.append(f"sessionId={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def close_session_in_queue_async( + async def close_session_in_queue( self, queue_name: str, session_id: str, @@ -803,6 +1137,22 @@ async def close_session_in_queue_async( Close a session in a queue The operation closes a session in a queue. + + Swagger operation ID: `CloseSessionInQueue`. + + Args: + queue_name: Name of a queue. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -812,7 +1162,7 @@ async def close_session_in_queue_async( f"/close" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -826,9 +1176,10 @@ async def close_session_in_queue_async( request_url, response.status, response.text, + response=response, ) - async def renew_lock_on_session_in_queue_async( + async def renew_lock_on_session_in_queue( self, queue_name: str, session_id: str, @@ -842,6 +1193,22 @@ async def renew_lock_on_session_in_queue_async( Renew lock on the session in a queue The operation renews a session in a queue. + + Swagger operation ID: `RenewLockOnSessionInQueue`. + + Args: + queue_name: Name of the queue. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -851,7 +1218,7 @@ async def renew_lock_on_session_in_queue_async( f"/renewlock" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -865,16 +1232,17 @@ async def renew_lock_on_session_in_queue_async( request_url, response.status, response.text, + response=response, ) - async def complete_message_in_topic_async( + async def complete_message_in_topic( self, topic_name: str, subscription_name: str, lock_token: str, + *, subscription_type: Optional[str] = None, session_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -884,6 +1252,25 @@ async def complete_message_in_topic_async( Complete the message in a topic subscription The operation completes a message in a topic subscription. + + Swagger operation ID: `CompleteMessageInTopic`. + + Args: + topic_name: Name of the topic. + subscription_name: Name of the topic subscription. + lock_token: Lock token of the message to complete. + subscription_type: Subscription type - Main or DeadLetter. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -911,7 +1298,7 @@ async def complete_message_in_topic_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -925,16 +1312,17 @@ async def complete_message_in_topic_async( request_url, response.status, response.text, + response=response, ) - async def abandon_message_in_topic_async( + async def abandon_message_in_topic( self, topic_name: str, subscription_name: str, lock_token: str, + *, subscription_type: Optional[str] = None, session_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -944,6 +1332,25 @@ async def abandon_message_in_topic_async( Abandon the message in a topic subscription The operation abandons a message in a topic subscription. + + Swagger operation ID: `AbandonMessageInTopic`. + + Args: + topic_name: Name of the topic. + subscription_name: Name of the topic subscription. + lock_token: Lock token of the message to abandon. + subscription_type: Subscription type - Main or DeadLetter. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -971,7 +1378,7 @@ async def abandon_message_in_topic_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -985,16 +1392,17 @@ async def abandon_message_in_topic_async( request_url, response.status, response.text, + response=response, ) - async def get_deferred_message_from_topic_async( + async def get_deferred_message_from_topic( self, topic_name: str, subscription_name: str, sequence_number: int, + *, subscription_type: Optional[str] = None, session_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1004,6 +1412,25 @@ async def get_deferred_message_from_topic_async( Get deferred message from a topic subscription The operation gets a deferred message from a topic subscription. + + Swagger operation ID: `GetDeferredMessageFromTopic`. + + Args: + topic_name: Name of the topic. + subscription_name: Name of the topic subscription. + sequence_number: Sequence number of message. + subscription_type: Queue type - Main or DeadLetter. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1031,7 +1458,7 @@ async def get_deferred_message_from_topic_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1045,6 +1472,7 @@ async def get_deferred_message_from_topic_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1052,14 +1480,14 @@ async def get_deferred_message_from_topic_async( return json.loads(response.text) - async def defer_message_in_topic_async( + async def defer_message_in_topic( self, topic_name: str, subscription_name: str, lock_token: str, + *, subscription_type: Optional[str] = None, session_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1069,6 +1497,25 @@ async def defer_message_in_topic_async( Defer the message in a topic subscription The operation defers a message in a topic subscription. + + Swagger operation ID: `DeferMessageInTopic`. + + Args: + topic_name: Name of the topic. + subscription_name: Name of the topic subscription. + lock_token: Lock token of the message to defer. + subscription_type: Subscription type - Main or DeadLetter. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1096,7 +1543,7 @@ async def defer_message_in_topic_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1110,17 +1557,18 @@ async def defer_message_in_topic_async( request_url, response.status, response.text, + response=response, ) - async def dead_letter_message_in_topic_async( + async def dead_letter_message_in_topic( self, topic_name: str, subscription_name: str, lock_token: str, + *, session_id: Optional[str] = None, dead_letter_reason: Optional[str] = None, dead_letter_error_description: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1130,6 +1578,26 @@ async def dead_letter_message_in_topic_async( Dead-letter the message in a topic subscription The operation moves the message to the topic Dead-Letter Queue. + + Swagger operation ID: `DeadLetterMessageInTopic`. + + Args: + topic_name: Name of the topic. + subscription_name: Name of the topic subscription. + lock_token: Lock token of the message to dead-letter. + session_id: Session id. + dead_letter_reason: Dead letter reason. + dead_letter_error_description: Dead letter error description. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1162,7 +1630,7 @@ async def dead_letter_message_in_topic_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1176,15 +1644,16 @@ async def dead_letter_message_in_topic_async( request_url, response.status, response.text, + response=response, ) - async def renew_lock_on_message_in_topic_async( + async def renew_lock_on_message_in_topic( self, topic_name: str, subscription_name: str, lock_token: str, - subscription_type: Optional[str] = None, *, + subscription_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1194,6 +1663,24 @@ async def renew_lock_on_message_in_topic_async( Renew lock on the message in a topic subscription The operation renews lock on a message in a topic subscription. + + Swagger operation ID: `RenewLockOnMessageInTopic`. + + Args: + topic_name: Name of the topic. + subscription_name: Name of the topic subscription. + lock_token: Lock token of the message to renew lock. + subscription_type: Subscription type - Main or DeadLetter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1216,7 +1703,7 @@ async def renew_lock_on_message_in_topic_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1230,15 +1717,16 @@ async def renew_lock_on_message_in_topic_async( request_url, response.status, response.text, + response=response, ) - async def create_topic_subscription_async( + async def create_topic_subscription( self, - input: CreateTopicSubscriptionInput, + input: CreateTopicSubscriptionInput | Mapping[str, Any], topic_name: str, subscription_name: str, - subscription_filter_type: Optional[str] = None, *, + subscription_filter_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1248,6 +1736,25 @@ async def create_topic_subscription_async( Create a topic subscription The operation creates a topic subscription. + + Swagger operation ID: `CreateTopicSubscription`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + topic_name: Name of the topic. + subscription_name: Name of the topic subscription. + subscription_filter_type: Filter type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1264,7 +1771,7 @@ async def create_topic_subscription_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1278,6 +1785,7 @@ async def create_topic_subscription_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1285,7 +1793,7 @@ async def create_topic_subscription_async( return json.loads(response.text) - async def delete_topic_subscription_async( + async def delete_topic_subscription( self, topic_name: str, subscription_name: str, @@ -1299,6 +1807,22 @@ async def delete_topic_subscription_async( Delete a topic subscription The operation deletes a topic subscription. + + Swagger operation ID: `DeleteTopicSubscription`. + + Args: + topic_name: Name of the topic. + subscription_name: Name of the topic subscription. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1307,7 +1831,7 @@ async def delete_topic_subscription_async( f"/{quote(str(subscription_name), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1321,27 +1845,51 @@ async def delete_topic_subscription_async( request_url, response.status, response.text, + response=response, ) - async def get_messages_from_topic_with_peek_lock_async( + def list_messages_from_topic_with_peek_lock( self, topic_name: str, subscription_name: str, + *, max_message_count: Optional[int] = None, subscription_type: Optional[str] = None, session_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get messages from a topic subscription (peek-lock) The operation receives messages from a topic subscription with peek-lock. If maximum message count is not provided, it reads 20 messages. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMessagesFromTopicWithPeekLock`. + + Args: + topic_name: Name of the topic. + subscription_name: Name of the topic subscription. + max_message_count: The maximum number of messages to return in the + batch. + subscription_type: Subscription type - Main or DeadLetter. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1370,29 +1918,50 @@ async def get_messages_from_topic_with_peek_lock_async( query_params.append(f"sessionId={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def close_session_in_topic_async( + async def close_session_in_topic( self, topic_name: str, subscription_name: str, @@ -1407,6 +1976,23 @@ async def close_session_in_topic_async( Close a session in the topic The operation closes a session in the topic. + + Swagger operation ID: `CloseSessionInTopic`. + + Args: + topic_name: Name of the topic. + subscription_name: Name of the topic subscription. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1418,7 +2004,7 @@ async def close_session_in_topic_async( f"/close" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1432,9 +2018,10 @@ async def close_session_in_topic_async( request_url, response.status, response.text, + response=response, ) - async def renew_lock_on_session_in_topic_async( + async def renew_lock_on_session_in_topic( self, topic_name: str, subscription_name: str, @@ -1449,6 +2036,23 @@ async def renew_lock_on_session_in_topic_async( Renew lock on the session in a topic subscription The operation renews a session in a topic subscription. + + Swagger operation ID: `RenewLockOnSessionInTopic`. + + Args: + topic_name: Name of the topic. + subscription_name: Name of the topic subscription. + session_id: Session id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1460,7 +2064,7 @@ async def renew_lock_on_session_in_topic_async( f"/renewlock" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1474,190 +2078,381 @@ async def renew_lock_on_session_in_topic_async( request_url, response.status, response.text, + response=response, ) - async def get_entities_async( + def list_entities( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all entities This operation gets all queues and topics in the Service Bus namespace. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetEntities`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/entities" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_system_properties_async( + return AsyncItemPaged(get_next, extract_data) + + def list_system_properties( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get the list of system properties This operation gets list of properties. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetSystemProperties`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/systemproperties" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page: + yield item - async def get_queues_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_queues( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get all queues This operation gets all queues in the Service Bus namespace. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetQueues`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/queues" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_session_options_async( + def list_session_options( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get session options This operation gets the list of options for session handling - None, Next available. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetSessionOptions`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/sessionoptions" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page: + yield item + + return None, items() - async def get_topics_async( + return AsyncItemPaged(get_next, extract_data) + + def list_topics( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get all topics This operation gets all topics in the Service Bus namespace. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTopics`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/topics" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_subscriptions_async( + def list_subscriptions( self, topic_name: str, *, @@ -1665,12 +2460,30 @@ async def get_subscriptions_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[str]: """ Get the subscriptions for a topic This operation gets the list of subscriptions for a topic in the Service Bus namespace. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetSubscriptions`. + + Args: + topic_name: Topic name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[str]: An Azure Core pager over connector results. + Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1678,29 +2491,50 @@ async def get_subscriptions_async( f"/{quote(quote(str(topic_name), safe=''), safe='')}" f"/subscriptions" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[str]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[str]: + for item in page: + yield item + + return None, items() - async def get_subscription_filter_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_subscription_filter( self, subscription_filter_type: str, *, @@ -1713,6 +2547,21 @@ async def get_subscription_filter_async( Get metadata of a filter Get metadata of a filter. + + Swagger operation ID: `GetSubscriptionFilterV2`. + + Args: + subscription_filter_type: Subscription filter type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/subscriptionfilterV2" query_params = [] @@ -1723,7 +2572,7 @@ async def get_subscription_filter_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1737,6 +2586,7 @@ async def get_subscription_filter_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/sharepointonline.py b/src/azure/connectors/sharepointonline.py index 77448ccc..31f15dab 100644 --- a/src/azure/connectors/sharepointonline.py +++ b/src/azure/connectors/sharepointonline.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,92 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "SharepointonlineClient", + "ApplicationPermissionIdentity", + "ApprovalData", + "ApproveHubSiteJoinResponse", + "BlobDataSetsMetadata", + "BlobMetadata", + "BlobMetadataPage", + "BlobMetadataResponse", + "CopyFileParameters", + "CopyFolderParameters", + "CreateAgreementsSolutionDocumentInput", + "CreateApprovalRequestInput", + "CreateContentAssemblyDocumentInput", + "CreateNewDocumentSetParameters", + "CreateNewDocumentSetResponse", + "CreateNewFolderParameters", + "CreateNewFolderResponse", + "DataSet", + "DataSetsList", + "DataSetsMetadata", + "DeletedItem", + "DeletedItemList", + "FileCheckInParameters", + "FormFieldMetadata", + "GetItemChangesMetadataResponse", + "GetItemChangesResponse", + "GetItemResponse", + "GroupPermissionIdentity", + "HubSiteJoinApprovalOutput", + "Item", + "ItemGrantAccessBody", + "ItemPermissionAddBody", + "ItemPermissionCreateLinkBody", + "ItemPermissionRecipient", + "ItemPermissionUpdateBody", + "ItemReference", + "ItemsList", + "MoveFileParameters", + "MoveFolderParameters", + "ObjectEntity", + "PassThroughNativeQuery", + "PatchFileItemInput", + "PatchFileItemResponse", + "PatchFileItemWithPredictedValuesParameters", + "PatchItemInput", + "PatchItemResponse", + "Permission", + "PermissionIdentitySet", + "PermissionsList", + "PostItemInput", + "PostItemResponse", + "Procedure", + "PublishedResult", + "SPBlobMetadataResponse", + "SPContentType", + "SPForASelectedFileResponse", + "SPListEntity", + "SPListExpandedUser", + "SPListItemAttachment", + "SetApprovalStatusOutput", + "SharePointHttpRequestBodyParameters", + "SharePointIds", + "SharingInvitation", + "SharingLink", + "SharingLinkPermission", + "SharingLinkPermissionIdentitySet", + "SharingLinkUserPermissionIdentity", + "SubmitDocGenFormInput", + "Table", + "TableCapabilitiesMetadata", + "TableCountRestrictionsMetadata", + "TableFilterRestrictionsMetadata", + "TableForm", + "TableMetadata", + "TableSelectRestrictionsMetadata", + "TableSortRestrictionsMetadata", + "TablesList", + "TabularDataSetsMetadata", + "UserPermissionIdentity", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +114,7 @@ class CreateAgreementsSolutionDocumentInput: Agreements Solution - Generate document within Agreements Solution workspace """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -42,48 +127,74 @@ class SPBlobMetadataResponse: Response for Agreements Solution - Generate document within Agreements Solution workspace """ - item_id: Optional[int] = field( + item_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ItemId"}, ) """ The value that can be used to Get or Update file properties in libraries. """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" @@ -95,7 +206,12 @@ class TablesList: Response for Get all lists and libraries """ - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Tables""" @@ -105,8 +221,9 @@ class ApproveHubSiteJoinResponse: Response for Approve hub site join request """ - approval_token: Optional[str] = field( + approval_token: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApprovalToken"}, ) """Approval Token""" @@ -118,7 +235,7 @@ class SharingLinkPermission: Response for Create sharing link for a file or folder """ - link: Optional[SharingLink] = None + link: Optional[SharingLink | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -127,41 +244,66 @@ class BlobMetadata: Response for Copy file (deprecated) """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" @@ -173,41 +315,66 @@ class BlobMetadataResponse: Response for Update file """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique id of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - last_modified: Optional[str] = field( + last_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastModified"}, ) """The date and time the file or folder was last modified.""" - size: Optional[int] = field(default=None, metadata={"wire_name": "Size"}) + size: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Size"}, + ) """The size of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """The etag of the file or folder.""" - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The filelocator of the file or folder.""" @@ -219,7 +386,7 @@ class CreateNewDocumentSetResponse: Response for Create new document set """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -232,7 +399,7 @@ class CreateNewFolderResponse: Response for Create new folder """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -245,35 +412,45 @@ class SPListExpandedUser: Response for Resolve person """ - claims: Optional[str] = field( + claims: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Claims"}, ) """user claims""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """user title""" - email: Optional[str] = field(default=None, metadata={"wire_name": "Email"}) + email: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Email"}, + ) """user email""" - picture: Optional[str] = field( + picture: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Picture"}, ) """user picture""" - department: Optional[str] = field( + department: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Department"}, ) """user department""" - job_title: Optional[str] = field( + job_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobTitle"}, ) """user job title""" - type_: Optional[str] = field( + type_: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.type"}, ) @@ -284,50 +461,66 @@ class TableForm: Response for Get form metadata (preview) """ - form_id: Optional[str] = field( + form_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FormID"}, ) """Gets or sets the form ID""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Gets or sets the form display name""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "Type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Type"}, + ) """Gets or sets the form type""" - link: Optional[str] = field(default=None, metadata={"wire_name": "Link"}) + link: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Link"}, + ) """Gets or sets the form link/URL""" - created_by: Optional[str] = field( + created_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedBy"}, ) """Gets or sets the user who created the form""" - created: Optional[str] = field( + created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Created"}, ) """Gets or sets the date the form was created""" - modified: Optional[str] = field( + modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Modified"}, ) """Gets or sets the date the form was last modified""" - modified_by: Optional[str] = field( + modified_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ModifiedBy"}, ) """Gets or sets the user who last modified the form""" - output_format: Optional[str] = field( + output_format: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OutputFormat"}, ) """ Gets or sets the output format (e.g. \"Word document\", \"PDF document\", \"None\") """ - fields_metadata: Optional[List[FormFieldMetadata]] = field( + fields_metadata: Optional[List[FormFieldMetadata | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FieldsMetadata"}, ) """Gets or sets Form Fields""" @@ -339,7 +532,7 @@ class SubmitDocGenFormInput: Generate a document from a form (preview) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -352,10 +545,16 @@ class ItemsList: Response for Get files (properties only) """ - value: Optional[List[Item]] = None + value: Optional[ + List[Item | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -367,7 +566,7 @@ class PostItemInput: Create item """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -380,7 +579,7 @@ class PostItemResponse: Response for Create item """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -393,7 +592,7 @@ class GetItemResponse: Response for Get item """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -406,7 +605,7 @@ class PatchItemInput: Update item """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -419,7 +618,7 @@ class PatchItemResponse: Response for Update item """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -432,7 +631,7 @@ class CreateApprovalRequestInput: Create an approval request for an item or file """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -445,10 +644,7 @@ class ApprovalData: Response for Create an approval request for an item or file """ - approval_id: Optional[str] = field( - default=None, - metadata={"wire_name": "ApprovalId"}, - ) + approval_id: str = dataclass_field(metadata={"wire_name": "ApprovalId"}) """The ID of the approval request created""" @@ -458,7 +654,7 @@ class GetItemChangesResponse: Response for Get changes for an item or a file (properties only) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -471,8 +667,9 @@ class Item: Response for Get file properties """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -483,7 +680,7 @@ class PatchFileItemInput: Update file properties """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -496,7 +693,7 @@ class PatchFileItemResponse: Response for Update file properties """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -509,25 +706,33 @@ class SetApprovalStatusOutput: Response for Set content approval status """ - e_tag: Optional[str] = field(default=None, metadata={"wire_name": "ETag"}) + e_tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETag"}, + ) """ETag of the item after the approval status was set""" - approval_link: Optional[str] = field( + approval_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApprovalLink"}, ) """A link to the item that needs approval""" - publish_start_date: Optional[str] = field( + publish_start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PublishStartDate"}, ) """Date time at which the item will be Published""" - content_approval_status: Optional[str] = field( + content_approval_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentApprovalStatus"}, ) """The content approval status of the list item""" - scheduled_version: Optional[str] = field( + scheduled_version: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ScheduledVersion"}, ) """The version of the item that has been scheduled""" @@ -539,15 +744,21 @@ class SPListItemAttachment: Response for Get attachments """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """File identifier""" - absolute_uri: Optional[str] = field( + absolute_uri: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AbsoluteUri"}, ) """Link to attachment""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Name""" @@ -559,7 +770,12 @@ class DeletedItemList: Response for When a file is deleted """ - value: Optional[List[DeletedItem]] = None + value: Optional[ + List[DeletedItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Deleted Items""" @@ -569,7 +785,7 @@ class CreateContentAssemblyDocumentInput: Generate document using Microsoft Syntex (preview) """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -582,15 +798,21 @@ class Table: Response for Get list views """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the table. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the table.""" - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """Additional table properties provided by the connector to the clients.""" @@ -602,7 +824,12 @@ class DataSetsList: Response for Get datasets """ - value: Optional[List[DataSet]] = None + value: Optional[ + List[DataSet | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of datasets""" @@ -612,26 +839,30 @@ class TableMetadata: Response for Agreements Solution - Get template fields """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Table name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Table title""" - x_ms_permission: Optional[str] = field( + x_ms_permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-permission"}, ) """Table permission""" - x_ms_capabilities: Optional[TableCapabilitiesMetadata] = field( + x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-capabilities"}, ) - schema: Optional[ObjectEntity] = None - referenced_entities: Optional[ObjectEntity] = field( + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referencedEntities"}, ) - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """URL link""" @@ -643,7 +874,7 @@ class ObjectEntity: Response for Get thumbnail size options """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -656,10 +887,15 @@ class SPListEntity: Response for Returns User fields for a list """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The Id of the SPField""" - entity_type: Optional[str] = field( + entity_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntityType"}, ) """What type of entity (field) this is""" @@ -671,7 +907,7 @@ class GetItemChangesMetadataResponse: Response for Get metadata about the return type of the GetItemChanges operation """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -680,8 +916,9 @@ class ApplicationPermissionIdentity: Definition: ApplicationPermissionIdentity """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Application display name""" @@ -693,15 +930,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -713,7 +952,12 @@ class BlobMetadataPage: Definition: BlobMetadataPage """ - value: Optional[List[BlobMetadata]] = None + value: Optional[ + List[BlobMetadata | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Blob metadata collection.""" @@ -723,23 +967,19 @@ class CopyFileParameters: Definition: CopyFileParameters """ - source_file_id: Optional[str] = field( - default=None, + source_file_id: str = dataclass_field( metadata={"wire_name": "sourceFileId"}, ) """File Identifier""" - destination_dataset: Optional[str] = field( - default=None, + destination_dataset: str = dataclass_field( metadata={"wire_name": "destinationDataset"}, ) """Example: https://contoso.sharepoint.com/sites/sitename""" - destination_folder_path: Optional[str] = field( - default=None, + destination_folder_path: str = dataclass_field( metadata={"wire_name": "destinationFolderPath"}, ) """Destination Folder""" - name_conflict_behavior: Optional[int] = field( - default=None, + name_conflict_behavior: int = dataclass_field( metadata={"wire_name": "nameConflictBehavior"}, ) """Pick one of the options available""" @@ -751,23 +991,19 @@ class CopyFolderParameters: Definition: CopyFolderParameters """ - source_folder_id: Optional[str] = field( - default=None, + source_folder_id: str = dataclass_field( metadata={"wire_name": "sourceFolderId"}, ) """File Identifier""" - destination_dataset: Optional[str] = field( - default=None, + destination_dataset: str = dataclass_field( metadata={"wire_name": "destinationDataset"}, ) """Example: https://contoso.sharepoint.com/sites/sitename""" - destination_folder_path: Optional[str] = field( - default=None, + destination_folder_path: str = dataclass_field( metadata={"wire_name": "destinationFolderPath"}, ) """Destination Folder""" - name_conflict_behavior: Optional[int] = field( - default=None, + name_conflict_behavior: int = dataclass_field( metadata={"wire_name": "nameConflictBehavior"}, ) """Pick one of the options available""" @@ -779,15 +1015,15 @@ class CreateNewDocumentSetParameters: Definition: CreateNewDocumentSetParameters """ - path: Optional[str] = None + path: str """Example: folder1/folder2/dsName""" - content_type_id: Optional[str] = field( - default=None, + content_type_id: str = dataclass_field( metadata={"wire_name": "contentTypeId"}, ) """Example: 0x0120D520""" - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) @@ -798,7 +1034,7 @@ class CreateNewFolderParameters: Definition: CreateNewFolderParameters """ - path: Optional[str] = None + path: str """Example: folder1/folder2/folder3""" @@ -808,14 +1044,24 @@ class DataSet: Definition: DataSet """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Dataset name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Dataset display name""" - query: Optional[List[PassThroughNativeQuery]] = None + query: Optional[ + List[PassThroughNativeQuery | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Pass-through Native Queries""" @@ -825,8 +1071,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -835,33 +1091,45 @@ class DeletedItem: Definition: DeletedItem """ - id: Optional[int] = field(default=None, metadata={"wire_name": "ID"}) + id: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID"}, + ) """List item id""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """ File name of the item in document libraries, display name of the item in lists """ - file_name_with_extension: Optional[str] = field( + file_name_with_extension: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileNameWithExtension"}, ) """ File name with extension of the item in document libraries, same as Name of the item in lists """ - deleted_by_user_name: Optional[str] = field( + deleted_by_user_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DeletedByUserName"}, ) """The name of the user who deleted this item""" - time_deleted: Optional[str] = field( + time_deleted: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TimeDeleted"}, ) """When this item was deleted""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """A true/false value to indicate if the item is a folder""" @@ -873,12 +1141,9 @@ class FileCheckInParameters: Definition: FileCheckInParameters """ - comment: Optional[str] = None + comment: str """Type comments describing what has changed in this version""" - checkin_type: Optional[int] = field( - default=None, - metadata={"wire_name": "checkinType"}, - ) + checkin_type: int = dataclass_field(metadata={"wire_name": "checkinType"}) """Select the type of version you would like to check in""" @@ -888,22 +1153,33 @@ class FormFieldMetadata: Definition: FormFieldMetadata """ - id: Optional[str] = field(default=None, metadata={"wire_name": "ID"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID"}, + ) """Gets or sets the field ID""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Gets or sets the field Name""" - is_required: Optional[bool] = field( + is_required: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsRequired"}, ) """Gets or sets a value indicating whether the field is required""" - data_type: Optional[str] = field( + data_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DataType"}, ) """Gets or sets the field data type""" - default_value: Optional[str] = field( + default_value: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DefaultValue"}, ) """Gets or sets the default value""" @@ -915,8 +1191,9 @@ class GroupPermissionIdentity: Definition: GroupPermissionIdentity """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Group display name""" @@ -928,23 +1205,27 @@ class HubSiteJoinApprovalOutput: Definition: HubSiteJoinApprovalOutput """ - requesting_site_url: Optional[str] = field( + requesting_site_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequestingSiteUrl"}, ) """Requesting Site Url""" - requesting_site_id: Optional[str] = field( + requesting_site_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequestingSiteId"}, ) """Requesting Site Id""" - requesting_site_title: Optional[str] = field( + requesting_site_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RequestingSiteTitle"}, ) """Requesting Site Title""" - approval_correlation_id: Optional[str] = field( + approval_correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApprovalCorrelationId"}, ) """Approval Correlation Id""" @@ -956,22 +1237,21 @@ class ItemGrantAccessBody: Definition: ItemGrantAccessBody """ - recipients: Optional[str] = None + recipients: str """A collection of recipients who will receive the sharing invitation""" - role_value: Optional[str] = field( - default=None, - metadata={"wire_name": "roleValue"}, - ) + role_value: str = dataclass_field(metadata={"wire_name": "roleValue"}) """Specify a role that is to be granted to the recipients""" - email_body: Optional[str] = field( + email_body: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "emailBody"}, ) """ A plain text formatted message that is included in the sharing invitation """ - send_email: Optional[bool] = field( + send_email: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sendEmail"}, ) """ @@ -985,33 +1265,31 @@ class ItemPermissionAddBody: Definition: ItemPermissionAddBody """ - recipients: Optional[List[ItemPermissionRecipient]] = None + recipients: List[ItemPermissionRecipient | Mapping[str, Any]] """ A collection of recipients who will receive access and the sharing invitation. """ - roles: Optional[List[str]] = None + roles: List[str] """ Specify the roles that are be granted to the recipients of the sharing invitation. """ - require_sign_in: Optional[bool] = field( - default=None, + require_sign_in: bool = dataclass_field( metadata={"wire_name": "requireSignIn"}, ) """ Specifies where the recipient of the invitation is required to sign-in to view the shared item. """ - send_invitation: Optional[bool] = field( - default=None, + send_invitation: bool = dataclass_field( metadata={"wire_name": "sendInvitation"}, ) """ Specifies if an email or post is generated (true) or if the permission is just created (false). """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """ A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters. @@ -1024,15 +1302,16 @@ class ItemPermissionCreateLinkBody: Definition: ItemPermissionCreateLinkBody """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """The type of sharing link to create""" - scope: Optional[str] = None + scope: str """ Choose who your sharing link gives access to. \"Anyone\" option will only work if your administrator has enabled it. """ - expiration_date_time: Optional[str] = field( + expiration_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "expirationDateTime"}, ) """ @@ -1047,7 +1326,7 @@ class ItemPermissionRecipient: Definition: ItemPermissionRecipient """ - email: Optional[str] = None + email: str """ The email address for the recipient, if the recipient has an associated email address. @@ -1060,7 +1339,7 @@ class ItemPermissionUpdateBody: Definition: ItemPermissionUpdateBody """ - roles: Optional[List[str]] = None + roles: List[str] """Specify updated roles for this permission.""" @@ -1070,12 +1349,13 @@ class ItemReference: Definition: ItemReference """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the parent item""" - path: Optional[str] = None + path: Optional[str] = dataclass_field(default=None, kw_only=True) """Path that can be used to navigate to the parent item""" - sharepoint_ids: Optional[SharePointIds] = field( + sharepoint_ids: Optional[SharePointIds | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sharepointIds"}, ) @@ -1086,23 +1366,19 @@ class MoveFileParameters: Definition: MoveFileParameters """ - source_file_id: Optional[str] = field( - default=None, + source_file_id: str = dataclass_field( metadata={"wire_name": "sourceFileId"}, ) """File Identifier""" - destination_dataset: Optional[str] = field( - default=None, + destination_dataset: str = dataclass_field( metadata={"wire_name": "destinationDataset"}, ) """Example: https://contoso.sharepoint.com/sites/sitename""" - destination_folder_path: Optional[str] = field( - default=None, + destination_folder_path: str = dataclass_field( metadata={"wire_name": "destinationFolderPath"}, ) """Destination Folder""" - name_conflict_behavior: Optional[int] = field( - default=None, + name_conflict_behavior: int = dataclass_field( metadata={"wire_name": "nameConflictBehavior"}, ) """Pick one of the options available""" @@ -1114,23 +1390,19 @@ class MoveFolderParameters: Definition: MoveFolderParameters """ - source_folder_id: Optional[str] = field( - default=None, + source_folder_id: str = dataclass_field( metadata={"wire_name": "sourceFolderId"}, ) """File Identifier""" - destination_dataset: Optional[str] = field( - default=None, + destination_dataset: str = dataclass_field( metadata={"wire_name": "destinationDataset"}, ) """Example: https://contoso.sharepoint.com/sites/sitename""" - destination_folder_path: Optional[str] = field( - default=None, + destination_folder_path: str = dataclass_field( metadata={"wire_name": "destinationFolderPath"}, ) """Destination Folder""" - name_conflict_behavior: Optional[int] = field( - default=None, + name_conflict_behavior: int = dataclass_field( metadata={"wire_name": "nameConflictBehavior"}, ) """Pick one of the options available""" @@ -1142,8 +1414,9 @@ class PassThroughNativeQuery: Definition: PassThroughNativeQuery """ - language: Optional[str] = field( + language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Language"}, ) """Query language""" @@ -1155,13 +1428,15 @@ class PatchFileItemWithPredictedValuesParameters: Definition: PatchFileItemWithPredictedValuesParameters """ - model_id: Optional[str] = field( + model_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "modelId"}, ) """Enter modelId of the Model which is used for prediction""" - predict_result: Optional[str] = field( + predict_result: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "predictResult"}, ) """Enter request content in JSON""" @@ -1173,27 +1448,37 @@ class Permission: Definition: Permission """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Permission id""" - granted_to: Optional[PermissionIdentitySet] = field( + granted_to: Optional[PermissionIdentitySet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "grantedTo"}, ) - granted_to_identities: Optional[List[SharingLinkPermissionIdentitySet]] = field( + granted_to_identities: Optional[ + List[SharingLinkPermissionIdentitySet | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "grantedToIdentities"}, ) """ For link type permissions, the details of the users to whom permission was granted """ - invitation: Optional[SharingInvitation] = None - inherited_from: Optional[ItemReference] = field( + invitation: Optional[ + SharingInvitation | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, + ) + inherited_from: Optional[ItemReference | Mapping[str, Any]] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "inheritedFrom"}, ) - link: Optional[SharingLink] = None - roles: Optional[List[str]] = None + link: Optional[SharingLink | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + roles: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """The type of permission - read, write, owner, member""" @@ -1203,9 +1488,24 @@ class PermissionIdentitySet: Definition: PermissionIdentitySet """ - application: Optional[ApplicationPermissionIdentity] = None - group: Optional[GroupPermissionIdentity] = None - user: Optional[UserPermissionIdentity] = None + application: Optional[ + ApplicationPermissionIdentity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + group: Optional[ + GroupPermissionIdentity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + user: Optional[ + UserPermissionIdentity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1214,7 +1514,12 @@ class PermissionsList: Definition: PermissionsList """ - value: Optional[List[Permission]] = None + value: Optional[ + List[Permission | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Permissions""" @@ -1224,10 +1529,15 @@ class Procedure: Definition: Procedure """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Procedure name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Procedure display name""" @@ -1239,8 +1549,7 @@ class PublishedResult: Definition: PublishedResult """ - is_file_published: Optional[bool] = field( - default=None, + is_file_published: bool = dataclass_field( metadata={"wire_name": "IsFilePublished"}, ) """ @@ -1255,13 +1564,13 @@ class SharePointHttpRequestBodyParameters: Definition: SharePointHttpRequestBodyParameters """ - method: Optional[str] = None + method: str """Http Method""" - uri: Optional[str] = None + uri: str """Example: _api/web/lists/getbytitle('Documents')""" - headers: Optional[Dict[str, str]] = None + headers: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True) """Enter JSON object of request headers""" - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """Enter request content in JSON""" @@ -1271,41 +1580,48 @@ class SharePointIds: Definition: SharePointIds """ - list_id: Optional[str] = field( + list_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "listId"}, ) """The unique identifier (guid) for the item's list in SharePoint""" - list_item_id: Optional[str] = field( + list_item_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "listItemId"}, ) """An integer identifier for the item within the containing list""" - list_item_unique_id: Optional[str] = field( + list_item_unique_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "listItemUniqueId"}, ) """ The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site """ - site_id: Optional[str] = field( + site_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "siteId"}, ) """The unique identifier (guid) for the item's site collection (SPSite)""" - site_url: Optional[str] = field( + site_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "siteUrl"}, ) """The SharePoint URL for the site that contains the item""" - tenant_id: Optional[str] = field( + tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tenantId"}, ) """The unique identifier (guid) for the tenancy""" - web_id: Optional[str] = field( + web_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webId"}, ) """The unique identifier (guid) for the item's site (SPWeb)""" @@ -1317,12 +1633,13 @@ class SharingInvitation: Definition: SharingInvitation """ - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """ The email address provided for the recipient of the sharing invitation """ - sign_in_required: Optional[bool] = field( + sign_in_required: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "signInRequired"}, ) """ @@ -1337,8 +1654,9 @@ class SharingLink: Definition: SharingLink """ - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """A link to the item""" @@ -1350,7 +1668,12 @@ class SharingLinkPermissionIdentitySet: Definition: SharingLinkPermissionIdentitySet """ - user: Optional[SharingLinkUserPermissionIdentity] = None + user: Optional[ + SharingLinkUserPermissionIdentity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1359,12 +1682,13 @@ class SharingLinkUserPermissionIdentity: Definition: SharingLinkUserPermissionIdentity """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """User display name""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """User email""" @@ -1374,9 +1698,17 @@ class SPContentType: Definition: SPContentType """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """Content type Id""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Content type name""" @@ -1386,15 +1718,21 @@ class SPForASelectedFileResponse: Definition: SPForASelectedFileResponse """ - id: Optional[int] = field(default=None, metadata={"wire_name": "ID"}) + id: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID"}, + ) """File Identifier""" - item_url: Optional[str] = field( + item_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "itemUrl"}, ) """File Url""" - file_name: Optional[str] = field( + file_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fileName"}, ) """File Name""" @@ -1406,34 +1744,49 @@ class TableCapabilitiesMetadata: Definition: TableCapabilitiesMetadata """ - sort_restrictions: Optional[TableSortRestrictionsMetadata] = field( + sort_restrictions: Optional[ + TableSortRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortRestrictions"}, ) - filter_restrictions: Optional[TableFilterRestrictionsMetadata] = field( + filter_restrictions: Optional[ + TableFilterRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterRestrictions"}, ) - select_restrictions: Optional[TableSelectRestrictionsMetadata] = field( + select_restrictions: Optional[ + TableSelectRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectRestrictions"}, ) - count_restrictions: Optional[TableCountRestrictionsMetadata] = field( + count_restrictions: Optional[ + TableCountRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "countRestrictions"}, ) - is_only_server_pagable: Optional[bool] = field( + is_only_server_pagable: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOnlyServerPagable"}, ) """Server paging restrictions""" - filter_function_support: Optional[List[str]] = field( + filter_function_support: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterFunctionSupport"}, ) """List of supported filter capabilities""" - server_paging_options: Optional[List[str]] = field( + server_paging_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serverPagingOptions"}, ) """List of supported server-driven paging capabilities""" @@ -1445,7 +1798,7 @@ class TableCountRestrictionsMetadata: Definition: TableCountRestrictionsMetadata """ - countable: Optional[bool] = None + countable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has countable columns""" @@ -1455,15 +1808,17 @@ class TableFilterRestrictionsMetadata: Definition: TableFilterRestrictionsMetadata """ - filterable: Optional[bool] = None + filterable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has filterable columns""" - non_filterable_properties: Optional[List[str]] = field( + non_filterable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nonFilterableProperties"}, ) """List of non filterable properties""" - required_properties: Optional[List[str]] = field( + required_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredProperties"}, ) """List of required properties""" @@ -1475,7 +1830,7 @@ class TableSelectRestrictionsMetadata: Definition: TableSelectRestrictionsMetadata """ - selectable: Optional[bool] = None + selectable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has selectable columns""" @@ -1485,15 +1840,17 @@ class TableSortRestrictionsMetadata: Definition: TableSortRestrictionsMetadata """ - sortable: Optional[bool] = None + sortable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has sortable columns""" - unsortable_properties: Optional[List[str]] = field( + unsortable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unsortableProperties"}, ) """List of unsortable properties""" - ascending_only_properties: Optional[List[str]] = field( + ascending_only_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ascendingOnlyProperties"}, ) """List of properties which support ascending order only""" @@ -1505,25 +1862,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -1535,12 +1896,13 @@ class UserPermissionIdentity: Definition: UserPermissionIdentity """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """User display name""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """User email""" @@ -1555,7 +1917,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1572,8 +1934,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1594,7 +1956,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1610,15 +1972,49 @@ def connector_name(self) -> str: return "sharepointonline" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -1635,7 +2031,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -1648,13 +2048,13 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def create_agreements_solution_document_async( + async def create_agreements_solution_document( self, - input: CreateAgreementsSolutionDocumentInput, + input: CreateAgreementsSolutionDocumentInput | Mapping[str, Any], dataset: str, template: str, - document_name: Optional[str] = None, *, + document_name: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1667,6 +2067,25 @@ async def create_agreements_solution_document_async( Use this action to create documents based on modern templates in a Agreements Solution workspace. This is behind a payment wall currently in planning (either license or PayG). + + Swagger operation ID: `CreateAgreementsSolutionDocument`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + template: Agreements Solution template. + document_name: Document file name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1686,7 +2105,7 @@ async def create_agreements_solution_document_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1700,6 +2119,7 @@ async def create_agreements_solution_document_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1707,7 +2127,7 @@ async def create_agreements_solution_document_async( return json.loads(response.text) - async def get_all_tables_async( + def list_all_tables( self, dataset: str, *, @@ -1715,11 +2135,29 @@ async def get_all_tables_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all lists and libraries Get all lists and libraries. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllTables`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1727,29 +2165,50 @@ async def get_all_tables_async( f"/{quote(quote(str(dataset), safe=''), safe='')}" f"/alltables" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def approve_hub_site_join_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def approve_hub_site_join( self, dataset: str, joining_site_id: str, @@ -1765,6 +2224,22 @@ async def approve_hub_site_join_async( Approve hub site join request. This will return an approval token that can be used to complete the join request using the join hub site action. + + Swagger operation ID: `ApproveHubSiteJoin`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + joining_site_id: Id of the requesting site. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1780,7 +2255,7 @@ async def approve_hub_site_join_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1794,6 +2269,7 @@ async def approve_hub_site_join_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1801,11 +2277,11 @@ async def approve_hub_site_join_async( return json.loads(response.text) - async def cancel_hub_site_join_approval_async( + async def cancel_hub_site_join_approval( self, dataset: str, - approval_correlation_id: Optional[str] = None, *, + approval_correlation_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1817,6 +2293,23 @@ async def cancel_hub_site_join_approval_async( Cancel hub join request. If applicable, you should specify the same Approval Correlation Id as used in the \"Set hub site join status to pending\" action. + + Swagger operation ID: `CancelHubSiteJoinApproval`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + approval_correlation_id: Approval correlation identifier for this + request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1833,7 +2326,7 @@ async def cancel_hub_site_join_approval_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1847,11 +2340,12 @@ async def cancel_hub_site_join_approval_async( request_url, response.status, response.text, + response=response, ) - async def create_sharing_link_async( + async def create_sharing_link( self, - input: ItemPermissionCreateLinkBody, + input: ItemPermissionCreateLinkBody | Mapping[str, Any], dataset: str, table: str, id: int, @@ -1865,6 +2359,25 @@ async def create_sharing_link_async( Create sharing link for a file or folder Create sharing link for a file or folder. + + Swagger operation ID: `CreateSharingLink`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint library name. + id: Id of the file or folder item. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1883,7 +2396,7 @@ async def create_sharing_link_async( f"/createLink" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1897,6 +2410,7 @@ async def create_sharing_link_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1904,13 +2418,13 @@ async def create_sharing_link_async( return json.loads(response.text) - async def copy_file_async( + async def copy_file( self, dataset: str, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1920,6 +2434,25 @@ async def copy_file_async( Copy file (deprecated) Copies a file to a SharePoint site. + + Swagger operation ID: `CopyFile`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + source: Path to the source file. + destination: Path to the destination file. + overwrite: Whether or not to overwrite the destination file if it + exists. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1945,7 +2478,7 @@ async def copy_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1959,6 +2492,7 @@ async def copy_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1966,9 +2500,9 @@ async def copy_file_async( return json.loads(response.text) - async def copy_file_2_async( + async def copy_file_2( self, - input: CopyFileParameters, + input: CopyFileParameters | Mapping[str, Any], dataset: str, *, timeout: Optional[float] = None, @@ -1982,6 +2516,23 @@ async def copy_file_2_async( Copies a file. Works in a similar way to the \"Copy to\" command in SharePoint libraries. Returns information about the new file after copy. + + Swagger operation ID: `CopyFileAsync`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1990,7 +2541,7 @@ async def copy_file_2_async( f"/copyFileAsync" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2004,6 +2555,7 @@ async def copy_file_2_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2011,9 +2563,9 @@ async def copy_file_2_async( return json.loads(response.text) - async def copy_folder_async( + async def copy_folder( self, - input: CopyFolderParameters, + input: CopyFolderParameters | Mapping[str, Any], dataset: str, *, timeout: Optional[float] = None, @@ -2027,6 +2579,23 @@ async def copy_folder_async( Copies a folder. Works in a similar way to the \"Copy to\" command in SharePoint libraries. Returns information about the new folder after copy. + + Swagger operation ID: `CopyFolderAsync`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2035,7 +2604,7 @@ async def copy_folder_async( f"/copyFolderAsync" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2049,6 +2618,7 @@ async def copy_folder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2056,7 +2626,7 @@ async def copy_folder_async( return json.loads(response.text) - async def create_file_async( + async def create_file( self, input: bytes, dataset: str, @@ -2073,6 +2643,25 @@ async def create_file_async( Uploads a file to a SharePoint site. Make sure to pick an existing library. + + Swagger operation ID: `CreateFile`. + + Args: + input: The binary request body. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + folder_path: Must start with an existing library. Add folders if + needed. + name: Name of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2091,7 +2680,7 @@ async def create_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -2108,6 +2697,7 @@ async def create_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2115,7 +2705,7 @@ async def create_file_async( return json.loads(response.text) - async def get_file_metadata_async( + async def get_file_metadata( self, dataset: str, id: str, @@ -2131,6 +2721,22 @@ async def get_file_metadata_async( Gets information about the file such as size, etag, created date, etc. Uses a file identifier to pick the file. Use \"Get file properties\" action to get to the values stored in the columns in the library. + + Swagger operation ID: `GetFileMetadata`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + id: Select a file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2140,7 +2746,7 @@ async def get_file_metadata_async( f"/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2154,6 +2760,7 @@ async def get_file_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2161,7 +2768,7 @@ async def get_file_metadata_async( return json.loads(response.text) - async def update_file_async( + async def update_file( self, input: bytes, dataset: str, @@ -2176,6 +2783,23 @@ async def update_file_async( Update file Updates the contents of the file specified by the file identifier. + + Swagger operation ID: `UpdateFile`. + + Args: + input: The binary request body. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + id: Select a file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2185,7 +2809,7 @@ async def update_file_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, @@ -2202,6 +2826,7 @@ async def update_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2209,7 +2834,7 @@ async def update_file_async( return json.loads(response.text) - async def delete_file_async( + async def delete_file( self, dataset: str, id: str, @@ -2223,6 +2848,22 @@ async def delete_file_async( Delete file Deletes the file specified by the file identifier. + + Swagger operation ID: `DeleteFile`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + id: Select a file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2232,7 +2873,7 @@ async def delete_file_async( f"/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2246,14 +2887,15 @@ async def delete_file_async( request_url, response.status, response.text, + response=response, ) - async def get_file_content_async( + async def get_file_content( self, dataset: str, id: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2264,6 +2906,23 @@ async def get_file_content_async( Gets file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment. + + Swagger operation ID: `GetFileContent`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + id: Select a file. + infer_content_type: Infer content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2282,7 +2941,7 @@ async def get_file_content_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2296,11 +2955,12 @@ async def get_file_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_file_thumbnail_async( + async def get_file_thumbnail( self, dataset: str, id: str, @@ -2315,6 +2975,23 @@ async def get_file_thumbnail_async( Get file thumbnail Gets the thumbnail of a file by its file identifier. + + Swagger operation ID: `GetFileThumbnail`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + id: Select a file. + size: The size of the thumbnail to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2332,7 +3009,7 @@ async def get_file_thumbnail_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2346,11 +3023,12 @@ async def get_file_thumbnail_async( request_url, response.status, response.text, + response=response, ) return response.content - async def list_root_folder_async( + def list_root_folder( self, dataset: str, *, @@ -2358,39 +3036,78 @@ async def list_root_folder_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List root folder Returns files in the root SharePoint folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRootFolder`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/datasets/{quote(quote(str(dataset), safe=''), safe='')}/folders" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None - - return json.loads(response.text) - - async def list_folder_async( + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) + + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_folder( self, dataset: str, id: str, @@ -2399,11 +3116,30 @@ async def list_folder_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List folder Returns files contained in a SharePoint folder. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListFolder`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + id: Unique identifier of the folder. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2412,29 +3148,50 @@ async def list_folder_async( f"/folders" f"/{quote(str(id), safe='')}" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def get_file_metadata_by_path_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_file_metadata_by_path( self, dataset: str, path: str, @@ -2450,6 +3207,22 @@ async def get_file_metadata_by_path_async( Gets information about the file such as size, etag, created date, etc. Uses a file path to pick the file. Use \"Get file properties\" action to get to the values stored in the columns in the library. + + Swagger operation ID: `GetFileMetadataByPath`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + path: Select a file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2466,7 +3239,7 @@ async def get_file_metadata_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2480,6 +3253,7 @@ async def get_file_metadata_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2487,12 +3261,12 @@ async def get_file_metadata_by_path_async( return json.loads(response.text) - async def get_file_content_by_path_async( + async def get_file_content_by_path( self, dataset: str, path: str, - infer_content_type: Optional[bool] = None, *, + infer_content_type: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2502,6 +3276,23 @@ async def get_file_content_by_path_async( Get file content using path Gets file contents using the file path. + + Swagger operation ID: `GetFileContentByPath`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + path: Select a file. + infer_content_type: Infer content-type based on extension. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2523,7 +3314,7 @@ async def get_file_content_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2537,11 +3328,12 @@ async def get_file_content_by_path_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_folder_metadata_async( + async def get_folder_metadata( self, dataset: str, id: str, @@ -2556,6 +3348,22 @@ async def get_folder_metadata_async( Gets information about the folder. Uses a file identifier to pick the folder. + + Swagger operation ID: `GetFolderMetadata`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + id: Select a folder. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2571,7 +3379,7 @@ async def get_folder_metadata_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2585,6 +3393,7 @@ async def get_folder_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2592,7 +3401,7 @@ async def get_folder_metadata_async( return json.loads(response.text) - async def get_folder_metadata_by_path_async( + async def get_folder_metadata_by_path( self, dataset: str, path: str, @@ -2607,6 +3416,22 @@ async def get_folder_metadata_by_path_async( Gets information about the folder. Uses a folder path to pick the folder. + + Swagger operation ID: `GetFolderMetadataByPath`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + path: Select a folder. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2623,7 +3448,7 @@ async def get_folder_metadata_by_path_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2637,6 +3462,7 @@ async def get_folder_metadata_by_path_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2644,9 +3470,9 @@ async def get_folder_metadata_by_path_async( return json.loads(response.text) - async def http_request_async( + async def http_request( self, - input: SharePointHttpRequestBodyParameters, + input: SharePointHttpRequestBodyParameters | Mapping[str, Any], dataset: str, *, timeout: Optional[float] = None, @@ -2660,6 +3486,23 @@ async def http_request_async( Construct a SharePoint REST API to invoke. Note - This action may execute any SharePoint REST API you have access to. Please proceed with caution. + + Swagger operation ID: `HttpRequest`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2668,7 +3511,7 @@ async def http_request_async( f"/httprequest" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2682,15 +3525,16 @@ async def http_request_async( request_url, response.status, response.text, + response=response, ) - async def join_hub_site_async( + async def join_hub_site( self, dataset: str, hub_site_id: str, + *, approval_token: Optional[str] = None, approval_correlation_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2703,6 +3547,25 @@ async def join_hub_site_async( to complete the join successfully if that hub requires approval. If applicable, you should specify the same Approval Correlation Id as used in the \"Set hub site join status to pending\" action. + + Swagger operation ID: `JoinHubSite`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + hub_site_id: Id of the hub site. + approval_token: Approval token for this request. + approval_correlation_id: Approval correlation identifier for this + request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2728,7 +3591,7 @@ async def join_hub_site_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2742,11 +3605,12 @@ async def join_hub_site_async( request_url, response.status, response.text, + response=response, ) - async def move_file_async( + async def move_file( self, - input: MoveFileParameters, + input: MoveFileParameters | Mapping[str, Any], dataset: str, *, timeout: Optional[float] = None, @@ -2760,6 +3624,23 @@ async def move_file_async( Moves a file. Works in a similar way to the \"Move to\" command in SharePoint libraries. Returns information about the new file after move. + + Swagger operation ID: `MoveFileAsync`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2768,7 +3649,7 @@ async def move_file_async( f"/moveFileAsync" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2782,6 +3663,7 @@ async def move_file_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2789,9 +3671,9 @@ async def move_file_async( return json.loads(response.text) - async def move_folder_async( + async def move_folder( self, - input: MoveFolderParameters, + input: MoveFolderParameters | Mapping[str, Any], dataset: str, *, timeout: Optional[float] = None, @@ -2805,6 +3687,23 @@ async def move_folder_async( Moves a folder. Works in a similar way to the \"Move to\" command in SharePoint libraries. Returns information about the new folder after move. + + Swagger operation ID: `MoveFolderAsync`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2813,7 +3712,7 @@ async def move_folder_async( f"/moveFolderAsync" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2827,6 +3726,7 @@ async def move_folder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2834,11 +3734,11 @@ async def move_folder_async( return json.loads(response.text) - async def notify_hub_site_join_approval_started_async( + async def notify_hub_site_join_approval_started( self, dataset: str, - approval_correlation_id: Optional[str] = None, *, + approval_correlation_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2851,6 +3751,23 @@ async def notify_hub_site_join_approval_started_async( Approval Correlation Id is an optional parameter that helps SharePoint identify a particular hub join request. The requesting site can only have one pending request at a given time. + + Swagger operation ID: `NotifyHubSiteJoinApprovalStarted`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + approval_correlation_id: Approval correlation identifier for this + request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2867,7 +3784,7 @@ async def notify_hub_site_join_approval_started_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2881,9 +3798,10 @@ async def notify_hub_site_join_approval_started_async( request_url, response.status, response.text, + response=response, ) - async def get_tables_async( + def list_tables( self, dataset: str, *, @@ -2891,41 +3809,80 @@ async def get_tables_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get lists Gets SharePoint lists from a site. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTables`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/datasets/{quote(quote(str(dataset), safe=''), safe='')}/tables" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def create_new_document_set_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_new_document_set( self, - input: CreateNewDocumentSetParameters, + input: CreateNewDocumentSetParameters | Mapping[str, Any], dataset: str, table: str, *, @@ -2938,6 +3895,24 @@ async def create_new_document_set_async( Create new document set Creates a new document set list item. + + Swagger operation ID: `CreateNewDocumentSet`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint library name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2948,7 +3923,7 @@ async def create_new_document_set_async( f"/createnewdocumentset" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2962,6 +3937,7 @@ async def create_new_document_set_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2969,13 +3945,13 @@ async def create_new_document_set_async( return json.loads(response.text) - async def create_new_folder_async( + async def create_new_folder( self, - input: CreateNewFolderParameters, + input: CreateNewFolderParameters | Mapping[str, Any], dataset: str, table: str, - view: Optional[str] = None, *, + view: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2985,6 +3961,26 @@ async def create_new_folder_async( Create new folder Creates a new folder or folder path. + + Swagger operation ID: `CreateNewFolder`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list or library name. + view: Avoid column threshold issues by only using columns defined + in a view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3003,7 +3999,7 @@ async def create_new_folder_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3017,6 +4013,7 @@ async def create_new_folder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3024,14 +4021,14 @@ async def create_new_folder_async( return json.loads(response.text) - async def search_for_user_async( + async def search_for_user( self, dataset: str, table: str, entity_id: str, search_value: str, - view: Optional[str] = None, *, + view: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3043,6 +4040,26 @@ async def search_for_user_async( Returns a single matching user value so it can be assigned to a column of type person. If there are no matches, or multiple matches, this action will error out. + + Swagger operation ID: `SearchForUser`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: Pick the list or library that the column is in. + entity_id: Pick the column you want to assign the value to. + search_value: Use the email address, or the full name of the user. + view: Avoid column threshold issues by only using columns defined + in a view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3067,7 +4084,7 @@ async def search_for_user_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3081,6 +4098,7 @@ async def search_for_user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3088,7 +4106,7 @@ async def search_for_user_async( return json.loads(response.text) - async def get_table_form_async( + async def get_table_form( self, dataset: str, table: str, @@ -3108,6 +4126,23 @@ async def get_table_form_async( part of AI in SharePoint Public Preview. For more info on getting started, see: https://learn.microsoft.com/sharepoint/dev/declarative-customization/structured-documents. + + Swagger operation ID: `GetTableForm`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + form: Form identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3119,7 +4154,7 @@ async def get_table_form_async( f"/{quote(quote(str(form), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3133,6 +4168,7 @@ async def get_table_form_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3140,14 +4176,14 @@ async def get_table_form_async( return json.loads(response.text) - async def submit_doc_gen_form_async( + async def submit_doc_gen_form( self, - input: SubmitDocGenFormInput, + input: SubmitDocGenFormInput | Mapping[str, Any], dataset: str, table: str, form: str, - view: Optional[str] = None, *, + view: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3161,6 +4197,26 @@ async def submit_doc_gen_form_async( data source. Document generation forms is a part of AI in SharePoint Public Preview. For more info on getting started, see: https://learn.microsoft.com/sharepoint/dev/declarative-customization/structured-documents. + + Swagger operation ID: `SubmitDocGenForm`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint document library name. + form: Form identifier. + view: This parameter does nothing. Please do not use. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3181,7 +4237,7 @@ async def submit_doc_gen_form_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3195,6 +4251,7 @@ async def submit_doc_gen_form_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3202,22 +4259,22 @@ async def submit_doc_gen_form_async( return json.loads(response.text) - async def get_file_items_async( + def list_file_items( self, dataset: str, table: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, folder_path: Optional[str] = None, view_scope_option: Optional[str] = None, view: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get files (properties only) @@ -3228,8 +4285,35 @@ async def get_file_items_async( On-Premises Data Gateway, the name of the library to connect to may need to be entered manually. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetFileItems`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint library name. + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + folder_path: Select a folder, or leave blank for the whole library. + view_scope_option: Return entries contained in sub-folders (default + = true). + view: Avoid column threshold issues by only using columns defined + in a view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3272,11 +4356,18 @@ async def get_file_items_async( query_params.append(f"view={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -3289,45 +4380,81 @@ async def get_file_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_items_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_items( self, dataset: str, table: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, folder_path: Optional[str] = None, view_scope_option: Optional[str] = None, view: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get items Gets items from a SharePoint list. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + top: Total number of entries to retrieve (default = all). + folder_path: Select a folder, or leave blank for the whole list. + view_scope_option: Return entries contained in sub-folders (default + = true). + view: Avoid column threshold issues by only using columns defined + in a view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3370,11 +4497,18 @@ async def get_items_async( query_params.append(f"view={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -3387,29 +4521,38 @@ async def get_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def post_item_async( + return AsyncItemPaged(get_next, extract_data) + + async def post_item( self, - input: PostItemInput, + input: PostItemInput | Mapping[str, Any], dataset: str, table: str, - view: Optional[str] = None, *, + view: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3419,6 +4562,26 @@ async def post_item_async( Create item Creates a new item in a SharePoint list. + + Swagger operation ID: `PostItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + view: Avoid column threshold issues by only using columns defined + in a view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3437,7 +4600,7 @@ async def post_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3451,6 +4614,7 @@ async def post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3458,13 +4622,13 @@ async def post_item_async( return json.loads(response.text) - async def get_item_async( + async def get_item( self, dataset: str, table: str, id: int, - view: Optional[str] = None, *, + view: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3474,6 +4638,25 @@ async def get_item_async( Get item Gets a single item by its id from a SharePoint list. + + Swagger operation ID: `GetItem`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + id: Unique identifier of item to be retrieved. + view: Avoid column threshold issues by only using columns defined + in a view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3493,7 +4676,7 @@ async def get_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3507,6 +4690,7 @@ async def get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3514,7 +4698,7 @@ async def get_item_async( return json.loads(response.text) - async def delete_item_async( + async def delete_item( self, dataset: str, table: str, @@ -3529,6 +4713,23 @@ async def delete_item_async( Delete item Deletes an item from a SharePoint list. + + Swagger operation ID: `DeleteItem`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + id: Unique identifier of item to be deleted. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3540,7 +4741,7 @@ async def delete_item_async( f"/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -3554,16 +4755,17 @@ async def delete_item_async( request_url, response.status, response.text, + response=response, ) - async def patch_item_async( + async def patch_item( self, - input: PatchItemInput, + input: PatchItemInput | Mapping[str, Any], dataset: str, table: str, id: int, - view: Optional[str] = None, *, + view: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3573,6 +4775,27 @@ async def patch_item_async( Update item Updates an item in a SharePoint list. + + Swagger operation ID: `PatchItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + id: Unique identifier of item to be updated. + view: Avoid column threshold issues by only using columns defined + in a view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3592,7 +4815,7 @@ async def patch_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -3606,6 +4829,7 @@ async def patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3613,9 +4837,9 @@ async def patch_item_async( return json.loads(response.text) - async def create_approval_request_async( + async def create_approval_request( self, - input: CreateApprovalRequestInput, + input: CreateApprovalRequestInput | Mapping[str, Any], dataset: str, table: str, id: int, @@ -3630,6 +4854,26 @@ async def create_approval_request_async( Create an approval request for an item or file Creates an approval request for an item or file. + + Swagger operation ID: `CreateApprovalRequest`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list or library name. + id: Id of the item the approval request is being created for. + approval_type: Select an approval type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3649,7 +4893,7 @@ async def create_approval_request_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3663,6 +4907,7 @@ async def create_approval_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3670,16 +4915,16 @@ async def create_approval_request_async( return json.loads(response.text) - async def get_item_changes_async( + async def get_item_changes( self, dataset: str, table: str, id: int, since: str, + *, until: Optional[str] = None, include_drafts: Optional[bool] = None, view: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3690,6 +4935,31 @@ async def get_item_changes_async( Returns information about columns that have changed within a given time window. Note: The list must have Versioning turned on. + + Swagger operation ID: `GetItemChanges`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list or library name. + id: Id of the item you want to fetch changes for. + since: Trigger Window Start token or an item version label (ex: + 3.0) or an ISO 8601 date (YYYY-MM-DDThh:mmZ). + until: Trigger Window End token or an item version label (ex: 3.0) + or an ISO 8601 date (YYYY-MM-DDThh:mmZ). If blank, defaults to + latest version. + include_drafts: Boolean for whether to consider changes from minor + (draft) versions. + view: Returns only columns defined in a view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3724,7 +4994,7 @@ async def get_item_changes_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -3738,6 +5008,7 @@ async def get_item_changes_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3745,9 +5016,9 @@ async def get_item_changes_async( return json.loads(response.text) - async def check_in_file_async( + async def check_in_file( self, - input: FileCheckInParameters, + input: FileCheckInParameters | Mapping[str, Any], dataset: str, table: str, id: int, @@ -3762,6 +5033,25 @@ async def check_in_file_async( Check in a checked out file in a document library, which makes the version of the document available to others. + + Swagger operation ID: `CheckInFile`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint library name. + id: Id of the list item the file is attached to. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3774,7 +5064,7 @@ async def check_in_file_async( f"/checkinfile" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3788,9 +5078,10 @@ async def check_in_file_async( request_url, response.status, response.text, + response=response, ) - async def check_out_file_async( + async def check_out_file( self, dataset: str, table: str, @@ -3807,6 +5098,23 @@ async def check_out_file_async( Check out a file in a document library to prevent others from editing the document, and your changes from being visible until the documented is checked in. + + Swagger operation ID: `CheckOutFile`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint library name. + id: Id of the list item the file is attached to. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3819,7 +5127,7 @@ async def check_out_file_async( f"/checkoutfile" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -3833,9 +5141,10 @@ async def check_out_file_async( request_url, response.status, response.text, + response=response, ) - async def discard_file_check_out_async( + async def discard_file_check_out( self, dataset: str, table: str, @@ -3855,6 +5164,23 @@ async def discard_file_check_out_async( versions, a new version is created each time you check a file back into the library. By discarding the checkout, you can avoid making new versions when you haven't made any changes to the file. + + Swagger operation ID: `DiscardFileCheckOut`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint library name. + id: Id of the list item the file is attached to. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3867,7 +5193,7 @@ async def discard_file_check_out_async( f"/discardfilecheckout" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -3881,15 +5207,16 @@ async def discard_file_check_out_async( request_url, response.status, response.text, + response=response, ) - async def get_file_item_async( + async def get_file_item( self, dataset: str, table: str, id: int, - view: Optional[str] = None, *, + view: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -3904,6 +5231,25 @@ async def get_file_item_async( the contents of the file. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually. + + Swagger operation ID: `GetFileItem`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint library name. + id: Unique identifier of item to be retrieved. + view: Avoid column threshold issues by only using columns defined + in a view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3924,7 +5270,7 @@ async def get_file_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3938,6 +5284,7 @@ async def get_file_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3945,9 +5292,9 @@ async def get_file_item_async( return json.loads(response.text) - async def grant_access_async( + async def grant_access( self, - input: ItemGrantAccessBody, + input: ItemGrantAccessBody | Mapping[str, Any], dataset: str, table: str, id: int, @@ -3961,6 +5308,26 @@ async def grant_access_async( Grant access to an item or a folder Grant access to an item or a folder in SharePoint to specific people. + + Swagger operation ID: `GrantAccess`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list or library name. + id: Unique identifier of the item or folder you want to grant + access to. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3973,7 +5340,7 @@ async def grant_access_async( f"/grantaccess" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3987,16 +5354,17 @@ async def grant_access_async( request_url, response.status, response.text, + response=response, ) - async def patch_file_item_async( + async def patch_file_item( self, - input: PatchFileItemInput, + input: PatchFileItemInput | Mapping[str, Any], dataset: str, table: str, id: int, - view: Optional[str] = None, *, + view: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4009,6 +5377,27 @@ async def patch_file_item_async( specified by the item id. Use \"Update file\" action to update file contents. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually. + + Swagger operation ID: `PatchFileItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint library name. + id: Unique identifier of item to be updated. + view: Avoid column threshold issues by only using columns defined + in a view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4029,7 +5418,7 @@ async def patch_file_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -4043,6 +5432,7 @@ async def patch_file_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4050,9 +5440,9 @@ async def patch_file_item_async( return json.loads(response.text) - async def patch_file_item_with_predicted_values_async( + async def patch_file_item_with_predicted_values( self, - input: PatchFileItemWithPredictedValuesParameters, + input: PatchFileItemWithPredictedValuesParameters | Mapping[str, Any], dataset: str, table: str, id: int, @@ -4067,6 +5457,25 @@ async def patch_file_item_with_predicted_values_async( Updates the values stored in library columns for a file analyzed by the model specified by the ModelId. + + Swagger operation ID: `PatchFileItemWithPredictedValues`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: Library Name. + id: Unique identifier of item to be updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4079,7 +5488,7 @@ async def patch_file_item_with_predicted_values_async( f"/patchfileitemwithpredictedvalues" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4093,6 +5502,7 @@ async def patch_file_item_with_predicted_values_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4100,15 +5510,15 @@ async def patch_file_item_with_predicted_values_async( return json.loads(response.text) - async def set_approval_status_async( + async def set_approval_status( self, dataset: str, table: str, id: int, approval_action: str, + *, comments: Optional[str] = None, entity_tag: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4121,6 +5531,26 @@ async def set_approval_status_async( has content approval turned on. You must provide an ETag for pages and files. You can get the ETag using the Get File Metadata action. This action is only available for SharePoint Online and SharePoint 2019. + + Swagger operation ID: `SetApprovalStatus`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint library name. + id: Id of the item you are setting the status of. + approval_action: Pick the approval action. + comments: Add the comments from the approver. + entity_tag: Add an ETag (required for files and pages). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4150,7 +5580,7 @@ async def set_approval_status_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -4164,6 +5594,7 @@ async def set_approval_status_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4171,7 +5602,7 @@ async def set_approval_status_async( return json.loads(response.text) - async def unshare_item_async( + async def unshare_item( self, dataset: str, table: str, @@ -4187,6 +5618,23 @@ async def unshare_item_async( Delete all links giving access to an item or a file and remove all people with direct access except for owners. + + Swagger operation ID: `UnshareItem`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list or library name. + id: Unique identifier of the item or file you want to stop sharing. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4199,7 +5647,7 @@ async def unshare_item_async( f"/unshare" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -4213,9 +5661,10 @@ async def unshare_item_async( request_url, response.status, response.text, + response=response, ) - async def get_item_attachments_async( + def list_item_attachments( self, dataset: str, table: str, @@ -4225,47 +5674,88 @@ async def get_item_attachments_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get attachments Returns the list of attachments for the specified list item. You can add a \"Get attachment content\" step and use the \"File identifier\" property returned by this action to get to the contents of the file. - """ - request_url = ( - f"{self._connection_runtime_url}" - f"/datasets" - f"/{quote(quote(str(dataset), safe=''), safe='')}" + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetItemAttachments`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + item_id: Id of the list item to get attachments from. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. + """ + request_url = ( + f"{self._connection_runtime_url}" + f"/datasets" + f"/{quote(quote(str(dataset), safe=''), safe='')}" f"/tables" f"/{quote(quote(str(table), safe=''), safe='')}" f"/items" f"/{quote(quote(str(item_id), safe=''), safe='')}" f"/attachments" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - async def create_attachment_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_attachment( self, input: bytes, dataset: str, @@ -4282,6 +5772,25 @@ async def create_attachment_async( Add attachment Adds a new attachment to the specified list item. + + Swagger operation ID: `CreateAttachment`. + + Args: + input: The binary request body. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + item_id: Id of the list item to attach the file to. + display_name: File name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4301,7 +5810,7 @@ async def create_attachment_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -4318,6 +5827,7 @@ async def create_attachment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4325,7 +5835,7 @@ async def create_attachment_async( return json.loads(response.text) - async def delete_attachment_async( + async def delete_attachment( self, dataset: str, table: str, @@ -4341,6 +5851,24 @@ async def delete_attachment_async( Delete attachment Deletes the specified attachment. + + Swagger operation ID: `DeleteAttachment`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + item_id: Id of the list item the file is attached to. + attachment_id: File identifier for the attachment. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4354,7 +5882,7 @@ async def delete_attachment_async( f"/{quote(str(attachment_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -4368,9 +5896,10 @@ async def delete_attachment_async( request_url, response.status, response.text, + response=response, ) - async def get_attachment_content_async( + async def get_attachment_content( self, dataset: str, table: str, @@ -4387,6 +5916,24 @@ async def get_attachment_content_async( Returns file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment. + + Swagger operation ID: `GetAttachmentContent`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + item_id: Id of the list item the file is attached to. + attachment_id: File identifier for the attachment. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4401,7 +5948,7 @@ async def get_attachment_content_async( f"/$value" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4415,20 +5962,21 @@ async def get_attachment_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def create_content_assembly_document_async( + async def create_content_assembly_document( self, - input: CreateContentAssemblyDocumentInput, + input: CreateContentAssemblyDocumentInput | Mapping[str, Any], dataset: str, table: str, template: str, + *, folder_path: Optional[str] = None, file_name: Optional[str] = None, view: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4441,6 +5989,28 @@ async def create_content_assembly_document_async( Microsoft Syntex. This preview requires a Syntex license. Pricing is subject to change. For more info see: https://docs.microsoft.com/en-us/microsoft-365/contentunderstanding/content-assembly. + + Swagger operation ID: `CreateContentAssemblyDocument`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint document library name. + template: Document template. + folder_path: Must start with an existing library. + file_name: Document file name. + view: This parameter does nothing. Please do not use. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4471,7 +6041,7 @@ async def create_content_assembly_document_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4485,6 +6055,7 @@ async def create_content_assembly_document_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4492,7 +6063,7 @@ async def create_content_assembly_document_async( return json.loads(response.text) - async def get_table_views_async( + def list_table_views( self, dataset: str, table: str, @@ -4501,11 +6072,30 @@ async def get_table_views_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get list views Gets views from a SharePoint list. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTableViews`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4515,35 +6105,56 @@ async def get_table_views_async( f"/{quote(quote(str(table), safe=''), safe='')}" f"/views" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def extract_folder_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def extract_folder( self, dataset: str, source: str, destination: str, - overwrite: Optional[bool] = None, *, + overwrite: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4553,6 +6164,25 @@ async def extract_folder_async( Extract folder Extracts an archive file into a SharePoint folder (example: .zip). + + Swagger operation ID: `ExtractFolderV2`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + source: Path to the source file. + destination: Path to the destination folder. + overwrite: Whether or not to overwrite the destination file if it + exists. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4578,7 +6208,7 @@ async def extract_folder_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -4592,6 +6222,7 @@ async def extract_folder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4599,43 +6230,81 @@ async def extract_folder_async( return json.loads(response.text) - async def get_data_sets_async( + def list_data_sets( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get datasets Gets the most recently used SharePoint sites. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDataSets`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/datasets" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_agreements_solution_templates_async( + def list_agreements_solution_templates( self, dataset: str, *, @@ -4643,11 +6312,29 @@ async def get_agreements_solution_templates_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Agreements Solution - Get Templates Gets templates from a Agreements Solution workspace. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAgreementsSolutionTemplates`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4656,29 +6343,50 @@ async def get_agreements_solution_templates_async( f"/agreements" f"/templates" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - async def get_agreements_solution_template_fields_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_agreements_solution_template_fields( self, dataset: str, template: str, @@ -4692,6 +6400,22 @@ async def get_agreements_solution_template_fields_async( Agreements Solution - Get template fields Gets fields from template in a Agreements Solution workspace. + + Swagger operation ID: `GetAgreementsSolutionTemplateFields`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + template: Agreements Solution template. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4703,7 +6427,7 @@ async def get_agreements_solution_template_fields_async( f"/fields" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4717,6 +6441,7 @@ async def get_agreements_solution_template_fields_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4724,7 +6449,7 @@ async def get_agreements_solution_template_fields_async( return json.loads(response.text) - async def get_tables_for_libraries_async( + def list_tables_for_libraries( self, dataset: str, *, @@ -4732,11 +6457,29 @@ async def get_tables_for_libraries_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get libraries Get libraries + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTablesForLibraries`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4745,29 +6488,50 @@ async def get_tables_for_libraries_async( f"/tablesfor" f"/libraries" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - async def get_thumbnail_size_options_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_thumbnail_size_options( self, *, timeout: Optional[float] = None, @@ -4779,10 +6543,24 @@ async def get_thumbnail_size_options_async( Get thumbnail size options Internal operation to get thumbnail size options. + + Swagger operation ID: `GetThumbnailSizeOptions`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getThumbnailSizeOptions" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4796,6 +6574,7 @@ async def get_thumbnail_size_options_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4803,13 +6582,13 @@ async def get_thumbnail_size_options_async( return json.loads(response.text) - async def get_table_async( + async def get_table( self, dataset: str, table: str, + *, view: Optional[str] = None, content_type_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -4819,6 +6598,25 @@ async def get_table_async( Get list metadata Gets metadata from a SharePoint list. + + Swagger operation ID: `GetTable`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + view: Avoid column threshold issues by only using columns defined + in a view. + content_type_id: Contentype Id to filter columns by content type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4842,7 +6640,7 @@ async def get_table_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4856,6 +6654,7 @@ async def get_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4863,7 +6662,7 @@ async def get_table_async( return json.loads(response.text) - async def get_tables_for_lists_and_libraries_async( + def list_tables_for_lists_and_libraries( self, dataset: str, *, @@ -4871,11 +6670,29 @@ async def get_tables_for_lists_and_libraries_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get lists and libraries Get lists and libraries + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTablesForListsAndLibraries`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4884,43 +6701,85 @@ async def get_tables_for_lists_and_libraries_async( f"/tablesfor" f"/listsandlibraries" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not response.text: - return None + return response, request_url - return json.loads(response.text) + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_entities_for_user_async( + return AsyncItemPaged(get_next, extract_data) + + def list_entities_for_user( self, dataset: str, table: str, - view: Optional[str] = None, *, + view: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Returns User fields for a list Returns User fields for a list. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetEntitiesForUser`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + view: Avoid column threshold issues by only using columns defined + in a view. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4939,29 +6798,50 @@ async def get_entities_for_user_async( query_params.append(f"view={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - async def get_table_forms_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_table_forms( self, dataset: str, table: str, @@ -4970,11 +6850,30 @@ async def get_table_forms_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get list forms Gets forms from a SharePoint list. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTableForms`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4984,29 +6883,50 @@ async def get_table_forms_async( f"/{quote(quote(str(table), safe=''), safe='')}" f"/forms" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_doc_gen_forms_async( + return AsyncItemPaged(get_next, extract_data) + + def list_doc_gen_forms( self, dataset: str, table: str, @@ -5015,12 +6935,31 @@ async def get_doc_gen_forms_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get document generation forms Gets published document generation forms from a SharePoint document library. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDocGenForms`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint document library name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5030,29 +6969,50 @@ async def get_doc_gen_forms_async( f"/{quote(quote(str(table), safe=''), safe='')}" f"/docgenforms" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_doc_gen_form_fields_async( + async def get_doc_gen_form_fields( self, dataset: str, table: str, @@ -5067,6 +7027,23 @@ async def get_doc_gen_form_fields_async( Get document generation form fields Gets fields from a document generation form in a SharePoint list. + + Swagger operation ID: `GetDocGenFormFields`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list name. + form: Form identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5079,7 +7056,7 @@ async def get_doc_gen_form_fields_async( f"/fields" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5093,6 +7070,7 @@ async def get_doc_gen_form_fields_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5100,45 +7078,83 @@ async def get_doc_gen_form_fields_async( return json.loads(response.text) - async def get_view_scope_options_async( + def list_view_scope_options( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get SPViewScope options to use for folder querying behavior Default - Only query current folder (non-recursive). Return both Files and Folders. RecursiveAll - Recursively query the folder. Return both Files and Folders. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetViewScopeOptions`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getViewScopeOptions" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - async def get_tables_for_lightweight_approval_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_tables_for_lightweight_approval( self, dataset: str, *, @@ -5146,11 +7162,29 @@ async def get_tables_for_lightweight_approval_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get lists and libraries where lightweight approvals is enabled Get lists and libraries where lightweight approvals is enabled + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTablesForLightweightApproval`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5159,29 +7193,50 @@ async def get_tables_for_lightweight_approval_async( f"/tablesfor" f"/lightweightapproval" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_approval_types_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_approval_types( self, *, timeout: Optional[float] = None, @@ -5193,10 +7248,24 @@ async def get_approval_types_async( Get available approval request types Internal operation to get the available approval request types. + + Swagger operation ID: `GetApprovalTypes`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getApprovalTypes" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5210,6 +7279,7 @@ async def get_approval_types_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5217,7 +7287,7 @@ async def get_approval_types_async( return json.loads(response.text) - async def get_approval_schema_async( + async def get_approval_schema( self, approval_type: int, *, @@ -5231,6 +7301,21 @@ async def get_approval_schema_async( Internal operation to fetch the schema for approval request creation based on the approval type. + + Swagger operation ID: `GetApprovalSchema`. + + Args: + approval_type: Type of approval request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getApprovalSchema" query_params = [] @@ -5241,7 +7326,7 @@ async def get_approval_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5255,6 +7340,7 @@ async def get_approval_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5262,7 +7348,7 @@ async def get_approval_schema_async( return json.loads(response.text) - async def get_item_changes_metadata_async( + async def get_item_changes_metadata( self, dataset: str, table: str, @@ -5276,6 +7362,22 @@ async def get_item_changes_metadata_async( Get metadata about the return type of the GetItemChanges operation Get metadata about the return type of the GetItemChanges operation. + + Swagger operation ID: `GetItemChangesMetadata`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint list or library name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5288,7 +7390,7 @@ async def get_item_changes_metadata_async( f"/changes" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5302,6 +7404,7 @@ async def get_item_changes_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5309,7 +7412,7 @@ async def get_item_changes_metadata_async( return json.loads(response.text) - async def get_tables_for_approval_async( + def list_tables_for_approval( self, dataset: str, *, @@ -5317,11 +7420,29 @@ async def get_tables_for_approval_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get libraries where Content Approval is supported Get libraries where Content Approval is supported + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTablesForApproval`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5330,29 +7451,50 @@ async def get_tables_for_approval_async( f"/tablesfor" f"/approval" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_day_of_week_options_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_day_of_week_options( self, *, timeout: Optional[float] = None, @@ -5364,10 +7506,24 @@ async def get_day_of_week_options_async( When to send updates Internal operation to get day of week options. + + Swagger operation ID: `GetDayOfWeekOptions`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/getDayOfWeekOptions" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5381,6 +7537,7 @@ async def get_day_of_week_options_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5388,7 +7545,7 @@ async def get_day_of_week_options_async( return json.loads(response.text) - async def get_content_assembly_templates_async( + def list_content_assembly_templates( self, dataset: str, table: str, @@ -5397,11 +7554,30 @@ async def get_content_assembly_templates_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get document library templates Gets templates from a SharePoint document library. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetContentAssemblyTemplates`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint document library name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5411,29 +7587,50 @@ async def get_content_assembly_templates_async( f"/{quote(quote(str(table), safe=''), safe='')}" f"/templates" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_content_assembly_placeholders_async( + async def get_content_assembly_placeholders( self, dataset: str, table: str, @@ -5448,6 +7645,23 @@ async def get_content_assembly_placeholders_async( Get placeholders from template Gets placeholders from template in a SharePoint document library. + + Swagger operation ID: `GetContentAssemblyPlaceholders`. + + Args: + dataset: Example: https://contoso.sharepoint.com/sites/sitename. + table: SharePoint document library name. + template: Document template. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5460,7 +7674,7 @@ async def get_content_assembly_placeholders_async( f"/placeholders" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5474,6 +7688,7 @@ async def get_content_assembly_placeholders_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/shifts.py b/src/azure/connectors/shifts.py index efbf2d08..4fb879b1 100644 --- a/src/azure/connectors/shifts.py +++ b/src/azure/connectors/shifts.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Literal, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,71 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "ShiftsClient", + "Activities", + "CreateShiftRequest", + "CreateTimeOffRequest", + "DraftOpenShift", + "DraftShift", + "DraftTimeOff", + "EditOpenShiftRequest", + "GetAllTeamsResponse", + "GetTimeOffReasonsResponse", + "ListOfferShiftRequestsResponse", + "ListOpenShiftChangeRequestsResponse", + "ListOpenShiftsCrossTeamResponse", + "ListOpenShiftsResponse", + "ListSchedulingGroupsResponse", + "ListShiftsCrossTeamResponse", + "ListShiftsResponse", + "ListSwapShiftsChangeRequestsResponse", + "ListTimeOffRequestsResponse", + "ListTimesOffCrossTeamResponse", + "ListTimesOffResponse", + "OfferShiftRequestApproveInput", + "OfferShiftRequestApproveResponse", + "OfferShiftRequestDeclineInput", + "OfferShiftRequestDeclineResponse", + "OfferShiftRequestResponse", + "OpenShiftChangeRequestApproveInput", + "OpenShiftChangeRequestApproveResponse", + "OpenShiftChangeRequestDeclineInput", + "OpenShiftChangeRequestDeclineResponse", + "OpenShiftChangeRequestResponse", + "OpenShiftResponse", + "ScheduleResponse", + "SchedulingGroupInfo", + "SchedulingGroupResponse", + "SharedOpenShift", + "SharedShift", + "SharedTimeOff", + "ShiftResponse", + "Subscription", + "SwapShiftsChangeRequestApproveInput", + "SwapShiftsChangeRequestApproveResponse", + "SwapShiftsChangeRequestDeclineInput", + "SwapShiftsChangeRequestDeclineResponse", + "SwapShiftsChangeRequestResponse", + "TeamInfo", + "Theme", + "TimeOffRequestApproveInput", + "TimeOffRequestApproveResponse", + "TimeOffRequestDeclineInput", + "TimeOffRequestDeclineResponse", + "TimeOffRequestResponse", + "TimeOffResponse", + "UserInfo", + "WebHookRequest", + "WebhookNotificationEntity", + "WebhookPushResponse", + "WebhookPushResponseResourceEntity", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,20 +93,23 @@ class ScheduleResponse: Response for Get a Schedule's details """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Schedule.""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timeZone"}, ) """The Time Zone of the Schedule.""" - provision_status: Optional[str] = field( + provision_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "provisionStatus"}, ) """The Provision Status of the Schedule.""" - provision_status_code: Optional[str] = field( + provision_status_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "provisionStatusCode"}, ) """The Provision Status Code of the Schedule.""" @@ -54,14 +121,21 @@ class ListTimesOffResponse: Response for List all Time Off instances in a team """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[TimeOffResponse]] = None + value: Optional[ + List[TimeOffResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Time Off instances""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -73,37 +147,44 @@ class TimeOffResponse: Response for Create a new Time Off instance """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Time Off.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - user_id: Optional[str] = field( + user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userId"}, ) """Assigned To User ID.""" - user_info: Optional[UserInfo] = field( + user_info: Optional[UserInfo | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userInfo"}, ) - team_info: Optional[TeamInfo] = field( + team_info: Optional[TeamInfo | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamInfo"}, ) - shared_time_off: Optional[SharedTimeOff] = field( + shared_time_off: Optional[SharedTimeOff | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sharedTimeOff"}, ) - draft_time_off: Optional[DraftTimeOff] = field( + draft_time_off: Optional[DraftTimeOff | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "draftTimeOff"}, ) @@ -114,14 +195,21 @@ class ListShiftsResponse: Response for List all Shifts in a team """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[ShiftResponse]] = None + value: Optional[ + List[ShiftResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Shifts""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -133,46 +221,55 @@ class ShiftResponse: Response for Create a new Shift """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Shift.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - user_id: Optional[str] = field( + user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userId"}, ) """Assigned To User ID.""" - scheduling_group_id: Optional[str] = field( + scheduling_group_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "schedulingGroupId"}, ) """Scheduling Group ID.""" - scheduling_group_info: Optional[SchedulingGroupInfo] = field( + scheduling_group_info: Optional[SchedulingGroupInfo | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "schedulingGroupInfo"}, ) - user_info: Optional[UserInfo] = field( + user_info: Optional[UserInfo | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userInfo"}, ) - team_info: Optional[TeamInfo] = field( + team_info: Optional[TeamInfo | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamInfo"}, ) - shared_shift: Optional[SharedShift] = field( + shared_shift: Optional[SharedShift | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sharedShift"}, ) - draft_shift: Optional[DraftShift] = field( + draft_shift: Optional[DraftShift | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "draftShift"}, ) @@ -183,14 +280,21 @@ class ListOpenShiftsResponse: Response for List all Open Shifts in a team """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[OpenShiftResponse]] = None + value: Optional[ + List[OpenShiftResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Open Shifts""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -202,37 +306,44 @@ class OpenShiftResponse: Response for Create a new Open Shift """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Open Shift.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - scheduling_group_id: Optional[str] = field( + scheduling_group_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "schedulingGroupId"}, ) """Scheduling Group ID""" - scheduling_group_info: Optional[SchedulingGroupInfo] = field( + scheduling_group_info: Optional[SchedulingGroupInfo | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "schedulingGroupInfo"}, ) - team_info: Optional[TeamInfo] = field( + team_info: Optional[TeamInfo | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamInfo"}, ) - shared_open_shift: Optional[SharedOpenShift] = field( + shared_open_shift: Optional[SharedOpenShift | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sharedOpenShift"}, ) - draft_open_shift: Optional[DraftOpenShift] = field( + draft_open_shift: Optional[DraftOpenShift | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "draftOpenShift"}, ) @@ -243,14 +354,16 @@ class GetTimeOffReasonsResponse: Response for List all Time Off Reasons in a team """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """The list of Time Off Reasons.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -262,14 +375,21 @@ class ListSchedulingGroupsResponse: Response for List all Scheduling Groups in a team """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[SchedulingGroupResponse]] = None + value: Optional[ + List[SchedulingGroupResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Scheduling Groups.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -281,23 +401,26 @@ class SchedulingGroupResponse: Response for Get a Scheduling Group """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Scheduling Group.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The display name for the Scheduling Group.""" - is_active: Optional[bool] = field( + is_active: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isActive"}, ) """ Indicates whether the Scheduling Group can be used when creating new entities or updating existing ones. """ - user_ids: Optional[List[str]] = field( + user_ids: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userIds"}, ) """List of IDs of users in the Scheduling Group.""" @@ -309,14 +432,21 @@ class ListTimeOffRequestsResponse: Response for List all Time Off requests in a team """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[TimeOffRequestResponse]] = None + value: Optional[ + List[TimeOffRequestResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Time Off requests.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -328,67 +458,79 @@ class TimeOffRequestResponse: Response for Get a Time Off request """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Time Off request.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - assigned_to: Optional[str] = field( + assigned_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedTo"}, ) """The person the request is assigned to: 'manager' or 'recipient'""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """'approved', 'pending' or 'declined'""" - sender_date_time: Optional[str] = field( + sender_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderDateTime"}, ) """Time when the request was sent""" - sender_message: Optional[str] = field( + sender_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderMessage"}, ) """The message from the request sender""" - sender_user_id: Optional[str] = field( + sender_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderUserId"}, ) """The ID of the user that sent the request""" - manager_action_date_time: Optional[str] = field( + manager_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionDateTime"}, ) """Time when the manager responded""" - manager_action_message: Optional[str] = field( + manager_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionMessage"}, ) """The message from the manager""" - manager_user_id: Optional[str] = field( + manager_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerUserId"}, ) """The ID of the manager that responded""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """Start of time requested off""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """End of time requested off""" - time_off_reason_id: Optional[str] = field( + time_off_reason_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timeOffReasonId"}, ) """The ID of the Time Off Reason""" @@ -400,7 +542,7 @@ class TimeOffRequestApproveInput: Approve a Time Off request """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """ A message from the manager to the sender/recipient when a request is accepted. @@ -413,7 +555,7 @@ class TimeOffRequestApproveResponse: Response for Approve a Time Off request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -426,7 +568,7 @@ class TimeOffRequestDeclineInput: Decline a Time Off request """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """ A message from the manager to the sender/recipient when a request is declined. @@ -439,7 +581,7 @@ class TimeOffRequestDeclineResponse: Response for Decline a Time Off request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -452,14 +594,21 @@ class ListOfferShiftRequestsResponse: Response for List all Offer Shift requests in a team """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[OfferShiftRequestResponse]] = None + value: Optional[ + List[OfferShiftRequestResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Offer Shift requests.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -471,72 +620,85 @@ class OfferShiftRequestResponse: Response for Get an Offer Shift request """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Offer Shift request.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - assigned_to: Optional[str] = field( + assigned_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedTo"}, ) """The person the request is assigned to: 'manager' or 'recipient'""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """'approved', 'pending' or 'declined'""" - sender_date_time: Optional[str] = field( + sender_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderDateTime"}, ) """Time when the request was sent""" - sender_message: Optional[str] = field( + sender_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderMessage"}, ) """The message from the request sender""" - sender_user_id: Optional[str] = field( + sender_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderUserId"}, ) """The ID of the user that sent the request""" - sender_shift_id: Optional[str] = field( + sender_shift_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderShiftId"}, ) """The ID of the Shift from the sender""" - recipient_action_date_time: Optional[str] = field( + recipient_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientActionDateTime"}, ) """Time when the recipient responded""" - recipient_action_message: Optional[str] = field( + recipient_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientActionMessage"}, ) """The message from the recipient""" - recipient_user_id: Optional[str] = field( + recipient_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientUserId"}, ) """The ID of the recipient of the request""" - manager_action_date_time: Optional[str] = field( + manager_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionDateTime"}, ) """Time when the manager responded""" - manager_action_message: Optional[str] = field( + manager_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionMessage"}, ) """The message from the manager""" - manager_user_id: Optional[str] = field( + manager_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerUserId"}, ) """The ID of the manager that responded""" @@ -548,7 +710,7 @@ class OfferShiftRequestApproveInput: Approve an Offer Shift request """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """A message when a request is accepted.""" @@ -558,7 +720,7 @@ class OfferShiftRequestApproveResponse: Response for Approve an Offer Shift request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -571,7 +733,7 @@ class OfferShiftRequestDeclineInput: Decline an Offer Shift request """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """A message when a request is declined.""" @@ -581,7 +743,7 @@ class OfferShiftRequestDeclineResponse: Response for Decline an Offer Shift request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -594,14 +756,21 @@ class ListSwapShiftsChangeRequestsResponse: Response for List all Swap Shifts requests in a team """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[SwapShiftsChangeRequestResponse]] = None + value: Optional[ + List[SwapShiftsChangeRequestResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Swap Shifts Change Requests.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -613,77 +782,91 @@ class SwapShiftsChangeRequestResponse: Response for Get a Swap Shifts request """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Swap Shift request.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - assigned_to: Optional[str] = field( + assigned_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedTo"}, ) """The person the request is assigned to: 'manager' or 'recipient'""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """'approved', 'pending' or 'declined'""" - sender_date_time: Optional[str] = field( + sender_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderDateTime"}, ) """Time when the request was sent""" - sender_message: Optional[str] = field( + sender_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderMessage"}, ) """The message from the request sender""" - sender_user_id: Optional[str] = field( + sender_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderUserId"}, ) """The ID of the user that sent the request""" - sender_shift_id: Optional[str] = field( + sender_shift_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderShiftId"}, ) """The ID of the Shift from the sender""" - recipient_action_date_time: Optional[str] = field( + recipient_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientActionDateTime"}, ) """Time when the recipient responded""" - recipient_action_message: Optional[str] = field( + recipient_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientActionMessage"}, ) """The message from the recipient""" - recipient_user_id: Optional[str] = field( + recipient_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientUserId"}, ) """The ID of the recipient of the request""" - recipient_shift_id: Optional[str] = field( + recipient_shift_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientShiftId"}, ) """The ID of the Shift from the recipient""" - manager_action_date_time: Optional[str] = field( + manager_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionDateTime"}, ) """Time when the manager responded""" - manager_action_message: Optional[str] = field( + manager_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionMessage"}, ) """The message from the manager""" - manager_user_id: Optional[str] = field( + manager_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerUserId"}, ) """The ID of the manager that responded""" @@ -695,7 +878,7 @@ class SwapShiftsChangeRequestApproveInput: Approve a Swap Shifts request """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """A message when a request is accepted.""" @@ -705,7 +888,7 @@ class SwapShiftsChangeRequestApproveResponse: Response for Approve a Swap Shifts request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -718,7 +901,7 @@ class SwapShiftsChangeRequestDeclineInput: Decline a Swap Shifts request """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """A message when a request is declined.""" @@ -728,7 +911,7 @@ class SwapShiftsChangeRequestDeclineResponse: Response for Decline a Swap Shifts request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -741,14 +924,21 @@ class ListOpenShiftChangeRequestsResponse: Response for List all Open Shift requests in a team """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[OpenShiftChangeRequestResponse]] = None + value: Optional[ + List[OpenShiftChangeRequestResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Open Shift Change Requests.""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -760,57 +950,67 @@ class OpenShiftChangeRequestResponse: Response for Get an Open Shift request """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Open Shift Change request.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - assigned_to: Optional[str] = field( + assigned_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedTo"}, ) """The person the request is assigned to: 'manager' or 'recipient'""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """'approved', 'pending' or 'declined'""" - sender_date_time: Optional[str] = field( + sender_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderDateTime"}, ) """Time when the request was sent""" - sender_message: Optional[str] = field( + sender_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderMessage"}, ) """The message from the request sender""" - sender_user_id: Optional[str] = field( + sender_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderUserId"}, ) """The ID of the user that sent the request""" - manager_action_date_time: Optional[str] = field( + manager_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionDateTime"}, ) """Time when the manager responded""" - manager_action_message: Optional[str] = field( + manager_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionMessage"}, ) """The message from the manager""" - manager_user_id: Optional[str] = field( + manager_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerUserId"}, ) """The ID of the manager that responded""" - open_shift_id: Optional[str] = field( + open_shift_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "openShiftId"}, ) """The ID of the Open Shift being requested""" @@ -822,7 +1022,7 @@ class OpenShiftChangeRequestApproveInput: Approve an Open Shift request """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """ A message from the manager to the sender/recipient when a request is accepted. @@ -835,7 +1035,7 @@ class OpenShiftChangeRequestApproveResponse: Response for Approve an Open Shift request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -848,7 +1048,7 @@ class OpenShiftChangeRequestDeclineInput: Decline an Open Shift request """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """ A message from the manager to the sender/recipient when a request is declined. @@ -861,7 +1061,7 @@ class OpenShiftChangeRequestDeclineResponse: Response for Decline an Open Shift request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -874,14 +1074,21 @@ class ListOpenShiftsCrossTeamResponse: Response for List all Open Shifts from my teams """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[OpenShiftResponse]] = None + value: Optional[ + List[OpenShiftResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Open Shifts""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -893,14 +1100,21 @@ class ListShiftsCrossTeamResponse: Response for List all Shifts from my teams """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[ShiftResponse]] = None + value: Optional[ + List[ShiftResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Shifts""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -912,14 +1126,21 @@ class ListTimesOffCrossTeamResponse: Response for List all Times Off from my teams """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[TimeOffResponse]] = None + value: Optional[ + List[TimeOffResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Times off""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -931,11 +1152,12 @@ class GetAllTeamsResponse: Response for List teams """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of one or more Teams you are a part of.""" @@ -945,8 +1167,7 @@ class WebHookRequest: Definition: WebHookRequest """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "notificationUrl"}, ) """ @@ -960,7 +1181,12 @@ class WebhookPushResponse: Definition: WebhookPushResponse """ - value: Optional[List[WebhookNotificationEntity]] = None + value: Optional[ + List[WebhookNotificationEntity | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of values""" @@ -970,23 +1196,29 @@ class WebhookNotificationEntity: Definition: WebhookNotificationEntity """ - subscription_id: Optional[str] = field( + subscription_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "subscriptionId"}, ) """WebHook Subscription Id""" - expiration_date_time: Optional[str] = field( + expiration_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "expirationDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - change_type: Optional[str] = field( + change_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "changeType"}, ) """Resource change type (created/updated/deleted).""" - resource_data: Optional[WebhookPushResponseResourceEntity] = field( + resource_data: Optional[ + WebhookPushResponseResourceEntity | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resourceData"}, ) @@ -997,20 +1229,23 @@ class WebhookPushResponseResourceEntity: Definition: WebhookPushResponseResourceEntity """ - id_2: Optional[str] = field( + id_2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.id"}, ) """Full resource path.""" - type_: Optional[str] = field( + type_: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.type"}, ) """Resoure Type.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ID of the resource that is updated.""" - team_id: Optional[str] = field( + team_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamId"}, ) """ID of team where the update happened.""" @@ -1022,25 +1257,28 @@ class Subscription: Definition: Subscription """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier for the subscription.""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """Specifies the resource that will be monitored for changes.""" - application_id: Optional[str] = field( + application_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "applicationId"}, ) """Identifier of the application used to create the subscription.""" - change_type: Optional[str] = field( + change_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "changeType"}, ) """ Indicates the type of change in the subscribed resource that will raise a notification. """ - client_state: Optional[str] = field( + client_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "clientState"}, ) """ @@ -1050,23 +1288,26 @@ class Subscription: clientState property sent with the subscription with the value of the clientState property received with each notification. """ - notification_url: Optional[str] = field( + notification_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationUrl"}, ) """ The URL of the endpoint that will receive the notifications. This URL must make use of the HTTPS protocol. """ - expiration_date_time: Optional[str] = field( + expiration_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "expirationDateTime"}, ) """ Specifies the date and time when the webhook subscription expires (UTC). """ - creator_id: Optional[str] = field( + creator_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creatorId"}, ) """ @@ -1084,22 +1325,25 @@ class SharedTimeOff: Definition: SharedTimeOff """ - time_off_reason_id: Optional[str] = field( + time_off_reason_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timeOffReasonId"}, ) """Time Off Reason ID.""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - theme: Optional[Theme] = None + theme: Optional[Theme] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1108,22 +1352,25 @@ class DraftTimeOff: Definition: DraftTimeOff """ - time_off_reason_id: Optional[str] = field( + time_off_reason_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timeOffReasonId"}, ) """Time Off Reason ID.""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - theme: Optional[Theme] = None + theme: Optional[Theme] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1132,25 +1379,28 @@ class SharedShift: Definition: SharedShift """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display Name""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Shift Notes""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - theme: Optional[Theme] = None - activities: Optional[Activities] = None + theme: Optional[Theme] = dataclass_field(default=None, kw_only=True) + activities: Optional[Activities] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1159,25 +1409,28 @@ class DraftShift: Definition: DraftShift """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display Name""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Notes""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - theme: Optional[Theme] = None - activities: Optional[Activities] = None + theme: Optional[Theme] = dataclass_field(default=None, kw_only=True) + activities: Optional[Activities] = dataclass_field(default=None, kw_only=True) Theme = Literal[ @@ -1205,17 +1458,19 @@ class SchedulingGroupInfo: Definition: SchedulingGroupInfo """ - scheduling_group_id: Optional[str] = field( + scheduling_group_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "schedulingGroupId"}, ) """The unique ID of the Scheduling Group.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The display name for the Scheduling Group.""" - code: Optional[str] = None + code: Optional[str] = dataclass_field(default=None, kw_only=True) """The scheduling group code.""" @@ -1225,13 +1480,15 @@ class UserInfo: Definition: UserInfo """ - user_id: Optional[str] = field( + user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userId"}, ) """The ID of the user.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The display name of the user.""" @@ -1243,13 +1500,15 @@ class TeamInfo: Definition: TeamInfo """ - team_id: Optional[str] = field( + team_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamId"}, ) """The ID of the team.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The display name for the team.""" @@ -1261,13 +1520,15 @@ class EditOpenShiftRequest: Definition: EditOpenShiftRequest """ - scheduling_group_id: Optional[str] = field( + scheduling_group_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "schedulingGroupId"}, ) """Scheduling Group ID""" - shared_open_shift: Optional[Dict[str, Any]] = field( + shared_open_shift: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sharedOpenShift"}, ) @@ -1278,30 +1539,34 @@ class SharedOpenShift: Definition: SharedOpenShift """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display Name""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Notes""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - theme: Optional[Theme] = None - open_slot_count: Optional[int] = field( + theme: Optional[Theme] = dataclass_field(default=None, kw_only=True) + open_slot_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "openSlotCount"}, ) """Open Slot Count""" - activities: Optional[Activities] = None + activities: Optional[Activities] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1310,30 +1575,34 @@ class DraftOpenShift: Definition: DraftOpenShift """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display Name""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Notes""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - theme: Optional[Theme] = None - open_slot_count: Optional[int] = field( + theme: Optional[Theme] = dataclass_field(default=None, kw_only=True) + open_slot_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "openSlotCount"}, ) """Open Slot Count""" - activities: Optional[Activities] = None + activities: Optional[Activities] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1342,20 +1611,17 @@ class CreateShiftRequest: Definition: CreateShiftRequest """ - scheduling_group_id: Optional[str] = field( + scheduling_group_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "schedulingGroupId"}, ) """Scheduling Group ID""" - shared_shift: Optional[Dict[str, Any]] = field( - default=None, + shared_shift: Dict[str, Any] = dataclass_field( metadata={"wire_name": "sharedShift"}, ) """Shared version of the Shift.""" - user_id: Optional[str] = field( - default=None, - metadata={"wire_name": "userId"}, - ) + user_id: str = dataclass_field(metadata={"wire_name": "userId"}) """Assigned to User ID""" @@ -1365,15 +1631,11 @@ class CreateTimeOffRequest: Definition: CreateTimeOffRequest """ - shared_time_off: Optional[Dict[str, Any]] = field( - default=None, + shared_time_off: Dict[str, Any] = dataclass_field( metadata={"wire_name": "sharedTimeOff"}, ) """Shared version of a TimeOff.""" - user_id: Optional[str] = field( - default=None, - metadata={"wire_name": "userId"}, - ) + user_id: str = dataclass_field(metadata={"wire_name": "userId"}) """Assigned to User ID""" @@ -1388,7 +1650,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1405,8 +1667,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1427,7 +1689,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1443,15 +1705,49 @@ def connector_name(self) -> str: return "shifts" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -1468,7 +1764,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -1481,7 +1781,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def get_schedule_async( + async def get_schedule( self, team_id: str, *, @@ -1495,13 +1795,28 @@ async def get_schedule_async( This operation returns details of a Schedule using the Schedule's unique ID. + + Swagger operation ID: `GetSchedule`. + + Args: + team_id: Add Team ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/teams/{quote(str(team_id), safe='')}/schedule" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1515,6 +1830,7 @@ async def get_schedule_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1522,25 +1838,44 @@ async def get_schedule_async( return json.loads(response.text) - async def list_times_off_async( + def list_times_off( self, team_id: str, + *, start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Time Off instances in a team This operation returns all Time Off instances in a Schedule - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListTimesOff`. + + Args: + team_id: Add Team ID. + start_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + end_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + top: Items per page (enable Pagination under .../Settings). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1564,11 +1899,18 @@ async def list_times_off_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1581,25 +1923,34 @@ async def list_times_off_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def create_time_off_async( + async def create_time_off( self, - input: CreateTimeOffRequest, + input: CreateTimeOffRequest | Mapping[str, Any], team_id: str, *, timeout: Optional[float] = None, @@ -1612,13 +1963,30 @@ async def create_time_off_async( This operation creates a new Time Off instance and assigns it to a member of the team + + Swagger operation ID: `CreateTimeOff`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/teams/{quote(str(team_id), safe='')}/schedule/timesoff" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1632,6 +2000,7 @@ async def create_time_off_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1639,7 +2008,7 @@ async def create_time_off_async( return json.loads(response.text) - async def get_time_off_async( + async def get_time_off( self, team_id: str, time_off_id: str, @@ -1653,6 +2022,22 @@ async def get_time_off_async( Get a Time Off instance This operation returns details for a Time Off using its unique ID. + + Swagger operation ID: `GetTimeOff`. + + Args: + team_id: Add Team ID. + time_off_id: The unique ID of the Time Off. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1664,7 +2049,7 @@ async def get_time_off_async( f"/{quote(str(time_off_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1678,6 +2063,7 @@ async def get_time_off_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1685,7 +2071,7 @@ async def get_time_off_async( return json.loads(response.text) - async def delete_time_off_async( + async def delete_time_off( self, team_id: str, time_off_id: str, @@ -1699,6 +2085,22 @@ async def delete_time_off_async( Delete a Time Off instance This operation deletes a Time Off using its unique ID. + + Swagger operation ID: `DeleteTimeOff`. + + Args: + team_id: Add Team ID. + time_off_id: The unique ID of the Time Off. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1710,7 +2112,7 @@ async def delete_time_off_async( f"/{quote(str(time_off_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1724,27 +2126,47 @@ async def delete_time_off_async( request_url, response.status, response.text, + response=response, ) - async def list_shifts_async( + def list_shifts( self, team_id: str, + *, start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Shifts in a team This operation returns all Shifts assigned to members of a team - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListShifts`. + + Args: + team_id: Add Team ID. + start_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + end_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + top: Items per page (enable Pagination under .../Settings). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1768,11 +2190,18 @@ async def list_shifts_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1785,25 +2214,34 @@ async def list_shifts_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def create_shift_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_shift( self, - input: CreateShiftRequest, + input: CreateShiftRequest | Mapping[str, Any], team_id: str, *, timeout: Optional[float] = None, @@ -1816,13 +2254,30 @@ async def create_shift_async( This operation creates a new Shift and assigns it to a member of the team + + Swagger operation ID: `CreateShift`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/teams/{quote(str(team_id), safe='')}/schedule/shifts" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1836,6 +2291,7 @@ async def create_shift_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1843,7 +2299,7 @@ async def create_shift_async( return json.loads(response.text) - async def get_shift_async( + async def get_shift( self, team_id: str, shift_id: str, @@ -1857,6 +2313,22 @@ async def get_shift_async( Get a Shift This operation returns details for a Shift using the Shift's unique ID. + + Swagger operation ID: `GetShift`. + + Args: + team_id: Add Team ID. + shift_id: The unique ID of the Shift. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1868,7 +2340,7 @@ async def get_shift_async( f"/{quote(str(shift_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1882,6 +2354,7 @@ async def get_shift_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1889,7 +2362,7 @@ async def get_shift_async( return json.loads(response.text) - async def delete_shift_async( + async def delete_shift( self, team_id: str, shift_id: str, @@ -1903,6 +2376,22 @@ async def delete_shift_async( Delete a Shift This operation deletes a Shift using the Shift's unique ID. + + Swagger operation ID: `DeleteShift`. + + Args: + team_id: Add Team ID. + shift_id: The unique ID of the Shift. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1914,7 +2403,7 @@ async def delete_shift_async( f"/{quote(str(shift_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1928,27 +2417,47 @@ async def delete_shift_async( request_url, response.status, response.text, + response=response, ) - async def list_open_shifts_async( + def list_open_shifts( self, team_id: str, + *, start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Open Shifts in a team This operation returns all Open Shifts in a team. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListOpenShifts`. + + Args: + team_id: Add Team ID. + start_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + end_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + top: Items per page (enable Pagination under .../Settings). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1972,11 +2481,18 @@ async def list_open_shifts_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1989,25 +2505,34 @@ async def list_open_shifts_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def create_open_shift_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_open_shift( self, - input: EditOpenShiftRequest, + input: EditOpenShiftRequest | Mapping[str, Any], team_id: str, *, timeout: Optional[float] = None, @@ -2019,13 +2544,30 @@ async def create_open_shift_async( Create a new Open Shift Create a new Open Shift in a Schedule. + + Swagger operation ID: `CreateOpenShift`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/teams/{quote(str(team_id), safe='')}/schedule/openShifts" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2039,6 +2581,7 @@ async def create_open_shift_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2046,7 +2589,7 @@ async def create_open_shift_async( return json.loads(response.text) - async def get_open_shift_async( + async def get_open_shift( self, team_id: str, open_shift_id: str, @@ -2060,6 +2603,22 @@ async def get_open_shift_async( Get an Open Shift This operation returns details for an Open Shift. + + Swagger operation ID: `GetOpenShift`. + + Args: + team_id: Add Team ID. + open_shift_id: The unique ID of the Open Shift. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2071,7 +2630,7 @@ async def get_open_shift_async( f"/{quote(str(open_shift_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2085,6 +2644,7 @@ async def get_open_shift_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2092,9 +2652,9 @@ async def get_open_shift_async( return json.loads(response.text) - async def update_open_shift_async( + async def update_open_shift( self, - input: EditOpenShiftRequest, + input: EditOpenShiftRequest | Mapping[str, Any], team_id: str, open_shift_id: str, *, @@ -2107,6 +2667,24 @@ async def update_open_shift_async( Update an Open Shift Update an Open Shift in a Schedule. + + Swagger operation ID: `UpdateOpenShift`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + open_shift_id: The unique ID of the Open Shift. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2118,7 +2696,7 @@ async def update_open_shift_async( f"/{quote(str(open_shift_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2132,6 +2710,7 @@ async def update_open_shift_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2139,7 +2718,7 @@ async def update_open_shift_async( return json.loads(response.text) - async def delete_open_shift_async( + async def delete_open_shift( self, team_id: str, open_shift_id: str, @@ -2153,6 +2732,22 @@ async def delete_open_shift_async( Delete an Open Shift This operation deletes an Open Shift. + + Swagger operation ID: `DeleteOpenShift`. + + Args: + team_id: Add Team ID. + open_shift_id: The unique ID of the Open Shift. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2164,7 +2759,7 @@ async def delete_open_shift_async( f"/{quote(str(open_shift_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2178,26 +2773,44 @@ async def delete_open_shift_async( request_url, response.status, response.text, + response=response, ) - async def list_time_off_reasons_async( + def list_time_off_reasons( self, team_id: str, - top: Optional[int] = None, *, + top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Time Off Reasons in a team This operation returns the list of Time Off Reasons associated with a team. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListTimeOffReasons`. + + Args: + team_id: Add Team ID. + top: Items per page (enable Pagination under .../Settings). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2215,11 +2828,18 @@ async def list_time_off_reasons_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2232,39 +2852,65 @@ async def list_time_off_reasons_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def list_scheduling_groups_async( + def list_scheduling_groups( self, team_id: str, - top: Optional[int] = None, *, + top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Scheduling Groups in a team This operation returns all Scheduling Groups in a Schedule. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListSchedulingGroups`. + + Args: + team_id: Add Team ID. + top: Items per page (enable Pagination under .../Settings). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2282,11 +2928,18 @@ async def list_scheduling_groups_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2299,23 +2952,32 @@ async def list_scheduling_groups_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_scheduling_group_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_scheduling_group( self, team_id: str, scheduling_group_id: str, @@ -2330,6 +2992,22 @@ async def get_scheduling_group_async( This operation returns details for a Scheduling Group using its unique ID. + + Swagger operation ID: `GetSchedulingGroup`. + + Args: + team_id: Add Team ID. + scheduling_group_id: The unique ID of the Scheduling Group. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2341,7 +3019,7 @@ async def get_scheduling_group_async( f"/{quote(str(scheduling_group_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2355,6 +3033,7 @@ async def get_scheduling_group_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2362,24 +3041,42 @@ async def get_scheduling_group_async( return json.loads(response.text) - async def list_time_off_requests_async( + def list_time_off_requests( self, team_id: str, + *, top: Optional[int] = None, state: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Time Off requests in a team This operation returns all Time Off requests in a Schedule. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListTimeOffRequests`. + + Args: + team_id: Add Team ID. + top: Items per page (enable Pagination under .../Settings). + state: Request state filter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2402,11 +3099,18 @@ async def list_time_off_requests_async( query_params.append(f"state={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2419,23 +3123,32 @@ async def list_time_off_requests_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_time_off_shift_request_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_time_off_shift_request( self, team_id: str, time_off_request_id: str, @@ -2449,6 +3162,22 @@ async def get_time_off_shift_request_async( Get a Time Off request This operation returns a Time Off request by ID. + + Swagger operation ID: `GetTimeOffShiftRequest`. + + Args: + team_id: Add Team ID. + time_off_request_id: The unique ID of the Time Off request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2460,7 +3189,7 @@ async def get_time_off_shift_request_async( f"/{quote(str(time_off_request_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2474,6 +3203,7 @@ async def get_time_off_shift_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2481,9 +3211,9 @@ async def get_time_off_shift_request_async( return json.loads(response.text) - async def time_off_request_approve_async( + async def time_off_request_approve( self, - input: TimeOffRequestApproveInput, + input: TimeOffRequestApproveInput | Mapping[str, Any], team_id: str, time_off_request_id: str, *, @@ -2496,6 +3226,24 @@ async def time_off_request_approve_async( Approve a Time Off request This operation allows managers to approve a Time Off request. + + Swagger operation ID: `TimeOffRequestApprove`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + time_off_request_id: The unique ID of the Time Off request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2508,7 +3256,7 @@ async def time_off_request_approve_async( f"/approve" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2522,6 +3270,7 @@ async def time_off_request_approve_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2529,9 +3278,9 @@ async def time_off_request_approve_async( return json.loads(response.text) - async def time_off_request_decline_async( + async def time_off_request_decline( self, - input: TimeOffRequestDeclineInput, + input: TimeOffRequestDeclineInput | Mapping[str, Any], team_id: str, time_off_request_id: str, *, @@ -2544,6 +3293,24 @@ async def time_off_request_decline_async( Decline a Time Off request This operation allows managers to decline a Time Off request. + + Swagger operation ID: `TimeOffRequestDecline`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + time_off_request_id: The unique ID of the Time Off request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2556,7 +3323,7 @@ async def time_off_request_decline_async( f"/decline" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2570,6 +3337,7 @@ async def time_off_request_decline_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2577,24 +3345,42 @@ async def time_off_request_decline_async( return json.loads(response.text) - async def list_offer_shift_requests_async( + def list_offer_shift_requests( self, team_id: str, + *, top: Optional[int] = None, state: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Offer Shift requests in a team This operation returns all Offer Shift requests in a Schedule. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListOfferShiftRequests`. + + Args: + team_id: Add Team ID. + top: Items per page (enable Pagination under .../Settings). + state: Request state filter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2617,11 +3403,18 @@ async def list_offer_shift_requests_async( query_params.append(f"state={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2634,23 +3427,32 @@ async def list_offer_shift_requests_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_offer_shift_request_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_offer_shift_request( self, team_id: str, offer_shift_request_id: str, @@ -2664,6 +3466,22 @@ async def get_offer_shift_request_async( Get an Offer Shift request This operation returns an Offer Shift request by ID. + + Swagger operation ID: `GetOfferShiftRequest`. + + Args: + team_id: Add Team ID. + offer_shift_request_id: The unique ID of the Offer Shift request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2675,7 +3493,7 @@ async def get_offer_shift_request_async( f"/{quote(str(offer_shift_request_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2689,6 +3507,7 @@ async def get_offer_shift_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2696,9 +3515,9 @@ async def get_offer_shift_request_async( return json.loads(response.text) - async def offer_shift_request_approve_async( + async def offer_shift_request_approve( self, - input: OfferShiftRequestApproveInput, + input: OfferShiftRequestApproveInput | Mapping[str, Any], team_id: str, offer_shift_request_id: str, *, @@ -2712,6 +3531,24 @@ async def offer_shift_request_approve_async( This operation allows recipients/managers to approve an Offer Shift request. + + Swagger operation ID: `OfferShiftRequestApprove`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + offer_shift_request_id: The unique ID of the Offer Shift request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2724,7 +3561,7 @@ async def offer_shift_request_approve_async( f"/approve" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2738,6 +3575,7 @@ async def offer_shift_request_approve_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2745,9 +3583,9 @@ async def offer_shift_request_approve_async( return json.loads(response.text) - async def offer_shift_request_decline_async( + async def offer_shift_request_decline( self, - input: OfferShiftRequestDeclineInput, + input: OfferShiftRequestDeclineInput | Mapping[str, Any], team_id: str, offer_shift_request_id: str, *, @@ -2760,6 +3598,24 @@ async def offer_shift_request_decline_async( Decline an Offer Shift request This operation allows users to decline an Offer Shift request. + + Swagger operation ID: `OfferShiftRequestDecline`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + offer_shift_request_id: The unique ID of the Offer Shift request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2772,7 +3628,7 @@ async def offer_shift_request_decline_async( f"/decline" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2786,6 +3642,7 @@ async def offer_shift_request_decline_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2793,24 +3650,42 @@ async def offer_shift_request_decline_async( return json.loads(response.text) - async def list_swap_shifts_change_requests_async( + def list_swap_shifts_change_requests( self, team_id: str, + *, top: Optional[int] = None, state: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Swap Shifts requests in a team This operation returns all Swap Shifts requests in a Schedule. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListSwapShiftsChangeRequests`. + + Args: + team_id: Add Team ID. + top: Items per page (enable Pagination under .../Settings). + state: Request state filter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2833,11 +3708,18 @@ async def list_swap_shifts_change_requests_async( query_params.append(f"state={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2850,23 +3732,32 @@ async def list_swap_shifts_change_requests_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_swap_shifts_change_request_async( + async def get_swap_shifts_change_request( self, team_id: str, swap_shifts_change_request_id: str, @@ -2880,6 +3771,22 @@ async def get_swap_shifts_change_request_async( Get a Swap Shifts request This operation returns a Swap Shifts request by ID. + + Swagger operation ID: `GetSwapShiftsChangeRequest`. + + Args: + team_id: Add Team ID. + swap_shifts_change_request_id: The unique ID of the request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2891,7 +3798,7 @@ async def get_swap_shifts_change_request_async( f"/{quote(str(swap_shifts_change_request_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2905,6 +3812,7 @@ async def get_swap_shifts_change_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2912,9 +3820,9 @@ async def get_swap_shifts_change_request_async( return json.loads(response.text) - async def swap_shifts_change_request_approve_async( + async def swap_shifts_change_request_approve( self, - input: SwapShiftsChangeRequestApproveInput, + input: SwapShiftsChangeRequestApproveInput | Mapping[str, Any], team_id: str, swap_shifts_change_request_id: str, *, @@ -2927,6 +3835,24 @@ async def swap_shifts_change_request_approve_async( Approve a Swap Shifts request This operation allows a user to approve a Swap Shifts request. + + Swagger operation ID: `SwapShiftsChangeRequestApprove`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + swap_shifts_change_request_id: The unique ID of the request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2939,7 +3865,7 @@ async def swap_shifts_change_request_approve_async( f"/approve" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2953,6 +3879,7 @@ async def swap_shifts_change_request_approve_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2960,9 +3887,9 @@ async def swap_shifts_change_request_approve_async( return json.loads(response.text) - async def swap_shifts_change_request_decline_async( + async def swap_shifts_change_request_decline( self, - input: SwapShiftsChangeRequestDeclineInput, + input: SwapShiftsChangeRequestDeclineInput | Mapping[str, Any], team_id: str, swap_shifts_change_request_id: str, *, @@ -2975,6 +3902,24 @@ async def swap_shifts_change_request_decline_async( Decline a Swap Shifts request This operation allows users to decline a Swap Shifts request. + + Swagger operation ID: `SwapShiftsChangeRequestDecline`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + swap_shifts_change_request_id: The unique ID of the request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2987,7 +3932,7 @@ async def swap_shifts_change_request_decline_async( f"/decline" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3001,6 +3946,7 @@ async def swap_shifts_change_request_decline_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3008,24 +3954,42 @@ async def swap_shifts_change_request_decline_async( return json.loads(response.text) - async def list_open_shift_change_requests_async( + def list_open_shift_change_requests( self, team_id: str, + *, top: Optional[int] = None, state: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Open Shift requests in a team This operation returns all Open Shift change requests in a Schedule. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListOpenShiftChangeRequests`. + + Args: + team_id: Add Team ID. + top: Items per page (enable Pagination under .../Settings). + state: Request state filter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3048,11 +4012,18 @@ async def list_open_shift_change_requests_async( query_params.append(f"state={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -3065,23 +4036,32 @@ async def list_open_shift_change_requests_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_open_shift_change_request_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_open_shift_change_request( self, team_id: str, open_shift_change_request_id: str, @@ -3095,6 +4075,22 @@ async def get_open_shift_change_request_async( Get an Open Shift request This operation returns an Open Shift change request by ID. + + Swagger operation ID: `GetOpenShiftChangeRequest`. + + Args: + team_id: Add Team ID. + open_shift_change_request_id: The unique ID of the request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3106,7 +4102,7 @@ async def get_open_shift_change_request_async( f"/{quote(str(open_shift_change_request_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3120,6 +4116,7 @@ async def get_open_shift_change_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3127,9 +4124,9 @@ async def get_open_shift_change_request_async( return json.loads(response.text) - async def open_shift_change_request_approve_async( + async def open_shift_change_request_approve( self, - input: OpenShiftChangeRequestApproveInput, + input: OpenShiftChangeRequestApproveInput | Mapping[str, Any], team_id: str, open_shift_change_request_id: str, *, @@ -3142,6 +4139,24 @@ async def open_shift_change_request_approve_async( Approve an Open Shift request This operation allows managers to approve an Open Shift request. + + Swagger operation ID: `OpenShiftChangeRequestApprove`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + open_shift_change_request_id: The unique ID of the request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3154,7 +4169,7 @@ async def open_shift_change_request_approve_async( f"/approve" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3168,6 +4183,7 @@ async def open_shift_change_request_approve_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3175,9 +4191,9 @@ async def open_shift_change_request_approve_async( return json.loads(response.text) - async def open_shift_change_request_decline_async( + async def open_shift_change_request_decline( self, - input: OpenShiftChangeRequestDeclineInput, + input: OpenShiftChangeRequestDeclineInput | Mapping[str, Any], team_id: str, open_shift_change_request_id: str, *, @@ -3190,6 +4206,24 @@ async def open_shift_change_request_decline_async( Decline an Open Shift request This operation allows managers to decline an Open Shift request. + + Swagger operation ID: `OpenShiftChangeRequestDecline`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Add Team ID. + open_shift_change_request_id: The unique ID of the request. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3202,7 +4236,7 @@ async def open_shift_change_request_decline_async( f"/decline" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3216,6 +4250,7 @@ async def open_shift_change_request_decline_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3223,25 +4258,43 @@ async def open_shift_change_request_decline_async( return json.loads(response.text) - async def list_open_shifts_cross_team_async( + def list_open_shifts_cross_team( self, + *, start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Open Shifts from my teams This operation returns Open Shifts that need to be filled from all your teams. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListOpenShiftsCrossTeam`. + + Args: + start_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + end_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + top: Items per page (enable Pagination under .../Settings). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/beta/me/joinedTeams/getOpenShifts" @@ -3264,11 +4317,18 @@ async def list_open_shifts_cross_team_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -3281,41 +4341,69 @@ async def list_open_shifts_cross_team_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def list_shifts_cross_team_async( + return AsyncItemPaged(get_next, extract_data) + + def list_shifts_cross_team( self, + *, start_time: Optional[str] = None, end_time: Optional[str] = None, assigned_to_user_name: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Shifts from my teams This operation returns assigned Shifts from all your teams. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListShiftsCrossTeam`. + + Args: + start_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + end_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + assigned_to_user_name: Assigned to user with name. + top: Items per page (enable Pagination under .../Settings). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/beta/me/joinedTeams/getShifts" @@ -3343,11 +4431,18 @@ async def list_shifts_cross_team_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -3360,41 +4455,69 @@ async def list_shifts_cross_team_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def list_times_off_cross_team_async( + def list_times_off_cross_team( self, + *, start_time: Optional[str] = None, end_time: Optional[str] = None, assigned_to_user_name: Optional[str] = None, top: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all Times Off from my teams This operation returns times when people are off from all your teams. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListTimesOffCrossTeam`. + + Args: + start_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + end_time: yyyy-MM-ddTHH:mm:ss.fffZ (UTC format). + assigned_to_user_name: Assigned to user with name. + top: How many times off to fetch. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/beta/me/joinedTeams/getTimesOff" @@ -3422,11 +4545,18 @@ async def list_times_off_cross_team_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -3439,58 +4569,105 @@ async def list_times_off_cross_team_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_all_teams_async( + return AsyncItemPaged(get_next, extract_data) + + def list_all_teams( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List teams This operation retrieves a list of all the Teams (Office 365 Groups) you are a member of. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllTeams`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/me/joinedTeams" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/signinghub.py b/src/azure/connectors/signinghub.py index fff7eba7..cd8c17f6 100644 --- a/src/azure/connectors/signinghub.py +++ b/src/azure/connectors/signinghub.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Literal, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Literal, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,253 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "SigninghubClient", + "AccessAuthentication", + "AccessDurationByDate", + "AccessDurationByDateResponse", + "AccessDurationByDays", + "AccessDurationByDaysResponse", + "AccessResponse", + "AccessSecurityPasswordResponse", + "AccessSecuritySmsOtpResponse", + "AccessSecurityTOTPResponse", + "AccessUpdateRequest", + "AddAttachmentResponse", + "AddDocumentPackageRequest", + "AddFieldResponse", + "AddPackageResponse", + "AddQrCodeResponse", + "ApiBulkSignAction", + "ApplyTemplateRequest", + "ApproveRequest", + "AssignFieldRequest", + "AttachmentDownloadAttachmentResponse", + "AttachmentFieldResponse", + "AttachmentPermissionRequest", + "AttachmentPermissionResponse", + "Authentication", + "AuthenticationPassword", + "AuthenticationRequest", + "AuthenticationResponse", + "AuthenticationSigningResponse", + "AuthenticationSigningSmsOtp", + "AuthenticationSigningSmsOtpResponse", + "AuthenticationSmsOtp", + "AutoPlaceFieldRequest", + "AutoPlaceFieldsResponse", + "BulkSignActionDocumentModel", + "BulkSignActionFieldModel", + "BulkSignAuthentication", + "BulkSignPackagesStatus", + "BulkSignRequest", + "BulkSignResponse", + "BulkSignStatusRequest", + "BulkSignStatusResponse", + "CertifyPermission", + "CertifyPermissionResponse", + "CertifyPolicyRequest", + "CertifyPolicyResponse", + "CertifyResponse", + "ChangeServicePlanRequest", + "CheckBoxFieldRequest", + "CheckBoxFormFillingRequest", + "CheckboxFieldResponse", + "CollaboratorGroupResponse", + "CollaboratorPlaceholderResponse", + "CollaboratorResponse", + "CollaboratorRole", + "CommentFieldRecipientResponse", + "CommentFieldResponse", + "ContactResponse", + "ContactSortBy", + "DeclineByDetails", + "DeclineRequest", + "DeleteDocumentFieldRequest", + "DeliveryMethod", + "DetailedResponse", + "DigitalSignatureFieldRequest", + "DigitalSignatureFieldResponse", + "DocumentCertifyResponse", + "DocumentDetails", + "DocumentDetailsResponse", + "DocumentLogsActions", + "DocumentLogsActionsInformation", + "DocumentOwnedBy", + "DocumentOwner", + "DocumentPackageStatus", + "DocumentResponse", + "DocumentTemplateResponse", + "DocumentType", + "DocumentsDownloadDocumentBytesResponse", + "DocumentsTemplateResponse", + "DropDownFormFillingRequest", + "DropdownFieldResponse", + "DurationByDate", + "DurationByDateResponse", + "DurationByDays", + "DurationByDaysResponse", + "ECCLevelAPI", + "EciModeAPI", + "ElectronicSealRecipient", + "ElectronicSignatureFieldResponse", + "EmailDeletedDocument", + "EmptyResponse", + "EnterpriseAccessResponse", + "EnterpriseAccessSecuritySmsOtpResponse", + "EnterpriseAuthenticationResponse", + "EnterpriseAuthenticationSigningResponse", + "EnterpriseAuthenticationSigningSmsOtpResponse", + "EnterpriseTemplateResponse", + "EnterpriseTemplateRole", + "ErrorWithDescriptionResponse", + "FieldAuthentication", + "FieldDimension", + "FieldDimenssionResponse", + "FieldResponse", + "FieldType", + "FieldValidationValue", + "FieldValidationValueRule", + "FieldsAutoAssignFieldInput", + "FieldsResponse", + "FolderItemSortBy", + "Font", + "FontResponse", + "FormFillingRequest", + "GetAttachmentResponse", + "GetPackageDetailsResponse", + "GetPackagesResponse", + "GroupMemberResponse", + "HandSignature", + "HandSignatureFieldResponse", + "InPersonFieldRequest", + "InPersonFieldResponse", + "InitialFieldRequest", + "InitialFieldResponse", + "InitialFillingRequest", + "LegalNoticeResponse", + "ListBoxFieldResponse", + "ListBoxFormFillingRequest", + "MoveToRequest", + "NextSignerEmail", + "NotifyInactiveDeleteUser", + "NotifyUnUsedDeleteDocument", + "PackageDownloadPackageBytesResponse", + "PageResponse", + "PermissionAccessDuration", + "PermissionAccessDurationResponse", + "PermissionLegalNotice", + "PermissionLegalNoticeResponse", + "PlaceholderRequest", + "PostProcessRecipientRequest", + "PostProcessRecipientResponse", + "PostProcessResponse", + "PostProcessUpdateRequest", + "QrCodeColor", + "QrCodeLogo", + "QrCodeOptions", + "QrCodeRequest", + "QrCodeResponse", + "RadioBoxFieldRequest", + "RadioFieldResponse", + "RadioFormFillingRequest", + "RecipientAccessDurationDetails", + "RecipientDeclineDetails", + "ReminderRepeat", + "ReminderResponse", + "RenameDocumentPackageRequest", + "RenameDocumentRequest", + "RepeatRequest", + "Response", + "ServicePlanAuthenticationProfile", + "ServicePlanAutoDeleteDocument", + "ServicePlanAutoDeleteUser", + "ServicePlanCapacity", + "ServicePlanCapacityRequest", + "ServicePlanCertifyOption", + "ServicePlanElectronicSealServer", + "ServicePlanEmailOtp", + "ServicePlanEvidenceReport", + "ServicePlanLevelOfAssurance", + "ServicePlanOneTimePassword", + "ServicePlanProfile", + "ServicePlanSigningServer", + "ServicePlanSmsNotification", + "ServicePlanSmsOtp", + "ServicePlanSmtpServer", + "SignDocumentRequest", + "SignDocumentResponse", + "SignatureFieldAuthentication", + "SignatureFieldAuthenticationOtp", + "SignatureFieldAuthenticationTotp", + "SignatureFieldResponse", + "SigningAuthentication", + "SigningServerCapacity", + "SigningServerCsp", + "SigningServerSignatureAppearance", + "StartWorkflowResponse", + "TemplateDocumentResponse", + "TemplateResponse", + "TemplateSmartFormResponse", + "TemplateSortBy", + "TextBoxFieldRequest", + "TextFieldResponse", + "TextFormFillingRequest", + "TextboxType", + "TotpPermissionResponse", + "UniqueIdentifierFieldResponse", + "UpdateCertifyPolicyRequest", + "UpdateCheckBoxFieldRequest", + "UpdateCollaboratorResponse", + "UpdateDigitalSignatureFieldRequest", + "UpdateInPersonFieldRequest", + "UpdateInitialFieldRequest", + "UpdateQrCodeRequest", + "UpdateQrCodeResponse", + "UpdateRadioBoxFieldRequest", + "UpdateReminderRequest", + "UpdateTextBoxFieldRequest", + "UpdateWorkSpaceRequest", + "UploadDocument", + "UploadDocumentLibraryCertifyResponse", + "UploadDocumentLibraryResponse", + "UploadDocumentLibraryTemplateResponse", + "UploadDocumentMetaInfoDetail", + "ValidationRule", + "VerificationResponse", + "WorflowGroupRequest", + "WorflowUserRequest", + "WorkSpaceMembers", + "WorkSpaceOwner", + "WorkSpaceResponse", + "WorkflowCollaboratorRole", + "WorkflowDetailUpdateRequest", + "WorkflowDetailsResponse", + "WorkflowDocumentsResponse", + "WorkflowEvidenceReportDownloadBytesResponse", + "WorkflowGatekeeperResponse", + "WorkflowGatekeeperUserResponse", + "WorkflowHistoryResponse", + "WorkflowMode", + "WorkflowModes", + "WorkflowPermission", + "WorkflowPermissionResponse", + "WorkflowPermissionsUpdateRequest", + "WorkflowPlaceholderUpdateRequest", + "WorkflowRecipient", + "WorkflowResponse", + "WorkflowType", + "WorkflowUserReorderRequest", + "WorkflowUserResponse", + "WorkflowUserUpdateRequest", + "WorkflowWorkflowAddGroupInput", + "WorkflowWorkflowAddPlaceholderInput", + "WorkflowWorkflowAddUserInput", +] + # Type Definitions @@ -29,7 +275,7 @@ class EmptyResponse: Response for Delete Attachment """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -42,7 +288,7 @@ class AttachmentDownloadAttachmentResponse: Response for Download Attachment """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -55,9 +301,9 @@ class GetAttachmentResponse: Response for Get Attachments """ - attachment_id: Optional[int] = None + attachment_id: int """Attachment id""" - attachment_name: Optional[str] = None + attachment_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Attachment name""" @@ -67,7 +313,7 @@ class AddAttachmentResponse: Response for Upload Attachment """ - attachment_id: Optional[int] = None + attachment_id: int """Attachment id""" @@ -77,9 +323,9 @@ class AddFieldResponse: Response for Add CheckBox Field """ - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the field created in the document.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time of field creation.""" @@ -89,19 +335,19 @@ class ContactResponse: Response for Get Contacts """ - id: Optional[int] = None + id: int """id of the contact.""" - user_name: Optional[str] = None + user_name: Optional[str] = dataclass_field(default=None, kw_only=True) """User name of the contact.""" - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the contact.""" - mobile_number: Optional[str] = None + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """Mobile number of the contact.""" - enterprise: Optional[bool] = None + enterprise: bool """True, if contact is enterprise.""" - user_national_id: Optional[str] = None + user_national_id: Optional[str] = dataclass_field(default=None, kw_only=True) """National identity number of the contact""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """DateTime when contact is added.""" @@ -111,7 +357,7 @@ class DocumentResponse: Response for Delete Document """ - package_name: Optional[str] = None + package_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Document Package name""" @@ -121,7 +367,7 @@ class DocumentsDownloadDocumentBytesResponse: Response for Download Document """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -134,8 +380,13 @@ class CertifyPolicyResponse: Response for Get Certify Policy for a document """ - certify: Optional[CertifyPermissionResponse] = None - lock_form_fields: Optional[bool] = None + certify: Optional[ + CertifyPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + lock_form_fields: bool """ True if forms fields are to be locked in the PDF after the last digital signature on the current document. @@ -148,31 +399,41 @@ class DocumentDetailsResponse: Response for Get Document Details """ - document_id: Optional[int] = None + document_id: int """ID of the newly created document.""" - document_name: Optional[str] = None + document_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the document.""" - document_order: Optional[int] = None - document_type: Optional[str] = None + document_order: int + document_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of the document e.g. \"PDF\".""" - document_width: Optional[int] = None + document_width: int """Width of the document in PDF format.""" - document_height: Optional[int] = None + document_height: int """Height of the document in PDF format.""" - document_source: Optional[str] = None + document_source: Optional[str] = dataclass_field(default=None, kw_only=True) """Identifies where the document was uploaded e.g. \"My App\".""" - document_pages: Optional[int] = None + document_pages: int """Total pages of the document.""" - form_fields: Optional[bool] = None + form_fields: bool """True if document has form fields.""" - lock_form_fields: Optional[bool] = None + lock_form_fields: bool """True if locking of form fields with the last signature is enabled.""" - uploaded_on: Optional[str] = None + uploaded_on: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time when the document was uploaded.""" - modified_on: Optional[str] = None + modified_on: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time when the document was last modified.""" - certify: Optional[DocumentCertifyResponse] = None - template: Optional[DocumentTemplateResponse] = None + certify: Optional[ + DocumentCertifyResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + template: Optional[ + DocumentTemplateResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -181,37 +442,52 @@ class UploadDocumentLibraryResponse: Response for Add or Update Document from Library """ - document_id: Optional[int] = None + document_id: int """ID of the newly created document.""" - document_name: Optional[str] = None + document_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the document.""" - document_size: Optional[int] = None + document_size: int """Uploaded document size in bytes""" - document_order: Optional[int] = None + document_order: int """Order of the document""" - document_type: Optional[str] = None + document_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of the document e.g. \"PDF\".""" - document_source: Optional[str] = None + document_source: Optional[str] = dataclass_field(default=None, kw_only=True) """Identifies where the document was uploaded e.g. \"My App\".""" - document_width: Optional[int] = None + document_width: int """Width of the document in PDF format.""" - document_height: Optional[int] = None + document_height: int """Height of the document in PDF format.""" - document_pages: Optional[int] = None + document_pages: int """Total pages of the document.""" - uploaded_on: Optional[str] = None + uploaded_on: str """The date and time when the document was uploaded.""" - modified_on: Optional[str] = None + modified_on: str """The date and time when the document was last modified.""" - form_fields: Optional[bool] = None + form_fields: bool """True if document has form fields.""" - lock_form_fields: Optional[bool] = None + lock_form_fields: bool """True if locking of form fields with the last signature is enabled.""" - certify: Optional[UploadDocumentLibraryCertifyResponse] = None - template: Optional[UploadDocumentLibraryTemplateResponse] = None - package_name: Optional[str] = None + certify: Optional[ + UploadDocumentLibraryCertifyResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + template: Optional[ + UploadDocumentLibraryTemplateResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + package_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Package name""" - metadata: Optional[UploadDocumentMetaInfoDetail] = None + metadata: Optional[ + UploadDocumentMetaInfoDetail | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -220,49 +496,56 @@ class UploadDocument: Response for Upload Document """ - document_id_2: Optional[int] = field( - default=None, - metadata={"wire_name": "documentId"}, - ) + document_id_2: int = dataclass_field(metadata={"wire_name": "documentId"}) """ This property is retained for backward compatibility and will be removed in later versions. Use document_id instead. """ - documentid: Optional[int] = None + documentid: int """ The document ID to be used later to share, download and get status of the document. will be removed later document_id will be used """ - document_id: Optional[int] = None + document_id: int """ The document ID to be used later to share, download and get status of the document. """ - document_name: Optional[str] = None + document_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the document.""" - document_order: Optional[int] = None + document_order: int """Document order in package""" - document_type: Optional[str] = None + document_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of the document e.g. \"PDF\".""" - document_source: Optional[str] = None + document_source: Optional[str] = dataclass_field(default=None, kw_only=True) """Identifies where the document was uploaded e.g. \"My App\".""" - document_width: Optional[int] = None + document_width: int """Width of the document in PDF format.""" - document_height: Optional[int] = None + document_height: int """Height of the document in PDF format.""" - document_pages: Optional[int] = None + document_pages: int """Total pages of the document.""" - uploaded_on: Optional[str] = None + uploaded_on: str """The date and time when the document was uploaded.""" - modified_on: Optional[str] = None + modified_on: str """The date and time when the document was last modified.""" - lock_form_fields: Optional[bool] = None + lock_form_fields: bool """True if locking of form fields with the last signature is enabled.""" - certify: Optional[CertifyPermissionResponse] = None - document_size: Optional[int] = None + certify: Optional[ + CertifyPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + document_size: int """Uploaded document size in bytes""" - metadata: Optional[UploadDocumentMetaInfoDetail] = None - package_name: Optional[str] = None + metadata: Optional[ + UploadDocumentMetaInfoDetail | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + package_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The document package name""" @@ -272,12 +555,27 @@ class EnterpriseAccessResponse: Response for Get Workflow User Authentication (Document Opening) of Enterprise Package """ - authentication: Optional[EnterpriseAuthenticationResponse] = None - authentication_signing: Optional[EnterpriseAuthenticationSigningResponse] = None - access_duration: Optional[PermissionAccessDurationResponse] = None + authentication: Optional[ + EnterpriseAuthenticationResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + authentication_signing: Optional[ + EnterpriseAuthenticationSigningResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + access_duration: Optional[ + PermissionAccessDurationResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) -FieldsAutoAssignFieldInput = List["AssignFieldRequest"] +FieldsAutoAssignFieldInput = List["AssignFieldRequest | Mapping[str, Any]"] @dataclass @@ -286,7 +584,7 @@ class AutoPlaceFieldsResponse: Response for AutoPlace Fields """ - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the field that was auto generated by the API.""" @@ -296,21 +594,91 @@ class FieldsResponse: Response for Get Document Fields """ - signature: Optional[List[DigitalSignatureFieldResponse]] = None + signature: Optional[ + List[DigitalSignatureFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of all digital signatures in the document.""" - hand_signature: Optional[List[HandSignatureFieldResponse]] = None - electronic_signature: Optional[List[ElectronicSignatureFieldResponse]] = None - initials: Optional[List[InitialFieldResponse]] = None - in_person_signature: Optional[List[Dict[str, Any]]] = None - text: Optional[List[TextFieldResponse]] = None - radio: Optional[List[RadioFieldResponse]] = None - checkbox: Optional[List[CheckboxFieldResponse]] = None - dropdown: Optional[List[DropdownFieldResponse]] = None - listbox: Optional[List[ListBoxFieldResponse]] = None - qrcode: Optional[List[QrCodeResponse]] = None - attachment: Optional[List[AttachmentFieldResponse]] = None - comment: Optional[List[CommentFieldResponse]] = None - unique_identifier: Optional[List[UniqueIdentifierFieldResponse]] = None + hand_signature: Optional[ + List[HandSignatureFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + electronic_signature: Optional[ + List[ElectronicSignatureFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + initials: Optional[ + List[InitialFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + in_person_signature: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + text: Optional[ + List[TextFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + radio: Optional[ + List[RadioFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + checkbox: Optional[ + List[CheckboxFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + dropdown: Optional[ + List[DropdownFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + listbox: Optional[ + List[ListBoxFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + qrcode: Optional[ + List[QrCodeResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + attachment: Optional[ + List[AttachmentFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + comment: Optional[ + List[CommentFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + unique_identifier: Optional[ + List[UniqueIdentifierFieldResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -319,14 +687,14 @@ class AddPackageResponse: Response for Add Package """ - package_id: Optional[int] = None + package_id: int """ The package ID to be used later to share, download and get status of the document. """ - workflow_mode: Optional[str] = None + workflow_mode: Optional[str] = dataclass_field(default=None, kw_only=True) """The workflow mode that is set while adding package.""" - workflow_type: Optional[str] = None + workflow_type: Optional[str] = dataclass_field(default=None, kw_only=True) """ Type of the workflow. Possible values are \"SERIAL\", \"PARALLEL\", \"INDIVIDUAL\" and \"CUSTOM\". @@ -339,7 +707,7 @@ class PackageDownloadPackageBytesResponse: Response for Download Package """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -352,48 +720,63 @@ class GetPackagesResponse: Response for Get Packages """ - package_id: Optional[int] = None + package_id: int """Package ID of the document package.""" - package_name: Optional[str] = None + package_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the document package.""" - package_owner: Optional[str] = None + package_owner: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the document package owner.""" - owner_name: Optional[str] = None + owner_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the document package owner.""" - shared_package: Optional[bool] = None + shared_package: bool """Shared Package""" - gatekeeper_package: Optional[bool] = None + gatekeeper_package: bool """Gatekeeper Package""" - package_status: Optional[str] = None + package_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Document status for the current logged in user. Possible values are \"DRAFT\", \"INPROGRESS\", \"PENDING\", \"DECLINED\", or \"COMPLETED\". """ - extension: Optional[str] = None + extension: Optional[str] = dataclass_field(default=None, kw_only=True) """Document Package extension""" - workflow_mode: Optional[str] = None + workflow_mode: Optional[str] = dataclass_field(default=None, kw_only=True) """Workflow Mode""" - folder: Optional[str] = None + folder: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the folder which contains the document package.""" - folder_id: Optional[int] = None + folder_id: int """Id of the folder which contains the document package.""" - unread: Optional[bool] = None + unread: bool """True, if the document is not read by the recipient yet.""" - next_signer: Optional[str] = None + next_signer: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the next signer if the document is in shared state.""" - next_signer_email: Optional[List[NextSignerEmail]] = None + next_signer_email: Optional[ + List[NextSignerEmail | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """ An object containing next signers username and email address. In case of group signer it will have a list of email addresses of all the group members. """ - uploaded_on: Optional[str] = None + uploaded_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time when the document was uploaded.""" - modified_on: Optional[str] = None + modified_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time when the document was last modified.""" - access_duration: Optional[RecipientAccessDurationDetails] = None - decline: Optional[RecipientDeclineDetails] = None - size: Optional[int] = None + access_duration: Optional[ + RecipientAccessDurationDetails | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + decline: Optional[ + RecipientDeclineDetails | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + size: int """Size of the document in bytes.""" @@ -403,20 +786,25 @@ class GetPackageDetailsResponse: Response for Get Package Details """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the document package.""" - owner: Optional[DocumentOwner] = None - read_only: Optional[bool] = None + owner: Optional[DocumentOwner | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + read_only: bool """ True if the applied template is read only. User will not be able to make any changes if a read only template is applied. """ - document_status: Optional[str] = None + document_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Document status for the current logged in user. Possible values are \"DRAFT\", \"INPROGRESS\", \"PENDING\", \"DECLINED\", or \"COMPLETED\". """ - documents: Optional[List[DocumentDetails]] = None + documents: Optional[ + List[DocumentDetails | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -425,11 +813,11 @@ class AddQrCodeResponse: Response for Add QR Code """ - data: Optional[str] = None + data: str """QR Code generated data""" - field_name: Optional[str] = None + field_name: str """Name of the field created in the document.""" - value: Optional[str] = None + value: str """Value will be the base64 of QrCode image""" @@ -439,7 +827,7 @@ class UpdateQrCodeResponse: Response for Update QR Code """ - value: Optional[str] = None + value: str """Value will be the base64 of QrCode image""" @@ -449,28 +837,38 @@ class TemplateResponse: Response for Get Templates """ - template_id: Optional[int] = None + template_id: int """Id of the template is returned here """ - template_name: Optional[str] = None + template_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the template.""" - template_public: Optional[bool] = None + template_public: bool """ Response is \"true\" if enterprise template is marked as public. Otherwise \"false\" would be returned """ - read_only: Optional[bool] = None + read_only: bool """ Response of \"true\" if the template is read only, and user cannot make any changes to the workflow after applying this template. Otherwise \"false\". """ - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time when the template was created""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the template""" - enterprise: Optional[bool] = None + enterprise: bool """True, if user belong to an enterprise.""" - documents: Optional[List[TemplateDocumentResponse]] = None - smart_form: Optional[TemplateSmartFormResponse] = None + documents: Optional[ + List[TemplateDocumentResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + smart_form: Optional[ + TemplateSmartFormResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -479,9 +877,9 @@ class SignatureFieldResponse: Response for Add Digital Signature Field """ - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the field created in the document.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time of field creation.""" @@ -491,8 +889,8 @@ class BulkSignResponse: Response for Bulk Sign Packages """ - status: Optional[str] = None - transaction_id: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) + transaction_id: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -501,8 +899,13 @@ class BulkSignStatusResponse: Response for Bulk Signing Status """ - status: Optional[str] = None - packages: Optional[List[BulkSignPackagesStatus]] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) + packages: Optional[ + List[BulkSignPackagesStatus | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -511,18 +914,23 @@ class SignDocumentResponse: Response for Sign Document """ - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the field for which the verification was requested.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Returns the status of signature field. Values are SIGNED, PENDING. Status helps in eIDAS enabled remote authorized signing. If sign request is sent to mobile the status is pending. """ - transaction_id: Optional[str] = None + transaction_id: Optional[str] = dataclass_field(default=None, kw_only=True) """This parameter is used while RAS signing""" - verification: Optional[VerificationResponse] = None - authentication_access_token: Optional[str] = None + verification: Optional[ + VerificationResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + authentication_access_token: Optional[str] = dataclass_field(default=None, kw_only=True) """It will contain the OIDC id_token when user is authenticated via OIDC""" @@ -532,26 +940,36 @@ class EnterpriseTemplateResponse: Response for Get Enterprise Templates """ - id: Optional[int] = None + id: int """Id of the template """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the template.""" - public: Optional[bool] = None + public: bool """ Response is \"true\" if enterprise template is marked as public. Otherwise \"false\" would be returned """ - read_only: Optional[bool] = None + read_only: bool """ Response of \"true\" if the template is read only, and user cannot make any changes to the workflow after applying this template. Otherwise \"false\". """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the template""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time when the template was created""" - roles: Optional[List[EnterpriseTemplateRole]] = None - documents: Optional[List[TemplateDocumentResponse]] = None + roles: Optional[ + List[EnterpriseTemplateRole | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + documents: Optional[ + List[TemplateDocumentResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -560,7 +978,7 @@ class WorkflowEvidenceReportDownloadBytesResponse: Response for Get Process Evidence Report """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -573,43 +991,63 @@ class WorkflowDetailsResponse: Response for Get Workflow Details """ - package_id: Optional[int] = None + package_id: int """Package ID of the document package.""" - package_name: Optional[str] = None + package_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the document package.""" - shared_package: Optional[bool] = None + shared_package: bool """shared package""" - package_owner: Optional[str] = None + package_owner: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the document package owner.""" - owner_name: Optional[str] = None + owner_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the document package owner.""" - package_status: Optional[str] = None + package_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Document status for the current logged in user. Possible values are \"DRAFT\", \"INPROGRESS\", \"PENDING\", \"DECLINED\", \"APPROVED\", \"UPDATED\" or \"COMPLETED\". """ - folder: Optional[str] = None + folder: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the folder which contains the document package.""" - folder_id: Optional[int] = None + folder_id: int """ID of the folder which contains the document package.""" - gatekeeper: Optional[bool] = None - next_signer: Optional[str] = None + gatekeeper: bool + next_signer: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the next signer if the document is in shared state.""" - next_signer_email: Optional[List[NextSignerEmail]] = None + next_signer_email: Optional[ + List[NextSignerEmail | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """ An object containing next signers username and email address. In case of group signer it will have a list of email addresses of all the group members. """ - uploaded_on: Optional[str] = None + uploaded_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time when the document was uploaded.""" - modified_on: Optional[str] = None + modified_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time when the document was last modified.""" - workflow: Optional[WorkflowResponse] = None - documents: Optional[List[WorkflowDocumentsResponse]] = None + workflow: Optional[ + WorkflowResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + documents: Optional[ + List[WorkflowDocumentsResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of documents that are uploaded in the package.""" - users: Optional[List[WorkflowUserResponse]] = None + users: Optional[ + List[WorkflowUserResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Recipients list for the workflow.""" @@ -619,25 +1057,40 @@ class WorkflowHistoryResponse: Response for Get Workflow History """ - package_id: Optional[int] = None + package_id: int """ID of the package for which the workflow history is requested.""" - package_name: Optional[str] = None - package_owner: Optional[str] = None + package_name: Optional[str] = dataclass_field(default=None, kw_only=True) + package_owner: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the package owner.""" - owner_name: Optional[str] = None + owner_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the package owner.""" - package_status: Optional[str] = None + package_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Status of the package/document with the current logged in user. Possible values are \"DRAFT\", \"INPROGRESS\", \"PENDING\", \"DECLINED\", \"APPROVED\", \"UPDATED\" or \"COMPLETED\". """ - next_signer: Optional[str] = None + next_signer: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the next recipient.""" - next_signer_email: Optional[List[NextSignerEmail]] = None + next_signer_email: Optional[ + List[NextSignerEmail | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Object having name and email address of the next recipient.""" - documents: Optional[List[WorkflowDocumentsResponse]] = None - actions: Optional[List[DocumentLogsActions]] = None + documents: Optional[ + List[WorkflowDocumentsResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + actions: Optional[ + List[DocumentLogsActions | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -646,16 +1099,21 @@ class ReminderResponse: Response for Get Workflow Reminder """ - enabled: Optional[bool] = None + enabled: bool """True, if reminders are enabled for the recipient""" - frequency: Optional[str] = None + frequency: Optional[str] = dataclass_field(default=None, kw_only=True) """Reminder Frequency. Possible Values are DAYS | HOURS. """ - remind_after: Optional[int] = None + remind_after: int """ The number of days after which the first reminder would be sent to workflow user. """ - repeat: Optional[ReminderRepeat] = None + repeat: Optional[ + ReminderRepeat | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -664,79 +1122,94 @@ class WorkflowRecipient: Response for Get Workflow Users """ - order: Optional[int] = None + order: int """Order of the recipient in the workflow.""" - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the recipient if user is not a group.""" - user_name: Optional[str] = None + user_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the recipient if user is not a group.""" - mobile_number: Optional[str] = None + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """Mobile number""" - delivery_method: Optional[str] = None + delivery_method: Optional[str] = dataclass_field(default=None, kw_only=True) """ Delivery method of recipient Possible values: EMAIL, SMS, or EMAIL_AND_SMS """ - user_photo_url: Optional[str] = None + user_photo_url: Optional[str] = dataclass_field(default=None, kw_only=True) """ API endpoint to access the resource, This will be provided only for main signers. e.g it will be null for group/delegator/gatekeeper etc. This URL does not make sure that signer image is exist. If image exist it will be provided by hitting the defined url otherwise it will be an empty string. """ - group_name: Optional[str] = None + group_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Group name of the recipient if recipient is a group.""" - group_members: Optional[List[GroupMemberResponse]] = None + group_members: Optional[ + List[GroupMemberResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """ A list of email addresses of the group members if recipient is a group. """ - delegatee: Optional[str] = None + delegatee: Optional[str] = dataclass_field(default=None, kw_only=True) """Delegatee email address, if recipient is not a group.""" - delegatee_name: Optional[str] = None + delegatee_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the delegatee user, if recipient is not a group.""" - role: Optional[str] = None + role: Optional[str] = dataclass_field(default=None, kw_only=True) """ Workflow role in which the recipient was added. This role is not the enterprise role. Possible values are \"SIGNER\", \"REVIEWER\",\"CARBON_COPY\" and \"EDITOR\". """ - reason: Optional[str] = None + reason: Optional[str] = dataclass_field(default=None, kw_only=True) """ Reason provided by the user when declining, approving or submitting a document. """ - process_status: Optional[str] = None + process_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Document processing status for the recipient. Possible values are \"UN_PROCESSED\", \"IN_PROGRESS\", \"SIGNED\", \"REVIEWED\", \"DECLINED\", \"EDITED\" or \"INVALID\". """ - processed_on: Optional[str] = None + processed_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time on which the document was processed.""" - processed_as: Optional[str] = None + processed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """ User may processed the field as COLLABORATOR , DELEGATOR, GROUP_MEMBER or OWNER. """ - processed_by: Optional[str] = None + processed_by: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the user who processed the document.""" - placeholder: Optional[str] = None + placeholder: Optional[str] = dataclass_field(default=None, kw_only=True) """Placeholder text if the recipient is a placeholder""" - signing_order: Optional[int] = None + signing_order: int """ Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to \"CUSTOM\". """ - user_national_id: Optional[str] = None + user_national_id: Optional[str] = dataclass_field(default=None, kw_only=True) """ National identity number of the user. This helps to identify user in the workflow """ - guest_user: Optional[bool] = None + guest_user: bool """Gest user""" - email_language_code: Optional[str] = None + email_language_code: Optional[str] = dataclass_field(default=None, kw_only=True) """email language code""" - electronic_seal: Optional[ElectronicSealRecipient] = None - gatekeepers: Optional[WorkflowGatekeeperResponse] = None + electronic_seal: Optional[ + ElectronicSealRecipient | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + gatekeepers: Optional[ + WorkflowGatekeeperResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -745,21 +1218,31 @@ class WorkflowPermissionResponse: Response for Get Workflow User Permissions """ - print: Optional[bool] = None + print: Optional[bool] = dataclass_field(default=None, kw_only=True) """True, if printing is allowed for this recipient.""" - download: Optional[bool] = None + download: Optional[bool] = dataclass_field(default=None, kw_only=True) """True, if download is allowed.""" - add_text: Optional[bool] = None + add_text: Optional[bool] = dataclass_field(default=None, kw_only=True) """True, if add text annotation on the document is allowed.""" - change_recipients: Optional[bool] = None + change_recipients: Optional[bool] = dataclass_field(default=None, kw_only=True) """ True, if the recipient on the current order can change other recipients in the workflow after workflow is shared. """ - add_attachment: Optional[bool] = None + add_attachment: Optional[bool] = dataclass_field(default=None, kw_only=True) """True, if attachments and merging of PDF documents is allowed.""" - legal_notice: Optional[PermissionLegalNoticeResponse] = None - attachment: Optional[AttachmentPermissionResponse] = None + legal_notice: Optional[ + PermissionLegalNoticeResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + attachment: Optional[ + AttachmentPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -768,17 +1251,17 @@ class StartWorkflowResponse: Response for Share Document Package """ - package_id: Optional[int] = None + package_id: int """ Package ID of the package just shared. Incase of individual sharing, more then one packages are created and shared with the recipients. API returns an array of packages along with IDs of newly created documents. """ - documents: Optional[List[int]] = None + documents: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """Array of document IDs which were part of the package before sharing.""" -WorkflowWorkflowAddGroupInput = List["WorflowGroupRequest"] +WorkflowWorkflowAddGroupInput = List["WorflowGroupRequest | Mapping[str, Any]"] @dataclass @@ -787,13 +1270,23 @@ class CollaboratorGroupResponse: Response for Add Groups to Workflow """ - permission: Optional[WorkflowPermissionResponse] = None - reminder: Optional[ReminderResponse] = None - signing_order: Optional[int] = None + permission: Optional[ + WorkflowPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + reminder: Optional[ + ReminderResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + signing_order: int """Signing order""" -WorkflowWorkflowAddPlaceholderInput = List["PlaceholderRequest"] +WorkflowWorkflowAddPlaceholderInput = List["PlaceholderRequest | Mapping[str, Any]"] @dataclass @@ -802,13 +1295,23 @@ class CollaboratorPlaceholderResponse: Response for Add Placeholder to Workflow """ - permission: Optional[WorkflowPermissionResponse] = None - reminder: Optional[ReminderResponse] = None - signing_order: Optional[int] = None + permission: Optional[ + WorkflowPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + reminder: Optional[ + ReminderResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + signing_order: int """Signing order""" -WorkflowWorkflowAddUserInput = List["WorflowUserRequest"] +WorkflowWorkflowAddUserInput = List["WorflowUserRequest | Mapping[str, Any]"] @dataclass @@ -817,16 +1320,26 @@ class CollaboratorResponse: Response for Add Users to Workflow """ - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """User email""" - signing_order: Optional[int] = None + signing_order: int """Signing order""" - guest_user: Optional[bool] = None + guest_user: bool """Is guest user""" - email_language_code: Optional[str] = None + email_language_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Email language code""" - permission: Optional[WorkflowPermissionResponse] = None - reminder: Optional[ReminderResponse] = None + permission: Optional[ + WorkflowPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + reminder: Optional[ + ReminderResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -835,13 +1348,13 @@ class UpdateCollaboratorResponse: Response for Update Workflow User """ - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """User email""" - signing_order: Optional[int] = None + signing_order: int """Signing order""" - guest_user: Optional[bool] = None + guest_user: bool """Is guest user""" - email_language_code: Optional[str] = None + email_language_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Email language code""" @@ -851,12 +1364,12 @@ class WorkSpaceResponse: Response for Get Shared Space """ - id: Optional[int] = None + id: int """Id of shared space""" - name: Optional[str] = None + name: str """Name of shared space""" - owner: Optional[WorkSpaceOwner] = None - members: Optional[List[WorkSpaceMembers]] = None + owner: WorkSpaceOwner | Mapping[str, Any] + members: List[WorkSpaceMembers | Mapping[str, Any]] """Members of shared space""" @@ -866,12 +1379,12 @@ class ErrorWithDescriptionResponse: Definition: ErrorWithDescriptionResponse """ - error: Optional[str] = None + error: Optional[str] = dataclass_field(default=None, kw_only=True) """ Error key to identify the error in programming and applications can respond based on the different error keys. """ - error_description: Optional[str] = None + error_description: Optional[str] = dataclass_field(default=None, kw_only=True) """ Error message against the error key returned. Client applications can present this error as it is or send their own error message. @@ -884,8 +1397,9 @@ class Response: Definition: Response """ - message: Optional[str] = field( + message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Message"}, ) """ @@ -901,10 +1415,15 @@ class DetailedResponse: Definition: DetailedResponse """ - error: Optional[str] = field(default=None, metadata={"wire_name": "Error"}) + error: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Error"}, + ) """Custom error code""" - message: Optional[str] = field( + message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Message"}, ) """ @@ -920,17 +1439,17 @@ class AuthenticationRequest: Definition: AuthenticationRequest """ - client_id: Optional[str] = None + client_id: str """ Application Name that you have configured in your Enterprise Account when configuring the integration options. """ - client_secret: Optional[str] = None + client_secret: str """ API Key that you generated in your Enterprise Account when configuring the integration options. """ - profile_name: Optional[str] = None + profile_name: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -939,8 +1458,8 @@ class ElectronicSealRecipient: Definition: ElectronicSealRecipient """ - name: Optional[str] = None - level_of_assurance: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + level_of_assurance: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -949,14 +1468,24 @@ class PermissionLegalNoticeResponse: Definition: PermissionLegalNoticeResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if legal notice is enabled and configured for the recipient.""" - allowed_notices: Optional[List[LegalNoticeResponse]] = None + allowed_notices: Optional[ + List[LegalNoticeResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """ List of legal notices allowed to the document owner from which he can select one for the recipient. """ - default_notice: Optional[List[LegalNoticeResponse]] = None + default_notice: Optional[ + List[LegalNoticeResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Default or selected legal notice for the recipient.""" @@ -966,10 +1495,10 @@ class LegalNoticeResponse: Definition: LegalNoticeResponse """ - legal_notice_id: Optional[int] = None - legal_notice_name: Optional[str] = None + legal_notice_id: int + legal_notice_name: Optional[str] = dataclass_field(default=None, kw_only=True) """LegalNoticeResponse""" - legal_notice_html: Optional[str] = None + legal_notice_html: Optional[str] = dataclass_field(default=None, kw_only=True) """HTML content of the legal notice.""" @@ -979,9 +1508,24 @@ class AccessResponse: Definition: AccessResponse """ - authentication: Optional[AuthenticationResponse] = None - authentication_signing: Optional[AuthenticationSigningResponse] = None - access_duration: Optional[PermissionAccessDurationResponse] = None + authentication: Optional[ + AuthenticationResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + authentication_signing: Optional[ + AuthenticationSigningResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + access_duration: Optional[ + PermissionAccessDurationResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -990,11 +1534,26 @@ class AuthenticationResponse: Definition: AuthenticationResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if authentication is enabled for the package.""" - password: Optional[AccessSecurityPasswordResponse] = None - sms_otp: Optional[AccessSecuritySmsOtpResponse] = None - totp: Optional[TotpPermissionResponse] = None + password: Optional[ + AccessSecurityPasswordResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + sms_otp: Optional[ + AccessSecuritySmsOtpResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + totp: Optional[ + TotpPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1003,9 +1562,9 @@ class AccessSecurityPasswordResponse: Definition: AccessSecurityPasswordResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if password authentication is enabled for the package.""" - user_password: Optional[str] = None + user_password: Optional[str] = dataclass_field(default=None, kw_only=True) """Authentication password for document access.""" @@ -1015,16 +1574,16 @@ class AccessSecuritySmsOtpResponse: Definition: AccessSecuritySmsOtpResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if SMS OTP authentication is enabled for the package.""" - otp_length: Optional[int] = None - retry_duration: Optional[int] = None - mobile_number: Optional[str] = None + otp_length: int + retry_duration: int + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication. """ - methods: Optional[List[str]] = None + methods: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Allowed OTP Methods""" @@ -1034,7 +1593,7 @@ class TotpPermissionResponse: Definition: TotpPermissionResponse """ - enabled: Optional[bool] = None + enabled: bool """Enabled""" @@ -1044,10 +1603,20 @@ class AuthenticationSigningResponse: Definition: AuthenticationSigningResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if authentication is enabled for the package.""" - sms_otp: Optional[AuthenticationSigningSmsOtpResponse] = None - totp: Optional[TotpPermissionResponse] = None + sms_otp: Optional[ + AuthenticationSigningSmsOtpResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + totp: Optional[ + TotpPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1056,14 +1625,14 @@ class AuthenticationSigningSmsOtpResponse: Definition: AuthenticationSigningSmsOtpResponse """ - otp_length: Optional[int] = None - retry_duration: Optional[int] = None - mobile_number: Optional[str] = None + otp_length: int + retry_duration: int + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication. """ - methods: Optional[List[str]] = None + methods: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Allowed OTP Methods""" @@ -1073,10 +1642,20 @@ class PermissionAccessDurationResponse: Definition: PermissionAccessDurationResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if access duration security is enabled for the package.""" - duration_by_date: Optional[AccessDurationByDateResponse] = None - duration_by_days: Optional[AccessDurationByDaysResponse] = None + duration_by_date: Optional[ + AccessDurationByDateResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + duration_by_days: Optional[ + AccessDurationByDaysResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1085,10 +1664,15 @@ class AccessDurationByDateResponse: Definition: AccessDurationByDateResponse """ - enabled: Optional[bool] = None + enabled: bool """True if access security is enabled for a duration by date and time.""" - accessible: Optional[bool] = None - duration: Optional[DurationByDateResponse] = None + accessible: bool + duration: Optional[ + DurationByDateResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1097,11 +1681,11 @@ class DurationByDateResponse: Definition: DurationByDateResponse """ - start_date_time: Optional[str] = None + start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True) """ Date and time from where the package will be accessible to the recipient. """ - end_date_time: Optional[str] = None + end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True) """ Date and time after which the package will not be accessible to the recipient. @@ -1114,10 +1698,15 @@ class AccessDurationByDaysResponse: Definition: AccessDurationByDaysResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if access security is enabled for a duration by number of days.""" - accessible: Optional[bool] = None - duration: Optional[DurationByDaysResponse] = None + accessible: bool + duration: Optional[ + DurationByDaysResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1126,7 +1715,7 @@ class DurationByDaysResponse: Definition: DurationByDaysResponse """ - total_days: Optional[int] = None + total_days: int """ Total number of days for which the package will be accessible to the recipient after receiving the package. @@ -1139,16 +1728,16 @@ class ReminderRepeat: Definition: ReminderRepeat """ - enabled: Optional[bool] = None + enabled: bool """True, if subsequent reminders are enabled.""" - frequency: Optional[str] = None + frequency: Optional[str] = dataclass_field(default=None, kw_only=True) """Repeat Reminder Frequency. Possible Values are DAYS | HOURS. """ - keep_reminding_after: Optional[int] = None + keep_reminding_after: int """ The number of days after which the subsequent reminders would be sent to workflow recipient. """ - total_reminders: Optional[int] = None + total_reminders: int """The number of subsequent reminders to be sent to workflow user.""" @@ -1158,14 +1747,19 @@ class AccessUpdateRequest: Definition: AccessUpdateRequest """ - apply_to_all: Optional[bool] = None + apply_to_all: bool """ True, if the access security or authentications are to be applied on all the recipients in the workflow. """ - authentication: Optional[AccessAuthentication] = None - authentication_signing: Optional[SigningAuthentication] = None - access_duration: Optional[PermissionAccessDuration] = None + authentication: AccessAuthentication | Mapping[str, Any] + authentication_signing: Optional[ + SigningAuthentication | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + access_duration: PermissionAccessDuration | Mapping[str, Any] @dataclass @@ -1174,11 +1768,26 @@ class AccessAuthentication: Definition: AccessAuthentication """ - enabled: Optional[bool] = None + enabled: bool """True, if authentication is enabled for the package.""" - password: Optional[AuthenticationPassword] = None - sms_otp: Optional[AuthenticationSmsOtp] = None - totp: Optional[TotpPermissionResponse] = None + password: Optional[ + AuthenticationPassword | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + sms_otp: Optional[ + AuthenticationSmsOtp | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + totp: Optional[ + TotpPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1187,9 +1796,9 @@ class AuthenticationPassword: Definition: AuthenticationPassword """ - enabled: Optional[bool] = None + enabled: bool """True, if password authentication is enabled for the package.""" - user_password: Optional[str] = None + user_password: Optional[str] = dataclass_field(default=None, kw_only=True) """ Password string if password field is enabled. If a password is already set and owner do not wish to change it, remove the field from the response, or @@ -1203,9 +1812,9 @@ class AuthenticationSmsOtp: Definition: AuthenticationSmsOtp """ - enabled: Optional[bool] = None + enabled: bool """True, if SMS OTP authentication is enabled for the package.""" - mobile_number: Optional[str] = None + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication. @@ -1218,10 +1827,20 @@ class SigningAuthentication: Definition: SigningAuthentication """ - enabled: Optional[bool] = None + enabled: bool """True, if authentication is enabled for the package.""" - sms_otp: Optional[AuthenticationSigningSmsOtp] = None - totp: Optional[TotpPermissionResponse] = None + sms_otp: Optional[ + AuthenticationSigningSmsOtp | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + totp: Optional[ + TotpPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1230,7 +1849,7 @@ class AuthenticationSigningSmsOtp: Definition: AuthenticationSigningSmsOtp """ - mobile_number: Optional[str] = None + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication. @@ -1243,10 +1862,20 @@ class PermissionAccessDuration: Definition: PermissionAccessDuration """ - enabled: Optional[bool] = None + enabled: bool """True, if access duration security is enabled for the package.""" - duration_by_date: Optional[AccessDurationByDate] = None - duration_by_days: Optional[AccessDurationByDays] = None + duration_by_date: Optional[ + AccessDurationByDate | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + duration_by_days: Optional[ + AccessDurationByDays | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1255,9 +1884,14 @@ class AccessDurationByDate: Definition: AccessDurationByDate """ - enabled: Optional[bool] = None + enabled: bool """True if access security is enabled for a duration by date and time.""" - duration: Optional[DurationByDate] = None + duration: Optional[ + DurationByDate | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1266,11 +1900,11 @@ class DurationByDate: Definition: DurationByDate """ - start_date_time: Optional[str] = None + start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True) """ Date and time from where the package will be accessible to the recipient. """ - end_date_time: Optional[str] = None + end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True) """ Date and time after which the package will not be accessible to the recipient. @@ -1283,9 +1917,14 @@ class AccessDurationByDays: Definition: AccessDurationByDays """ - enabled: Optional[bool] = None + enabled: bool """True, if access security is enabled for a duration by number of days.""" - duration: Optional[DurationByDays] = None + duration: Optional[ + DurationByDays | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1294,7 +1933,7 @@ class DurationByDays: Definition: DurationByDays """ - total_days: Optional[int] = None + total_days: int """ Total number of days for which the package will be accessible to the recipient after receiving the package. @@ -1307,23 +1946,28 @@ class QrCodeRequest: Definition: QrCodeRequest """ - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field. """ - dimensions: Optional[FieldDimension] = None - data: Optional[str] = None + dimensions: FieldDimension | Mapping[str, Any] + data: Optional[str] = dataclass_field(default=None, kw_only=True) """ The plain text data to be encoded in the QR code. Default is URL generated to access the related document. e.g. {base_url}/document/{document_unique_id} """ - options: Optional[QrCodeOptions] = None - color: Optional[QrCodeColor] = None - logo: Optional[QrCodeLogo] = None + options: Optional[ + QrCodeOptions | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + color: Optional[QrCodeColor | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + logo: Optional[QrCodeLogo | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1332,13 +1976,13 @@ class FieldDimension: Definition: FieldDimension """ - x: Optional[float] = None + x: float """Left location of the field in pixel.""" - y: Optional[float] = None + y: float """Top location of the field in pixel.""" - width: Optional[float] = None + width: float """Width of the field in pixel.""" - height: Optional[float] = None + height: float """Height of the field in pixel.""" @@ -1348,15 +1992,15 @@ class QrCodeOptions: Definition: QrCodeOptions """ - error_correction_level: Optional[ECCLevelAPI] = None - encoding: Optional[EciModeAPI] = None - pixels_per_module: Optional[int] = None + error_correction_level: ECCLevelAPI + encoding: EciModeAPI + pixels_per_module: int """ Specifies the number of pixels per module in the QR code. A higher number results in a larger and more detailed QR code. Default is \"20\" Possible Values are : 20 | 30 | 40 | 50 """ - add_margins: Optional[bool] = None + add_margins: bool """ Indicates whether quiet zones (margins) should be drawn around the QR code. Quiet zones help scanners to detect and decode the QR code more accurately. @@ -1376,12 +2020,12 @@ class QrCodeColor: Definition: QrCodeColor """ - dots: Optional[str] = None + dots: Optional[str] = dataclass_field(default=None, kw_only=True) """ Represents the dark color used for the dots in the QR code. Default is \"black\". e.g. \"#000000\" """ - background: Optional[str] = None + background: Optional[str] = dataclass_field(default=None, kw_only=True) """ Represents the light color used for the background of the QR code. Default is \"white\". e.g. \"#ffffff\" @@ -1394,14 +2038,14 @@ class QrCodeLogo: Definition: QrCodeLogo """ - base64: Optional[str] = None + base64: Optional[str] = dataclass_field(default=None, kw_only=True) """An optional icon (base64) to place in the center of the QR code.""" - hide_background_dots: Optional[bool] = None + hide_background_dots: bool """ The background color behind the icon, if an icon is provided. If color is not provided transparent background is implemented. """ - size: Optional[int] = None + size: int """ The size of the icon as a percentage of the QR code's size, if an icon is provided. Default is \"15\". Possible Values are : 10 | 15 | 20 | 25 | 30 | @@ -1424,10 +2068,20 @@ class SignatureFieldAuthentication: Definition: SignatureFieldAuthentication """ - enabled: Optional[bool] = None + enabled: bool """True, if authentication is enabled for the field. False otherwise.""" - otp: Optional[SignatureFieldAuthenticationOtp] = None - totp: Optional[SignatureFieldAuthenticationTotp] = None + otp: Optional[ + SignatureFieldAuthenticationOtp | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + totp: Optional[ + SignatureFieldAuthenticationTotp | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1436,12 +2090,12 @@ class SignatureFieldAuthenticationOtp: Definition: SignatureFieldAuthenticationOtp """ - enabled: Optional[bool] = None + enabled: bool """ True, if SMS/Email OTP authentication is enabled for the field. False otherwise. """ - mobile_number: Optional[str] = None + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """Mobile number of the recipient to which the field is assigned.""" @@ -1451,7 +2105,7 @@ class SignatureFieldAuthenticationTotp: Definition: SignatureFieldAuthenticationTotp """ - enabled: Optional[bool] = None + enabled: bool """ True, if TOTP authentication is enabled for the field. False otherwise. """ @@ -1463,22 +2117,27 @@ class UpdateQrCodeRequest: Definition: UpdateQrCodeRequest """ - field_name: Optional[str] = None + field_name: str """Current name of the field, that is to be updated.""" - renamed_as: Optional[str] = None + renamed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """Updated name of the field if renaming is intended.""" - page_no: Optional[int] = None + page_no: int """Page number for which field is need to be updated""" - dimensions: Optional[FieldDimension] = None - data: Optional[str] = None + dimensions: FieldDimension | Mapping[str, Any] + data: Optional[str] = dataclass_field(default=None, kw_only=True) """ The plain text data to be encoded in the QR code. Default is URL generated to access the related document. e.g. {base_url}/document/{document_unique_id} """ - options: Optional[QrCodeOptions] = None - color: Optional[QrCodeColor] = None - logo: Optional[QrCodeLogo] = None + options: Optional[ + QrCodeOptions | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + color: Optional[QrCodeColor | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + logo: Optional[QrCodeLogo | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1487,8 +2146,13 @@ class FieldValidationValue: Definition: FieldValidationValue """ - required: Optional[bool] = None - rules: Optional[List[FieldValidationValueRule]] = None + required: bool + rules: Optional[ + List[FieldValidationValueRule | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1497,12 +2161,16 @@ class FieldValidationValueRule: Definition: FieldValidationValueRule """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ Specifies the type of validation rule, which is currently always set to EQUALS for text field. """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Represents the value used for validation.""" @@ -1512,44 +2180,49 @@ class PostProcessResponse: Definition: PostProcessResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if post processing is enabled for the package.""" - contacts: Optional[List[str]] = None + contacts: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ List of email addresses to which the email will be sent when the workflow is completed. """ - recipients: Optional[List[PostProcessRecipientResponse]] = None + recipients: Optional[ + List[PostProcessRecipientResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """ List of the name and email addresses to whom the emails are sent when the post processing is executed after the workflow completion. """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """ Any custom string message that is to be sent to the contacts when the workflow is completed. """ - google_drive: Optional[bool] = None + google_drive: bool """ True, if google drive uploading is turned on for the package. Documents will be uploaded to google drive when the workflow is completed. """ - one_drive: Optional[bool] = None + one_drive: bool """ True, if one drive uploading is turned on for the package. Documents will be uploaded to one drive when the workflow is completed. """ - dropbox: Optional[bool] = None + dropbox: bool """ True, if dropbox uploading is turned on for the package. Documents will be uploaded to google drive when the workflow is completed. """ - workflow_recipients: Optional[bool] = None + workflow_recipients: bool """ True, if workflow completion report is to be sent to all recipients of the workflow when post processing is executed. Default value is false. """ - document_processing_report: Optional[bool] = None + document_processing_report: bool """ True, if Send the document processing report (XML) is to be enabled to for the workflow @@ -1562,8 +2235,8 @@ class PostProcessRecipientResponse: Definition: PostProcessRecipientResponse """ - name: Optional[str] = None - email: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + email: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1572,14 +2245,14 @@ class CertifyResponse: Definition: CertifyResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if certify signature settings are enabled for the document.""" - allowed_permissions: Optional[List[str]] = None + allowed_permissions: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Certify permission level set for the document with certify signature settings. """ - default_permission: Optional[str] = None + default_permission: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1588,9 +2261,9 @@ class GroupMemberResponse: Definition: GroupMemberResponse """ - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the group member""" - user_name: Optional[str] = None + user_name: Optional[str] = dataclass_field(default=None, kw_only=True) """User name of the group member""" @@ -1600,7 +2273,7 @@ class AttachmentPermissionResponse: Definition: AttachmentPermissionResponse """ - enabled: Optional[bool] = None + enabled: bool """Enabled""" @@ -1616,8 +2289,8 @@ class PostProcessRecipientRequest: Definition: PostProcessRecipientRequest """ - name: Optional[str] = None - email: Optional[str] = None + name: str + email: str @dataclass @@ -1626,8 +2299,13 @@ class UpdateCertifyPolicyRequest: Definition: UpdateCertifyPolicyRequest """ - certify: Optional[CertifyPolicyRequest] = None - lock_form_fields: Optional[bool] = None + certify: Optional[ + CertifyPolicyRequest | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + lock_form_fields: bool """ True if form fields are to be locked after the last signature on the current document. @@ -1640,9 +2318,9 @@ class CertifyPolicyRequest: Definition: CertifyPolicyRequest """ - enabled: Optional[bool] = None + enabled: bool """True if certify settings are to be enabled for the document.""" - permission: Optional[CertifyPermission] = None + permission: CertifyPermission CertifyPermission = Literal[ @@ -1658,7 +2336,7 @@ class DeleteDocumentFieldRequest: Definition: DeleteDocumentFieldRequest """ - field_name: Optional[str] = None + field_name: str """Name of the field to be deleted.""" @@ -1688,9 +2366,9 @@ class EnterpriseTemplateRole: Definition: EnterpriseTemplateRole """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the enterprise role assigned to the user.""" - id: Optional[int] = None + id: int """Id of the enterprise role assigned to the user.""" @@ -1700,9 +2378,9 @@ class TemplateDocumentResponse: Definition: TemplateDocumentResponse """ - id: Optional[int] = None + id: int """Id of the template document """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the template document.""" @@ -1721,9 +2399,9 @@ class NextSignerEmail: Definition: Next_signer_email """ - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the next signer.""" - user_name: Optional[str] = None + user_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the next signer.""" @@ -1733,7 +2411,12 @@ class WorkflowGatekeeperResponse: Definition: WorkflowGatekeeperResponse """ - emails: Optional[List[WorkflowGatekeeperUserResponse]] = None + emails: Optional[ + List[WorkflowGatekeeperUserResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Getekeepers""" @@ -1743,7 +2426,7 @@ class WorkflowGatekeeperUserResponse: Definition: WorkflowGatekeeperUserResponse """ - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1752,11 +2435,26 @@ class EnterpriseAuthenticationResponse: Definition: EnterpriseAuthenticationResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if authentication is enabled for the package.""" - password: Optional[AccessSecurityPasswordResponse] = None - sms_otp: Optional[EnterpriseAccessSecuritySmsOtpResponse] = None - totp: Optional[TotpPermissionResponse] = None + password: Optional[ + AccessSecurityPasswordResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + sms_otp: Optional[ + EnterpriseAccessSecuritySmsOtpResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + totp: Optional[ + TotpPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1765,11 +2463,11 @@ class EnterpriseAccessSecuritySmsOtpResponse: Definition: EnterpriseAccessSecuritySmsOtpResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if SMS OTP authentication is enabled for the package.""" - otp_length: Optional[int] = None - retry_duration: Optional[int] = None - mobile_number: Optional[str] = None + otp_length: int + retry_duration: int + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication. @@ -1782,10 +2480,20 @@ class EnterpriseAuthenticationSigningResponse: Definition: EnterpriseAuthenticationSigningResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if authentication is enabled for the package.""" - sms_otp: Optional[EnterpriseAuthenticationSigningSmsOtpResponse] = None - totp: Optional[TotpPermissionResponse] = None + sms_otp: Optional[ + EnterpriseAuthenticationSigningSmsOtpResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + totp: Optional[ + TotpPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1794,9 +2502,9 @@ class EnterpriseAuthenticationSigningSmsOtpResponse: Definition: EnterpriseAuthenticationSigningSmsOtpResponse """ - otp_length: Optional[int] = None - retry_duration: Optional[int] = None - mobile_number: Optional[str] = None + otp_length: int + retry_duration: int + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication. @@ -1809,9 +2517,9 @@ class DocumentOwner: Definition: DocumentOwner """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the document package owner.""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email of the document package owner.""" @@ -1821,19 +2529,23 @@ class DocumentDetails: Definition: DocumentDetails """ - id: Optional[int] = None + id: int """ID of the newly created document.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the document.""" - uploaded_on: Optional[str] = None + uploaded_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time when the document was uploaded.""" - modified_on: Optional[str] = None + modified_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time when the document was last modified.""" - size: Optional[int] = None + size: int """Size of the document in bytes.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type of the document e.g. \"PDF\".""" - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Identifies where the document was uploaded e.g. \"My App\".""" @@ -1843,9 +2555,9 @@ class ChangeServicePlanRequest: Definition: ChangeServicePlanRequest """ - user_email: Optional[str] = None + user_email: str """Email address of the account owner.""" - service_plan: Optional[str] = None + service_plan: str """New Service Plan name, which is to be assigned to the user.""" @@ -1855,9 +2567,9 @@ class TemplateSmartFormResponse: Definition: TemplateSmartFormResponse """ - active_count: Optional[int] = None + active_count: int """Active count """ - total_count: Optional[int] = None + total_count: int """Total""" @@ -1867,14 +2579,14 @@ class ServicePlanLevelOfAssurance: Definition: ServicePlanLevelOfAssurance """ - allowed: Optional[List[str]] = None + allowed: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Allowed level of assurances, Possible values are: ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE, ELECTRONIC_SEAL, ADVANCED_ELECTRONIC_SEAL, QUALIFIED_ELECTRONIC_SEAL, ELECTRONIC_SIGNATURE """ - default: Optional[List[str]] = None + default: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Default level of assurances, Possible values are: ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, @@ -1889,12 +2601,12 @@ class ServicePlanCertifyOption: Definition: ServicePlanCertifyOption """ - allowed: Optional[List[str]] = None + allowed: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Allowed document certify options, Possible values are: NO_CHANGES_ALLOWED, FORM_FILLING_ALLOWED, FORM_FILLING_WITH_ANNOTATIONS_ALLOWED """ - default: Optional[str] = None + default: Optional[str] = dataclass_field(default=None, kw_only=True) """ Default document certify options, Possible values are: NO_CHANGES_ALLOWED, FORM_FILLING_ALLOWED, FORM_FILLING_WITH_ANNOTATIONS_ALLOWED @@ -1907,12 +2619,22 @@ class ServicePlanAutoDeleteDocument: Definition: ServicePlanAutoDeleteDocument """ - enabled: Optional[bool] = None + enabled: bool """True, If auto deletion of the unused documents is enabled.""" - duration: Optional[int] = None + duration: int """Total number of unused days. """ - notify: Optional[NotifyUnUsedDeleteDocument] = None - email_document: Optional[EmailDeletedDocument] = None + notify: Optional[ + NotifyUnUsedDeleteDocument | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + email_document: Optional[ + EmailDeletedDocument | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1921,9 +2643,9 @@ class NotifyUnUsedDeleteDocument: Definition: NotifyUnUsedDeleteDocument """ - enabled: Optional[bool] = None + enabled: bool """True, If notify the user before days to deleting unused documents.""" - duration: Optional[int] = None + duration: int """Total number of days before notifying the user. """ @@ -1933,9 +2655,9 @@ class EmailDeletedDocument: Definition: EmailDeletedDocument """ - enabled: Optional[bool] = None + enabled: bool """True, If deleted document as attachment is enabled""" - workflow_evidence_report: Optional[bool] = None + workflow_evidence_report: bool """ True, Email the workflow evidence report as an attachment of the completed document is enabled @@ -1948,19 +2670,64 @@ class ServicePlanSigningServer: Definition: ServicePlanSigningServer """ - key_location: Optional[str] = None + key_location: Optional[str] = dataclass_field(default=None, kw_only=True) """Key location of the signing server, possible values are SERVER, LOCAL""" - order: Optional[int] = None + order: Optional[int] = dataclass_field(default=None, kw_only=True) """Signing server order""" - signing_profile: Optional[ServicePlanProfile] = None - electronic_seal: Optional[SigningServerCapacity] = None - advanced_electronic_seal: Optional[SigningServerCapacity] = None - qualified_electronic_seal: Optional[SigningServerCapacity] = None - advanced_electronic_signature: Optional[SigningServerCapacity] = None - high_trust_advanced_signature: Optional[SigningServerCapacity] = None - qualified_electronic_signature: Optional[SigningServerCapacity] = None - signature_appearances: Optional[SigningServerSignatureAppearance] = None - csp: Optional[SigningServerCsp] = None + signing_profile: Optional[ + ServicePlanProfile | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + electronic_seal: Optional[ + SigningServerCapacity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + advanced_electronic_seal: Optional[ + SigningServerCapacity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + qualified_electronic_seal: Optional[ + SigningServerCapacity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + advanced_electronic_signature: Optional[ + SigningServerCapacity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + high_trust_advanced_signature: Optional[ + SigningServerCapacity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + qualified_electronic_signature: Optional[ + SigningServerCapacity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + signature_appearances: Optional[ + SigningServerSignatureAppearance | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + csp: Optional[ + SigningServerCsp | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1969,9 +2736,9 @@ class ServicePlanProfile: Definition: ServicePlanProfile """ - id: Optional[int] = None + id: int """ID of the profile""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the profile""" @@ -1981,9 +2748,14 @@ class SigningServerCapacity: Definition: SigningServerCapacity """ - enabled: Optional[bool] = None + enabled: bool """True, If to add the Signing Capacities.""" - capacities: Optional[List[ServicePlanCapacity]] = None + capacities: Optional[ + List[ServicePlanCapacity | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Total number of Signing Capacities added are signing server.""" @@ -1993,18 +2765,18 @@ class ServicePlanCapacity: Definition: ServicePlanCapacity """ - id: Optional[int] = None + id: int """Id of the Capacity""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the Capacity""" - level_of_assurance: Optional[str] = None + level_of_assurance: Optional[str] = dataclass_field(default=None, kw_only=True) """ Level of assurance of the capacity, possible values are ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE, ELECTRONIC_SEAL, ADVANCED_ELECTRONIC_SEAL, QUALIFIED_ELECTRONIC_SEAL. """ - key_protection: Optional[str] = None + key_protection: Optional[str] = dataclass_field(default=None, kw_only=True) """ Key protection option of the capacity, possible values are NO_PASSWORD, USER_PASSWORD, SYSTEM_PASSWORD, REMOTE_AUTHORISATION. @@ -2017,12 +2789,12 @@ class SigningServerSignatureAppearance: Definition: SigningServerSignatureAppearance """ - signature_appearance: Optional[str] = None + signature_appearance: Optional[str] = dataclass_field(default=None, kw_only=True) """ Appearances of the signature, possible values are COMPANY_LOGO, HAND_SIGNATURE, DETAILED_SIGNATURE """ - signature_appearance_logo: Optional[str] = None + signature_appearance_logo: Optional[str] = dataclass_field(default=None, kw_only=True) """Logo of the signature appearance""" @@ -2032,10 +2804,15 @@ class SigningServerCsp: Definition: SigningServerCsp """ - enabled: Optional[bool] = None + enabled: bool """True, If to add Push Certificates to CSP.""" - virtual_profile: Optional[ServicePlanProfile] = None - auto_delete_certificates: Optional[bool] = None + virtual_profile: Optional[ + ServicePlanProfile | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + auto_delete_certificates: bool """ True, If Automatically delete certificates and users from CSP when user is removed. @@ -2048,10 +2825,30 @@ class ServicePlanElectronicSealServer: Definition: ServicePlanElectronicSealServer """ - electronic_seal_profile: Optional[ServicePlanProfile] = None - electronic_seal: Optional[SigningServerCapacity] = None - advanced_electronic_seal: Optional[SigningServerCapacity] = None - qualified_electronic_seal: Optional[SigningServerCapacity] = None + electronic_seal_profile: Optional[ + ServicePlanProfile | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + electronic_seal: Optional[ + SigningServerCapacity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + advanced_electronic_seal: Optional[ + SigningServerCapacity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + qualified_electronic_seal: Optional[ + SigningServerCapacity | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -2060,9 +2857,19 @@ class ServicePlanAuthenticationProfile: Definition: ServicePlanAuthenticationProfile """ - allowed: Optional[List[ServicePlanProfile]] = None + allowed: Optional[ + List[ServicePlanProfile | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Allowed authentication profile in service plan""" - default: Optional[ServicePlanProfile] = None + default: Optional[ + ServicePlanProfile | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -2071,12 +2878,16 @@ class ServicePlanEvidenceReport: Definition: ServicePlanEvidenceReport """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ Type of workflow evidence recording, Possible values are \"BASIC\", \"DETAILED\" """ - delete_document_logs: Optional[bool] = None + delete_document_logs: bool """ True, If enable to delete document logs on generation of Workflow Evidence Report. @@ -2089,13 +2900,23 @@ class ServicePlanOneTimePassword: Definition: ServicePlanOneTimePassword """ - email_otp: Optional[ServicePlanEmailOtp] = None - sms_otp: Optional[ServicePlanSmsOtp] = None - otp_length: Optional[int] = None + email_otp: Optional[ + ServicePlanEmailOtp | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + sms_otp: Optional[ + ServicePlanSmsOtp | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + otp_length: int """Character count of OTP to be generated for authentication.""" - otp_expiry: Optional[int] = None + otp_expiry: int """OTP expiry duration in seconds""" - otp_retry_interval: Optional[int] = None + otp_retry_interval: int """OTP retry interval duration in seconds""" @@ -2105,7 +2926,7 @@ class ServicePlanEmailOtp: Definition: ServicePlanEmailOtp """ - enabled: Optional[bool] = None + enabled: bool """True, if Email OTP are enabled for the service plan.""" @@ -2115,9 +2936,9 @@ class ServicePlanSmsOtp: Definition: ServicePlanSmsOtp """ - enabled: Optional[bool] = None + enabled: bool """True, if SMS OTP are enabled for the service plan.""" - server: Optional[str] = None + server: Optional[str] = dataclass_field(default=None, kw_only=True) """SMS OTP server""" @@ -2127,10 +2948,11 @@ class ServicePlanSmtpServer: Definition: ServicePlanSmtpServer """ - enabled: Optional[bool] = None + enabled: bool """True, if SMTP Server is enabled for the service plan.""" - server: Optional[str] = field( + server: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Server"}, ) """SMTP Server""" @@ -2142,10 +2964,11 @@ class ServicePlanSmsNotification: Definition: ServicePlanSmsNotification """ - enabled: Optional[bool] = None + enabled: bool """True, if SMS notification gateway is enabled for the service plan.""" - server: Optional[str] = field( + server: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Server"}, ) """SMS Gateway""" @@ -2157,11 +2980,16 @@ class ServicePlanAutoDeleteUser: Definition: ServicePlanAutoDeleteUser """ - enabled: Optional[bool] = None + enabled: bool """True, If auto deletion of the inactive users is enabled.""" - inactive_days: Optional[int] = None + inactive_days: int """Total number of inactive days. """ - notify: Optional[NotifyInactiveDeleteUser] = None + notify: Optional[ + NotifyInactiveDeleteUser | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -2170,9 +2998,9 @@ class NotifyInactiveDeleteUser: Definition: NotifyInactiveDeleteUser """ - enabled: Optional[bool] = None + enabled: bool """True, If notify the user before days to deleting inactive users.""" - duration: Optional[int] = None + duration: int """Total number of days before notifying the user. """ @@ -2182,7 +3010,7 @@ class ServicePlanCapacityRequest: Definition: ServicePlanCapacityRequest """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the Capacity""" @@ -2192,20 +3020,20 @@ class WorkflowDetailUpdateRequest: Definition: WorkflowDetailUpdateRequest """ - workflow_type: Optional[WorkflowType] = None - workflow_mode: Optional[WorkflowModes] = None - continue_on_decline: Optional[bool] = None + workflow_type: Optional[WorkflowType] = dataclass_field(default=None, kw_only=True) + workflow_mode: Optional[WorkflowModes] = dataclass_field(default=None, kw_only=True) + continue_on_decline: Optional[bool] = dataclass_field(default=None, kw_only=True) """ True, if workflow needs to continue even if any recipient declines the document. If no value is provided, old value will be retained. """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """ A custom string message from the document owner to every recipient, this message appears in the sharing email as well as on the screen. If no value is provided, old value will be retained. """ - comments: Optional[bool] = None + comments: Optional[bool] = dataclass_field(default=None, kw_only=True) """Allow comments""" @@ -2218,40 +3046,45 @@ class PostProcessUpdateRequest: Definition: PostProcessUpdateRequest """ - enabled: Optional[bool] = None + enabled: bool """True, if post processing is turned on for the package.""" - contacts: Optional[List[str]] = None - recipients: Optional[List[PostProcessRecipientRequest]] = None + contacts: Optional[List[str]] = dataclass_field(default=None, kw_only=True) + recipients: Optional[ + List[PostProcessRecipientRequest | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """ List of the name and email addresses to whom the emails are sent when the post processing is executed after the workflow completion. """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """ A custom string message for all the contacts. Message becomes part of the email sent to the contacts. """ - google_drive: Optional[bool] = None + google_drive: Optional[bool] = dataclass_field(default=None, kw_only=True) """ True, if document is to be uploaded to the provided google account after the workflow completion. """ - dropbox: Optional[bool] = None + dropbox: Optional[bool] = dataclass_field(default=None, kw_only=True) """ True, if document is to be uploaded to the provided dropbox account after the workflow completion. """ - onedrive: Optional[bool] = None + onedrive: Optional[bool] = dataclass_field(default=None, kw_only=True) """ True, if document is to be uploaded to the provided oneDrive account after the workflow completion. """ - workflow_recipients: Optional[bool] = None + workflow_recipients: bool """ True, if workflow completion report is to be sent to all recipients of the workflow when post processing is executed. Default value is false. """ - document_processing_report: Optional[bool] = None + document_processing_report: bool """ True, if Send the document processing report (XML) is to be enabled to for the workflow @@ -2264,26 +3097,26 @@ class WorflowUserRequest: Definition: WorflowUserRequest """ - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the user to be added in the workflow.""" - user_name: Optional[str] = None + user_name: str """Name of the recipient to be added in the workflow.""" - user_national_id: Optional[str] = None + user_national_id: Optional[str] = dataclass_field(default=None, kw_only=True) """User national id of the recipient""" - email_notification: Optional[bool] = None + email_notification: bool """ If set as true, SigningHub will send notifications to the user via email as per the document owner and user notification settings. A value of false means no notifications will be sent to user throughout the workflow. """ - role: Optional[CollaboratorRole] = None - signing_order: Optional[int] = None + role: CollaboratorRole + signing_order: Optional[int] = dataclass_field(default=None, kw_only=True) """ Order of the recipient in the workflow. This signing order is mandatory when workflow type is \"CUSTOM\". """ - delivery_method: Optional[DeliveryMethod] = None - mobile_number: Optional[str] = None + delivery_method: DeliveryMethod + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """Mobile Number""" @@ -2303,42 +3136,47 @@ class WorkflowResponse: Definition: WorkflowResponse """ - workflow_type: Optional[str] = None + workflow_type: Optional[str] = dataclass_field(default=None, kw_only=True) """ Type of the workflow, there are four types of workflows supported in the application. Possible values are \"SERIAL\", \"PARALLEL\", \"INDIVIDUAL\" and \"CUSTOM\". """ - continue_on_decline: Optional[bool] = None + continue_on_decline: bool """ True, if workflow needs to be continued even after a recipient declines at his turn. """ - workflow_status: Optional[str] = None + workflow_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Processing status of the workflow, possible values are \"DRAFT\", \"IN_PRGORESS\" and \"COMPLETED\". """ - workflow_mode: Optional[str] = None + workflow_mode: Optional[str] = dataclass_field(default=None, kw_only=True) """ Mode of the workflow, there are three types of workflow modes supported in application. Possible values are \"ONLY_ME\", \"ME_AND_OTHERS\" and \"ONLY_OTHERS\" """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """ Any custom string message that is to be sent to all the recipient of the workflow by the document owner. """ - read_only: Optional[bool] = None + read_only: bool """ If any template applied on the documents in this workflow is read only or locked template then the workflow is read only. SigningHub will not allow the end users to make any changes to this workflow in draft state and this workflow is to be shared as it is. """ - post_process: Optional[PostProcessResponse] = None - comments: Optional[bool] = None + post_process: Optional[ + PostProcessResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + comments: bool """Comments""" @@ -2348,52 +3186,62 @@ class WorkflowDocumentsResponse: Definition: WorkflowDocumentsResponse """ - document_id: Optional[int] = None + document_id: int """ID of the document.""" - document_name: Optional[str] = None + document_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the document.""" - document_type: Optional[str] = None + document_type: Optional[str] = dataclass_field(default=None, kw_only=True) """ Original document extension when the document was uploaded before conversion to the PDF. """ - document_order: Optional[int] = None + document_order: int """Order of the document in the document package.""" - document_source: Optional[str] = None + document_source: Optional[str] = dataclass_field(default=None, kw_only=True) """Source of the document from where the document was uploaded.""" - update_required: Optional[bool] = None + update_required: bool """True if document is required to update """ - document_height: Optional[int] = None + document_height: int """Height of the PDF document.""" - document_width: Optional[int] = None + document_width: int """Width of the PDF document.""" - document_pages: Optional[int] = None + document_pages: int """Total number of pages in the document.""" - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time on which the document was uploaded.""" - modified_on: Optional[str] = None + modified_on: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time on which the document was last modified.""" - form_fields: Optional[bool] = None + form_fields: bool """True, if document has form fields.""" - template: Optional[DocumentsTemplateResponse] = None - certify: Optional[CertifyResponse] = None - lock_form_fields: Optional[bool] = None + template: Optional[ + DocumentsTemplateResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + certify: Optional[ + CertifyResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + lock_form_fields: bool """ True, if document is set to lock the form fields with the last digital signature on the document. """ - locked: Optional[bool] = None - has_signed_signature_fields: Optional[bool] = None + locked: bool + has_signed_signature_fields: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Pdf document meta info: true if pdf document have signed signature fields """ - attachments: Optional[bool] = None + attachments: bool """True, if document has attachments.""" - conformance_level: Optional[str] = None + conformance_level: Optional[str] = dataclass_field(default=None, kw_only=True) """Document conformance level""" - document_size: Optional[int] = None + document_size: int """Size of document.""" - formatted: Optional[bool] = None + formatted: bool """This property is for XML document, that either its formatted or not""" @@ -2403,11 +3251,11 @@ class DocumentsTemplateResponse: Definition: DocumentsTemplateResponse """ - template_id: Optional[int] = None + template_id: int """ID of the template applied to the document.""" - template_name: Optional[str] = None + template_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the template applied to the document.""" - read_only: Optional[bool] = None + read_only: bool """ True, if template is configured as read only. No changes to the workflow should be made after a read only template is applied. @@ -2420,84 +3268,109 @@ class WorkflowUserResponse: Definition: WorkflowUserResponse """ - order: Optional[int] = None + order: int """Order of the recipient in the workflow.""" - user_name: Optional[str] = None + user_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the recipient if recipient is not a group. If recipient is a placeholder it will contain the name of the placeholder. """ - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """ Email address of the recipient if recipient is not a group or placeholder. """ - mobile_number: Optional[str] = None + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """Mobile number""" - delivery_method: Optional[str] = None + delivery_method: Optional[str] = dataclass_field(default=None, kw_only=True) """ Delivery method of recipient Possible values: EMAIL, SMS, or EMAIL_AND_SMS """ - user_photo_url: Optional[str] = None + user_photo_url: Optional[str] = dataclass_field(default=None, kw_only=True) """ API endpoint to access the resource, This will be provided only for main signers. e.g it will be null for group/delegator/gatekeeper etc. This URL does not make sure that signer image is exist. If image exist it will be provided by hitting the defined url otherwise it will be an empty string. """ - group_name: Optional[str] = None + group_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the group if recipient is a group.""" - group_members: Optional[List[str]] = None + group_members: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """List of all the email addresses and names of the users.""" - delegator: Optional[str] = None + delegator: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the user who is delegator to this recipient.""" - gatekeeper: Optional[str] = None + gatekeeper: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the user who is gatekeeper to this recipient.""" - gatekeepers: Optional[WorkflowGatekeeperResponse] = None - role: Optional[str] = None + gatekeepers: Optional[ + WorkflowGatekeeperResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + role: Optional[str] = dataclass_field(default=None, kw_only=True) """ Role of the recipient i.e., \"SIGNER\", \"REVIEWER\", \"EDITOR\",\"CARBON_COPY\" or \"INPERSON_HOST\". """ - process_status: Optional[str] = None + process_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Document processing status for the recipient. Possible values are \"UN_PROCESSED\", \"IN_PROGRESS\", \"SIGNED\", \"REVIEWED\", \"DECLINED\", \"EDITED\" or \"INVALID\". """ - processed_on: Optional[str] = None + processed_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time on which the document was processed.""" - processed_as: Optional[str] = None + processed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """ User may processed the field as COLLABORATOR, DELEGATOR, GROUP_MEMBER or OWNER. """ - processed_by: Optional[str] = None + processed_by: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the user who processed the document.""" - reason: Optional[str] = None + reason: Optional[str] = dataclass_field(default=None, kw_only=True) """ Reason provided by the user when declining, approving or submitting a document. """ - placeholder: Optional[str] = None + placeholder: Optional[str] = dataclass_field(default=None, kw_only=True) """Placeholder text if the recipient is a placeholder.""" - permission: Optional[WorkflowPermissionResponse] = None - authentications: Optional[AccessResponse] = None - reminder: Optional[ReminderResponse] = None - signing_order: Optional[int] = None + permission: Optional[ + WorkflowPermissionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + authentications: Optional[ + AccessResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + reminder: Optional[ + ReminderResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + signing_order: int """ Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to \"CUSTOM\". """ - user_national_id: Optional[str] = None + user_national_id: Optional[str] = dataclass_field(default=None, kw_only=True) """ National identity number of the user. This helps to identify user in the workflow """ - guest_user: Optional[bool] = None + guest_user: bool """Gest user""" - email_language_code: Optional[str] = None + email_language_code: Optional[str] = dataclass_field(default=None, kw_only=True) """Email language code""" - electronic_seal: Optional[ElectronicSealRecipient] = None + electronic_seal: Optional[ + ElectronicSealRecipient | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -2506,9 +3379,9 @@ class DocumentCertifyResponse: Definition: DocumentCertifyResponse """ - enabled: Optional[bool] = None + enabled: bool """True if certify signature is enabled for the document.""" - permission: Optional[str] = None + permission: Optional[str] = dataclass_field(default=None, kw_only=True) """ It is the certify permissions to be applied on the PDF document when the first signature is created. The possible values are \"NO_CHANGES_ALLOWED\", @@ -2522,9 +3395,9 @@ class DocumentTemplateResponse: Definition: DocumentTemplateResponse """ - template_name: Optional[str] = None + template_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the template applied on the document.""" - read_only: Optional[bool] = None + read_only: bool """ True if the applied template is read only. User will not be able to make any changes if a read only template is applied. @@ -2537,9 +3410,9 @@ class ApplyTemplateRequest: Definition: ApplyTemplateRequest """ - template_name: Optional[str] = None + template_name: str """Name of template to be applied on the document.""" - apply_to_all: Optional[bool] = None + apply_to_all: bool """ True, if template is to be applied on all the documents in the package. """ @@ -2551,13 +3424,13 @@ class AddDocumentPackageRequest: Definition: AddDocumentPackageRequest """ - package_name: Optional[str] = None + package_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ The name of the package. Default package name is always \"Untitled\" if the package_name is not provided. """ - workflow_mode: Optional[WorkflowMode] = None - folder_name: Optional[str] = None + workflow_mode: WorkflowMode + folder_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ The name of the folder. It will be used to upload package in any folder of the user, either it is a custom folder or a shared folder. @@ -2573,7 +3446,7 @@ class ApproveRequest: Definition: ApproveRequest """ - reason: Optional[str] = None + reason: Optional[str] = dataclass_field(default=None, kw_only=True) """The reason for approving a package.""" @@ -2583,7 +3456,7 @@ class DeclineRequest: Definition: DeclineRequest """ - reason: Optional[str] = None + reason: Optional[str] = dataclass_field(default=None, kw_only=True) """Reason provided by the user for declining.""" @@ -2593,7 +3466,7 @@ class RenameDocumentPackageRequest: Definition: RenameDocumentPackageRequest """ - package_name: Optional[str] = None + package_name: str """New name of the document package. """ @@ -2603,9 +3476,9 @@ class RecipientAccessDurationDetails: Definition: RecipientAccessDurationDetails """ - date_from: Optional[str] = None + date_from: Optional[str] = dataclass_field(default=None, kw_only=True) """Start date/time for a recipient to access the document """ - date_to: Optional[str] = None + date_to: Optional[str] = dataclass_field(default=None, kw_only=True) """End date/time for a recipient to access the document """ @@ -2615,11 +3488,16 @@ class RecipientDeclineDetails: Definition: RecipientDeclineDetails """ - reason: Optional[str] = None + reason: Optional[str] = dataclass_field(default=None, kw_only=True) """Define reason of document decline""" - auto_decline: Optional[bool] = None + auto_decline: bool """Indication of document is manually/auto declined """ - declined_by: Optional[DeclineByDetails] = None + declined_by: Optional[ + DeclineByDetails | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -2628,9 +3506,9 @@ class DeclineByDetails: Definition: DeclineByDetails """ - user_name: Optional[str] = None + user_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of user who have declined the workflow """ - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email of user who have declined the workflow """ @@ -2651,11 +3529,11 @@ class CertifyPermissionResponse: Definition: CertifyPermissionResponse """ - enabled: Optional[bool] = None + enabled: bool """True if certify signature is enabled for the document.""" - allowed_permissions: Optional[List[str]] = None + allowed_permissions: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Set of allowed certify permission levels for the document.""" - default_permission: Optional[str] = None + default_permission: Optional[str] = dataclass_field(default=None, kw_only=True) """Selected permission level for the certify signature settings.""" @@ -2665,27 +3543,27 @@ class UploadDocumentMetaInfoDetail: Definition: UploadDocumentMetaInfoDetail """ - attachments: Optional[bool] = None + attachments: bool """true if pdf document has any attachment""" - form_fields: Optional[bool] = None + form_fields: bool """true if pdf document has any form field""" - blank_signatures: Optional[bool] = None + blank_signatures: bool """true if pdf document has any blank signature field""" - signed_signatures: Optional[bool] = None + signed_signatures: bool """true if pdf document has any signed signature field""" - conformance: Optional[str] = None + conformance: Optional[str] = dataclass_field(default=None, kw_only=True) """ null/empty if document does not contains any conformance level otherwise contains formation like 1A, 1B etc """ - locked: Optional[bool] = None + locked: bool """true if pdf document is locked""" - certify: Optional[str] = None + certify: Optional[str] = dataclass_field(default=None, kw_only=True) """ CertifyLevel of pdf document. Possible values NotCertified, NoChangesAllowed, FormFilling, FormFillingAndAnnotations """ - qr_code: Optional[bool] = None + qr_code: bool """true if pdf document has any Qr Code, otherwise its false""" @@ -2695,7 +3573,7 @@ class RenameDocumentRequest: Definition: RenameDocumentRequest """ - document_name: Optional[str] = None + document_name: str """New name of the document.""" @@ -2708,74 +3586,74 @@ class VerificationResponse: Definition: VerificationResponse """ - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the field for which the verification was requested.""" - signer_name: Optional[str] = None + signer_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the signer.""" - signature_status: Optional[str] = None + signature_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ If the overall status of the signature is valid or not. Possible values are \"VALID\" or \"INVALID\". """ - signing_reason: Optional[str] = None + signing_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """ Reason provided by the user while signing the field. In case of witness signing, custom signing reason would be set """ - signing_location: Optional[str] = None + signing_location: Optional[str] = dataclass_field(default=None, kw_only=True) """Location entered by the user while signing the field.""" - contact_information: Optional[str] = None + contact_information: Optional[str] = dataclass_field(default=None, kw_only=True) """Contact information entered by the user while signing the field.""" - signing_time: Optional[str] = None + signing_time: Optional[str] = dataclass_field(default=None, kw_only=True) """ Date and time of signing in 8601 format. Default timezone from SH Admin is followed the the time. """ - ltv: Optional[bool] = None + ltv: bool """True, if signature is LTV.""" - qualified: Optional[bool] = None + qualified: bool """True, if signatures are qualified.""" - certified: Optional[bool] = None + certified: bool """True, if signatures are certified.""" - certify_permission: Optional[str] = None + certify_permission: Optional[str] = dataclass_field(default=None, kw_only=True) """Permission level for certified digital signature.""" - timestamp_at: Optional[str] = None + timestamp_at: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time when signature was time-stamped.""" - timestamp_authority: Optional[str] = None + timestamp_authority: Optional[str] = dataclass_field(default=None, kw_only=True) """Authority by which the signature was time-stamped.""" - subject_dn: Optional[str] = None + subject_dn: Optional[str] = dataclass_field(default=None, kw_only=True) """Subject DN from the certificate used while signing the field.""" - issuer_dn: Optional[str] = None + issuer_dn: Optional[str] = dataclass_field(default=None, kw_only=True) """Issuers DN from the certificate used while signing the field.""" - cert_valid_from: Optional[str] = None + cert_valid_from: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time from which the certificate is valid.""" - cert_valid_to: Optional[str] = None + cert_valid_to: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time to which the certificate is valid.""" - signature_type: Optional[str] = None + signature_type: Optional[str] = dataclass_field(default=None, kw_only=True) """ Type of signatures, possible values are \"PADES_PART2\" or \"PADES_PART4\". """ - signature_algorithm: Optional[str] = None + signature_algorithm: Optional[str] = dataclass_field(default=None, kw_only=True) """Signature algorithm used while signing the field.""" - signature_application: Optional[str] = None + signature_application: Optional[str] = dataclass_field(default=None, kw_only=True) """Application name from where the field was signed.""" - signature_policy_id: Optional[int] = None + signature_policy_id: int """Signature policy ID.""" - signature_policy_uri: Optional[str] = None + signature_policy_uri: Optional[str] = dataclass_field(default=None, kw_only=True) """Signature policy URI.""" - signer_photo: Optional[str] = None + signer_photo: Optional[str] = dataclass_field(default=None, kw_only=True) """Base64 image of the signer's avatar.""" - signer_photo_url: Optional[str] = None - signed_hash: Optional[str] = None + signer_photo_url: Optional[str] = dataclass_field(default=None, kw_only=True) + signed_hash: Optional[str] = dataclass_field(default=None, kw_only=True) """Hash of the document that was signed in respective signature.""" - display: Optional[str] = None - page_number: Optional[int] = None + display: Optional[str] = dataclass_field(default=None, kw_only=True) + page_number: int """Page number of the signature field""" - lei_number: Optional[str] = None + lei_number: Optional[str] = dataclass_field(default=None, kw_only=True) """LEI number if availbale in certificate""" - lei_role: Optional[str] = None + lei_role: Optional[str] = dataclass_field(default=None, kw_only=True) """LEI role if available in certificate""" - error_message: Optional[str] = None + error_message: Optional[str] = dataclass_field(default=None, kw_only=True) """ An error message returns in case the application unable to get verification results. @@ -2788,38 +3666,48 @@ class BulkSignRequest: Definition: BulkSignRequest """ - ids: Optional[List[int]] = None + ids: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """ An array of the document package ids that are selected for bulk signing. """ - hand_signature_initials_image: Optional[str] = None + hand_signature_initials_image: Optional[str] = dataclass_field(default=None, kw_only=True) """Base64 image used for the filling of the initials""" - hand_signature_initials_method: Optional[HandSignature] = None - hand_signature_image: Optional[str] = None + hand_signature_initials_method: Optional[ + HandSignature + ] = dataclass_field( + default=None, + kw_only=True, + ) + hand_signature_image: Optional[str] = dataclass_field(default=None, kw_only=True) """Base64 encoded string image of the visible signature appearance""" - hand_signature_method: Optional[HandSignature] = None - signing_reason: Optional[str] = None + hand_signature_method: Optional[HandSignature] = dataclass_field(default=None, kw_only=True) + signing_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """Reason of signing provided by the recipient.""" - signing_location: Optional[str] = None + signing_location: Optional[str] = dataclass_field(default=None, kw_only=True) """Locale of the signer provided by the recipient""" - contact_information: Optional[str] = None + contact_information: Optional[str] = dataclass_field(default=None, kw_only=True) """Contact information of the signer provided by the recipient""" - appearance_design: Optional[str] = None + appearance_design: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are \"COMPANY_LOGO\", \"DETAILED_SIGNATURE\", \"HAND_SIGNATURE\" """ - signing_server: Optional[str] = None + signing_server: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of signing server using which the document is to be signed""" - signing_capacity: Optional[str] = None + signing_capacity: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of certification profile/signing capacity using which the document is to be signed """ - authentication: Optional[BulkSignAuthentication] = None - transaction_id: Optional[str] = None + authentication: Optional[ + BulkSignAuthentication | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + transaction_id: Optional[str] = dataclass_field(default=None, kw_only=True) """re-initiated signing process transaction id""" @@ -2829,19 +3717,19 @@ class BulkSignAuthentication: Definition: BulkSignAuthentication """ - mechanism: Optional[str] = None + mechanism: Optional[str] = dataclass_field(default=None, kw_only=True) """ Mechanism of the authentication. Possible values for mechanism are: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """ It is an optional parameter, but it's only required when using 'AUTHENTICATION_PASSWORD' as a parameter value under 'mechanism' """ - token: Optional[str] = None + token: Optional[str] = dataclass_field(default=None, kw_only=True) """ It is an optional parameter that will be received from third party server, but it's only required when using either @@ -2850,21 +3738,21 @@ class BulkSignAuthentication: 'AUTHENTICATION_LINKED_IN' 'AUTHENTICATION_SALES_FORCE' as a parameter value under 'mechanism' """ - user_identifier: Optional[str] = None + user_identifier: Optional[str] = dataclass_field(default=None, kw_only=True) """ It is an optional parameter, but it's only required when using 'AUTHENTICATION_ACTIVE_DIRECTORY' or 'AUTHENTICATION_SAML' as a parameter value under 'mechanism' """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ It is an optional parameter, but it's only required when using 'AUTHENTICATION_SALES_FORCE' or 'AUTHENTICATION_IDFY' as a parameter value under 'mechanism'. For 'AUTHENTICATION_IDFY' it's requestId """ - code_verifier: Optional[str] = None + code_verifier: Optional[str] = dataclass_field(default=None, kw_only=True) """Code Verifier if PKCE is enabled for the client.""" - nonce: Optional[str] = None + nonce: Optional[str] = dataclass_field(default=None, kw_only=True) """Nonce value if it is enabled for the client.""" @@ -2877,14 +3765,19 @@ class BulkSignPackagesStatus: Definition: BulkSignPackagesStatus """ - id: Optional[int] = None - name: Optional[str] = None - status: Optional[str] = None - action: Optional[str] = None + id: int + name: Optional[str] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) + action: Optional[str] = dataclass_field(default=None, kw_only=True) """Required action key if any""" - error: Optional[str] = None - percentage: Optional[int] = None - documents: Optional[List[BulkSignActionDocumentModel]] = None + error: Optional[str] = dataclass_field(default=None, kw_only=True) + percentage: int + documents: Optional[ + List[BulkSignActionDocumentModel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Documents in the current package""" @@ -2894,8 +3787,13 @@ class BulkSignActionDocumentModel: Definition: BulkSignActionDocumentModel """ - id: Optional[int] = None - fields: Optional[List[BulkSignActionFieldModel]] = None + id: int + fields: Optional[ + List[BulkSignActionFieldModel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -2904,9 +3802,9 @@ class BulkSignActionFieldModel: Definition: BulkSignActionFieldModel """ - name: Optional[str] = None - hash: Optional[str] = None - hashing_algo: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + hash: Optional[str] = dataclass_field(default=None, kw_only=True) + hashing_algo: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -2915,7 +3813,7 @@ class BulkSignStatusRequest: Definition: BulkSignStatusRequest """ - transaction_id: Optional[str] = None + transaction_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identification number of the bulk signing transaction""" @@ -2925,9 +3823,9 @@ class SignDocumentRequest: Definition: SignDocumentRequest """ - field_name: Optional[str] = None + field_name: str """Unique identifier of the signature field in the document.""" - hand_signature_image: Optional[str] = None + hand_signature_image: Optional[str] = dataclass_field(default=None, kw_only=True) """ Base64 encoded string image of the visible signature appearance, which is placed onto the document. Note this can be retrieved from the user's @@ -2936,45 +3834,50 @@ class SignDocumentRequest: is binary, so the business application must then Base64 encode it before submitting in this API call.) """ - hand_signature_method: Optional[HandSignature] = None - signing_reason: Optional[str] = None + hand_signature_method: Optional[HandSignature] = dataclass_field(default=None, kw_only=True) + signing_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """ Reason of signing provided by the recipient. Note: Commitment type indication for XML documents """ - signing_location: Optional[str] = None + signing_location: Optional[str] = dataclass_field(default=None, kw_only=True) """Locale of the signer provided by the recipient.""" - contact_information: Optional[str] = None + contact_information: Optional[str] = dataclass_field(default=None, kw_only=True) """Contact information of the signer provided by the recipient.""" - user_name: Optional[str] = None + user_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the signer provided by the recipient. Note this applies to in-person signing operations only. """ - user_password: Optional[str] = None + user_password: Optional[str] = dataclass_field(default=None, kw_only=True) """Password provided by the user subject to user's signature settings.""" - appearance_design: Optional[str] = None + appearance_design: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are \"COMPANY_LOGO\",\"DETAILED_SIGNATURE\",\"HAND_SIGNATURE\" """ - signing_capacity: Optional[str] = None + signing_capacity: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of certification profile/signing capacity using which the document is to be signed. If not provided the default capacity will be used to sign. Provided name must be exactly same as of the actual profile due to case sensitivity. """ - skip_verification: Optional[bool] = None + skip_verification: bool """ No signature verification returns in response body when it is set as true. Default value for this parameter set to false. """ - signing_server: Optional[str] = None + signing_server: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of signing server using which the document is to be signed.""" - authentication: Optional[Authentication] = None + authentication: Optional[ + Authentication | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -2983,19 +3886,19 @@ class Authentication: Definition: Authentication """ - mechanism: Optional[str] = None + mechanism: Optional[str] = dataclass_field(default=None, kw_only=True) """ Mechanism of the authentication. Possible values for mechanism are: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC """ - password: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) """ It is an optional parameter, but it's only required when using 'AUTHENTICATION_PASSWORD' as a parameter value under 'mechanism' """ - token: Optional[str] = None + token: Optional[str] = dataclass_field(default=None, kw_only=True) """ It is an optional parameter that will be received from third party server, but it's only required when using either @@ -3004,21 +3907,21 @@ class Authentication: 'AUTHENTICATION_LINKED_IN' 'AUTHENTICATION_SALES_FORCE' as a parameter value under 'mechanism' """ - user_identifier: Optional[str] = None + user_identifier: Optional[str] = dataclass_field(default=None, kw_only=True) """ It is an optional parameter, but it's only required when using 'AUTHENTICATION_ACTIVE_DIRECTORY' or 'AUTHENTICATION_SAML' as a parameter value under 'mechanism' """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ It is an optional parameter, but it's only required when using 'AUTHENTICATION_SALES_FORCE' or 'AUTHENTICATION_IDFY' as a parameter value under 'mechanism'. For 'AUTHENTICATION_IDFY' it's requestId """ - code_verifier: Optional[str] = None + code_verifier: Optional[str] = dataclass_field(default=None, kw_only=True) """Code Verifier if PKCE is enabled for the client.""" - nonce: Optional[str] = None + nonce: Optional[str] = dataclass_field(default=None, kw_only=True) """Nonce value if it is enabled for the client.""" @@ -3028,29 +3931,29 @@ class AutoPlaceFieldRequest: Definition: AutoPlaceFieldRequest """ - search_text: Optional[str] = None + search_text: Optional[str] = dataclass_field(default=None, kw_only=True) """Word that needs to be searched in the document.""" - order: Optional[int] = None + order: int """ Order of the user to which the fields will be assigned automatically. Workflow in SigningHub orders recipients. This list begins with \"1\" for the first designated signer. """ - placement: Optional[str] = None + placement: Optional[str] = dataclass_field(default=None, kw_only=True) """ If the text is found, fields are to be placed in the document. Placement of the field can be mentioned in this attribute. Possible values of placement of a field are LEFT, RIGHT, TOP, BOTTOM. If no value is provided the default value will be LEFT. """ - field_type: Optional[str] = None + field_type: Optional[str] = dataclass_field(default=None, kw_only=True) """ Type of field to be created in the document. Possible values are \"SIGNATURE\", \"IN_PERSON_SIGNATURE\", \"INITIALS\", \"TEXT\", \"NUMBER\" ,\"NAME\", \"EMAIL\", \"COMPANY\", \"JOBTITLE\", \"RADIOBOX\", \"CHECKBOX\", \"DATE\", \"ATTACHMENT\" """ - level_of_assurance: Optional[List[str]] = None + level_of_assurance: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Level Of Assurance to be updated. Possible Values are \"ELECTRONIC_SIGNATURE\", \"ELECTRONIC_SEAL\", @@ -3058,15 +3961,20 @@ class AutoPlaceFieldRequest: \"ADVANCED_ELECTRONIC_SIGNATURE\", \"HIGH_TRUST_ADVANCED\", \"QUALIFIED_ELECTRONIC_SIGNATURE\" """ - dimensions: Optional[FieldDimension] = None - placeholder: Optional[str] = None + dimensions: Optional[ + FieldDimension | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + placeholder: Optional[str] = dataclass_field(default=None, kw_only=True) """Provide note in the case of Mandatory Attachment""" - radio_group_name: Optional[str] = None + radio_group_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ The group name required only when adding a Radio Box type field to group multiple Radio boxes together. """ - format: Optional[str] = None + format: Optional[str] = dataclass_field(default=None, kw_only=True) """

Text format of the field. Used for the date type field only. Possible values are

  • m/d
  • m/d/yy
  • m/d/yyyy
    • @@ -3076,20 +3984,25 @@ class AutoPlaceFieldRequest:
  • mmm-yyyy
  • mmmm-yy
  • mmmm-yyyy
  • mmmm d, yyyy
  • dd/mm/yy
  • ddmmmyyyy
""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value that user want to show in the field.""" - max_length: Optional[int] = None + max_length: int """ Maximum length of the value allowed in the field. Must between 1 - 9999 """ - validation_rule: Optional[str] = None + validation_rule: Optional[str] = dataclass_field(default=None, kw_only=True) """ One or more rules for validation of the fields possible values are \"MANDATORY\" or \"OPTIONAL\". """ - validation: Optional[FieldValidationValue] = None - font: Optional[Font] = None - multiline: Optional[bool] = None + validation: Optional[ + FieldValidationValue | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + font: Optional[Font | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + multiline: bool """ This belongs to Text Area field type and If set to true, text area field would be created with multi line option. @@ -3102,17 +4015,17 @@ class Font: Definition: Font """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the font selected for the text field. Possible values are \"COURIER\", \"HELVETICA\". """ - size: Optional[str] = None + size: Optional[str] = dataclass_field(default=None, kw_only=True) """ Size of the font selected for the text field. Possible values are 8, 10, 12, 14, 16, 18, 20 """ - embedded_size: Optional[str] = None + embedded_size: Optional[str] = dataclass_field(default=None, kw_only=True) """Size of the font in the original PDF document.""" @@ -3122,22 +4035,47 @@ class FormFillingRequest: Definition: FormFillingRequest """ - auto_save: Optional[bool] = None + auto_save: bool """ Default value is false. True, if the form fields are being saved without user intervention e.g., while closing the document or pressing back. For Signing, Initials, In-persons, Reviewing, Submit actions the value is false. """ - text: Optional[List[TextFormFillingRequest]] = None + text: Optional[ + List[TextFormFillingRequest | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """It has the list of textboxes data to save""" - radio: Optional[List[RadioFormFillingRequest]] = None + radio: Optional[ + List[RadioFormFillingRequest | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """It has the list of radios value to save""" - checkbox: Optional[List[CheckBoxFormFillingRequest]] = None + checkbox: Optional[ + List[CheckBoxFormFillingRequest | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """It has the list of checkboxes value to save""" - dropdown: Optional[List[DropDownFormFillingRequest]] = None + dropdown: Optional[ + List[DropDownFormFillingRequest | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """It has the list of dropdowns value to save""" - listbox: Optional[List[ListBoxFormFillingRequest]] = None + listbox: Optional[ + List[ListBoxFormFillingRequest | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """It has the list of listboxes value to save""" @@ -3147,9 +4085,9 @@ class TextFormFillingRequest: Definition: TextFormFillingRequest """ - field_name: Optional[str] = None + field_name: str """Unique identifier of the field in the document.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value of the field to be saved in the document.""" @@ -3159,11 +4097,11 @@ class RadioFormFillingRequest: Definition: RadioFormFillingRequest """ - field_name: Optional[str] = None + field_name: str """Unique identifier of the field in the document.""" - radio_group_name: Optional[str] = None + radio_group_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Group name to which the radio button belongs.""" - value: Optional[bool] = None + value: bool """Value of the field to be saved in the document.""" @@ -3173,9 +4111,9 @@ class CheckBoxFormFillingRequest: Definition: CheckBoxFormFillingRequest """ - field_name: Optional[str] = None + field_name: str """Unique identifier of the field in the document.""" - value: Optional[bool] = None + value: bool """Value of the field to be saved in the document.""" @@ -3185,9 +4123,9 @@ class DropDownFormFillingRequest: Definition: DropDownFormFillingRequest """ - field_name: Optional[str] = None + field_name: str """Unique identifier of the field in the document.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value of the field to be saved in the document.""" @@ -3197,9 +4135,9 @@ class ListBoxFormFillingRequest: Definition: ListBoxFormFillingRequest """ - field_name: Optional[str] = None + field_name: str """Unique identifier of the field in the document.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value of the field to be saved in the document.""" @@ -3209,16 +4147,16 @@ class InitialFieldRequest: Definition: InitialFieldRequest """ - order: Optional[int] = None + order: int """The order of the user in workflow for which the field is being added.""" - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field. """ - dimensions: Optional[FieldDimension] = None + dimensions: FieldDimension | Mapping[str, Any] @dataclass @@ -3227,12 +4165,12 @@ class InitialFillingRequest: Definition: InitialFillingRequest """ - field_name: Optional[str] = None + field_name: str """Unique identifier of the field in the document.""" - image: Optional[str] = None + image: str """Base64 image used for the filling of the initials.""" - method: Optional[HandSignature] = None - apply_to_all: Optional[bool] = None + method: Optional[HandSignature] = dataclass_field(default=None, kw_only=True) + apply_to_all: bool """True if all initials are to be filled.""" @@ -3242,13 +4180,13 @@ class UpdateInitialFieldRequest: Definition: UpdateInitialFieldRequest """ - field_name: Optional[str] = None + field_name: str """Current name of the field, that is to be updated.""" - renamed_as: Optional[str] = None + renamed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """Updated name of the field if renaming is intended.""" - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - dimensions: Optional[FieldDimension] = None + dimensions: FieldDimension | Mapping[str, Any] @dataclass @@ -3257,33 +4195,38 @@ class InPersonFieldRequest: Definition: InPersonFieldRequest """ - order: Optional[int] = None + order: int """The order of the user in workflow for which the field is being added.""" - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field. """ - placeholder: Optional[str] = None + placeholder: str """ String identifier for the inperson field, it can be Customer, Jack, CEO etc. """ - dimensions: Optional[FieldDimension] = None - display: Optional[str] = None + dimensions: FieldDimension | Mapping[str, Any] + display: Optional[str] = dataclass_field(default=None, kw_only=True) """ Visibility of the field that is to be added, possible values are \"VISIBLE\" and \"INVISIBLE\" """ - level_of_assurance: Optional[List[str]] = None + level_of_assurance: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Level Of Assurance to be updated. Possible Values are \"ELECTRONIC_SEAL\", \"ADVANCED_ELECTRONIC_SEAL\", \"QUALIFIED_ELECTRONIC_SEAL\", \"ELECTRONIC_SIGNATURE\" """ - authentication_signing: Optional[SignatureFieldAuthentication] = None + authentication_signing: Optional[ + SignatureFieldAuthentication | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -3292,30 +4235,40 @@ class UpdateInPersonFieldRequest: Definition: UpdateInPersonFieldRequest """ - field_name: Optional[str] = None + field_name: str """Current name of the field, that is to be updated.""" - renamed_as: Optional[str] = None + renamed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """updated name of the field, if renaming is intended.""" - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - placeholder: Optional[str] = None + placeholder: Optional[str] = dataclass_field(default=None, kw_only=True) """ String identifier for the in-person field, it can be Customer, Jack, CEO etc. """ - dimensions: Optional[FieldDimension] = None - display: Optional[str] = None + dimensions: Optional[ + FieldDimension | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + display: Optional[str] = dataclass_field(default=None, kw_only=True) """ Visibility of the field that is to be updated, possible values are \"VISIBLE\" and \"INVISIBLE\" """ - level_of_assurance: Optional[List[str]] = None + level_of_assurance: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Level Of Assurance to be updated. Possible Values are \"ELECTRONIC_SEAL\", \"ADVANCED_ELECTRONIC_SEAL\", \"QUALIFIED_ELECTRONIC_SEAL\", \"ELECTRONIC_SIGNATURE\" """ - authentication_signing: Optional[SignatureFieldAuthentication] = None + authentication_signing: Optional[ + SignatureFieldAuthentication | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -3324,16 +4277,16 @@ class DigitalSignatureFieldRequest: Definition: DigitalSignatureFieldRequest """ - order: Optional[int] = None + order: int """Order of the recipient for which the field is being created.""" - page_no: Optional[int] = None + page_no: int """Page number at which the field is about to be created.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field. """ - level_of_assurance: Optional[List[str]] = None + level_of_assurance: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Level Of Assurance to be added. Possible Values are \"ELECTRONIC_SIGNATURE\", \"ELECTRONIC_SEAL\", @@ -3341,13 +4294,23 @@ class DigitalSignatureFieldRequest: \"ADVANCED_ELECTRONIC_SIGNATURE\", \"HIGH_TRUST_ADVANCED\", \"QUALIFIED_ELECTRONIC_SIGNATURE\" """ - dimensions: Optional[FieldDimension] = None - display: Optional[str] = None + dimensions: Optional[ + FieldDimension | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + display: Optional[str] = dataclass_field(default=None, kw_only=True) """ Visibility of the field that is to be added, possible values are \"VISIBLE\" and \"INVISIBLE\" """ - authentication_signing: Optional[SignatureFieldAuthentication] = None + authentication_signing: Optional[ + SignatureFieldAuthentication | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -3356,9 +4319,9 @@ class UpdateDigitalSignatureFieldRequest: Definition: UpdateDigitalSignatureFieldRequest """ - field_name: Optional[str] = None + field_name: str """Current name of the field, which is to be updated.""" - level_of_assurance: Optional[List[str]] = None + level_of_assurance: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Level Of Assurance to be updated. Possible Values are \"ELECTRONIC_SIGNATURE\", \"ELECTRONIC_SEAL\", @@ -3366,17 +4329,27 @@ class UpdateDigitalSignatureFieldRequest: \"ADVANCED_ELECTRONIC_SIGNATURE\", \"HIGH_TRUST_ADVANCED\", \"QUALIFIED_ELECTRONIC_SIGNATURE\" """ - renamed_as: Optional[str] = None + renamed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """Updated name of the field if renaming of the field is intended.""" - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - dimensions: Optional[FieldDimension] = None - display: Optional[str] = None + dimensions: Optional[ + FieldDimension | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + display: Optional[str] = dataclass_field(default=None, kw_only=True) """ Visibility of the field that is to be updated, possible values are \"VISIBLE\" and \"INVISIBLE\" """ - authentication_signing: Optional[SignatureFieldAuthentication] = None + authentication_signing: Optional[ + SignatureFieldAuthentication | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -3385,19 +4358,19 @@ class CheckBoxFieldRequest: Definition: CheckBoxFieldRequest """ - order: Optional[int] = None + order: int """The order of the user in workflow for which the field is being added.""" - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field. """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value of the field. Possible values are \"true\" or \"false\"""" - dimensions: Optional[FieldDimension] = None - validation_rule: Optional[str] = None + dimensions: FieldDimension | Mapping[str, Any] + validation_rule: Optional[str] = dataclass_field(default=None, kw_only=True) """ One or more rules for validation of the fields possible values are \"MANDATORY\" or \"OPTIONAL\". @@ -3410,16 +4383,16 @@ class UpdateCheckBoxFieldRequest: Definition: UpdateCheckBoxFieldRequest """ - field_name: Optional[str] = None + field_name: str """Current name of the field, that is to be updated.""" - renamed_as: Optional[str] = None + renamed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """Updated name of the field if renaming is intended.""" - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value of the field. Possible values are \"true\" or \"false\"""" - dimensions: Optional[FieldDimension] = None - validation_rule: Optional[str] = None + dimensions: FieldDimension | Mapping[str, Any] + validation_rule: Optional[str] = dataclass_field(default=None, kw_only=True) """ One or more rules for validation of the fields possible values are \"MANDATORY\" or \"OPTIONAL\". @@ -3432,22 +4405,19 @@ class TextBoxFieldRequest: Definition: TextBoxFieldRequest """ - order: Optional[int] = None + order: int """The order of the user in workflow for which the field is being added.""" - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - type_: Optional[TextboxType] = field( - default=None, - metadata={"wire_name": "type"}, - ) - value: Optional[str] = None + type_: TextboxType = dataclass_field(metadata={"wire_name": "type"}) + value: Optional[str] = dataclass_field(default=None, kw_only=True) """ Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned. """ - placeholder: Optional[str] = None + placeholder: Optional[str] = dataclass_field(default=None, kw_only=True) """ Placeholder text for the text field. For name, email, company, job title and date, placeholder value can be \"NAME\", \"EMAIL\", \"COMPANY\", @@ -3456,11 +4426,11 @@ class TextBoxFieldRequest: own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer. """ - max_length: Optional[int] = None + max_length: int """ Maximum length of the value allowed in the field. Must between 1 - 9999 """ - format: Optional[str] = None + format: Optional[str] = dataclass_field(default=None, kw_only=True) """

Text format of the field. Used for the date type field only. Possible values are

  • m/d
  • m/d/yy
  • m/d/yyyy
    • @@ -3470,17 +4440,22 @@ class TextBoxFieldRequest:
  • mmm-yyyy
  • mmmm-yy
  • mmmm-yyyy
  • mmmm d, yyyy
  • dd/mm/yy
  • ddmmmyyyy
""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field. """ - field_type: Optional[FieldType] = None - validation_rule: Optional[ValidationRule] = None - validation: Optional[FieldValidationValue] = None - font: Optional[Font] = None - dimensions: Optional[FieldDimension] = None - multiline: Optional[bool] = None + field_type: FieldType + validation_rule: ValidationRule + validation: Optional[ + FieldValidationValue | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + font: Font | Mapping[str, Any] + dimensions: FieldDimension | Mapping[str, Any] + multiline: bool """If set to true, text area field would be created""" @@ -3490,33 +4465,38 @@ class UpdateTextBoxFieldRequest: Definition: UpdateTextBoxFieldRequest """ - field_name: Optional[str] = None + field_name: str """Current name of the field, that is to be updated.""" - renamed_as: Optional[str] = None + renamed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """Updated name of the field if renaming is intended.""" - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """ Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned. """ - max_length: Optional[int] = None + max_length: int """ Maximum length of the value allowed in the field. Must between 1 - 9999 """ - field_type: Optional[FieldType] = None - validation_rule: Optional[ValidationRule] = None - font: Optional[Font] = None - dimensions: Optional[FieldDimension] = None - placeholder: Optional[str] = None + field_type: FieldType + validation_rule: ValidationRule + font: Optional[Font | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + dimensions: Optional[ + FieldDimension | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + placeholder: Optional[str] = dataclass_field(default=None, kw_only=True) """ Developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer. """ - format: Optional[str] = None + format: Optional[str] = dataclass_field(default=None, kw_only=True) """

Text format of the field. Used for the date type field only. Possible values are

  • m/d
  • m/d/yy
  • m/d/yyyy
    • @@ -3526,7 +4506,12 @@ class UpdateTextBoxFieldRequest:
  • mmm-yyyy
  • mmmm-yy
  • mmmm-yyyy
  • mmmm d, yyyy
  • dd/mm/yy
  • ddmmmyyyy
""" - validation: Optional[FieldValidationValue] = None + validation: Optional[ + FieldValidationValue | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -3535,20 +4520,20 @@ class RadioBoxFieldRequest: Definition: RadioBoxFieldRequest """ - order: Optional[int] = None + order: int """The order of the user in workflow for which the field is being added.""" - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field. """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value of the field. Possible values are \"true\" or \"false\"""" - validation_rule: Optional[ValidationRule] = None - radio_group_name: Optional[str] = None - dimensions: Optional[FieldDimension] = None + validation_rule: ValidationRule + radio_group_name: str + dimensions: FieldDimension | Mapping[str, Any] @dataclass @@ -3557,18 +4542,18 @@ class UpdateRadioBoxFieldRequest: Definition: UpdateRadioBoxFieldRequest """ - field_name: Optional[str] = None + field_name: str """Current name of the field, that is to be updated.""" - renamed_as: Optional[str] = None + renamed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """Updated name of the field if renaming is intended.""" - page_no: Optional[int] = None + page_no: int """Page number on which the field is to be created.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value of the field. Possible values are \"true\" or \"false\"""" - validation_rule: Optional[ValidationRule] = None - radio_group_name: Optional[str] = None + validation_rule: ValidationRule + radio_group_name: str """The group name to which the field belongs.""" - dimensions: Optional[FieldDimension] = None + dimensions: FieldDimension | Mapping[str, Any] ContactSortBy = Literal["CREATEDON", "NAME", "EMAIL"] @@ -3580,9 +4565,9 @@ class WorkSpaceMembers: Definition: WorkSpaceMembers """ - name: Optional[str] = None + name: str """Name of work space member""" - email: Optional[str] = None + email: str """Email Address of work space member""" @@ -3592,9 +4577,9 @@ class WorkSpaceOwner: Definition: WorkSpaceOwner """ - name: Optional[str] = None + name: str """Name of work space owner""" - email: Optional[str] = None + email: str """Email Address of work space owner""" @@ -3604,13 +4589,13 @@ class UploadDocumentLibraryCertifyResponse: Definition: UploadDocumentLibraryCertifyResponse """ - enabled: Optional[bool] = None + enabled: bool """True if certify signature is enabled for the document.""" - allowed_permissions: Optional[List[str]] = None + allowed_permissions: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Set of allowed certify permission levels for the document.""" - default_permission: Optional[str] = None + default_permission: Optional[str] = dataclass_field(default=None, kw_only=True) """Selected permission level for the certify signature settings.""" - permission: Optional[str] = None + permission: Optional[str] = dataclass_field(default=None, kw_only=True) """ It is the certify permissions to be applied on the PDF document when the first signature is created. The possible values are \"NO_CHANGES_ALLOWED\", @@ -3624,9 +4609,9 @@ class UploadDocumentLibraryTemplateResponse: Definition: UploadDocumentLibraryTemplateResponse """ - template_name: Optional[str] = None + template_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the template applied on the document.""" - read_only: Optional[bool] = None + read_only: bool """ True if the applied template is read only. User will not be able to make any changes if a read only template is applied. @@ -3639,12 +4624,12 @@ class WorkflowPermissionsUpdateRequest: Definition: WorkflowPermissionsUpdateRequest """ - apply_to_all: Optional[bool] = None + apply_to_all: bool """ True, if the permissions are to be applied on all the recipients in the workflow. """ - permissions: Optional[WorkflowPermission] = None + permissions: WorkflowPermission | Mapping[str, Any] @dataclass @@ -3653,23 +4638,33 @@ class WorkflowPermission: Definition: WorkflowPermission """ - print: Optional[bool] = None + print: Optional[bool] = dataclass_field(default=None, kw_only=True) """It defines whether recipient is allowed to print the document.""" - download: Optional[bool] = None + download: Optional[bool] = dataclass_field(default=None, kw_only=True) """It defines whether recipient is allowed to download the document.""" - add_text: Optional[bool] = None + add_text: Optional[bool] = dataclass_field(default=None, kw_only=True) """ It defines whether recipient is allowed to add text fields in the document. """ - change_recipients: Optional[bool] = None + change_recipients: Optional[bool] = dataclass_field(default=None, kw_only=True) """It allows the user to change any recipient who has not signed yet.""" - add_attachment: Optional[bool] = None + add_attachment: Optional[bool] = dataclass_field(default=None, kw_only=True) """ It defines whether recipient is allowed to add attachments in the PDF document. """ - legal_notice: Optional[PermissionLegalNotice] = None - attachment: Optional[AttachmentPermissionRequest] = None + legal_notice: Optional[ + PermissionLegalNotice | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + attachment: Optional[ + AttachmentPermissionRequest | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -3678,7 +4673,7 @@ class AttachmentPermissionRequest: Definition: AttachmentPermissionRequest """ - enabled: Optional[bool] = None + enabled: bool """Enabled""" @@ -3688,9 +4683,9 @@ class PermissionLegalNotice: Definition: PermissionLegalNotice """ - enabled: Optional[bool] = None + enabled: bool """True, if legal notice is enabled.""" - legal_notice_name: Optional[str] = None + legal_notice_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the legal notice selected for the recipient.""" @@ -3700,21 +4695,26 @@ class DocumentLogsActions: Definition: DocumentLogsActions """ - log_id: Optional[int] = None + log_id: int """ID of an action performed on the document.""" - date_time: Optional[str] = None + date_time: Optional[str] = dataclass_field(default=None, kw_only=True) """Date and time when the action was performed.""" - action_type: Optional[str] = None - user_email: Optional[str] = None + action_type: Optional[str] = dataclass_field(default=None, kw_only=True) + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email of the user who performed the action.""" - user_name: Optional[str] = None + user_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the user who performed the action.""" - enterprise_name: Optional[str] = None + enterprise_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ The name of Enterprise to which the user belongs. If the user doesn't belong to an enterprise, then this element is not present. """ - information: Optional[DocumentLogsActionsInformation] = None + information: Optional[ + DocumentLogsActionsInformation | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -3723,12 +4723,16 @@ class DocumentLogsActionsInformation: Definition: DocumentLogsActionsInformation """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ The type of extra information about the action e.g. \"SIGNING_METHOD\" which means what signing method user used to sign the document. """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """ The value of the extra information about the action e.g. \"LOCAL\" which means user signed the document using locally held credentials. @@ -3741,34 +4745,34 @@ class WorkflowUserUpdateRequest: Definition: WorkflowUserUpdateRequest """ - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """ The email address of the new user to be updated in workflow. If no value is provided, old value will be retained. """ - user_name: Optional[str] = None + user_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the recipient to be updated. If no value is provided, old value will be retained. """ - email_notification: Optional[bool] = None + email_notification: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Setting its value to \"true\" sends an email notification to the user when its turn arrives in workflow. Setting its value to \"false\" does not send the email notification to the user on its turn. If no value is provided, old value will be retained. """ - mobile_number: Optional[str] = None + mobile_number: Optional[str] = dataclass_field(default=None, kw_only=True) """Mobile number. If no value is provided, old value will be retained.""" - role: Optional[WorkflowCollaboratorRole] = None - signing_order: Optional[int] = None + role: WorkflowCollaboratorRole + signing_order: Optional[int] = dataclass_field(default=None, kw_only=True) """ Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to \"CUSTOM\". """ - email_language_code: Optional[str] = None + email_language_code: Optional[str] = dataclass_field(default=None, kw_only=True) """email language code""" - delivery_method: Optional[DeliveryMethod] = None + delivery_method: DeliveryMethod WorkflowCollaboratorRole = Literal[ @@ -3786,7 +4790,7 @@ class WorkflowUserReorderRequest: Definition: WorkflowUserReorderRequest """ - order: Optional[int] = None + order: int """The order of the recipient which is to be updated.""" @@ -3796,21 +4800,26 @@ class UpdateReminderRequest: Definition: UpdateReminderRequest """ - apply_to_all: Optional[bool] = None + apply_to_all: bool """ True, if reminder settings are to be applied on all the recipients in the workflow. """ - enabled: Optional[bool] = None + enabled: bool """True, if reminder settings are to be enabled.""" - frequency: Optional[str] = None + frequency: Optional[str] = dataclass_field(default=None, kw_only=True) """Reminder Frequency. Possible Values are DAYS | HOURS. """ - remind_after: Optional[int] = None + remind_after: int """ Required, in case of enabled property will true. The number of days after which the first reminder would be sent to workflow user. """ - repeat: Optional[RepeatRequest] = None + repeat: Optional[ + RepeatRequest | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -3819,16 +4828,16 @@ class RepeatRequest: Definition: RepeatRequest """ - enabled: Optional[bool] = None + enabled: bool """True, if subsequent reminders are enabled.""" - frequency: Optional[str] = None + frequency: Optional[str] = dataclass_field(default=None, kw_only=True) """Repeat Reminder Frequency. Possible Values are DAYS | HOURS. """ - keep_reminding_after: Optional[int] = None + keep_reminding_after: int """ Required, in case of enabled property will true. The number of days after which the subsequent reminders would be sent to workflow user. """ - total_reminders: Optional[int] = None + total_reminders: int """ Required, in case of enabled property will true. The number of subsequent reminders would be sent to workflow user. @@ -3841,17 +4850,17 @@ class WorflowGroupRequest: Definition: WorflowGroupRequest """ - group_name: Optional[str] = None + group_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the new group to be added in workflow.""" - email_notification: Optional[bool] = None + email_notification: bool """ Setting its value to \"true\" sends an email notification to the user when its turn arrives in workflow. Setting its value to \"false\" does not send the email notification to the user on its turn. If no value is provided, default value of \"true\" will be set. """ - role: Optional[CollaboratorRole] = None - signing_order: Optional[int] = None + role: CollaboratorRole + signing_order: Optional[int] = dataclass_field(default=None, kw_only=True) """ Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to \"CUSTOM\". @@ -3864,16 +4873,16 @@ class PlaceholderRequest: Definition: PlaceholderRequest """ - placeholder: Optional[str] = None + placeholder: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the new placeholder to be added in workflow.""" - email_notification: Optional[bool] = None + email_notification: bool """ Setting its value to \"true\" sends an email notification to the user when its turn arrives in workflow. Setting its value to \"false\" does not send the email notification to the user on its turn. """ - role: Optional[CollaboratorRole] = None - signing_order: Optional[int] = None + role: CollaboratorRole + signing_order: Optional[int] = dataclass_field(default=None, kw_only=True) """ Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to \"CUSTOM\". @@ -3886,20 +4895,20 @@ class WorkflowPlaceholderUpdateRequest: Definition: WorkflowPlaceholderUpdateRequest """ - placeholder: Optional[str] = None + placeholder: Optional[str] = dataclass_field(default=None, kw_only=True) """ The name of the new placeholder to be added in workflow. If no value is provided, old value will be retained. """ - email_notification: Optional[bool] = None + email_notification: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Setting its value to \"true\" sends an email notification to the user when its turn arrives in workflow. Setting its value to \"false\" does not send the email notification to the user on its turn. If no value is provided, old value will be retained. """ - role: Optional[WorkflowCollaboratorRole] = None - signing_order: Optional[int] = None + role: WorkflowCollaboratorRole + signing_order: Optional[int] = dataclass_field(default=None, kw_only=True) """ Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to \"CUSTOM\". @@ -3912,9 +4921,14 @@ class UpdateWorkSpaceRequest: Definition: UpdateWorkSpaceRequest """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of shared space""" - members: Optional[List[WorkSpaceMembers]] = None + members: Optional[ + List[WorkSpaceMembers | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Members of shared space""" @@ -3924,7 +4938,7 @@ class MoveToRequest: Definition: MoveToRequest """ - folder_name: Optional[str] = None + folder_name: str """Target folder name in which package need to move""" @@ -3934,50 +4948,69 @@ class DigitalSignatureFieldResponse: Definition: DigitalSignatureFieldResponse """ - order: Optional[int] = None + order: int """ Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null. """ - display_order: Optional[int] = None + display_order: int """Display order according to the SigningHub viewer.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - embedded: Optional[bool] = None + embedded: bool """True, if field is part of the PDF document.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER. """ - process_status: Optional[str] = None + process_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED. """ - processed_on: Optional[str] = None + processed_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date time on which the document is processed.""" - processed_as: Optional[str] = None + processed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """ User who processed the field as COLLABORATOR, DELEGATEE, GROUP_MEMBER or OWNER. """ - created_on: Optional[str] = None + created_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date time on which the field is added""" - processed_by: Optional[str] = None + processed_by: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the user who processed the field.""" - dimensions: Optional[FieldDimenssionResponse] = None - verification: Optional[VerificationResponse] = None - nid: Optional[str] = None - display: Optional[str] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + verification: Optional[ + VerificationResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + nid: Optional[str] = dataclass_field(default=None, kw_only=True) + display: Optional[str] = dataclass_field(default=None, kw_only=True) """ Returns the visibility value of the digital signature field, possible values are \"VISIBLE\" and \"INVISIBLE\". """ - level_of_assurance: Optional[List[str]] = None - authentication: Optional[FieldAuthentication] = None + level_of_assurance: Optional[List[str]] = dataclass_field(default=None, kw_only=True) + authentication: Optional[ + FieldAuthentication | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -3986,8 +5019,8 @@ class FieldDimenssionResponse: Definition: FieldDimenssionResponse """ - field: Optional[FieldResponse] = None - page: Optional[PageResponse] = None + field: Optional[FieldResponse | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + page: Optional[PageResponse | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -3996,13 +5029,13 @@ class FieldResponse: Definition: FieldResponse """ - x: Optional[float] = None + x: float """Left location of the field in pixel.""" - y: Optional[float] = None + y: float """Top location of the field in pixel.""" - width: Optional[float] = None + width: float """Width of the field in pixel.""" - height: Optional[float] = None + height: float """Height of the field in pixel.""" @@ -4012,9 +5045,9 @@ class PageResponse: Definition: PageResponse """ - width: Optional[float] = None + width: float """Width of the page where field is placed in the PDF.""" - height: Optional[float] = None + height: float """Height of the page where field is placed in the PDF.""" @@ -4024,12 +5057,22 @@ class FieldAuthentication: Definition: FieldAuthentication """ - enabled: Optional[bool] = None + enabled: bool """ True, if authentications are enabled for the electronic signature fields. """ - sms_otp: Optional[AccessSecuritySmsOtpResponse] = None - totp: Optional[AccessSecurityTOTPResponse] = None + sms_otp: Optional[ + AccessSecuritySmsOtpResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + totp: Optional[ + AccessSecurityTOTPResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -4038,7 +5081,7 @@ class AccessSecurityTOTPResponse: Definition: AccessSecurityTOTPResponse """ - enabled: Optional[bool] = None + enabled: bool """True, if TOTP authentication is enabled for the package.""" @@ -4048,40 +5091,49 @@ class HandSignatureFieldResponse: Definition: HandSignatureFieldResponse """ - order: Optional[int] = None + order: int """ Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null. """ - display_order: Optional[int] = None + display_order: int """Display order according to the SigningHub viewer.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - embedded: Optional[bool] = None + embedded: bool """True, if field is part of the PDF document.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER. """ - process_status: Optional[str] = None + process_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED. """ - processed_on: Optional[str] = None + processed_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date time on which the document is processed.""" - processed_as: Optional[str] = None + processed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """ User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER. """ - processed_by: Optional[str] = None + processed_by: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the user who processed the field.""" - dimensions: Optional[FieldDimenssionResponse] = None - nid: Optional[str] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + nid: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -4090,47 +5142,66 @@ class ElectronicSignatureFieldResponse: Definition: ElectronicSignatureFieldResponse """ - order: Optional[int] = None + order: int """Email address of the user who processed the field.""" - display_order: Optional[int] = None + display_order: int """Display order according to the SigningHub viewer.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - embedded: Optional[bool] = None + embedded: bool """True, if field is part of the PDF document.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER. """ - process_status: Optional[str] = None + process_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED. """ - processed_on: Optional[str] = None + processed_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date time on which the document is processed.""" - processed_as: Optional[str] = None + processed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """ User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER. """ - processed_by: Optional[str] = None + processed_by: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the user who processed the field.""" - dimensions: Optional[FieldDimenssionResponse] = None - signature_sub_type: Optional[str] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + signature_sub_type: Optional[str] = dataclass_field(default=None, kw_only=True) """ The signature sub-type can be a WITNESS signature. If witness signatures are enabled in service plan, E-Signature fields are signed with a common certificate shared by all the users in the service plan. Possible values are WITNESS or NONE. """ - authentication: Optional[FieldAuthentication] = None - verification: Optional[VerificationResponse] = None - nid: Optional[str] = None - display: Optional[str] = None + authentication: Optional[ + FieldAuthentication | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + verification: Optional[ + VerificationResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + nid: Optional[str] = dataclass_field(default=None, kw_only=True) + display: Optional[str] = dataclass_field(default=None, kw_only=True) """ Returns the visibility value of the electronic signature field, possible values are \"VISIBLE\" and \"INVISIBLE\". @@ -4143,33 +5214,38 @@ class InitialFieldResponse: Definition: InitialFieldResponse """ - order: Optional[int] = None + order: int """ Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null. """ - display_order: Optional[int] = None + display_order: int """Display order according to the SigningHub viewer.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - process_status: Optional[str] = None + process_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED. """ - processed_on: Optional[str] = None + processed_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date time on which the document is processed.""" - processed_as: Optional[str] = None + processed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """ User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER. """ - processed_by: Optional[str] = None + processed_by: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the user who processed the field.""" - dimensions: Optional[FieldDimenssionResponse] = None - embedded: Optional[bool] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + embedded: bool """True, if field is part of the PDF document.""" @@ -4179,56 +5255,75 @@ class InPersonFieldResponse: Definition: InPersonFieldResponse """ - order: Optional[int] = None + order: int """ Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null. """ - display_order: Optional[int] = None + display_order: int """Display order according to the SigningHub viewer.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - embedded: Optional[bool] = None + embedded: bool """True, if field is part of the PDF document.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) - process_status: Optional[str] = None + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) + process_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED. """ - processed_on: Optional[str] = None + processed_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date time on which the document is processed.""" - processed_as: Optional[str] = None + processed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """ User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER. """ - processed_by: Optional[str] = None + processed_by: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the user who processed the field.""" - placeholder: Optional[str] = None + placeholder: Optional[str] = dataclass_field(default=None, kw_only=True) """ Name of the in-person signer or placeholder e.g., Customer, Sales Representative etc. """ - signature_sub_type: Optional[str] = None + signature_sub_type: Optional[str] = dataclass_field(default=None, kw_only=True) """ The signature sub-type for in-person signatures can be a WITNESS signature. If witness signatures are enabled in service plan, In-person fields are signed with a common certificate shared by all the users in the service plan. Possible values are WITNESS or NONE. """ - dimensions: Optional[FieldDimenssionResponse] = None - verification: Optional[VerificationResponse] = None - display: Optional[str] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + verification: Optional[ + VerificationResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + display: Optional[str] = dataclass_field(default=None, kw_only=True) """ Returns the visibility value of the inperson field, possible values are \"VISIBLE\" and \"INVISIBLE\". """ - level_of_assurance: Optional[List[str]] = None + level_of_assurance: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """In Person selected level of assurances""" - authentication: Optional[FieldAuthentication] = None + authentication: Optional[ + FieldAuthentication | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -4237,29 +5332,33 @@ class TextFieldResponse: Definition: TextFieldResponse """ - required: Optional[bool] = None + required: bool """True if field required in pdf""" - order: Optional[int] = None + order: int """ Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null. """ - tab_order: Optional[int] = None + tab_order: int """Tab order in the PDF document""" - display_order: Optional[int] = None + display_order: int """Display order according to the SigningHub viewer.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - embedded: Optional[bool] = None + embedded: bool """True, if field is part of the PDF document.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ Type of the text field, possible values are \"TEXT\", \"NAME\", \"COMPANY\", \"JOBTITLE\", \"EMAIL\", \"DATE\". """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """ Value of the field. For type = DATE or format_type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss @@ -4267,29 +5366,34 @@ class TextFieldResponse: YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned. """ - read_only: Optional[bool] = None + read_only: bool """True, if the field is marked read only in the PDF document.""" - validation_rule: Optional[str] = None + validation_rule: Optional[str] = dataclass_field(default=None, kw_only=True) """ One or more rules for validation of the fields, possible values are \"MANDATORY\" or \"OPTIONAL\". """ - validation: Optional[FieldValidationValue] = None - visible: Optional[bool] = None + validation: Optional[ + FieldValidationValue | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + visible: bool """True, if the field is not hidden in the PDF document.""" - multiline: Optional[bool] = None + multiline: bool """True, if the field is multi line in the PDF document.""" - font: Optional[FontResponse] = None - max_length: Optional[int] = None + font: Optional[FontResponse | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + max_length: int """Maximum content length allowed to be filled in the field.""" - format_type: Optional[str] = None + format_type: Optional[str] = dataclass_field(default=None, kw_only=True) """ If field is a textbox it can follow different input types. Possible values are ALPHANUMERIC, NUMBER, TEXT, EMAIL, TIME or DATE. """ - placeholder: Optional[str] = None + placeholder: Optional[str] = dataclass_field(default=None, kw_only=True) """Placeholder text for the textbox field.""" - format: Optional[str] = None + format: Optional[str] = dataclass_field(default=None, kw_only=True) """

Text format of the field. Used for the date type field only. Possible values are

  • m/d
  • m/d/yy
  • m/d/yyyy
    • @@ -4299,20 +5403,25 @@ class TextFieldResponse:
  • mmm-yyyy
  • mmmm-yy
  • mmmm-yyyy
  • mmmm d, yyyy
  • dd/mm/yy
  • ddmmmyyyy
""" - color: Optional[str] = None + color: Optional[str] = dataclass_field(default=None, kw_only=True) """Color of the text in the form fields.""" - border_color: Optional[str] = None + border_color: Optional[str] = dataclass_field(default=None, kw_only=True) """Border color of the form field.""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """tooltip of the form field.""" - field_rotation: Optional[int] = None + field_rotation: int """Field Rotation""" - align: Optional[str] = None + align: Optional[str] = dataclass_field(default=None, kw_only=True) """ Text alignment for the form field. Possible values are \"RIGHT\", \"LEFT\", \"CENTER\" or \"JUSTIFY\" """ - dimensions: Optional[FieldDimenssionResponse] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -4321,47 +5430,56 @@ class RadioFieldResponse: Definition: RadioFieldResponse """ - required: Optional[bool] = None + required: bool """True if field required in pdf""" - order: Optional[int] = None + order: int """ Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null. """ - tab_order: Optional[int] = None + tab_order: int """Tab order in the PDF document.""" - display_order: Optional[int] = None + display_order: int """Display order according to the SigningHub viewer.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - embedded: Optional[bool] = None + embedded: bool """True, if field is part of the PDF document.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) - value: Optional[bool] = None + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) + value: bool """Value of the field.""" - read_only: Optional[bool] = None + read_only: bool """True, if the field is marked readonly in the PDF document.""" - validation_rule: Optional[str] = None + validation_rule: Optional[str] = dataclass_field(default=None, kw_only=True) """ One or more rules for validation of the fields possible values are \"MANDATORY\" or \"OPTIONAL\". """ - radio_group_name: Optional[str] = None + radio_group_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The group name to which the field belongs.""" - checked: Optional[bool] = None + checked: bool """True, if the field is selected""" - visible: Optional[bool] = None + visible: bool """True if the field is not hidden in the PDF document.""" - dimensions: Optional[FieldDimenssionResponse] = None - color: Optional[str] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + color: Optional[str] = dataclass_field(default=None, kw_only=True) """Color of the text in the form fields.""" - border_color: Optional[str] = None + border_color: Optional[str] = dataclass_field(default=None, kw_only=True) """Border color of the form field.""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """tooltip of the form field.""" - field_rotation: Optional[int] = None + field_rotation: int """Field Rotation""" @@ -4371,45 +5489,54 @@ class CheckboxFieldResponse: Definition: CheckboxFieldResponse """ - required: Optional[bool] = None + required: bool """True if field required in pdf""" - order: Optional[int] = None + order: int """ Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null. """ - tab_order: Optional[int] = None + tab_order: int """Tab order in the PDF document""" - display_order: Optional[int] = None + display_order: int """Display order according to the SigningHub viewer.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - embedded: Optional[bool] = None + embedded: bool """True, if field is part of the PDF document.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) - value: Optional[bool] = None + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) + value: bool """Value of the field.""" - read_only: Optional[bool] = None + read_only: bool """True, if the field is marked read only in the PDF document.""" - checked: Optional[bool] = None + checked: bool """True if the field is selected.""" - visible: Optional[bool] = None + visible: bool """True if the field is not hidden in the PDF document.""" - validation_rule: Optional[str] = None + validation_rule: Optional[str] = dataclass_field(default=None, kw_only=True) """ One or more rules for validation of the fields possible values are \"MANDATORY\" or \"OPTIONAL\". """ - dimensions: Optional[FieldDimenssionResponse] = None - color: Optional[str] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + color: Optional[str] = dataclass_field(default=None, kw_only=True) """Color of the text in the form fields.""" - border_color: Optional[str] = None + border_color: Optional[str] = dataclass_field(default=None, kw_only=True) """Border color of the form field.""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """tooltip of the form field.""" - field_rotation: Optional[int] = None + field_rotation: int """Field Rotation""" @@ -4419,45 +5546,50 @@ class DropdownFieldResponse: Definition: DropdownFieldResponse """ - required: Optional[bool] = None + required: bool """True if field required in pdf""" - order: Optional[int] = None + order: int """ Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null. """ - tab_order: Optional[int] = None + tab_order: int """Tab order in the PDF document.""" - display_order: Optional[int] = None + display_order: int """Display order according to the SigningHub viewer.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - embedded: Optional[bool] = None + embedded: bool """True, if field is part of the PDF document.""" - validation_rule: Optional[str] = None + validation_rule: Optional[str] = dataclass_field(default=None, kw_only=True) """ One or more rules for validation of the fields possible values are \"MANDATORY\" or \"OPTIONAL\". """ - read_only: Optional[bool] = None + read_only: bool """True, if the field is marked read only in the PDF document.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value of the field .""" - choices: Optional[List[str]] = None + choices: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Choices available for the dropdown to choose a value from.""" - visible: Optional[bool] = None + visible: bool """True, if the field is not hidden in the PDF document.""" - dimensions: Optional[FieldDimenssionResponse] = None - font: Optional[FontResponse] = None - color: Optional[str] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + font: Optional[FontResponse | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + color: Optional[str] = dataclass_field(default=None, kw_only=True) """Color of the text in the form fields.""" - border_color: Optional[str] = None + border_color: Optional[str] = dataclass_field(default=None, kw_only=True) """Border color of the form field.""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """tooltip of the form field.""" - field_rotation: Optional[int] = None + field_rotation: int """Field Rotation""" @@ -4467,43 +5599,48 @@ class ListBoxFieldResponse: Definition: ListBoxFieldResponse """ - order: Optional[int] = None + order: int """ Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null. """ - tab_order: Optional[int] = None + tab_order: int """Tab order in the PDF document.""" - display_order: Optional[int] = None + display_order: int """Display order according to the SigningHub viewer.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - embedded: Optional[bool] = None + embedded: bool """True, if field is part of the PDF document.""" - validation_rule: Optional[str] = None + validation_rule: Optional[str] = dataclass_field(default=None, kw_only=True) """ One or more rules for validation of the fields possible values are \"MANDATORY\" or \"OPTIONAL\". """ - read_only: Optional[bool] = None + read_only: bool """True, if the field is marked read only in the PDF document.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value of the field.""" - choices: Optional[List[str]] = None + choices: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Choices available for the dropdown to choose a value from.""" - visible: Optional[bool] = None + visible: bool """True, if the field is not hidden in the PDF document.""" - dimensions: Optional[FieldDimenssionResponse] = None - font: Optional[FontResponse] = None - color: Optional[str] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + font: Optional[FontResponse | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + color: Optional[str] = dataclass_field(default=None, kw_only=True) """Color of the text in the form fields.""" - border_color: Optional[str] = None + border_color: Optional[str] = dataclass_field(default=None, kw_only=True) """Border color of the form field.""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """tooltip of the form field.""" - field_rotation: Optional[int] = None + field_rotation: int """Field Rotation""" @@ -4513,15 +5650,15 @@ class FontResponse: Definition: FontResponse """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Font name for the text field. For user defined fields SigningHub only support \"COURIER\", \"HELVETICA\". In case of existing fields in a PDF file, font value can be anything that is set in the PDF. """ - size: Optional[int] = None + size: int """Font size for the text field.""" - embedded_size: Optional[float] = None + embedded_size: float """Size of the font in the original PDF document.""" @@ -4531,24 +5668,38 @@ class QrCodeResponse: Definition: QrCodeResponse """ - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Field Type PDF_FIELD_TYPE like QR""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """QrCode generated base64 will be provided inly in draft mode""" - dimensions: Optional[FieldDimenssionResponse] = None - data: Optional[str] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + data: Optional[str] = dataclass_field(default=None, kw_only=True) """ The plain text data to be encoded in the QR code. Default is URL generated to access the related document. e.g. {base_url}/document/{document_unique_id} """ - options: Optional[QrCodeOptions] = None - color: Optional[QrCodeColor] = None - logo: Optional[QrCodeLogo] = None + options: Optional[ + QrCodeOptions | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + color: Optional[QrCodeColor | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + logo: Optional[QrCodeLogo | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -4557,37 +5708,43 @@ class AttachmentFieldResponse: Definition: AttachmentFieldResponse """ - order: Optional[int] = None + order: int """Order of the recipient to whom this field is assigned.""" - display_order: Optional[int] = None + display_order: int """Display order according to the SigningHub viewer.""" - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - process_status: Optional[str] = None + process_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED. """ - processed_on: Optional[str] = None + processed_on: Optional[str] = dataclass_field(default=None, kw_only=True) """Date time on which the document is processed.""" - processed_as: Optional[str] = None + processed_as: Optional[str] = dataclass_field(default=None, kw_only=True) """ User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER. """ - processed_by: Optional[str] = None + processed_by: Optional[str] = dataclass_field(default=None, kw_only=True) """Email address of the user who processed the field.""" - attachment_ref_id: Optional[int] = field( + attachment_ref_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "attachmentRefId"}, ) """Attachmet ref id""" - note: Optional[str] = None + note: Optional[str] = dataclass_field(default=None, kw_only=True) """Attachmet note Only in case of \"MANDATORY\" attachment rule""" - validation_rule: Optional[ValidationRule] = None - dimensions: Optional[FieldDimenssionResponse] = None + validation_rule: ValidationRule + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -4596,17 +5753,27 @@ class CommentFieldResponse: Definition: CommentFieldResponse """ - id: Optional[int] = None + id: int """Comment field id""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - unread_count: Optional[int] = None + unread_count: int """Unread comments""" - private: Optional[bool] = None + private: bool """Private""" - recipients: Optional[List[CommentFieldRecipientResponse]] = None + recipients: Optional[ + List[CommentFieldRecipientResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Recipients""" - dimensions: Optional[FieldDimenssionResponse] = None + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -4615,14 +5782,19 @@ class UniqueIdentifierFieldResponse: Definition: UniqueIdentifierFieldResponse """ - field_name: Optional[str] = None + field_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the field.""" - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """Value of the field.""" - page_no: Optional[int] = None + page_no: int """Page number of the document on which the field exists.""" - font: Optional[FontResponse] = None - dimensions: Optional[FieldDimenssionResponse] = None + font: Optional[FontResponse | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + dimensions: Optional[ + FieldDimenssionResponse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -4631,9 +5803,9 @@ class CommentFieldRecipientResponse: Definition: CommentFieldRecipientResponse """ - user_name: Optional[str] = None + user_name: Optional[str] = dataclass_field(default=None, kw_only=True) """User name""" - user_email: Optional[str] = None + user_email: Optional[str] = dataclass_field(default=None, kw_only=True) """User email""" @@ -4643,15 +5815,15 @@ class AssignFieldRequest: Definition: AssignFieldRequest """ - field_name: Optional[str] = None + field_name: str """Name of the signature field that is to be assigned.""" - radio_group_name: Optional[str] = None + radio_group_name: Optional[str] = dataclass_field(default=None, kw_only=True) """provide group name for radio box""" - order: Optional[int] = None + order: int """ The order of the user in workflow, to which the field is being assigned. """ - level_of_assurance: Optional[List[str]] = None + level_of_assurance: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Level Of Assurance to be added. Possible Values are \"ELECTRONIC_SIGNATURE\", \"ELECTRONIC_SEAL\", @@ -4672,7 +5844,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -4689,8 +5861,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -4711,7 +5883,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -4726,7 +5898,84 @@ def __init__( def connector_name(self) -> str: return "signinghub" - async def attachment_delete_attachment_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def attachment_delete_attachment( self, package_id: int, document_id: int, @@ -4742,6 +5991,24 @@ async def attachment_delete_attachment_async( Business applications can use this service API to delete the attachment of a document. + + Swagger operation ID: `V4_Attachment_DeleteAttachment`. + + Args: + package_id: Package ID of the package to which the document is + added. + document_id: ID of the document to which the attachment is added. + attachment_id: ID of the attachment. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4754,7 +6021,7 @@ async def attachment_delete_attachment_async( f"/{quote(str(attachment_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -4768,6 +6035,7 @@ async def attachment_delete_attachment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4775,7 +6043,7 @@ async def attachment_delete_attachment_async( return json.loads(response.text) - async def attachment_download_attachment_async( + async def attachment_download_attachment( self, package_id: int, document_id: int, @@ -4791,6 +6059,24 @@ async def attachment_download_attachment_async( Business applications can use this service API to download the attachment of a document. + + Swagger operation ID: `V4_Attachment_DownloadAttachment`. + + Args: + package_id: Package ID of the package to which the document is + added. + document_id: ID of the document to which the attachment is added. + attachment_id: ID of the attachment. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4803,7 +6089,7 @@ async def attachment_download_attachment_async( f"/{quote(str(attachment_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4817,6 +6103,7 @@ async def attachment_download_attachment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4824,7 +6111,7 @@ async def attachment_download_attachment_async( return json.loads(response.text) - async def attachment_get_attachments_async( + def list_attachment_get_attachments( self, package_id: int, document_id: int, @@ -4833,12 +6120,32 @@ async def attachment_get_attachments_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Attachments Business applications can use this service API to get the attachments of a document. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `V4_Attachment_GetAttachments`. + + Args: + package_id: Package ID of the package to which the document is + added. + document_id: ID of the document to which the attachment is added. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4849,29 +6156,50 @@ async def attachment_get_attachments_async( f"/{quote(str(document_id), safe='')}" f"/attachments" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def attachment_upload_attachment_async( + return AsyncItemPaged(get_next, extract_data) + + async def attachment_upload_attachment( self, input: bytes, package_id: int, @@ -4887,6 +6215,25 @@ async def attachment_upload_attachment_async( Business applications can use this service API to upload a attachment in a document. + + Swagger operation ID: `V4_Attachment_UploadAttachment`. + + Args: + input: The binary request body. + package_id: Package ID of the package to which the document is + added. + document_id: ID of the document to which the attachment needs to be + add. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4898,7 +6245,7 @@ async def attachment_upload_attachment_async( f"/attachments" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -4915,6 +6262,7 @@ async def attachment_upload_attachment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4922,9 +6270,9 @@ async def attachment_upload_attachment_async( return json.loads(response.text) - async def checkbox_add_check_box_async( + async def checkbox_add_check_box( self, - input: CheckBoxFieldRequest, + input: CheckBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -4950,6 +6298,24 @@ async def checkbox_add_check_box_async( will be assigned. If either width or height (or both) is provided, the system will compare these provided values with each other. The larger value between width and height will be assigned to both dimensions. + + Swagger operation ID: `V4_Checkbox_AddCheckBox`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4962,7 +6328,7 @@ async def checkbox_add_check_box_async( f"/checkbox" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4976,6 +6342,7 @@ async def checkbox_add_check_box_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4983,9 +6350,9 @@ async def checkbox_add_check_box_async( return json.loads(response.text) - async def checkbox_update_check_box_async( + async def checkbox_update_check_box( self, - input: UpdateCheckBoxFieldRequest, + input: UpdateCheckBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -5006,6 +6373,24 @@ async def checkbox_update_check_box_async( be used when a template was applied or the document was created using the GUI interface. It's width and height cannot be updated. They will remain the same as when they were added. + + Swagger operation ID: `V4_Checkbox_UpdateCheckBox`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5018,7 +6403,7 @@ async def checkbox_update_check_box_async( f"/checkbox" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5032,6 +6417,7 @@ async def checkbox_update_check_box_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5039,18 +6425,18 @@ async def checkbox_update_check_box_async( return json.loads(response.text) - async def contacts_get_async( + def list_contacts_get( self, record_per_page: int, page_no: int, + *, sort_by: Optional[str] = None, asc: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Contacts @@ -5061,6 +6447,27 @@ async def contacts_get_async( specific contacts or that of the enterprise to which the user belongs. The search response information contains the user email address and respective user name. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `V4_Contacts_Get`. + + Args: + record_per_page: Total number of records to be retrieved in a page. + page_no: Page number to be retrieved. + sort_by: Sort the result by possible values are mentioned above. + asc: Order the result set by ascending or descending. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5083,29 +6490,50 @@ async def contacts_get_async( query_params.append(f"asc={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def documents_delete_document_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def documents_delete_document( self, package_id: int, document_id: int, @@ -5120,6 +6548,23 @@ async def documents_delete_document_async( Business applications can use this service API to delete a document in a package. + + Swagger operation ID: `V4_Documents_DeleteDocument`. + + Args: + package_id: Package ID of the package to which the document is + added. + document_id: ID of the document to be deleted. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5130,7 +6575,7 @@ async def documents_delete_document_async( f"/{quote(str(document_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5144,6 +6589,7 @@ async def documents_delete_document_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5151,7 +6597,7 @@ async def documents_delete_document_async( return json.loads(response.text) - async def documents_download_document_bytes_async( + async def documents_download_document_bytes( self, package_id: int, document_id: int, @@ -5166,6 +6612,23 @@ async def documents_download_document_bytes_async( Business applications can use this service API to download the document bytes. The package ID and document ID is provided in the resource URL. + + Swagger operation ID: `V4_Documents_DownloadDocumentBytes`. + + Args: + package_id: Package ID of the package to which the document is + added. + document_id: The ID of the document to be downloaded. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5176,7 +6639,7 @@ async def documents_download_document_bytes_async( f"/{quote(str(document_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5190,6 +6653,7 @@ async def documents_download_document_bytes_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5197,7 +6661,7 @@ async def documents_download_document_bytes_async( return json.loads(response.text) - async def documents_get_certify_policy_async( + async def documents_get_certify_policy( self, package_id: int, document_id: int, @@ -5212,6 +6676,23 @@ async def documents_get_certify_policy_async( Business applications can use this service API to get certify signature settings of a document in a package. + + Swagger operation ID: `V4_Documents_GetCertifyPolicy`. + + Args: + package_id: Package ID of the package to which the document is + added. + document_id: The ID of the document to be downloaded. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5223,7 +6704,7 @@ async def documents_get_certify_policy_async( f"/certify" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5237,6 +6718,7 @@ async def documents_get_certify_policy_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5244,7 +6726,7 @@ async def documents_get_certify_policy_async( return json.loads(response.text) - async def documents_get_document_details_async( + async def documents_get_document_details( self, package_id: int, document_id: int, @@ -5259,6 +6741,24 @@ async def documents_get_document_details_async( Business applications can use this service API to get the document details. The document ID is provided in the URL as \"{document_id}\". + + Swagger operation ID: `V4_Documents_GetDocumentDetails`. + + Args: + package_id: The Package ID of the package to which the document is + added. + document_id: The document ID for which the document details are + requested. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5270,7 +6770,7 @@ async def documents_get_document_details_async( f"/details" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5284,6 +6784,7 @@ async def documents_get_document_details_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5291,9 +6792,9 @@ async def documents_get_document_details_async( return json.loads(response.text) - async def documents_rename_document_async( + async def documents_rename_document( self, - input: RenameDocumentRequest, + input: RenameDocumentRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -5307,6 +6808,26 @@ async def documents_rename_document_async( Business applications can use this service API to rename a document in a package. + + Swagger operation ID: `V4_Documents_RenameDocument`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID of the package to which the document is + added. + document_id: The ID of the document to on which the action is to be + performed. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5317,7 +6838,7 @@ async def documents_rename_document_async( f"/{quote(str(document_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5331,6 +6852,7 @@ async def documents_rename_document_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5338,9 +6860,9 @@ async def documents_rename_document_async( return json.loads(response.text) - async def documents_update_certify_policy_async( + async def documents_update_certify_policy( self, - input: UpdateCertifyPolicyRequest, + input: UpdateCertifyPolicyRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -5354,6 +6876,26 @@ async def documents_update_certify_policy_async( Business applications can use this service API to update certify signature settings for a document in a package. + + Swagger operation ID: `V4_Documents_UpdateCertifyPolicy`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID of the package to which the document is + added. + document_id: The ID of the document on which the action is to be + performed. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5365,7 +6907,7 @@ async def documents_update_certify_policy_async( f"/certify" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5379,6 +6921,7 @@ async def documents_update_certify_policy_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5386,7 +6929,7 @@ async def documents_update_certify_policy_async( return json.loads(response.text) - async def documents_upload_from_library_async( + async def documents_upload_from_library( self, package_id: int, document_id: int, @@ -5405,6 +6948,23 @@ async def documents_upload_from_library_async( resource URL to identify the library document to be copied. Note a package must already exist before you can add a document using this call. + + Swagger operation ID: `V4_Documents_UploadFromLibrary`. + + Args: + package_id: The Package ID of the package to which the document is + being added. + document_id: The library document ID that need to add/updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5416,7 +6976,7 @@ async def documents_upload_from_library_async( f"/{quote(str(document_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -5430,6 +6990,7 @@ async def documents_upload_from_library_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5437,7 +6998,7 @@ async def documents_upload_from_library_async( return json.loads(response.text) - async def documents_upload_stream_async( + async def documents_upload_stream( self, input: bytes, package_id: int, @@ -5461,13 +7022,30 @@ async def documents_upload_stream_async( converted to PDF format upon upload.Click here for the full list. Note PDF documents are not altered upon upload to the system. Note a package must already exist before you can add a document using this call. + + Swagger operation ID: `V4_Documents_UploadStream`. + + Args: + input: The binary request body. + package_id: Package ID of the package to which the document is + being added. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/documents" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -5484,6 +7062,7 @@ async def documents_upload_stream_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5491,7 +7070,7 @@ async def documents_upload_stream_async( return json.loads(response.text) - async def enterprise_documents_get_enterprise_workflow_access_async( + async def enterprise_documents_get_enterprise_workflow_access( self, package_id: int, order: int, @@ -5512,6 +7091,25 @@ async def enterprise_documents_get_enterprise_workflow_access_async( to access document package outside the scope of this duration if the access security is enabled. Document owner can also configure authentication based security of the package for a recipient. + + Swagger operation ID: + `V4_EnterpriseDocuments_GetEnterpriseWorkflowAccess`. + + Args: + package_id: The package ID for which workflow access security and + authentication is to be updated. + order: Order of the recipient in the workflow for which the access + security and authentication is to be updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5524,7 +7122,7 @@ async def enterprise_documents_get_enterprise_workflow_access_async( f"/authentication" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5538,6 +7136,7 @@ async def enterprise_documents_get_enterprise_workflow_access_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5545,9 +7144,9 @@ async def enterprise_documents_get_enterprise_workflow_access_async( return json.loads(response.text) - async def enterprise_documents_update_enterprise_workflow_access_async( + async def enterprise_documents_update_enterprise_workflow_access( self, - input: AccessUpdateRequest, + input: AccessUpdateRequest | Mapping[str, Any], package_id: int, order: int, *, @@ -5564,6 +7163,27 @@ async def enterprise_documents_update_enterprise_workflow_access_async( authentications and access duration for the recipients. This API can also be used by the enterprise administrator or the enterprise user if the \"scope\" variable was used in the authentication request + + Swagger operation ID: + `V4_EnterpriseDocuments_UpdateEnterpriseWorkflowAccess`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The package ID for which workflow access security and + authentication is to be updated. + order: Order of the recipient in the workflow for which the access + security and authentication is to be updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5576,7 +7196,7 @@ async def enterprise_documents_update_enterprise_workflow_access_async( f"/authentication" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5590,6 +7210,7 @@ async def enterprise_documents_update_enterprise_workflow_access_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5597,7 +7218,7 @@ async def enterprise_documents_update_enterprise_workflow_access_async( return json.loads(response.text) - async def fields_auto_assign_field_async( + async def fields_auto_assign_field( self, input: FieldsAutoAssignFieldInput, package_id: int, @@ -5621,6 +7242,24 @@ async def fields_auto_assign_field_async( they are numbered \"1\", \"2\", and \"3\" respectfully.This API call allows you to assign a user by their workflow order number, to an input field on the document. + + Swagger operation ID: `V4_Fields_AutoAssignField`. + + Args: + input: The request body. + package_id: Package ID to which the document is added. + document_id: The document ID for which workflow user needs to be + updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5633,7 +7272,7 @@ async def fields_auto_assign_field_async( f"/assign" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5647,6 +7286,7 @@ async def fields_auto_assign_field_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5654,9 +7294,9 @@ async def fields_auto_assign_field_async( return json.loads(response.text) - async def fields_auto_place_async( + async def fields_auto_place( self, - input: AutoPlaceFieldRequest, + input: AutoPlaceFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -5693,6 +7333,25 @@ async def fields_auto_place_async( Workflow](#operation/Workflow_WorkflowAddUser) for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. + + Swagger operation ID: `V4_Fields_AutoPlace`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The ID of the package to which the document is added. + document_id: The ID of the document for which the fields are + requested. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5705,7 +7364,7 @@ async def fields_auto_place_async( f"/autoplace" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5719,6 +7378,7 @@ async def fields_auto_place_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5726,9 +7386,9 @@ async def fields_auto_place_async( return json.loads(response.text) - async def fields_delete_document_field_async( + async def fields_delete_document_field( self, - input: DeleteDocumentFieldRequest, + input: DeleteDocumentFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -5742,6 +7402,24 @@ async def fields_delete_document_field_async( Business applications can use this service API to delete a field of document in a package. + + Swagger operation ID: `V4_Fields_DeleteDocumentField`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5753,7 +7431,7 @@ async def fields_delete_document_field_async( f"/fields" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=input, timeout=timeout, headers=headers, @@ -5767,6 +7445,7 @@ async def fields_delete_document_field_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5774,9 +7453,9 @@ async def fields_delete_document_field_async( return json.loads(response.text) - async def fields_fill_form_fields_async( + async def fields_fill_form_fields( self, - input: FormFillingRequest, + input: FormFillingRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -5790,6 +7469,24 @@ async def fields_fill_form_fields_async( Business applications can use this service API to fill one or more form fields in a document by a specified user in the order. + + Swagger operation ID: `V4_Fields_FillFormFields`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The ID of the document. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5801,7 +7498,7 @@ async def fields_fill_form_fields_async( f"/fields" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5815,6 +7512,7 @@ async def fields_fill_form_fields_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5822,7 +7520,7 @@ async def fields_fill_form_fields_async( return json.loads(response.text) - async def fields_get_all_document_fields_async( + async def fields_get_all_document_fields( self, package_id: int, document_id: int, @@ -5838,6 +7536,26 @@ async def fields_get_all_document_fields_async( Business applications can use this service API to get document fields i.e., initials, in-persons, signature fields or form fields. + + Swagger operation ID: `V4_Fields_GetAllDocumentFields`. + + Args: + package_id: The ID of the package to which the document is added. + document_id: The ID of the document for which the fields are + requested. + page_no: Page no of the document for which the fields are + requested. If page number is not provided fields of whole + document are returned. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5850,7 +7568,7 @@ async def fields_get_all_document_fields_async( f"/{quote(str(page_no), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5864,6 +7582,7 @@ async def fields_get_all_document_fields_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5871,9 +7590,9 @@ async def fields_get_all_document_fields_async( return json.loads(response.text) - async def folder_move_package_async( + async def folder_move_package( self, - input: MoveToRequest, + input: MoveToRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, @@ -5886,13 +7605,30 @@ async def folder_move_package_async( Business applications can use this service API to move the document package to a shared space or user's custom folder. + + Swagger operation ID: `V4_Folder_MovePackage`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package id that need to move to folder. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/move_to" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -5906,6 +7642,7 @@ async def folder_move_package_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5913,9 +7650,9 @@ async def folder_move_package_async( return json.loads(response.text) - async def initials_add_initial_async( + async def initials_add_initial( self, - input: InitialFieldRequest, + input: InitialFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -5937,6 +7674,24 @@ async def initials_add_initial_async( Workflow](#operation/Workflow_WorkflowAddUser) for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. + + Swagger operation ID: `V4_Initials_AddInitial`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5949,7 +7704,7 @@ async def initials_add_initial_async( f"/initials" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5963,6 +7718,7 @@ async def initials_add_initial_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5970,9 +7726,9 @@ async def initials_add_initial_async( return json.loads(response.text) - async def initials_fill_async( + async def initials_fill( self, - input: InitialFillingRequest, + input: InitialFillingRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -5986,6 +7742,24 @@ async def initials_fill_async( Business applications can use this service API to fill an initials field in a document by a specified user in the order. + + Swagger operation ID: `V4_Initials_Fill`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The ID of the document. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5997,7 +7771,7 @@ async def initials_fill_async( f"/initial" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6011,6 +7785,7 @@ async def initials_fill_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6018,9 +7793,9 @@ async def initials_fill_async( return json.loads(response.text) - async def initials_update_initial_async( + async def initials_update_initial( self, - input: UpdateInitialFieldRequest, + input: UpdateInitialFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -6040,6 +7815,24 @@ async def initials_update_initial_async( Document Fields](#operation/Documents_GetDocumentFields).The latter can be used when a template was applied or the document was created using the GUI interface. + + Swagger operation ID: `V4_Initials_UpdateInitial`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6052,7 +7845,7 @@ async def initials_update_initial_async( f"/initials" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -6066,6 +7859,7 @@ async def initials_update_initial_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6073,9 +7867,9 @@ async def initials_update_initial_async( return json.loads(response.text) - async def in_person_add_in_person_async( + async def in_person_add_in_person( self, - input: InPersonFieldRequest, + input: InPersonFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -6106,6 +7900,24 @@ async def in_person_add_in_person_async( recipient would be in the same location.This type of signature is not intended for use whereby a document is shared with recipients over email link in the normal loose integration method. + + Swagger operation ID: `V4_InPerson_AddInPerson`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6118,7 +7930,7 @@ async def in_person_add_in_person_async( f"/in_person_signature" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6132,6 +7944,7 @@ async def in_person_add_in_person_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6139,9 +7952,9 @@ async def in_person_add_in_person_async( return json.loads(response.text) - async def in_person_update_in_person_async( + async def in_person_update_in_person( self, - input: UpdateInPersonFieldRequest, + input: UpdateInPersonFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -6162,6 +7975,24 @@ async def in_person_update_in_person_async( Fields](#operation/Documents_GetDocumentFields).The latter can be used when a template was applied or the document was created using the GUI interface. + + Swagger operation ID: `V4_InPerson_UpdateInPerson`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6174,7 +8005,7 @@ async def in_person_update_in_person_async( f"/in_person_signature" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -6188,6 +8019,7 @@ async def in_person_update_in_person_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6195,9 +8027,9 @@ async def in_person_update_in_person_async( return json.loads(response.text) - async def package_add_package_async( + async def package_add_package( self, - input: AddDocumentPackageRequest, + input: AddDocumentPackageRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -6214,10 +8046,26 @@ async def package_add_package_async( exist before you can upload or add documents to SigningHub.. Even a single document is a part of a package: a package containing one document. Note: A package can be renamed if required once created. + + Swagger operation ID: `V4_Package_AddPackage`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v4/packages" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6231,6 +8079,7 @@ async def package_add_package_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6238,9 +8087,9 @@ async def package_add_package_async( return json.loads(response.text) - async def package_approve_async( + async def package_approve( self, - input: ApproveRequest, + input: ApproveRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, @@ -6253,13 +8102,30 @@ async def package_approve_async( Business applications can use this service API to approve a document by a specified user in the order. + + Swagger operation ID: `V4_Package_Approve`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The ID of the package to be approved. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/approve" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6273,6 +8139,7 @@ async def package_approve_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6280,9 +8147,9 @@ async def package_approve_async( return json.loads(response.text) - async def package_decline_async( + async def package_decline( self, - input: DeclineRequest, + input: DeclineRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, @@ -6295,13 +8162,30 @@ async def package_decline_async( Business applications can use this service API to decline a document by a specified user in the order. + + Swagger operation ID: `V4_Package_Decline`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The ID of the package to be declined. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/decline" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6315,6 +8199,7 @@ async def package_decline_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6322,7 +8207,7 @@ async def package_decline_async( return json.loads(response.text) - async def package_delete_package_async( + async def package_delete_package( self, package_id_bulk_action: int, *, @@ -6340,13 +8225,29 @@ async def package_delete_package_async( automatically declined as result of delete operation. If the document status is SHARED, then the document is automatically recalled and workflow is stopped before the document is deleted. + + Swagger operation ID: `V4_Package_DeletePackage`. + + Args: + package_id_bulk_action: Package ID of the package which contains + the document. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id_bulk_action), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -6360,6 +8261,7 @@ async def package_delete_package_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6367,11 +8269,11 @@ async def package_delete_package_async( return json.loads(response.text) - async def package_download_package_bytes_async( + async def package_download_package_bytes( self, package_id_bulk_action: int, - document_ids: Optional[List[int]] = None, *, + document_ids: Optional[List[int]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -6387,6 +8289,24 @@ async def package_download_package_bytes_async( document, the download is the binary zip file of all documents. The x-password and x-otp headers are optional. They are required if the document owner set them during the workflow creation phase. + + Swagger operation ID: `V4_Package_DownloadPackageBytes`. + + Args: + package_id_bulk_action: The package ID to be downloaded. + document_ids: The Document IDs parameter is optional. If + x-combine-files is set to true, the documents will be merged + based on the mentioned documents of the package. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6412,7 +8332,7 @@ async def package_download_package_bytes_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6426,6 +8346,7 @@ async def package_download_package_bytes_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6433,7 +8354,7 @@ async def package_download_package_bytes_async( return json.loads(response.text) - async def package_finish_async( + async def package_finish( self, package_id: int, *, @@ -6464,13 +8385,28 @@ async def package_finish_async( SigningHub App, this method is invoked by the application to ensure the workflow continues to process and the next signatory is notified, and the document status is available via the configured call-back URL. + + Swagger operation ID: `V4_Package_Finish`. + + Args: + package_id: The ID of the package to be finished. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/finish" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -6484,6 +8420,7 @@ async def package_finish_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6491,9 +8428,9 @@ async def package_finish_async( return json.loads(response.text) - async def package_gatekeeper_approve_async( + async def package_gatekeeper_approve( self, - input: ApproveRequest, + input: ApproveRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, @@ -6506,6 +8443,23 @@ async def package_gatekeeper_approve_async( Business applications can use this service API to gatekeeper approve a document by a specified user in the order. + + Swagger operation ID: `V4_Package_GatekeeperApprove`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The ID of the package to be approved. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6516,7 +8470,7 @@ async def package_gatekeeper_approve_async( f"/approve" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6530,6 +8484,7 @@ async def package_gatekeeper_approve_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6537,9 +8492,9 @@ async def package_gatekeeper_approve_async( return json.loads(response.text) - async def package_gatekeeper_decline_async( + async def package_gatekeeper_decline( self, - input: DeclineRequest, + input: DeclineRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, @@ -6552,6 +8507,23 @@ async def package_gatekeeper_decline_async( Business applications can use this service API to gatekeeper decline a document by a specified user in the order. + + Swagger operation ID: `V4_Package_GatekeeperDecline`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The ID of the package to be declined. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6562,7 +8534,7 @@ async def package_gatekeeper_decline_async( f"/decline" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6576,6 +8548,7 @@ async def package_gatekeeper_decline_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6583,11 +8556,12 @@ async def package_gatekeeper_decline_async( return json.loads(response.text) - async def package_get_all_packages_async( + def list_package_get_all_packages( self, document_status: str, page_no: int, record_per_page: int, + *, package_name: Optional[str] = None, package_id: Optional[int] = None, recipient_from: Optional[str] = None, @@ -6607,18 +8581,60 @@ async def package_get_all_packages_async( document_statuses: Optional[List[str]] = None, owned_by: Optional[str] = None, smart_form: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Packages Business applications can use this service API to get a list of documents filtered by different statuses. Users can divide the records into pages by providing a number of records per page. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `V4_Package_GetAllPackages`. + + Args: + document_status: Filter by document status possible values are ALL, + DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, EDITED, REVIEWED, + COMPLETED, EXPIRING_IN_SEVEN_DAYS. + page_no: Page number, according the division of records per page. + record_per_page: Number of records that are needed to be fetched in + one request. + package_name: Package Name. + package_id: Package Id. + recipient_from: From. + recipient_to: To. + document_id: Document Id. + expiry: Expiry (Days). + modified_from: From Modified Date. + modified_to: To Modified Date. + size_from: From Size (KB). + size_to: To Size (KB). + certified_documents: Only certified signed documents. + form_fields: Only documents that have form fields. + attachments: Only documents that have attachments. + document_type: Document Type like XML, PDF, DOCX etc. + sort_by: Sort the resultant records as per your choice. + asc: Sorted the resultant records by ascending or descending order. + document_statuses: Document Type. + owned_by: Owned By filter possible values are ME_OTHERS, ME, + OTHERS. + smart_form: Smart form name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6733,33 +8749,54 @@ async def package_get_all_packages_async( if smart_form is not None: value = str(smart_form) if isinstance(smart_form, bool): - value = value.lower() - query_params.append(f"smart-form={quote(value, safe='')}") - if query_params: - request_url += '?' + '&'.join(query_params) - - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + value = value.lower() + query_params.append(f"smart-form={quote(value, safe='')}") + if query_params: + request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - async def package_get_package_details_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def package_get_package_details( self, package_id: int, *, @@ -6775,13 +8812,28 @@ async def package_get_package_details_async( package. This API can also be used by the business application to perform action on behalf of the enterprise user via \"Scope Authentication\". + + Swagger operation ID: `V4_Package_GetPackageDetails`. + + Args: + package_id: Package ID of the document package. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/details" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6795,6 +8847,7 @@ async def package_get_package_details_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6802,9 +8855,9 @@ async def package_get_package_details_async( return json.loads(response.text) - async def package_rename_package_async( + async def package_rename_package( self, - input: RenameDocumentPackageRequest, + input: RenameDocumentPackageRequest | Mapping[str, Any], package_id_bulk_action: int, *, timeout: Optional[float] = None, @@ -6817,13 +8870,30 @@ async def package_rename_package_async( This service API is used to rename a document package. The document package is identified by its unique identifier in the URL of the call. + + Swagger operation ID: `V4_Package_RenamePackage`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id_bulk_action: Package ID to change the name of. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id_bulk_action), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -6837,6 +8907,7 @@ async def package_rename_package_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6844,7 +8915,7 @@ async def package_rename_package_async( return json.loads(response.text) - async def package_submit_async( + async def package_submit( self, package_id: int, *, @@ -6864,13 +8935,29 @@ async def package_submit_async( [SigningHub Roles](http://manuals.ascertia.com/SigningHubv7/default.aspx#pageid=1056) for a description of all available workflow recipient roles. + + Swagger operation ID: `V4_Package_Submit`. + + Args: + package_id: The SigningHub package ID that contains the document to + be submitted. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/submit" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -6884,6 +8971,7 @@ async def package_submit_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6891,9 +8979,9 @@ async def package_submit_async( return json.loads(response.text) - async def qr_add_qr_code_async( + async def qr_add_qr_code( self, - input: QrCodeRequest, + input: QrCodeRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -6907,6 +8995,24 @@ async def qr_add_qr_code_async( Business applications can use this service API to add a QR Code to a document in a package. + + Swagger operation ID: `V4_QR_AddQRCode`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6919,7 +9025,7 @@ async def qr_add_qr_code_async( f"/qrcode" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6933,6 +9039,7 @@ async def qr_add_qr_code_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6940,9 +9047,9 @@ async def qr_add_qr_code_async( return json.loads(response.text) - async def qr_update_qr_code_async( + async def qr_update_qr_code( self, - input: UpdateQrCodeRequest, + input: UpdateQrCodeRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -6956,6 +9063,24 @@ async def qr_update_qr_code_async( Business applications can use this service API to update a QR Code of a document in a package. + + Swagger operation ID: `V4_QR_UpdateQRCode`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6968,7 +9093,7 @@ async def qr_update_qr_code_async( f"/qrcode" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -6982,6 +9107,7 @@ async def qr_update_qr_code_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6989,9 +9115,9 @@ async def qr_update_qr_code_async( return json.loads(response.text) - async def radio_add_radio_box_async( + async def radio_add_radio_box( self, - input: RadioBoxFieldRequest, + input: RadioBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -7017,6 +9143,24 @@ async def radio_add_radio_box_async( will be assigned. If either width or height (or both) is provided, the system will compare these provided values with each other. The larger value between width and height will be assigned to both dimensions. + + Swagger operation ID: `V4_Radio_AddRadioBox`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7029,7 +9173,7 @@ async def radio_add_radio_box_async( f"/radio" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7043,6 +9187,7 @@ async def radio_add_radio_box_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7050,9 +9195,9 @@ async def radio_add_radio_box_async( return json.loads(response.text) - async def radio_update_radio_box_async( + async def radio_update_radio_box( self, - input: UpdateRadioBoxFieldRequest, + input: UpdateRadioBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -7073,6 +9218,24 @@ async def radio_update_radio_box_async( when a template was applied or the document was created using the GUI interface. It's width and height cannot be updated. They will remain the same as when they were added. + + Swagger operation ID: `V4_Radio_UpdateRadioBox`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7085,7 +9248,7 @@ async def radio_update_radio_box_async( f"/radio" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -7099,6 +9262,7 @@ async def radio_update_radio_box_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7106,18 +9270,18 @@ async def radio_update_radio_box_async( return json.loads(response.text) - async def settings_get_templates_async( + def list_settings_get_templates( self, record_per_page: int, page_no: int, + *, sort_by: Optional[str] = None, asc: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Templates @@ -7126,6 +9290,29 @@ async def settings_get_templates_async( supplied under the \"x-search-text\" header.Furthermore, it is possible to search a user's personal templates or the enterprise templates as allowed against their user role by their enterprise admin. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `V4_Settings_GetTemplates`. + + Args: + record_per_page: Total number of records to be retrieved in a page. + page_no: Page number to be retrieved. + sort_by: Sort by column. Possible Values are CREATED_ON and NAME. + Default is sort by CREATED_ON. + asc: The resulting list order. Default resulting list will be + descending. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7148,31 +9335,52 @@ async def settings_get_templates_async( query_params.append(f"asc={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def signature_add_signature_async( + async def signature_add_signature( self, - input: DigitalSignatureFieldRequest, + input: DigitalSignatureFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -7195,6 +9403,25 @@ async def signature_add_signature_async( information.Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. + + Swagger operation ID: `V4_Signature_AddSignature`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The package ID for which workflow details need to be + updated. + document_id: The document ID where the field is to be added. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7207,7 +9434,7 @@ async def signature_add_signature_async( f"/signature" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7221,6 +9448,7 @@ async def signature_add_signature_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7228,9 +9456,9 @@ async def signature_add_signature_async( return json.loads(response.text) - async def signature_update_signature_async( + async def signature_update_signature( self, - input: UpdateDigitalSignatureFieldRequest, + input: UpdateDigitalSignatureFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -7251,6 +9479,24 @@ async def signature_update_signature_async( Fields](#operation/Documents_GetDocumentFields).The latter can be used when a template was applied or the document was created using the GUI interface. + + Swagger operation ID: `V4_Signature_UpdateSignature`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7263,7 +9509,7 @@ async def signature_update_signature_async( f"/signature" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -7277,6 +9523,7 @@ async def signature_update_signature_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7284,9 +9531,9 @@ async def signature_update_signature_async( return json.loads(response.text) - async def signing_bulk_sign_documents_async( + async def signing_bulk_sign_documents( self, - input: BulkSignRequest, + input: BulkSignRequest | Mapping[str, Any], package_id_bulk_action: str, *, timeout: Optional[float] = None, @@ -7334,13 +9581,31 @@ async def signing_bulk_sign_documents_async( applications must retrieve the OTP from the use and submit it when making the API call. This is done using the \"x-otp\" header in the request. + + Swagger operation ID: `V4_Signing_BulkSignDocuments`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id_bulk_action: Bulk action to be performed. Possible + values are: SIGN | SHARE. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id_bulk_action), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7354,6 +9619,7 @@ async def signing_bulk_sign_documents_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7361,9 +9627,9 @@ async def signing_bulk_sign_documents_async( return json.loads(response.text) - async def signing_bulk_sign_status_async( + async def signing_bulk_sign_status( self, - input: BulkSignStatusRequest, + input: BulkSignStatusRequest | Mapping[str, Any], bulk_action: str, *, timeout: Optional[float] = None, @@ -7392,13 +9658,31 @@ async def signing_bulk_sign_status_async( signing process to complete the signing process on failed documents, the ACTION property will be REINITIATE_SIGNING_PROCESS, and the STATUS property will be PENDING. + + Swagger operation ID: `V4_Signing_BulkSignStatus`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + bulk_action: Bulk action to be performed. Possible values are: SIGN + | SHARE. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(bulk_action), safe='')}/status" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7412,6 +9696,7 @@ async def signing_bulk_sign_status_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7419,9 +9704,9 @@ async def signing_bulk_sign_status_async( return json.loads(response.text) - async def signing_sign_document_async( + async def signing_sign_document( self, - input: SignDocumentRequest, + input: SignDocumentRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -7466,6 +9751,25 @@ async def signing_sign_document_async( business applications must retrieve the OTP from the use and submit it when making the API call. This is done using the \"x-otp\" header in the request. + + Swagger operation ID: `V4_Signing_SignDocument`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The identifier of the package that contains the + document for signature. + document_id: Identifier of the document to be signed. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7477,7 +9781,7 @@ async def signing_sign_document_async( f"/sign" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7491,6 +9795,7 @@ async def signing_sign_document_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7498,19 +9803,19 @@ async def signing_sign_document_async( return json.loads(response.text) - async def template_get_enterprise_templates_async( + def list_template_get_enterprise_templates( self, record_per_page: int, page_no: int, + *, sort_by: Optional[str] = None, asc: Optional[bool] = None, id: Optional[List[int]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Enterprise Templates @@ -7519,6 +9824,28 @@ async def template_get_enterprise_templates_async( administrator or the enterprise user if the \"scope\" variable was used in the authentication request. It is possible to search based upon the criterion supplied under the \"x-search-text\" header. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `V4_Template_GetEnterpriseTemplates`. + + Args: + record_per_page: Total number of records to be retrieved in a page. + page_no: Page number to be retrieved. + sort_by: Sort the result by possible values are mentioned above. + asc: Order the result set by ascending or descending. + id: Search by template ids. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7557,31 +9884,52 @@ async def template_get_enterprise_templates_async( query_params.append(f"id={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def text_box_add_text_box_async( + return AsyncItemPaged(get_next, extract_data) + + async def text_box_add_text_box( self, - input: TextBoxFieldRequest, + input: TextBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -7603,6 +9951,24 @@ async def text_box_add_text_box_async( to Workflow](#operation/Workflow_WorkflowAddUser) for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. + + Swagger operation ID: `V4_TextBox_AddTextBox`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7615,7 +9981,7 @@ async def text_box_add_text_box_async( f"/text" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7629,6 +9995,7 @@ async def text_box_add_text_box_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7636,9 +10003,9 @@ async def text_box_add_text_box_async( return json.loads(response.text) - async def text_box_update_text_box_async( + async def text_box_update_text_box( self, - input: UpdateTextBoxFieldRequest, + input: UpdateTextBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -7658,6 +10025,24 @@ async def text_box_update_text_box_async( Fields](#operation/Documents_GetDocumentFields). The latter can be used when a template was applied or the document was created using the GUI interface. + + Swagger operation ID: `V4_TextBox_UpdateTextBox`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: Package ID to which the document is added. + document_id: The document ID for which the action is to be taken. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7670,7 +10055,7 @@ async def text_box_update_text_box_async( f"/text" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -7684,6 +10069,7 @@ async def text_box_update_text_box_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7691,9 +10077,9 @@ async def text_box_update_text_box_async( return json.loads(response.text) - async def workflow_apply_template_async( + async def workflow_apply_template( self, - input: ApplyTemplateRequest, + input: ApplyTemplateRequest | Mapping[str, Any], package_id: int, document_id: int, *, @@ -7722,6 +10108,27 @@ async def workflow_apply_template_async( applying such a template, these form fields will be created on the target document even if these form fields were already present in the document. + + Swagger operation ID: `V4_Workflow_ApplyTemplate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The Package ID of the package to which the template + needs to be applied. + document_id: The document ID on which the template needs to be + applied. If the value is set to 0, if template is to be applied + on all the documents in the package. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7733,7 +10140,7 @@ async def workflow_apply_template_async( f"/template" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7747,6 +10154,7 @@ async def workflow_apply_template_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7754,7 +10162,7 @@ async def workflow_apply_template_async( return json.loads(response.text) - async def workflow_evidence_report_download_bytes_async( + async def workflow_evidence_report_download_bytes( self, package_id: int, *, @@ -7768,13 +10176,28 @@ async def workflow_evidence_report_download_bytes_async( Business applications can use this service API to download the workflow process evidence report of a document. + + Swagger operation ID: `V4_WorkflowEvidenceReport_DownloadBytes`. + + Args: + package_id: The ID of the document. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/report" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7788,6 +10211,7 @@ async def workflow_evidence_report_download_bytes_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7795,7 +10219,7 @@ async def workflow_evidence_report_download_bytes_async( return json.loads(response.text) - async def workflow_get_workflow_detail_async( + async def workflow_get_workflow_detail( self, package_id: int, *, @@ -7809,13 +10233,28 @@ async def workflow_get_workflow_detail_async( Business applications can use this service API to get workflow details for the package. + + Swagger operation ID: `V4_Workflow_GetWorkflowDetail`. + + Args: + package_id: The ID of the package to be downloaded. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/workflow" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7829,6 +10268,7 @@ async def workflow_get_workflow_detail_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7836,7 +10276,7 @@ async def workflow_get_workflow_detail_async( return json.loads(response.text) - async def workflow_get_workflow_history_async( + async def workflow_get_workflow_history( self, package_id: int, page_no: int, @@ -7854,6 +10294,24 @@ async def workflow_get_workflow_history_async( of actions performed on a document. The package ID is provided in the resource URL. The search field (x-search-text header) is intended for email, document name, action, infokey, and infovalue. + + Swagger operation ID: `V4_Workflow_GetWorkflowHistory`. + + Args: + package_id: The ID of the document for which the log is required. + page_no: Page number to be retrieved. + records_per_page: Total number of records to be retrieved in a + page. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7865,7 +10323,7 @@ async def workflow_get_workflow_history_async( f"/{quote(str(records_per_page), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7879,6 +10337,7 @@ async def workflow_get_workflow_history_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7886,7 +10345,7 @@ async def workflow_get_workflow_history_async( return json.loads(response.text) - async def workflow_get_workflow_reminder_async( + async def workflow_get_workflow_reminder( self, package_id: int, order: int, @@ -7906,6 +10365,24 @@ async def workflow_get_workflow_reminder_async( the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow. + + Swagger operation ID: `V4_Workflow_GetWorkflowReminder`. + + Args: + package_id: The package ID for which workflow reminders to be + updated. + order: The order of the user for which the workflow reminders to be + updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7917,7 +10394,7 @@ async def workflow_get_workflow_reminder_async( f"/reminders" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7931,6 +10408,7 @@ async def workflow_get_workflow_reminder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7938,7 +10416,7 @@ async def workflow_get_workflow_reminder_async( return json.loads(response.text) - async def workflow_get_workflow_users_async( + def list_workflow_get_workflow_users( self, package_id: int, *, @@ -7946,40 +10424,79 @@ async def workflow_get_workflow_users_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Workflow Users Business applications can use this service API to get workflow details for the package. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `V4_Workflow_GetWorkflowUsers`. + + Args: + package_id: The ID of the package to be downloaded. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/workflow/users" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def workflow_mark_workflow_completed_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def workflow_mark_workflow_completed( self, package_id: int, *, @@ -7999,13 +10516,29 @@ async def workflow_mark_workflow_completed_async( Bearer token should belong to document owner or enterprise admin can use scope variable to get the access token on behalf of document owner to perform this action. + + Swagger operation ID: `V4_Workflow_MarkWorkflowCompleted`. + + Args: + package_id: The package ID from which the recipient is to be + deleted. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/complete" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -8019,6 +10552,7 @@ async def workflow_mark_workflow_completed_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8026,7 +10560,7 @@ async def workflow_mark_workflow_completed_async( return json.loads(response.text) - async def workflow_permission_get_workflow_permissions_async( + async def workflow_permission_get_workflow_permissions( self, package_id: int, order: int, @@ -8042,6 +10576,26 @@ async def workflow_permission_get_workflow_permissions_async( Business applications can use this service API to get document permissions for a recipient. Recipient is identified by the order in the workflow. The ID of the package is provided in the resource URL. + + Swagger operation ID: `V4_WorkflowPermission_GetWorkflowPermissions`. + + Args: + package_id: The document ID for which workflow user needs to be + updated. + order: The order of the user in workflow for which the permissions + are requested. By providing the value 0 in order, service would + return the permissions of most recently added collaborator in + the workflow. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8053,7 +10607,7 @@ async def workflow_permission_get_workflow_permissions_async( f"/permissions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8067,6 +10621,7 @@ async def workflow_permission_get_workflow_permissions_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8074,9 +10629,9 @@ async def workflow_permission_get_workflow_permissions_async( return json.loads(response.text) - async def workflow_permission_update_workflow_permissions_async( + async def workflow_permission_update_workflow_permissions( self, - input: WorkflowPermissionsUpdateRequest, + input: WorkflowPermissionsUpdateRequest | Mapping[str, Any], package_id: int, order: int, *, @@ -8095,6 +10650,27 @@ async def workflow_permission_update_workflow_permissions_async( within the workflow. The ID of the document package is provided in the resource URL, and the workflow user is identified by the order at which it is added to the workflow. + + Swagger operation ID: + `V4_WorkflowPermission_UpdateWorkflowPermissions`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The package ID for which workflow permissions to be + updated. + order: The order of the recipient for which the workflow + permissions to be updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8106,7 +10682,7 @@ async def workflow_permission_update_workflow_permissions_async( f"/permissions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -8120,6 +10696,7 @@ async def workflow_permission_update_workflow_permissions_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8127,7 +10704,7 @@ async def workflow_permission_update_workflow_permissions_async( return json.loads(response.text) - async def workflow_recall_workflow_async( + async def workflow_recall_workflow( self, package_id: int, *, @@ -8142,13 +10719,28 @@ async def workflow_recall_workflow_async( Business applications can use this service API to stop a workflow in progress. The document ID is provided in the resource URL. After recall the document status automatically changes to \"DRAFT\". + + Swagger operation ID: `V4_Workflow_RecallWorkflow`. + + Args: + package_id: The ID of the package to be recalled. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/workflow" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -8162,6 +10754,7 @@ async def workflow_recall_workflow_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8169,7 +10762,7 @@ async def workflow_recall_workflow_async( return json.loads(response.text) - async def workflow_start_workflow_async( + async def workflow_start_workflow( self, package_id: int, *, @@ -8186,13 +10779,28 @@ async def workflow_start_workflow_async( already have been prepared by applying a template and optionally updating the users and actions defined in template. The package ID to be shared is provided in the resource URL. + + Swagger operation ID: `V4_Workflow_StartWorkflow`. + + Args: + package_id: The document package to be shared. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/workflow" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -8206,6 +10814,7 @@ async def workflow_start_workflow_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8213,9 +10822,9 @@ async def workflow_start_workflow_async( return json.loads(response.text) - async def workflow_update_workflow_async( + async def workflow_update_workflow( self, - input: WorkflowDetailUpdateRequest, + input: WorkflowDetailUpdateRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, @@ -8231,13 +10840,31 @@ async def workflow_update_workflow_async( to a document, but business applications wants to override the certify permission or post processing details. The package ID is provided in the resource URL. + + Swagger operation ID: `V4_Workflow_UpdateWorkflow`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The package ID for which workflow details need to be + updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/workflow" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -8251,6 +10878,7 @@ async def workflow_update_workflow_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8258,9 +10886,9 @@ async def workflow_update_workflow_async( return json.loads(response.text) - async def workflow_update_workflow_post_process_async( + async def workflow_update_workflow_post_process( self, - input: PostProcessUpdateRequest, + input: PostProcessUpdateRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, @@ -8273,6 +10901,24 @@ async def workflow_update_workflow_post_process_async( Business applications can use this service API to add placeholder to a workflow a document in a package. + + Swagger operation ID: `V4_Workflow_UpdateWorkflowPostProcess`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: ID of the document package for which the post + processing is being updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8283,7 +10929,7 @@ async def workflow_update_workflow_post_process_async( f"/post_process" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -8297,6 +10943,7 @@ async def workflow_update_workflow_post_process_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8304,9 +10951,9 @@ async def workflow_update_workflow_post_process_async( return json.loads(response.text) - async def workflow_update_workflow_reminder_async( + async def workflow_update_workflow_reminder( self, - input: UpdateReminderRequest, + input: UpdateReminderRequest | Mapping[str, Any], package_id: int, order: int, *, @@ -8325,6 +10972,26 @@ async def workflow_update_workflow_reminder_async( settings within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow. + + Swagger operation ID: `V4_Workflow_UpdateWorkflowReminder`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The package ID for which workflow reminders to be + updated. + order: The order of the user for which the workflow reminders to be + updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8336,7 +11003,7 @@ async def workflow_update_workflow_reminder_async( f"/reminders" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -8350,6 +11017,7 @@ async def workflow_update_workflow_reminder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8357,7 +11025,7 @@ async def workflow_update_workflow_reminder_async( return json.loads(response.text) - async def workflow_workflow_add_group_async( + async def workflow_workflow_add_group( self, input: WorkflowWorkflowAddGroupInput, package_id: int, @@ -8378,13 +11046,29 @@ async def workflow_workflow_add_group_async( user/group, already present in the workflow. While XML type document preparation, only supported role types are \"SIGNER\", \"REVIEWER\" and \"CARBON_COPY\" + + Swagger operation ID: `V4_Workflow_WorkflowAddGroup`. + + Args: + input: The request body. + package_id: ID of the package for which the group is to be added. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/workflow/groups" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8398,6 +11082,7 @@ async def workflow_workflow_add_group_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8405,7 +11090,7 @@ async def workflow_workflow_add_group_async( return json.loads(response.text) - async def workflow_workflow_add_placeholder_async( + async def workflow_workflow_add_placeholder( self, input: WorkflowWorkflowAddPlaceholderInput, package_id: int, @@ -8428,6 +11113,23 @@ async def workflow_workflow_add_placeholder_async( be assigned to individual users at a later stage. While XML type document preparation, only supported role types are \"SIGNER\", \"REVIEWER\" and \"CARBON_COPY\" + + Swagger operation ID: `V4_Workflow_WorkflowAddPlaceholder`. + + Args: + input: The request body. + package_id: ID of the package for which the placeholder is to be + added. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8438,7 +11140,7 @@ async def workflow_workflow_add_placeholder_async( f"/placeholder" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8452,6 +11154,7 @@ async def workflow_workflow_add_placeholder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8459,7 +11162,7 @@ async def workflow_workflow_add_placeholder_async( return json.loads(response.text) - async def workflow_workflow_add_user_async( + async def workflow_workflow_add_user( self, input: WorkflowWorkflowAddUserInput, package_id: int, @@ -8500,13 +11203,30 @@ async def workflow_workflow_add_user_async( workflow; all in parallel order. Note, while XML type document preparation, only supported role types are \"SIGNER\", \"REVIEWER\" and \"CARBON_COPY\" + + Swagger operation ID: `V4_Workflow_WorkflowAddUser`. + + Args: + input: The request body. + package_id: SigningHub package ID, which the recipients are to be + added to. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/packages/{quote(str(package_id), safe='')}/workflow/users" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -8520,6 +11240,7 @@ async def workflow_workflow_add_user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8527,7 +11248,7 @@ async def workflow_workflow_add_user_async( return json.loads(response.text) - async def workflow_workflow_delete_user_async( + async def workflow_workflow_delete_user( self, package_id: int, order: int, @@ -8542,6 +11263,24 @@ async def workflow_workflow_delete_user_async( Business applications can use this service API to delete workflow recipient. + + Swagger operation ID: `V4_Workflow_WorkflowDeleteUser`. + + Args: + package_id: The package ID from which the recipient is to be + deleted. + order: Order of the recipient in the workflow which is to be + deleted. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8552,7 +11291,7 @@ async def workflow_workflow_delete_user_async( f"/{quote(str(order), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -8566,6 +11305,7 @@ async def workflow_workflow_delete_user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8573,9 +11313,9 @@ async def workflow_workflow_delete_user_async( return json.loads(response.text) - async def workflow_workflow_update_placeholder_async( + async def workflow_workflow_update_placeholder( self, - input: WorkflowPlaceholderUpdateRequest, + input: WorkflowPlaceholderUpdateRequest | Mapping[str, Any], package_id: int, order: int, *, @@ -8595,6 +11335,25 @@ async def workflow_workflow_update_placeholder_async( place holder is identified by the order at which it is added to the workflow. While XML type document preparation, only supported role types are \"SIGNER\", \"REVIEWER\" and \"CARBON_COPY\" + + Swagger operation ID: `V4_Workflow_WorkflowUpdatePlaceholder`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: ID of the package for which the placeholder is to be + added. + order: Order of the recipient in the workflow. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8606,7 +11365,7 @@ async def workflow_workflow_update_placeholder_async( f"/placeholder" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -8620,6 +11379,7 @@ async def workflow_workflow_update_placeholder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8627,9 +11387,9 @@ async def workflow_workflow_update_placeholder_async( return json.loads(response.text) - async def workflow_workflow_user_update_async( + async def workflow_workflow_user_update( self, - input: WorkflowUserUpdateRequest, + input: WorkflowUserUpdateRequest | Mapping[str, Any], package_id: int, order: int, *, @@ -8650,6 +11410,25 @@ async def workflow_workflow_user_update_async( identified by the order at which it is added to the workflow. Note, while XML type document preparation, only supports role types \"SIGNER\", \"REVIEWER\" and \"CARBON_COPY\". + + Swagger operation ID: `V4_Workflow_WorkflowUserUpdate`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: The package ID for which workflow user needs to be + updated. + order: The order of the user in workflow. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8661,7 +11440,7 @@ async def workflow_workflow_user_update_async( f"/user" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -8675,6 +11454,7 @@ async def workflow_workflow_user_update_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8682,9 +11462,9 @@ async def workflow_workflow_user_update_async( return json.loads(response.text) - async def workflow_workflow_user_update_order_async( + async def workflow_workflow_user_update_order( self, - input: WorkflowUserReorderRequest, + input: WorkflowUserReorderRequest | Mapping[str, Any], package_id: int, order: int, *, @@ -8698,6 +11478,25 @@ async def workflow_workflow_user_update_order_async( Business applications can use this service API to update order of the recipient in the workflow. + + Swagger operation ID: `V4_Workflow_WorkflowUserUpdateOrder`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + package_id: ID of the package to which the recipients are to be + added. + order: Existing order of the recipient which is to be updated. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -8709,7 +11508,7 @@ async def workflow_workflow_user_update_order_async( f"/reorder" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -8723,6 +11522,7 @@ async def workflow_workflow_user_update_order_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8730,7 +11530,7 @@ async def workflow_workflow_user_update_order_async( return json.loads(response.text) - async def work_space_delete_shared_space_async( + async def work_space_delete_shared_space( self, id: int, *, @@ -8746,13 +11546,28 @@ async def work_space_delete_shared_space_async( The availability of deleting shared spaces is subject to the assigned enterprise user role. To allow this provision Enterprise Admin will enable the 'Manage Shared Space' option in Roles>Document Settings. + + Swagger operation ID: `V4_WorkSpace_DeleteSharedSpace`. + + Args: + id: Id of shared space that you want to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/shared_spaces/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -8766,6 +11581,7 @@ async def work_space_delete_shared_space_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8773,7 +11589,7 @@ async def work_space_delete_shared_space_async( return json.loads(response.text) - async def work_space_get_shared_space_async( + async def work_space_get_shared_space( self, id: int, *, @@ -8788,13 +11604,28 @@ async def work_space_get_shared_space_async( Business applications can use this service API to get a specific shared space. This API returns information about shared space, its owner and collaborator. + + Swagger operation ID: `V4_WorkSpace_GetSharedSpace`. + + Args: + id: Id of shared space that you want to get. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/shared_spaces/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -8808,6 +11639,7 @@ async def work_space_get_shared_space_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -8815,9 +11647,9 @@ async def work_space_get_shared_space_async( return json.loads(response.text) - async def work_space_update_shared_space_async( + async def work_space_update_shared_space( self, - input: UpdateWorkSpaceRequest, + input: UpdateWorkSpaceRequest | Mapping[str, Any], id: int, *, timeout: Optional[float] = None, @@ -8832,13 +11664,30 @@ async def work_space_update_shared_space_async( The availability of updating shared spaces is subject to the assigned enterprise user role. To allow this provision Enterprise Admin will enable the 'Manage Shared Space' option in Roles>Document Settings. + + Swagger operation ID: `V4_WorkSpace_UpdateSharedSpace`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + id: Id of shared space that you want to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v4/shared_spaces/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -8852,6 +11701,7 @@ async def work_space_update_shared_space_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/slack.py b/src/azure/connectors/slack.py index 33333a2a..30131ca5 100644 --- a/src/azure/connectors/slack.py +++ b/src/azure/connectors/slack.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,21 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "SlackClient", + "Channel", + "CreateChannelResponse", + "JoinChannelResponse", + "ListChannelsResponse", + "PostMessageRequest", + "PostMessageResponse", + "SetDNDResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +43,7 @@ class SetDNDResponse: Response for Set do not disturb """ - snooze_enabled: Optional[bool] = None + snooze_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether snooze is enabled.""" @@ -39,7 +53,7 @@ class CreateChannelResponse: Response for Create a channel """ - channel: Optional[Channel] = None + channel: Optional[Channel | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -48,8 +62,8 @@ class JoinChannelResponse: Response for Join a public channel """ - channel: Optional[Channel] = None - warning: Optional[str] = None + channel: Optional[Channel | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + warning: Optional[str] = dataclass_field(default=None, kw_only=True) """Whether the user is already in the channel or not.""" @@ -59,9 +73,15 @@ class ListChannelsResponse: Response for List public channels (Pagination support) """ - value: Optional[List[Channel]] = None - next_link: Optional[str] = field( + value: Optional[ + List[Channel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """Link to get next page of results""" @@ -73,15 +93,15 @@ class PostMessageResponse: Response for Post message """ - ok: Optional[bool] = None + ok: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates if the operation was successful.""" - channel: Optional[str] = None + channel: Optional[str] = dataclass_field(default=None, kw_only=True) """The channel which the message was posted to.""" - ts: Optional[str] = None + ts: Optional[str] = dataclass_field(default=None, kw_only=True) """Unix timestamp for when the message was created.""" - message: Optional[Dict[str, Any]] = None + message: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """A channel message.""" - error: Optional[str] = None + error: Optional[str] = dataclass_field(default=None, kw_only=True) """Details of the error messages, if any.""" @@ -91,9 +111,9 @@ class Channel: Definition: Channel """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The id of the channel.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of channel.""" @@ -103,40 +123,40 @@ class PostMessageRequest: Definition: PostMessageRequest """ - channel: Optional[str] = None + channel: str """ Channel, private group, or IM channel to send message to. Can be a name(ex: #general) or an encoded ID. """ - text: Optional[str] = None + text: str """ Body of the message to send. Slack API will truncate messages containing more than 40,000 characters. For formatting options, see https://api.slack.com/docs/formatting """ - username: Optional[str] = None + username: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the bot.""" - as_user: Optional[bool] = None + as_user: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Pass true to post the message as the authenticated user, instead of as a bot. """ - parse: Optional[str] = None + parse: Optional[str] = dataclass_field(default=None, kw_only=True) """ Change how messages are treated. For details, see https://api.slack.com/docs/formatting """ - mrkdwn: Optional[bool] = None + mrkdwn: Optional[bool] = dataclass_field(default=None, kw_only=True) """Slack markup parsing setting. Enabled by default.""" - link_names: Optional[int] = None + link_names: Optional[int] = dataclass_field(default=None, kw_only=True) """Find and link channel names and usernames.""" - unfurl_links: Optional[bool] = None + unfurl_links: Optional[bool] = dataclass_field(default=None, kw_only=True) """Pass true to enable unfurling of primarily text-based content.""" - unfurl_media: Optional[bool] = None + unfurl_media: Optional[bool] = dataclass_field(default=None, kw_only=True) """Pass false to disable unfurling of media content.""" - icon_url: Optional[str] = None + icon_url: Optional[str] = dataclass_field(default=None, kw_only=True) """URL to an image to use as an icon for this message.""" - icon_emoji: Optional[str] = None + icon_emoji: Optional[str] = dataclass_field(default=None, kw_only=True) """Emoji to use as an icon for this message.""" @@ -151,7 +171,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -168,8 +188,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -190,7 +210,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -206,15 +226,49 @@ def connector_name(self) -> str: return "slack" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -231,7 +285,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -244,10 +302,10 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def set_dnd_async( + async def set_dnd( self, - num_minutes: Optional[str] = None, *, + num_minutes: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -257,6 +315,21 @@ async def set_dnd_async( Set do not disturb Set the do not disturb status for the user. + + Swagger operation ID: `SetDND`. + + Args: + num_minutes: The number of minutes to set do not disturb. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/dnd.setSnooze" query_params = [] @@ -268,7 +341,7 @@ async def set_dnd_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -282,6 +355,7 @@ async def set_dnd_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -289,11 +363,11 @@ async def set_dnd_async( return json.loads(response.text) - async def create_channel_async( + async def create_channel( self, + *, name: Optional[str] = None, is_private: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -303,6 +377,22 @@ async def create_channel_async( Create a channel Create a channel in slack. + + Swagger operation ID: `CreateChannel_V2`. + + Args: + name: The name of the new channel. + is_private: Channel is private or not. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/conversations.create" query_params = [] @@ -319,7 +409,7 @@ async def create_channel_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -333,6 +423,7 @@ async def create_channel_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -340,10 +431,10 @@ async def create_channel_async( return json.loads(response.text) - async def join_channel_async( + async def join_channel( self, - channel: Optional[str] = None, *, + channel: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -353,6 +444,21 @@ async def join_channel_async( Join a public channel Join a public channel in slack. + + Swagger operation ID: `JoinChannel_V2`. + + Args: + channel: The name of the channel. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/conversations.join" query_params = [] @@ -364,7 +470,7 @@ async def join_channel_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -378,6 +484,7 @@ async def join_channel_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -385,28 +492,50 @@ async def join_channel_async( return json.loads(response.text) - async def list_channels_async( + def list_channels( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ List public channels (Pagination support) List the public channels in slack. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `ListChannels_V3`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v3/conversations.list" + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -419,25 +548,34 @@ async def list_channels_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def post_message_async( + return AsyncItemPaged(get_next, extract_data) + + async def post_message( self, - input: PostMessageRequest, + input: PostMessageRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -448,10 +586,26 @@ async def post_message_async( Post message This operation is used to post a message to the specified channel. + + Swagger operation ID: `PostMessage_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/chat.postMessage" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -465,6 +619,7 @@ async def post_message_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/smtp.py b/src/azure/connectors/smtp.py index 6ea363ca..ba1ba3cb 100644 --- a/src/azure/connectors/smtp.py +++ b/src/azure/connectors/smtp.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, List, Any, Mapping from azure.core.credentials import AzureKeyCredential @@ -18,6 +18,12 @@ ConnectorResponseHook, ) +__all__ = [ + "SmtpClient", + "Attachment", + "Email", +] + # Type Definitions @@ -27,23 +33,19 @@ class Attachment: Definition: Attachment """ - content_data: Optional[str] = field( - default=None, - metadata={"wire_name": "ContentData"}, - ) + content_data: str = dataclass_field(metadata={"wire_name": "ContentData"}) """Content data""" - content_type: Optional[str] = field( - default=None, - metadata={"wire_name": "ContentType"}, - ) + content_type: str = dataclass_field(metadata={"wire_name": "ContentType"}) """Content type""" - file_name: Optional[str] = field( + file_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileName"}, ) """File name""" - content_id: Optional[str] = field( + content_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContentId"}, ) """Content id""" @@ -55,47 +57,72 @@ class Email: Definition: Email """ - from_: Optional[str] = field(default=None, metadata={"wire_name": "From"}) + from_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "From"}, + ) """Email address of sender like sender@domain.com""" - to: Optional[str] = field(default=None, metadata={"wire_name": "To"}) + to: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "To"}, + ) """ Specify email addresses separated by semicolons like recipient1@domain.com;recipient2@domain.com """ - c_c: Optional[str] = field(default=None, metadata={"wire_name": "CC"}) + c_c: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "CC"}, + ) """ Specify email addresses separated by semicolons like recipient1@domain.com;recipient2@domain.com """ - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Email subject""" - body: Optional[str] = field(default=None, metadata={"wire_name": "Body"}) + body: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Body"}, + ) """Email body""" - bcc: Optional[str] = field(default=None, metadata={"wire_name": "Bcc"}) + bcc: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Bcc"}, + ) """ Specify email addresses separated by semicolons like recipient1@domain.com;recipient2@domain.com. """ - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Importance of the email (High, Normal, or Low)""" - read_receipt: Optional[str] = field( + read_receipt: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReadReceipt"}, ) """Specify email address for Read receipt""" - delivery_receipt: Optional[str] = field( + delivery_receipt: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DeliveryReceipt"}, ) """Specify email address for Delivery receipt""" - attachments: Optional[List[Attachment]] = field( + attachments: Optional[List[Attachment | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """Attachments to be sent along with the email""" @@ -112,7 +139,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -129,8 +156,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -151,7 +178,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -166,9 +193,9 @@ def __init__( def connector_name(self) -> str: return "smtp" - async def send_email_async( + async def send_email( self, - input: Email, + input: Email | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -179,10 +206,26 @@ async def send_email_async( Send Email This operation sends an email to one or more recipients. + + Swagger operation ID: `SendEmailV3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/SendEmailV3" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -196,4 +239,5 @@ async def send_email_async( request_url, response.status, response.text, + response=response, ) diff --git a/src/azure/connectors/sql.py b/src/azure/connectors/sql.py index 80776bb9..40290903 100644 --- a/src/azure/connectors/sql.py +++ b/src/azure/connectors/sql.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,69 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "SqlClient", + "BlobDataSetsMetadata", + "DataSet", + "DataSetParameter", + "DataSetsList", + "DataSetsMetadata", + "DataWithSensitivityLabelInfo", + "Database", + "DatabasesList", + "DynamicTree", + "DynamicTreeOpenBrowse", + "DynamicTreeSettings", + "DynamicValues", + "ExecutePassThroughNativeQueryResponse", + "ExecuteProcedureInput", + "ExecuteProcedureResponse", + "GetItemResponse", + "GetItemsResponse", + "GetTablesResponse", + "Item", + "ItemsList", + "NoNaturalKeyColumnConnectorMetadata", + "ODataServersList", + "ObjectEntity", + "PQMetadata", + "PQMetadataValue", + "PQRows", + "PassThroughNativeQuery", + "PassThroughNativeQueryBody", + "PassThroughNativeQueryMetadata", + "PassThroughNativeQueryResult", + "PassThroughPQBody", + "PassThroughPQResult", + "PatchItemInput", + "PatchItemResponse", + "PostItemInput", + "PostItemResponse", + "Procedure", + "ProcedureMetadata", + "ProcedureResult", + "ProceduresList", + "SensitivityLabelMetadata", + "Server", + "SqlItem", + "SqlItemsList", + "SqlPassThroughNativeQueryBody", + "SqlPassThroughNativeQueryResult", + "Table", + "TableCapabilitiesMetadata", + "TableCountRestrictionsMetadata", + "TableFilterRestrictionsMetadata", + "TableMetadata", + "TableSelectRestrictionsMetadata", + "TableSortRestrictionsMetadata", + "TablesList", + "TabularDataSetsMetadata", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +91,7 @@ class ExecutePassThroughNativeQueryResponse: Response for Execute a SQL query """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -42,7 +104,7 @@ class ExecuteProcedureInput: Execute stored procedure """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -55,7 +117,7 @@ class ExecuteProcedureResponse: Response for Execute stored procedure """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -68,7 +130,7 @@ class GetItemResponse: Response for Get row """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -81,15 +143,24 @@ class GetItemsResponse: Response for Get rows """ - metadata: Optional[List[DataWithSensitivityLabelInfo]] = field( + metadata: Optional[ + List[DataWithSensitivityLabelInfo | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@metadata"}, ) """List of Sensitivity Labels""" - value: Optional[List[SqlItem]] = None + value: Optional[ + List[SqlItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Columns""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -101,7 +172,12 @@ class SqlItemsList: Response for When an item is created """ - value: Optional[List[SqlItem]] = None + value: Optional[ + List[SqlItem | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items""" @@ -111,12 +187,20 @@ class GetTablesResponse: Response for Get tables """ - metadata: Optional[List[DataWithSensitivityLabelInfo]] = field( + metadata: Optional[ + List[DataWithSensitivityLabelInfo | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@metadata"}, ) """List of Sensitivity Labels""" - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Tables""" @@ -126,7 +210,7 @@ class PatchItemInput: Update row """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -139,7 +223,7 @@ class PatchItemResponse: Response for Update row """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -152,7 +236,7 @@ class PostItemInput: Insert row """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -165,7 +249,7 @@ class PostItemResponse: Response for Insert row """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -178,7 +262,12 @@ class ODataServersList: Response for List the servers """ - value: Optional[List[Server]] = None + value: Optional[ + List[Server | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of datasets""" @@ -188,7 +277,12 @@ class DatabasesList: Response for List the databases """ - value: Optional[List[Database]] = None + value: Optional[ + List[Database | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of datasets""" @@ -198,10 +292,16 @@ class TablesList: Response for GetTablesForDeleteItem """ - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Tables""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -213,11 +313,11 @@ class PassThroughNativeQueryMetadata: Response for Get pass-through native SQL query metadata """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Query name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Query title""" - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -226,7 +326,12 @@ class ProceduresList: Response for Get stored procedures """ - value: Optional[List[Procedure]] = None + value: Optional[ + List[Procedure | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Procedures""" @@ -236,11 +341,11 @@ class ProcedureMetadata: Response for Get metadata of a Procedure """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Procedure name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Procedure title""" - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -249,26 +354,30 @@ class TableMetadata: Response for Get metadata of a table """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Table name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Table title""" - x_ms_permission: Optional[str] = field( + x_ms_permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-permission"}, ) """Table permission""" - x_ms_capabilities: Optional[TableCapabilitiesMetadata] = field( + x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-capabilities"}, ) - schema: Optional[ObjectEntity] = None - referenced_entities: Optional[ObjectEntity] = field( + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referencedEntities"}, ) - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """Url link""" @@ -280,15 +389,17 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Blob dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Blob dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Blob dataset url encoding""" @@ -300,21 +411,32 @@ class Database: Definition: Database """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the database. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the database.""" - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """ Additional database properties provided by the connector to the clients. """ - tables: Optional[List[Table]] = None + tables: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Database items""" @@ -324,14 +446,24 @@ class DataSet: Definition: DataSet """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Dataset name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Dataset display name""" - query: Optional[List[PassThroughNativeQuery]] = None + query: Optional[ + List[PassThroughNativeQuery | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Pass-through Native Queries""" @@ -341,30 +473,38 @@ class DataSetParameter: Definition: DataSetParameter """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Type""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Parameter url encoding""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description""" - required: Optional[bool] = None + required: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is parameter required""" - x_ms_summary: Optional[str] = field( + x_ms_summary: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-summary"}, ) """Summary""" - x_ms_dynamic_values: Optional[DynamicValues] = field( + x_ms_dynamic_values: Optional[DynamicValues | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-dynamic-values"}, ) - x_ms_dynamic_tree: Optional[DynamicTree] = field( + x_ms_dynamic_tree: Optional[DynamicTree | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-dynamic-tree"}, ) @@ -375,7 +515,12 @@ class DataSetsList: Definition: DataSetsList """ - value: Optional[List[DataSet]] = None + value: Optional[ + List[DataSet | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of datasets""" @@ -385,17 +530,36 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None - dataset_format: Optional[str] = field( + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + dataset_format: Optional[str] = dataclass_field( + default=None, + kw_only=True, metadata={"wire_name": "datasetFormat"}, ) """Dataset Format""" - parameters: Optional[List[DataSetParameter]] = None + parameters: Optional[ + List[DataSetParameter | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Parameters""" - no_natural_key_column_connector: Optional[NoNaturalKeyColumnConnectorMetadata] = field( + no_natural_key_column_connector: Optional[ + NoNaturalKeyColumnConnectorMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "noNaturalKeyColumnConnector"}, ) @@ -406,10 +570,13 @@ class DataWithSensitivityLabelInfo: Definition: DataWithSensitivityLabelInfo """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name""" - sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = field( + sensitivity_label_info: Optional[ + List[SensitivityLabelMetadata | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelInfo"}, ) """List of Sensitivity Label Information""" @@ -421,9 +588,24 @@ class DynamicTree: Definition: DynamicTree """ - settings: Optional[DynamicTreeSettings] = None - open: Optional[DynamicTreeOpenBrowse] = None - browse: Optional[DynamicTreeOpenBrowse] = None + settings: Optional[ + DynamicTreeSettings | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + open: Optional[ + DynamicTreeOpenBrowse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + browse: Optional[ + DynamicTreeOpenBrowse | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -432,30 +614,35 @@ class DynamicTreeOpenBrowse: Definition: DynamicTreeOpenBrowse """ - path: Optional[str] = None + path: Optional[str] = dataclass_field(default=None, kw_only=True) """Path""" - item_value_path: Optional[str] = field( + item_value_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "itemValuePath"}, ) """Item value path""" - item_title_path: Optional[str] = field( + item_title_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "itemTitlePath"}, ) """Item title path""" - item_full_title_path: Optional[str] = field( + item_full_title_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "itemFullTitlePath"}, ) """Item full title path""" - item_is_parent: Optional[str] = field( + item_is_parent: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "itemIsParent"}, ) """Is item parent""" - selectable_filter: Optional[str] = field( + selectable_filter: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectableFilter"}, ) """Selectable filter""" @@ -467,18 +654,21 @@ class DynamicTreeSettings: Definition: DynamicTreeSettings """ - can_select_parent_nodes: Optional[bool] = field( + can_select_parent_nodes: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "canSelectParentNodes"}, ) """Can select parent nodes""" - can_select_leaf_nodes: Optional[bool] = field( + can_select_leaf_nodes: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "canSelectLeafNodes"}, ) """Can select leaf nodes""" - selected_item_placeholder: Optional[str] = field( + selected_item_placeholder: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectedItemPlaceholder"}, ) """Selected item placeholder in the path""" @@ -490,20 +680,23 @@ class DynamicValues: Definition: DynamicValues """ - path: Optional[str] = None + path: Optional[str] = dataclass_field(default=None, kw_only=True) """Path""" - value_collection: Optional[str] = field( + value_collection: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "value-collection"}, ) """Value collection""" - value_path: Optional[str] = field( + value_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "value-path"}, ) """Value path""" - value_title: Optional[str] = field( + value_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "value-title"}, ) """Value title""" @@ -515,8 +708,9 @@ class Item: Definition: Item """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -527,7 +721,12 @@ class ItemsList: Definition: ItemsList """ - value: Optional[List[Item]] = None + value: Optional[ + List[Item | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of Items""" @@ -537,18 +736,21 @@ class NoNaturalKeyColumnConnectorMetadata: Definition: NoNaturalKeyColumnConnectorMetadata """ - create_key_column_path: Optional[str] = field( + create_key_column_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createKeyColumnPath"}, ) """Path to create key column""" - create_key_column_method: Optional[str] = field( + create_key_column_method: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createKeyColumnMethod"}, ) """Method to create key column""" - key_column_name_url_encoding: Optional[str] = field( + key_column_name_url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "keyColumnNameUrlEncoding"}, ) """Key column name url encoding""" @@ -560,7 +762,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -573,8 +775,9 @@ class PassThroughNativeQuery: Definition: PassThroughNativeQuery """ - language: Optional[str] = field( + language: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Language"}, ) """Query language""" @@ -586,15 +789,17 @@ class PassThroughNativeQueryBody: Definition: PassThroughNativeQueryBody """ - query: Optional[str] = None + query: Optional[str] = dataclass_field(default=None, kw_only=True) """Query Text""" - formal_parameters: Optional[Dict[str, str]] = field( + formal_parameters: Optional[Dict[str, str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "formalParameters"}, ) """Formal Parameters""" - actual_parameters: Optional[Dict[str, ObjectEntity]] = field( + actual_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actualParameters"}, ) """Actual parameters""" @@ -606,13 +811,17 @@ class PassThroughNativeQueryResult: Definition: PassThroughNativeQueryResult """ - output_parameters: Optional[Dict[str, ObjectEntity]] = field( + output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OutputParameters"}, ) """Output parameter values""" - result_sets: Optional[Dict[str, List[Dict[str, ObjectEntity]]]] = field( + result_sets: Optional[ + Dict[str, List[Dict[str, ObjectEntity | Mapping[str, Any]]]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultSets"}, ) """Collection of all result sets""" @@ -624,10 +833,15 @@ class Procedure: Definition: Procedure """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """Procedure name""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """Procedure display name""" @@ -639,20 +853,25 @@ class ProcedureResult: Definition: ProcedureResult """ - output_parameters: Optional[Dict[str, ObjectEntity]] = field( + output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OutputParameters"}, ) """ Output parameter values. The schema is dynamic based on the procedure. """ - return_code: Optional[int] = field( + return_code: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReturnCode"}, ) """Return code of a procedure.""" - result_sets: Optional[Dict[str, List[Dict[str, ObjectEntity]]]] = field( + result_sets: Optional[ + Dict[str, List[Dict[str, ObjectEntity | Mapping[str, Any]]]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultSets"}, ) """ @@ -667,41 +886,47 @@ class SensitivityLabelMetadata: Definition: SensitivityLabelMetadata """ - sensitivity_label_id: Optional[str] = field( + sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sensitivityLabelId"}, ) """SensitivityLabel Id.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel name.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """SensitivityLabel displayName info""" - tooltip: Optional[str] = None + tooltip: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel details on tooltip.""" - priority: Optional[int] = None + priority: Optional[int] = dataclass_field(default=None, kw_only=True) """SensitivityLabel priority.""" - color: Optional[str] = None + color: Optional[str] = dataclass_field(default=None, kw_only=True) """SensitivityLabel color.""" - is_encrypted: Optional[bool] = field( + is_encrypted: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEncrypted"}, ) """ is SensitivityLabel Encrypted.""" - is_enabled: Optional[bool] = field( + is_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEnabled"}, ) """Whether SensitivityLabel is Enabled.""" - is_parent: Optional[bool] = field( + is_parent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isParent"}, ) """Whether SensitivityLabel is Parent.""" - parent_sensitivity_label_id: Optional[str] = field( + parent_sensitivity_label_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentSensitivityLabelId"}, ) """Parent SensitivityLabel Id.""" @@ -713,21 +938,32 @@ class Server: Definition: Server """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the server. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the server.""" - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """ Additional server properties provided by the connector to the clients. """ - databases: Optional[List[Database]] = None + databases: Optional[ + List[Database | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Table items""" @@ -737,8 +973,9 @@ class SqlItem: Definition: SqlItem """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -749,15 +986,17 @@ class SqlPassThroughNativeQueryBody: Definition: SqlPassThroughNativeQueryBody """ - actual_parameters: Optional[Dict[str, ObjectEntity]] = field( + actual_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actualParameters"}, ) """Actual parameters""" - query: Optional[str] = None + query: Optional[str] = dataclass_field(default=None, kw_only=True) """Query Text""" - formal_parameters: Optional[Dict[str, str]] = field( + formal_parameters: Optional[Dict[str, str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "formalParameters"}, ) """Formal Parameters""" @@ -769,13 +1008,17 @@ class SqlPassThroughNativeQueryResult: Definition: SqlPassThroughNativeQueryResult """ - output_parameters: Optional[Dict[str, ObjectEntity]] = field( + output_parameters: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OutputParameters"}, ) """Output parameter values""" - result_sets: Optional[Dict[str, List[Dict[str, ObjectEntity]]]] = field( + result_sets: Optional[ + Dict[str, List[Dict[str, ObjectEntity | Mapping[str, Any]]]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResultSets"}, ) """Collection of all result sets""" @@ -787,15 +1030,21 @@ class Table: Definition: Table """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the table. The name is used at runtime.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the table.""" - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DynamicProperties"}, ) """Additional table properties provided by the connector to the clients.""" @@ -807,34 +1056,49 @@ class TableCapabilitiesMetadata: Definition: TableCapabilitiesMetadata """ - sort_restrictions: Optional[TableSortRestrictionsMetadata] = field( + sort_restrictions: Optional[ + TableSortRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortRestrictions"}, ) - filter_restrictions: Optional[TableFilterRestrictionsMetadata] = field( + filter_restrictions: Optional[ + TableFilterRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterRestrictions"}, ) - select_restrictions: Optional[TableSelectRestrictionsMetadata] = field( + select_restrictions: Optional[ + TableSelectRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectRestrictions"}, ) - count_restrictions: Optional[TableCountRestrictionsMetadata] = field( + count_restrictions: Optional[ + TableCountRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "countRestrictions"}, ) - is_only_server_pagable: Optional[bool] = field( + is_only_server_pagable: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOnlyServerPagable"}, ) """Server paging restrictions""" - filter_function_support: Optional[List[str]] = field( + filter_function_support: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterFunctionSupport"}, ) """List of supported filter capabilities""" - server_paging_options: Optional[List[str]] = field( + server_paging_options: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "serverPagingOptions"}, ) """List of supported server-driven paging capabilities""" @@ -846,15 +1110,17 @@ class TableFilterRestrictionsMetadata: Definition: TableFilterRestrictionsMetadata """ - filterable: Optional[bool] = None + filterable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has filterable columns""" - non_filterable_properties: Optional[List[str]] = field( + non_filterable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nonFilterableProperties"}, ) """List of non filterable properties""" - required_properties: Optional[List[str]] = field( + required_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredProperties"}, ) """List of required properties""" @@ -866,7 +1132,7 @@ class TableSelectRestrictionsMetadata: Definition: TableSelectRestrictionsMetadata """ - selectable: Optional[bool] = None + selectable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has selectable columns""" @@ -876,7 +1142,7 @@ class TableCountRestrictionsMetadata: Definition: TableCountRestrictionsMetadata """ - countable: Optional[bool] = None + countable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has countable columns""" @@ -886,15 +1152,17 @@ class TableSortRestrictionsMetadata: Definition: TableSortRestrictionsMetadata """ - sortable: Optional[bool] = None + sortable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has sortable columns""" - unsortable_properties: Optional[List[str]] = field( + unsortable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unsortableProperties"}, ) """List of unsortable properties""" - ascending_only_properties: Optional[List[str]] = field( + ascending_only_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ascendingOnlyProperties"}, ) """List of properties which support ascending order only""" @@ -906,25 +1174,29 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """Dataset source""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Dataset display name""" - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) """Dataset url encoding""" - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) """Table display name""" - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) """Table plural display name""" @@ -936,7 +1208,7 @@ class PassThroughPQBody: Definition: PassThroughPQBody """ - query: Optional[str] = None + query: Optional[str] = dataclass_field(default=None, kw_only=True) """Query Text""" @@ -946,9 +1218,15 @@ class PQMetadata: Definition: PQMetadata """ - value: Optional[PQMetadataValue] = None - result_type: Optional[str] = field( + value: Optional[ + PQMetadataValue | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + result_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resultType"}, ) """Result Type""" @@ -960,11 +1238,11 @@ class PQMetadataValue: Definition: PQMetadataValue """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Query name""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Query title""" - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -973,7 +1251,7 @@ class PassThroughPQResult: Definition: PassThroughPQResult """ - value: Optional[PQRows] = None + value: Optional[PQRows | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -982,7 +1260,7 @@ class PQRows: Definition: PQRows """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1000,7 +1278,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1017,8 +1295,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1039,7 +1317,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1055,15 +1333,49 @@ def connector_name(self) -> str: return "sql" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -1080,7 +1392,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -1093,7 +1409,7 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def delete_item_async( + async def delete_item( self, server: str, database: str, @@ -1109,6 +1425,24 @@ async def delete_item_async( Delete row This operation deletes a row from a table. + + Swagger operation ID: `DeleteItem_V2`. + + Args: + server: Name of SQL server. + database: Database name. + table: Name of table. + id: Unique identifier of the row to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1124,7 +1458,7 @@ async def delete_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1138,11 +1472,12 @@ async def delete_item_async( request_url, response.status, response.text, + response=response, ) - async def execute_pass_through_native_query_async( + async def execute_pass_through_native_query( self, - input: SqlPassThroughNativeQueryBody, + input: SqlPassThroughNativeQueryBody | Mapping[str, Any], server: str, database: str, *, @@ -1155,6 +1490,24 @@ async def execute_pass_through_native_query_async( Execute a SQL query Execute a SQL query + + Swagger operation ID: `ExecutePassThroughNativeQuery_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + server: Name of SQL server. + database: Database name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1168,7 +1521,7 @@ async def execute_pass_through_native_query_async( f"/sql" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1182,6 +1535,7 @@ async def execute_pass_through_native_query_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1189,9 +1543,9 @@ async def execute_pass_through_native_query_async( return json.loads(response.text) - async def execute_procedure_async( + async def execute_procedure( self, - input: ExecuteProcedureInput, + input: ExecuteProcedureInput | Mapping[str, Any], server: str, database: str, procedure: str, @@ -1205,6 +1559,25 @@ async def execute_procedure_async( Execute stored procedure This operation runs a stored procedure. + + Swagger operation ID: `ExecuteProcedure_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + server: Name of SQL server. + database: Database name. + procedure: Name of stored procedure. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1218,7 +1591,7 @@ async def execute_procedure_async( f"/{quote(quote(str(procedure), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1232,6 +1605,7 @@ async def execute_procedure_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1239,7 +1613,7 @@ async def execute_procedure_async( return json.loads(response.text) - async def get_item_async( + async def get_item( self, server: str, database: str, @@ -1255,6 +1629,24 @@ async def get_item_async( Get row This operation gets a row from a table. + + Swagger operation ID: `GetItem_V2`. + + Args: + server: Name of SQL server. + database: Database name. + table: Name of SQL table. + id: Unique identifier of the row to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1270,7 +1662,7 @@ async def get_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1284,6 +1676,7 @@ async def get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1291,11 +1684,12 @@ async def get_item_async( return json.loads(response.text) - async def get_items_async( + def list_items( self, server: str, database: str, table: str, + *, apply: Optional[str] = None, filter: Optional[str] = None, orderby: Optional[str] = None, @@ -1305,19 +1699,49 @@ async def get_items_async( count: Optional[bool] = None, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get rows This operation gets rows from a table. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems_V2`. + + Args: + server: Name of SQL server. + database: Database name. + table: Name of SQL table. + apply: A sequence of OData aggregation transformations. + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + skip: The number of entries to skip (default = 0). + top: Total number of entries to retrieve (default = all). + select: Specific fields to retrieve from entries (default = all). + count: Option to specify if only total entity count should be + returned in the query (default = false). + extract_sensitivity_label: Specify whether to extract MIP labels. + purview_account_name: Default collection will be queried unless + specified. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1379,11 +1803,18 @@ async def get_items_async( query_params.append(f"purviewAccountName={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1396,38 +1827,69 @@ async def get_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_tables_async( + def list_tables( self, server: str, database: str, + *, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get tables This operation gets tables from a database. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTables_V2`. + + Args: + server: Name of SQL server. + database: Database name. + extract_sensitivity_label: Specify whether to extract MIP labels. + purview_account_name: Default collection will be queried unless + specified. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1452,31 +1914,52 @@ async def get_tables_async( query_params.append(f"purviewAccountName={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def patch_item_async( + async def patch_item( self, - input: PatchItemInput, + input: PatchItemInput | Mapping[str, Any], server: str, database: str, table: str, @@ -1491,6 +1974,26 @@ async def patch_item_async( Update row This operation updates an existing row in a table. + + Swagger operation ID: `PatchItem_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + server: Name of SQL server. + database: Database name. + table: Name of table. + id: Unique identifier of the row to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1506,7 +2009,7 @@ async def patch_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1520,6 +2023,7 @@ async def patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1527,9 +2031,9 @@ async def patch_item_async( return json.loads(response.text) - async def post_item_async( + async def post_item( self, - input: PostItemInput, + input: PostItemInput | Mapping[str, Any], server: str, database: str, table: str, @@ -1543,6 +2047,25 @@ async def post_item_async( Insert row This operation inserts a new row into a table. + + Swagger operation ID: `PostItem_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + server: Name of SQL server. + database: Database name. + table: Name of table. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1557,7 +2080,7 @@ async def post_item_async( f"/items" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1571,6 +2094,7 @@ async def post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1578,43 +2102,81 @@ async def post_item_async( return json.loads(response.text) - async def get_servers_async( + def list_servers( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List the servers List the servers + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetServers`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/servers" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - async def get_databases_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_databases( self, server: str, *, @@ -1622,11 +2184,29 @@ async def get_databases_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List the databases List the databases + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDatabases`. + + Args: + server: Server name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/databases" query_params = [] @@ -1636,29 +2216,50 @@ async def get_databases_async( query_params.append(f"server={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - async def get_tables_for_delete_item_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_tables_for_delete_item( self, server: str, database: str, @@ -1667,14 +2268,31 @@ async def get_tables_for_delete_item_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ GetTablesForDeleteItem GetTablesForDeleteItem - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetTablesForDeleteItem_V2`. + + Args: + server: Name of SQL server. + database: Database name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1687,11 +2305,18 @@ async def get_tables_for_delete_item_async( f"/tablesfor" f"/deleteitem" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1704,25 +2329,34 @@ async def get_tables_for_delete_item_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_pass_through_native_query_metadata_async( + async def get_pass_through_native_query_metadata( self, - input: SqlPassThroughNativeQueryBody, + input: SqlPassThroughNativeQueryBody | Mapping[str, Any], server: str, database: str, *, @@ -1735,6 +2369,24 @@ async def get_pass_through_native_query_metadata_async( Get pass-through native SQL query metadata Retrieves metadata for a pass-through native SQL query. + + Swagger operation ID: `GetPassThroughNativeQueryMetadata_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + server: Name of SQL server. + database: Database name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1749,7 +2401,7 @@ async def get_pass_through_native_query_metadata_async( f"/sql" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1763,6 +2415,7 @@ async def get_pass_through_native_query_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1770,7 +2423,7 @@ async def get_pass_through_native_query_metadata_async( return json.loads(response.text) - async def get_procedures_v2_async( + def list_procedures_v2( self, server: str, database: str, @@ -1779,11 +2432,30 @@ async def get_procedures_v2_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get stored procedures This operation gets stored procedures for a database. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetProcedures_V2`. + + Args: + server: Name of SQL server. + database: Database name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1795,29 +2467,50 @@ async def get_procedures_v2_async( f"{quote(quote(str(database), safe=''), safe='')}" f"/procedures" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - async def get_procedure_v2_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_procedure_v2( self, server: str, database: str, @@ -1832,6 +2525,23 @@ async def get_procedure_v2_async( Get metadata of a Procedure Get metadata of a Procedure. + + Swagger operation ID: `GetProcedure_V2`. + + Args: + server: Name of SQL server. + database: Database name. + procedure: Procedure name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1846,7 +2556,7 @@ async def get_procedure_v2_async( f"/{quote(quote(str(procedure), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1860,6 +2570,7 @@ async def get_procedure_v2_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1867,7 +2578,7 @@ async def get_procedure_v2_async( return json.loads(response.text) - async def get_tables_for_get_item_async( + def list_tables_for_get_item( self, server: str, database: str, @@ -1876,14 +2587,31 @@ async def get_tables_for_get_item_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ GetTablesForGetItem GetTablesForGetItem - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetTablesForGetItem_V2`. + + Args: + server: Name of SQL server. + database: Database name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1896,11 +2624,18 @@ async def get_tables_for_get_item_async( f"/tablesfor" f"/getitem" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1913,30 +2648,39 @@ async def get_tables_for_get_item_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_table_async( + async def get_table( self, server: str, database: str, table: str, + *, extract_sensitivity_label: Optional[bool] = None, purview_account_name: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1946,6 +2690,26 @@ async def get_table_async( Get metadata of a table Get metadata of a table. + + Swagger operation ID: `GetTable_V2`. + + Args: + server: Name of SQL server. + database: Database name. + table: table name. + extract_sensitivity_label: Specify whether to extract MIP labels. + purview_account_name: Default collection will be queried unless + specified. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1973,7 +2737,7 @@ async def get_table_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1987,6 +2751,7 @@ async def get_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1994,7 +2759,7 @@ async def get_table_async( return json.loads(response.text) - async def get_tables_for_get_on_new_items_async( + def list_tables_for_get_on_new_items( self, server: str, database: str, @@ -2003,14 +2768,31 @@ async def get_tables_for_get_on_new_items_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ GetTablesForOnItemCreated GetTablesForOnItemCreated - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetTablesForGetOnNewItems_V2`. + + Args: + server: Name of SQL server. + database: Database name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2023,11 +2805,18 @@ async def get_tables_for_get_on_new_items_async( f"/tablesfor" f"/getonnewitems" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2040,23 +2829,32 @@ async def get_tables_for_get_on_new_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_tables_for_get_on_updated_items_async( + return AsyncItemPaged(get_next, extract_data) + + def list_tables_for_get_on_updated_items( self, server: str, database: str, @@ -2065,14 +2863,31 @@ async def get_tables_for_get_on_updated_items_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ GetTablesForOnItemUpdated GetTablesForOnItemUpdated - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetTablesForGetOnUpdatedItems_V2`. + + Args: + server: Name of SQL server. + database: Database name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2085,11 +2900,18 @@ async def get_tables_for_get_on_updated_items_async( f"/tablesfor" f"/getonupdateditems" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2102,23 +2924,32 @@ async def get_tables_for_get_on_updated_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_tables_for_patch_item_async( + return AsyncItemPaged(get_next, extract_data) + + def list_tables_for_patch_item( self, server: str, database: str, @@ -2127,14 +2958,31 @@ async def get_tables_for_patch_item_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ GetTablesForPatchItem GetTablesForPatchItem - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetTablesForPatchItem_V2`. + + Args: + server: Name of SQL server. + database: Database name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2147,11 +2995,18 @@ async def get_tables_for_patch_item_async( f"/tablesfor" f"/patchitem" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2164,23 +3019,32 @@ async def get_tables_for_patch_item_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_table_for_patch_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_table_for_patch( self, server: str, database: str, @@ -2195,6 +3059,23 @@ async def get_table_for_patch_async( Get metadata of a table for Patch operation Get metadata of a table for Patch operation. + + Swagger operation ID: `GetTableForPatch_V2`. + + Args: + server: Name of SQL server. + database: Database name. + table: table name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2210,7 +3091,7 @@ async def get_table_for_patch_async( f"/forPatchItem" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2224,6 +3105,7 @@ async def get_table_for_patch_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2231,7 +3113,7 @@ async def get_table_for_patch_async( return json.loads(response.text) - async def get_tables_for_post_item_async( + def list_tables_for_post_item( self, server: str, database: str, @@ -2240,14 +3122,31 @@ async def get_tables_for_post_item_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ GetTablesForPostItem GetTablesForPostItem - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetTablesForPostItem_V2`. + + Args: + server: Name of SQL server. + database: Database name. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2260,11 +3159,18 @@ async def get_tables_for_post_item_async( f"/tablesfor" f"/postitem" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2277,23 +3183,32 @@ async def get_tables_for_post_item_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_procedure_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_procedure( self, procedure: str, *, @@ -2306,6 +3221,21 @@ async def get_procedure_async( Get procedure metadata This operation gets metadata for a stored procedure. + + Swagger operation ID: `GetProcedure`. + + Args: + procedure: Name of stored procedure. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2316,7 +3246,7 @@ async def get_procedure_async( f"/{quote(quote(str(procedure), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2330,6 +3260,7 @@ async def get_procedure_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2337,43 +3268,81 @@ async def get_procedure_async( return json.loads(response.text) - async def get_procedures_async( + def list_procedures( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get stored procedures This operation gets stored procedures for a database. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetProcedures`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/datasets/default/procedures" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/starmind.py b/src/azure/connectors/starmind.py index 4e0e0b04..70cf58dd 100644 --- a/src/azure/connectors/starmind.py +++ b/src/azure/connectors/starmind.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Literal, Any, Mapping from urllib.parse import quote import json @@ -20,6 +20,31 @@ ConnectorResponseHook, ) +__all__ = [ + "StarmindClient", + "Attachment", + "Comment", + "ConceptLabelMatch", + "ExpertConceptScores", + "FindExpertsInput", + "FindExpertsResponse", + "FindQuestionsResponse", + "GraphQLError", + "GraphQLUserResponse", + "KnowledgeSpace", + "Language", + "PostQuestionDraftInput", + "PublishQuestionDraftResponse", + "Question", + "QuestionComplete", + "Solution", + "SolutionAuthorityApproval", + "SolutionValidation", + "User", + "UserId", + "UserLegacy", +] + # Type Definitions @@ -29,8 +54,8 @@ class FindExpertsInput: Find experts """ - language: Optional[Language] = None - text_query: Optional[str] = None + language: Optional[Language] = dataclass_field(default=None, kw_only=True) + text_query: str """ Primary search text to identify experts. Can be a question, a summary of a text, one or multiple topics. @@ -43,12 +68,17 @@ class FindExpertsResponse: Response for Find experts """ - experts: Optional[List[Dict[str, Any]]] = None + experts: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """ List of experts matching the search query. May be empty if no experts are found. """ - label_matches: Optional[List[ConceptLabelMatch]] = None + label_matches: Optional[ + List[ConceptLabelMatch | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """ The matched labels for the expert search query. May be empty if no labels match. @@ -61,14 +91,20 @@ class FindQuestionsResponse: Response for Find questions """ - links: Optional[Dict[str, Any]] = field( + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) """_links""" - items: Optional[List[Question]] = None + items: Optional[ + List[Question | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Paginated results of the question search.""" - total: Optional[int] = None + total: Optional[int] = dataclass_field(default=None, kw_only=True) """Total number of questions matching the request.""" @@ -78,8 +114,13 @@ class GraphQLUserResponse: Response for Get user by id """ - data: Optional[Dict[str, Any]] = None - errors: Optional[List[GraphQLError]] = None + data: Dict[str, Any] + errors: Optional[ + List[GraphQLError | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Optional array of GraphQL errors; only present if errors occurred""" @@ -89,22 +130,22 @@ class PostQuestionDraftInput: Create a question draft """ - category: Optional[int] = None + category: Optional[int] = dataclass_field(default=None, kw_only=True) """The optional id of the category to assign the question draft to""" - title: Optional[str] = None + title: str """ Question title, Between 4 and 100 characters by default. Depending on the network configuration the title max length may be limited or extended further. """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ The optional question description providing detailed context and information about the question. Depending on the network configuration the description might be enforced to be non-empty. """ - language: Optional[Language] = None - knowledge_space: Optional[int] = None + language: Optional[Language] = dataclass_field(default=None, kw_only=True) + knowledge_space: Optional[int] = dataclass_field(default=None, kw_only=True) """the id of the knowledge space to assign the question to""" @@ -114,63 +155,63 @@ class Question: Response for Create a question draft """ - knowledge_space_id: Optional[int] = None + knowledge_space_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique knowledge space id to which the question belongs.""" - upvote_count: Optional[int] = None + upvote_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of upvotes the question has received.""" - view_count: Optional[int] = None + view_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of times the question has been viewed by users.""" - published: Optional[str] = None + published: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the question was published (yyyy-MM-ddTHH:mm:ss.fffZ) """ - is_deleted: Optional[bool] = None + is_deleted: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Indicates if the question is deleted. Deleted questions are not visible to users, but can still be accessed by the administrators. """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The question title""" - last_activity: Optional[str] = None + last_activity: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating the last activity with the question (yyyy-MM-ddTHH:mm:ss.fffZ) """ - is_published: Optional[bool] = None + is_published: Optional[bool] = dataclass_field(default=None, kw_only=True) """ The question is_published flag indicates whether the question is published or not. A published solution is visible to all users, while an unpublished solution is in draft state only visible to the author. """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the question was created (yyyy-MM-ddTHH:mm:ss.fffZ) """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ Question description providing detailed context and information about the question """ - solution_count: Optional[int] = None + solution_count: Optional[int] = dataclass_field(default=None, kw_only=True) """ This is the number of solutions that have been provided for this question. """ - content_updated: Optional[str] = None + content_updated: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the question's content or attachments were last updated (yyyy-MM-ddTHH:mm:ss.fffZ) """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique question id""" - updated: Optional[str] = None + updated: Optional[str] = dataclass_field(default=None, kw_only=True) """ Last time the resource has been updated in the DB. This date does not reflect content updates but any update to any fields of the record. Use content_updated for information about content updates. """ - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The question language""" @@ -180,7 +221,7 @@ class PublishQuestionDraftResponse: Response for Publish a question """ - number_of_experts: Optional[int] = None + number_of_experts: Optional[int] = dataclass_field(default=None, kw_only=True) """number_of_experts""" @@ -190,75 +231,100 @@ class QuestionComplete: Definition: QuestionComplete """ - knowledge_space_id: Optional[int] = None + knowledge_space_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique knowledge space id to which the question belongs.""" - upvote_count: Optional[int] = None + upvote_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of upvotes the question has received.""" - view_count: Optional[int] = None + view_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of times the question has been viewed by users.""" - published: Optional[str] = None + published: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the question was published (yyyy-MM-ddTHH:mm:ss.fffZ) """ - is_deleted: Optional[bool] = None + is_deleted: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Indicates if the question is deleted. Deleted questions are not visible to users, but can still be accessed by the administrators. """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The question title""" - last_activity: Optional[str] = None + last_activity: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating the last activity with the question (yyyy-MM-ddTHH:mm:ss.fffZ) """ - is_published: Optional[bool] = None + is_published: Optional[bool] = dataclass_field(default=None, kw_only=True) """ The question is_published flag indicates whether the question is published or not. A published solution is visible to all users, while an unpublished solution is in draft state only visible to the author. """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the question was created (yyyy-MM-ddTHH:mm:ss.fffZ) """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ Question description providing detailed context and information about the question """ - solution_count: Optional[int] = None + solution_count: Optional[int] = dataclass_field(default=None, kw_only=True) """ This is the number of solutions that have been provided for this question. """ - content_updated: Optional[str] = None + content_updated: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the question's content or attachments were last updated (yyyy-MM-ddTHH:mm:ss.fffZ) """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique question id""" - updated: Optional[str] = None + updated: Optional[str] = dataclass_field(default=None, kw_only=True) """ Last time the resource has been updated in the DB. This date does not reflect content updates but any update to any fields of the record. Use content_updated for information about content updates. """ - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The question language""" - source: Optional[str] = None + source: Optional[str] = dataclass_field(default=None, kw_only=True) """source""" - concepts: Optional[List[ConceptLabelMatch]] = None + concepts: Optional[ + List[ConceptLabelMatch | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The assigned question concepts""" - knowledge_space: Optional[KnowledgeSpace] = None + knowledge_space: Optional[ + KnowledgeSpace | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The assigned question knowledge space""" - solutions: Optional[List[Solution]] = None + solutions: Optional[ + List[Solution | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The question solutions""" - attachments: Optional[List[Attachment]] = None + attachments: Optional[ + List[Attachment | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The question attachments""" - comments: Optional[List[Comment]] = None + comments: Optional[ + List[Comment | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The question comments""" @@ -268,19 +334,19 @@ class ConceptLabelMatch: Definition: ConceptLabelMatch """ - concept_id: Optional[str] = None + concept_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique concept id""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The concept description""" - is_flat: Optional[bool] = None + is_flat: Optional[bool] = dataclass_field(default=None, kw_only=True) """is_flat""" - label_match: Optional[str] = None + label_match: Optional[str] = dataclass_field(default=None, kw_only=True) """The label that matched the concept""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """Concept language""" - ontology_id: Optional[str] = None + ontology_id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ontology id to which the concept belongs""" - primary_label: Optional[str] = None + primary_label: Optional[str] = dataclass_field(default=None, kw_only=True) """Concept primary label""" @@ -290,22 +356,22 @@ class Attachment: Definition: Attachment """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the attachment was created (yyyy-MM-ddTHH:mm:ss.fffZ) """ - hash: Optional[str] = None + hash: Optional[str] = dataclass_field(default=None, kw_only=True) """The attachment hash""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """the unique attachment id""" - link: Optional[str] = None + link: Optional[str] = dataclass_field(default=None, kw_only=True) """The relative url to the attachment resource""" - mime_type: Optional[str] = None + mime_type: Optional[str] = dataclass_field(default=None, kw_only=True) """The attachment file mime_type""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The attachment file name""" - size: Optional[int] = None + size: Optional[int] = dataclass_field(default=None, kw_only=True) """The attachment file size""" @@ -315,34 +381,34 @@ class Comment: Definition: Comment """ - content_updated: Optional[str] = None + content_updated: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the comment's description was last updated (yyyy-MM-ddTHH:mm:ss.fffZ) """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the comment was created (yyyy-MM-ddTHH:mm:ss.fffZ) """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ This is the main text of the comment that provides additional information or context to the question or solution. """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique comment id""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The comment language""" - updated: Optional[str] = None + updated: Optional[str] = dataclass_field(default=None, kw_only=True) """ Last time the resource has been updated in the DB. This date does not reflect content updates but any update to any fields of the record. Use content_updated for information about content updates. """ - upvote_count: Optional[int] = None + upvote_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of upvotes the comment has received.""" - user: Optional[UserLegacy] = None + user: Optional[UserLegacy | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -351,64 +417,84 @@ class Solution: Definition: Solution """ - accepted_by_question_poser: Optional[str] = None + accepted_by_question_poser: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating whether the solution has been accepted by the question poser (yyyy-MM-ddTHH:mm:ss.fffZ) """ - attachments: Optional[List[Attachment]] = None + attachments: Optional[ + List[Attachment | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The solution attachments""" - comments: Optional[List[Comment]] = None + comments: Optional[ + List[Comment | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The solution comments""" - content_updated: Optional[str] = None + content_updated: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the solution's content was last updated (yyyy-MM-ddTHH:mm:ss.fffZ) """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the solution was created (yyyy-MM-ddTHH:mm:ss.fffZ) """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ This is the main text of the solution that provides the answer or guidance to the question posed. """ - expires: Optional[str] = None + expires: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the solution is about to expiry and requires revalidation (yyyy-MM-ddTHH:mm:ss.fffZ) """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """the unique solution id""" - is_published: Optional[bool] = None + is_published: Optional[bool] = dataclass_field(default=None, kw_only=True) """ The solution is_published flag indicates whether the solution is published or not. A published solution is visible to all users. """ - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """The solution language""" - published: Optional[str] = None + published: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the solution was published (yyyy-MM-ddTHH:mm:ss.fffZ) """ - rating_count: Optional[int] = None + rating_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Total number of ratings for the solution.""" - solution_authority_approval: Optional[SolutionAuthorityApproval] = None - updated: Optional[str] = None + solution_authority_approval: Optional[ + SolutionAuthorityApproval | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + updated: Optional[str] = dataclass_field(default=None, kw_only=True) """ Last time the resource has been updated in the DB. This date does not reflect content updates but any update to any fields of the record. Use content_updated for information about content updates. """ - upvote_count: Optional[int] = None + upvote_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of upvotes the solution has received.""" - user: Optional[UserLegacy] = None + user: Optional[UserLegacy | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) """The user who created the solution""" - validated: Optional[SolutionValidation] = None - validity_period: Optional[str] = None + validated: Optional[ + SolutionValidation | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + validity_period: Optional[str] = dataclass_field(default=None, kw_only=True) """Validity period until the solution is considered expired""" @@ -418,17 +504,19 @@ class SolutionValidation: Definition: SolutionValidation """ - revalidated_at: Optional[str] = field( + revalidated_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "revalidatedAt"}, ) """The date when the solution was revalidated""" - validity_period: Optional[str] = field( + validity_period: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "validityPeriod"}, ) """The validity period until the solution is considered expired""" - user: Optional[UserLegacy] = None + user: Optional[UserLegacy | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) """The user who validated the solution""" @@ -438,13 +526,13 @@ class SolutionAuthorityApproval: Definition: SolutionAuthorityApproval """ - approval_date: Optional[str] = None + approval_date: Optional[str] = dataclass_field(default=None, kw_only=True) """Date of the solution authority approval (yyyy-MM-ddTHH:mm:ss.fffZ)""" - solution_authority_id: Optional[int] = None + solution_authority_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ID of the solution authority""" - solution_authority_name: Optional[str] = None + solution_authority_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the solution authority""" - user: Optional[UserLegacy] = None + user: Optional[UserLegacy | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -453,18 +541,19 @@ class UserLegacy: Definition: UserLegacy """ - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """email""" - global_user_id: Optional[str] = field( + global_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "globalUserId"}, ) """global_user_id""" - image: Optional[str] = None + image: Optional[str] = dataclass_field(default=None, kw_only=True) """image""" - firstname: Optional[str] = None + firstname: Optional[str] = dataclass_field(default=None, kw_only=True) """firstname""" - lastname: Optional[str] = None + lastname: Optional[str] = dataclass_field(default=None, kw_only=True) """lastname""" @@ -477,56 +566,56 @@ class User: Definition: User """ - about: Optional[str] = None + about: Optional[str] = dataclass_field(default=None, kw_only=True) """ Custom text entered by the user to describe themselves in their 'About Me' section """ - avatar_url: Optional[str] = None + avatar_url: Optional[str] = dataclass_field(default=None, kw_only=True) """URL to the user's avatar image""" - company: Optional[str] = None + company: Optional[str] = dataclass_field(default=None, kw_only=True) """Company of the user""" - country: Optional[str] = None + country: Optional[str] = dataclass_field(default=None, kw_only=True) """ISO 3166-1 alpha-2 country code (e.g. ch, us, de) of the user""" - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the user was created (yyyy-MM-ddTHH:mm:ss.fffZ) """ - deleted: Optional[str] = None + deleted: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the user was deleted (yyyy-MM-ddTHH:mm:ss.fffZ). Without admin permissions, only non deleted user will be returned """ - department: Optional[str] = None + department: Optional[str] = dataclass_field(default=None, kw_only=True) """Department of the user""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """Email of the user""" - first_name: Optional[str] = None + first_name: Optional[str] = dataclass_field(default=None, kw_only=True) """First name of the user.""" - first_seen: Optional[str] = None + first_seen: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the user logged in the first time (yyyy-MM-ddTHH:mm:ss.fffZ) """ - id: Optional[UserId] = None - is_federated: Optional[bool] = None + id: Optional[UserId] = dataclass_field(default=None, kw_only=True) + is_federated: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Indicates whether the user authenticates using local credentials (email/password) rather than an external SSO provider (SAML, OpenID Connect) """ - is_technical: Optional[bool] = None + is_technical: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Indicates whether the user is a technical API user (non-interactive/machine account); when true the user typically authenticates via API key """ - language: Optional[Language] = None + language: Optional[Language] = dataclass_field(default=None, kw_only=True) """The user's interface language preference""" - last_name: Optional[str] = None + last_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Last name of the user.""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """Location of the user""" - position: Optional[str] = None + position: Optional[str] = dataclass_field(default=None, kw_only=True) """Company of the user""" @@ -536,24 +625,24 @@ class KnowledgeSpace: Definition: KnowledgeSpace """ - automatic_new_user_assignment: Optional[bool] = None + automatic_new_user_assignment: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates if new users are automatically assigned""" - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp indicating when the knowledge space was created (yyyy-MM-ddTHH:mm:ss.fffZ) """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the knowledge space""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique knowledge space id""" - is_closed: Optional[bool] = None + is_closed: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates if the knowledge space is non public""" - member_count: Optional[int] = None + member_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of members""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the knowledge space""" - updated: Optional[str] = None + updated: Optional[str] = dataclass_field(default=None, kw_only=True) """Last time the resource has been updated in the DB.""" @@ -569,10 +658,10 @@ class GraphQLError: Definition: GraphQLError """ - extensions: Optional[Dict[str, Any]] = None - locations: Optional[List[Dict[str, Any]]] = None - message: Optional[str] = None - path: Optional[List[str]] = None + extensions: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + locations: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + message: Optional[str] = dataclass_field(default=None, kw_only=True) + path: Optional[List[str]] = dataclass_field(default=None, kw_only=True) # Client Class @@ -586,7 +675,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -603,8 +692,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -625,7 +714,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -640,9 +729,9 @@ def __init__( def connector_name(self) -> str: return "starmind" - async def find_experts_async( + async def find_experts( self, - input: FindExpertsInput, + input: FindExpertsInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -660,10 +749,26 @@ async def find_experts_async( we show from returned users by selecting concepts based on the primary label in the chosen language. Returned concepts are deduplicated when multiple concepts share the same primary label. + + Swagger operation ID: `FindExperts_V3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v3/experts" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -677,6 +782,7 @@ async def find_experts_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -684,13 +790,13 @@ async def find_experts_async( return json.loads(response.text) - async def find_questions_async( + async def find_questions( self, + *, query: Optional[str] = None, limit: Optional[int] = None, filter: Optional[str] = None, sort: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -704,6 +810,24 @@ async def find_questions_async( `items`. By default, all published questions are returned, ordered by their last activity (descending). A combination of filters, search queries and ordering criteria can be applied to the result. + + Swagger operation ID: `FindQuestions_V3`. + + Args: + query: The question search query. + limit: Limit the number of returned questions. Defaults to 10. + filter: Filter the list of questions using a predefined filter. + sort: Specify the criteria the result is sorted by. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v3/questions" query_params = [] @@ -730,7 +854,7 @@ async def find_questions_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -744,6 +868,7 @@ async def find_questions_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -751,7 +876,7 @@ async def find_questions_async( return json.loads(response.text) - async def get_user_by_id_async( + async def get_user_by_id( self, id: str, *, @@ -764,13 +889,29 @@ async def get_user_by_id_async( Get user by id Retrieves user information based on the provided user id. + + Swagger operation ID: `GetUserById_V3`. + + Args: + id: The unique global user identifier (UUID) as path parameter used + to reference the user across the Starmind platform. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v3/users/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -784,6 +925,7 @@ async def get_user_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -791,9 +933,9 @@ async def get_user_by_id_async( return json.loads(response.text) - async def post_question_draft_async( + async def post_question_draft( self, - input: PostQuestionDraftInput, + input: PostQuestionDraftInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -809,10 +951,26 @@ async def post_question_draft_async( discoverable, and allow other users to answer it. Providing the optional description helps experts understand the question better and increases the chances of getting high-quality answers. + + Swagger operation ID: `PostQuestionDraft_V3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/v3/questions" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -826,6 +984,7 @@ async def post_question_draft_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -833,7 +992,7 @@ async def post_question_draft_async( return json.loads(response.text) - async def publish_question_draft_async( + async def publish_question_draft( self, question_id: int, *, @@ -848,13 +1007,28 @@ async def publish_question_draft_async( Publishes a question draft. Publishing the question triggers expert search, makes the question discoverable, and allows other users to answer it. Questions are always published anonymously. + + Swagger operation ID: `PublishQuestionDraft_V3`. + + Args: + question_id: The ID of the question draft to be published. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/v3/questions/{quote(str(question_id), safe='')}/publish" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -868,6 +1042,7 @@ async def publish_question_draft_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/starrezrestv1.py b/src/azure/connectors/starrezrestv1.py index fcddbe8f..7a803c7d 100644 --- a/src/azure/connectors/starrezrestv1.py +++ b/src/azure/connectors/starrezrestv1.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,57 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "Starrezrestv1Client", + "CreateBookingInput", + "CreateBookingResponse", + "CreateEntryApplicationInput", + "CreateEntryApplicationResponse", + "CreateEntryEnrollmentInput", + "CreateEntryEnrollmentResponse", + "CreateEntryInput", + "CreateEntryResponse", + "CreateRoomSpaceInput", + "CreateRoomSpaceMaintenanceInput", + "CreateRoomSpaceMaintenanceResponse", + "CreateRoomSpaceResponse", + "CreateTransactionInput", + "CreateTransactionResponse", + "DeleteResponse", + "SelectBookingInput", + "SelectEntryAddressInput", + "SelectEntryApplicationInput", + "SelectEntryCustomFieldInput", + "SelectEntryDetailInput", + "SelectEntryEnrollmentInput", + "SelectEntryInput", + "SelectRoomLocationInput", + "SelectRoomSpaceInput", + "SelectRoomSpaceMaintenanceInput", + "SelectTermInput", + "SelectTermSessionInput", + "SelectTransactionInput", + "UpdateBookingInput", + "UpdateBookingResponse", + "UpdateEntryAddressInput", + "UpdateEntryAddressResponse", + "UpdateEntryApplicationInput", + "UpdateEntryApplicationResponse", + "UpdateEntryCustomFieldInput", + "UpdateEntryCustomFieldResponse", + "UpdateEntryDetailInput", + "UpdateEntryDetailResponse", + "UpdateEntryEnrollmentInput", + "UpdateEntryEnrollmentResponse", + "UpdateEntryInput", + "UpdateEntryResponse", + "UpdateRoomSpaceMaintenanceInput", + "UpdateRoomSpaceMaintenanceResponse", +] + # Type Definitions @@ -29,201 +79,249 @@ class SelectEntryInput: Get Entry """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - address_type_id: Optional[int] = field( + address_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AddressTypeID"}, ) """Address type of the entry's active address record.""" - birth_gender_enum: Optional[str] = field( + birth_gender_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Birth_GenderEnum"}, ) """The gender of the entry at birth.""" - booking_id: Optional[int] = field( + booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingID"}, ) """Pointer to the active booking record.""" - category_id: Optional[int] = field( + category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CategoryID"}, ) """The category that the entry belongs to.""" - conference_email: Optional[str] = field( + conference_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ConferenceEmail"}, ) """ The email that is used to identify a student through Conference registration. """ - contact_id: Optional[int] = field( + contact_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactID"}, ) """Pointer to the contact record.""" - created_by_security_user_id: Optional[int] = field( + created_by_security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedBy_SecurityUserID"}, ) """Pointer to the security user record.""" - date_created: Optional[Dict[str, Any]] = field( + date_created: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateCreated"}, ) - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - directory_flag_privacy: Optional[bool] = field( + directory_flag_privacy: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DirectoryFlagPrivacy"}, ) """Determines if the entry has elected to remain private.""" - d_o_b: Optional[Dict[str, Any]] = field( + d_o_b: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DOB"}, ) - entry_application_id: Optional[int] = field( + entry_application_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryApplicationID"}, ) """Pointer to the active application record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Unique ID for this Entry field.""" - entry_status_enum: Optional[str] = field( + entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryStatusEnum"}, ) """The status of the entry.""" - event_id: Optional[int] = field( + event_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EventID"}, ) """Pointer to the event record.""" - gender_enum: Optional[str] = field( + gender_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GenderEnum"}, ) """Entry gender.""" - i_d1: Optional[str] = field(default=None, metadata={"wire_name": "ID1"}) + i_d1: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID1"}, + ) """Generic ID field.""" - i_d2: Optional[str] = field(default=None, metadata={"wire_name": "ID2"}) + i_d2: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID2"}, + ) """Generic ID field.""" - i_d3: Optional[str] = field(default=None, metadata={"wire_name": "ID3"}) + i_d3: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID3"}, + ) """Generic ID field.""" - i_d4: Optional[int] = field(default=None, metadata={"wire_name": "ID4"}) + i_d4: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID4"}, + ) """Generic ID field.""" - i_d5: Optional[int] = field(default=None, metadata={"wire_name": "ID5"}) + i_d5: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID5"}, + ) """Generic ID field.""" - last_check_in_out_date: Optional[Dict[str, Any]] = field( + last_check_in_out_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastCheckInOutDate"}, ) - name_first: Optional[str] = field( + name_first: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameFirst"}, ) """The first or given name of the entry.""" - name_initials: Optional[str] = field( + name_initials: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameInitials"}, ) """Name initials.""" - name_last: Optional[str] = field( + name_last: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameLast"}, ) """The surname, family name or last name of the entry.""" - name_other: Optional[str] = field( + name_other: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameOther"}, ) """Alternative name.""" - name_preferred: Optional[str] = field( + name_preferred: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NamePreferred"}, ) """Preferred name.""" - name_sharer: Optional[str] = field( + name_sharer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameSharer"}, ) """Additional occupant name.""" - name_title: Optional[str] = field( + name_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameTitle"}, ) """The title or salutation of the entry.""" - name_web: Optional[str] = field( + name_web: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameWeb"}, ) """A name to display for this entry on the Web.""" - pin_number: Optional[int] = field( + pin_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PinNumber"}, ) """Personal Identification Number.""" - portal_auth_provider_user_id: Optional[str] = field( + portal_auth_provider_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalAuthProviderUserID"}, ) """ User identification used to identify the entry in PortalX. This could be an email, username or other identifier. """ - portal_email: Optional[str] = field( + portal_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalEmail"}, ) """The email that is used by the student to login to the portal.""" - position: Optional[str] = field( + position: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Position"}, ) """Entry position in the institution.""" - previous_entry_status_enum: Optional[str] = field( + previous_entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Previous_EntryStatusEnum"}, ) """The previous entry status.""" - tax_exemption_enum: Optional[str] = field( + tax_exemption_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxExemptionEnum"}, ) """Tax exemption.""" - testing: Optional[bool] = field( + testing: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Testing"}, ) """Testing User.""" @@ -235,166 +333,211 @@ class CreateEntryInput: Create Entry """ - address_type_id: Optional[int] = field( + address_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AddressTypeID"}, ) """Address type of the entry's active address record.""" - birth_gender_enum: Optional[str] = field( + birth_gender_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Birth_GenderEnum"}, ) """The gender of the entry at birth.""" - booking_id: Optional[int] = field( + booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingID"}, ) """Pointer to the active booking record.""" - category_id: Optional[int] = field( + category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CategoryID"}, ) """The category that the entry belongs to.""" - conference_email: Optional[str] = field( + conference_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ConferenceEmail"}, ) """ The email that is used to identify a student through Conference registration. """ - contact_id: Optional[int] = field( + contact_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactID"}, ) """Pointer to the contact record.""" - directory_flag_privacy: Optional[bool] = field( + directory_flag_privacy: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DirectoryFlagPrivacy"}, ) """Determines if the entry has elected to remain private.""" - d_o_b: Optional[str] = field(default=None, metadata={"wire_name": "DOB"}) + d_o_b: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "DOB"}, + ) """Date of birth.""" - entry_application_id: Optional[int] = field( + entry_application_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryApplicationID"}, ) """Pointer to the active application record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Unique ID for this Entry field.""" - entry_status_enum: Optional[str] = field( + entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryStatusEnum"}, ) """The status of the entry.""" - event_id: Optional[int] = field( + event_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EventID"}, ) """Pointer to the event record.""" - gender_enum: Optional[str] = field( + gender_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GenderEnum"}, ) """Entry gender.""" - i_d1: Optional[str] = field(default=None, metadata={"wire_name": "ID1"}) + i_d1: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID1"}, + ) """Generic ID field.""" - i_d2: Optional[str] = field(default=None, metadata={"wire_name": "ID2"}) + i_d2: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID2"}, + ) """Generic ID field.""" - i_d3: Optional[str] = field(default=None, metadata={"wire_name": "ID3"}) + i_d3: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID3"}, + ) """Generic ID field.""" - i_d4: Optional[int] = field(default=None, metadata={"wire_name": "ID4"}) + i_d4: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID4"}, + ) """Generic ID field.""" - i_d5: Optional[int] = field(default=None, metadata={"wire_name": "ID5"}) + i_d5: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID5"}, + ) """Generic ID field.""" - last_check_in_out_date: Optional[str] = field( + last_check_in_out_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastCheckInOutDate"}, ) """The last date a check-in or check-out was performed.""" - name_first: Optional[str] = field( - default=None, - metadata={"wire_name": "NameFirst"}, - ) + name_first: str = dataclass_field(metadata={"wire_name": "NameFirst"}) """The first or given name of the entry.""" - name_initials: Optional[str] = field( + name_initials: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameInitials"}, ) """Name initials.""" - name_last: Optional[str] = field( - default=None, - metadata={"wire_name": "NameLast"}, - ) + name_last: str = dataclass_field(metadata={"wire_name": "NameLast"}) """The surname, family name or last name of the entry.""" - name_other: Optional[str] = field( + name_other: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameOther"}, ) """Alternative name.""" - name_preferred: Optional[str] = field( + name_preferred: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NamePreferred"}, ) """Preferred name.""" - name_sharer: Optional[str] = field( + name_sharer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameSharer"}, ) """Additional occupant name.""" - name_title: Optional[str] = field( + name_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameTitle"}, ) """The title or salutation of the entry.""" - name_web: Optional[str] = field( + name_web: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameWeb"}, ) """A name to display for this entry on the Web.""" - password: Optional[str] = field( + password: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Password"}, ) """Password""" - pin_number: Optional[int] = field( + pin_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PinNumber"}, ) """Personal Identification Number.""" - portal_auth_provider_user_id: Optional[str] = field( + portal_auth_provider_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalAuthProviderUserID"}, ) """ User identification used to identify the entry in PortalX. This could be an email, username or other identifier. """ - portal_email: Optional[str] = field( + portal_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalEmail"}, ) """The email that is used by the student to login to the portal.""" - position: Optional[str] = field( + position: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Position"}, ) """Entry position in the institution.""" - previous_entry_status_enum: Optional[str] = field( + previous_entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Previous_EntryStatusEnum"}, ) """The previous entry status.""" - tax_exemption_enum: Optional[str] = field( + tax_exemption_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxExemptionEnum"}, ) """Tax exemption.""" - testing: Optional[bool] = field( + testing: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Testing"}, ) """Testing User.""" @@ -406,166 +549,219 @@ class CreateEntryResponse: Response for Create Entry """ - address_type_id: Optional[int] = field( + address_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AddressTypeID"}, ) """Address type of the entry's active address record.""" - birth_gender_enum: Optional[str] = field( + birth_gender_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Birth_GenderEnum"}, ) """The gender of the entry at birth.""" - booking_id: Optional[int] = field( + booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingID"}, ) """Pointer to the active booking record.""" - category_id: Optional[int] = field( + category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CategoryID"}, ) """The category that the entry belongs to.""" - conference_email: Optional[str] = field( + conference_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ConferenceEmail"}, ) """ The email that is used to identify a student through Conference registration. """ - contact_id: Optional[int] = field( + contact_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactID"}, ) """Pointer to the contact record.""" - directory_flag_privacy: Optional[bool] = field( + directory_flag_privacy: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DirectoryFlagPrivacy"}, ) """Determines if the entry has elected to remain private.""" - d_o_b: Optional[str] = field(default=None, metadata={"wire_name": "DOB"}) + d_o_b: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "DOB"}, + ) """Date of birth.""" - entry_application_id: Optional[int] = field( + entry_application_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryApplicationID"}, ) """Pointer to the active application record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Unique ID for this Entry field.""" - entry_status_enum: Optional[str] = field( + entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryStatusEnum"}, ) """The status of the entry.""" - event_id: Optional[int] = field( + event_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EventID"}, ) """Pointer to the event record.""" - gender_enum: Optional[str] = field( + gender_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GenderEnum"}, ) """Entry gender.""" - i_d1: Optional[str] = field(default=None, metadata={"wire_name": "ID1"}) + i_d1: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID1"}, + ) """Generic ID field.""" - i_d2: Optional[str] = field(default=None, metadata={"wire_name": "ID2"}) + i_d2: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID2"}, + ) """Generic ID field.""" - i_d3: Optional[str] = field(default=None, metadata={"wire_name": "ID3"}) + i_d3: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID3"}, + ) """Generic ID field.""" - i_d4: Optional[int] = field(default=None, metadata={"wire_name": "ID4"}) + i_d4: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID4"}, + ) """Generic ID field.""" - i_d5: Optional[int] = field(default=None, metadata={"wire_name": "ID5"}) + i_d5: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID5"}, + ) """Generic ID field.""" - last_check_in_out_date: Optional[str] = field( + last_check_in_out_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastCheckInOutDate"}, ) """The last date a check-in or check-out was performed.""" - name_first: Optional[str] = field( + name_first: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameFirst"}, ) """The first or given name of the entry.""" - name_initials: Optional[str] = field( + name_initials: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameInitials"}, ) """Initials in name.""" - name_last: Optional[str] = field( + name_last: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameLast"}, ) """The surname, family name or last name of the entry.""" - name_other: Optional[str] = field( + name_other: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameOther"}, ) """Alternative name.""" - name_preferred: Optional[str] = field( + name_preferred: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NamePreferred"}, ) """Preferred name.""" - name_sharer: Optional[str] = field( + name_sharer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameSharer"}, ) """Additional occupant name.""" - name_title: Optional[str] = field( + name_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameTitle"}, ) """The title or salutation of the entry.""" - name_web: Optional[str] = field( + name_web: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameWeb"}, ) """A name to display for this entry on the Web.""" - password: Optional[str] = field( + password: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Password"}, ) """Password""" - pin_number: Optional[int] = field( + pin_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PinNumber"}, ) """Personal Identification Number.""" - portal_auth_provider_user_id: Optional[str] = field( + portal_auth_provider_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalAuthProviderUserID"}, ) """ User identification used to identify the entry in PortalX. This could be an email, username or other identifier. """ - portal_email: Optional[str] = field( + portal_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalEmail"}, ) """Portal email.""" - position: Optional[str] = field( + position: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Position"}, ) """Entry position in the institution.""" - previous_entry_status_enum: Optional[str] = field( + previous_entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Previous_EntryStatusEnum"}, ) """The previous entry status.""" - tax_exemption_enum: Optional[str] = field( + tax_exemption_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxExemptionEnum"}, ) """Tax exemption.""" - testing: Optional[bool] = field( + testing: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Testing"}, ) """Testing user.""" @@ -577,166 +773,219 @@ class UpdateEntryInput: Update Entry """ - address_type_id: Optional[int] = field( + address_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AddressTypeID"}, ) """Address type of the entry's active address record.""" - birth_gender_enum: Optional[str] = field( + birth_gender_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Birth_GenderEnum"}, ) """The gender of the entry at birth.""" - booking_id: Optional[int] = field( + booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingID"}, ) """Pointer to the active booking record.""" - category_id: Optional[int] = field( + category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CategoryID"}, ) """The category that the entry belongs to.""" - conference_email: Optional[str] = field( + conference_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ConferenceEmail"}, ) """ The email that is used to identify a student through Conference registration. """ - contact_id: Optional[int] = field( + contact_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactID"}, ) """Pointer to the contact record.""" - directory_flag_privacy: Optional[bool] = field( + directory_flag_privacy: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DirectoryFlagPrivacy"}, ) """Determines if the entry has elected to remain private.""" - d_o_b: Optional[str] = field(default=None, metadata={"wire_name": "DOB"}) + d_o_b: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "DOB"}, + ) """Date of birth.""" - entry_application_id: Optional[int] = field( + entry_application_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryApplicationID"}, ) """Pointer to the active application record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Unique ID for this Entry field.""" - entry_status_enum: Optional[str] = field( + entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryStatusEnum"}, ) """The status of the entry.""" - event_id: Optional[int] = field( + event_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EventID"}, ) """Pointer to the event record.""" - gender_enum: Optional[str] = field( + gender_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GenderEnum"}, ) """Entry gender.""" - i_d1: Optional[str] = field(default=None, metadata={"wire_name": "ID1"}) + i_d1: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID1"}, + ) """Generic ID field.""" - i_d2: Optional[str] = field(default=None, metadata={"wire_name": "ID2"}) + i_d2: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID2"}, + ) """Generic ID field.""" - i_d3: Optional[str] = field(default=None, metadata={"wire_name": "ID3"}) + i_d3: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID3"}, + ) """Generic ID field.""" - i_d4: Optional[int] = field(default=None, metadata={"wire_name": "ID4"}) + i_d4: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID4"}, + ) """Generic ID field.""" - i_d5: Optional[int] = field(default=None, metadata={"wire_name": "ID5"}) + i_d5: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID5"}, + ) """Generic ID field.""" - last_check_in_out_date: Optional[str] = field( + last_check_in_out_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastCheckInOutDate"}, ) """The last date a check-in or check-out was performed.""" - name_first: Optional[str] = field( + name_first: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameFirst"}, ) """The first or given name of the entry.""" - name_initials: Optional[str] = field( + name_initials: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameInitials"}, ) """Name initials.""" - name_last: Optional[str] = field( + name_last: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameLast"}, ) """The surname, family name or last name of the entry.""" - name_other: Optional[str] = field( + name_other: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameOther"}, ) """Alternative name.""" - name_preferred: Optional[str] = field( + name_preferred: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NamePreferred"}, ) """Preferred name.""" - name_sharer: Optional[str] = field( + name_sharer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameSharer"}, ) """Additional occupant name.""" - name_title: Optional[str] = field( + name_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameTitle"}, ) """The title or salutation of the entry.""" - name_web: Optional[str] = field( + name_web: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameWeb"}, ) """A name to display for this entry on the Web.""" - password: Optional[str] = field( + password: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Password"}, ) """Password""" - pin_number: Optional[int] = field( + pin_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PinNumber"}, ) """Personal Identification Number.""" - portal_auth_provider_user_id: Optional[str] = field( + portal_auth_provider_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalAuthProviderUserID"}, ) """ User identification used to identify the entry in PortalX. This could be an email, username or other identifier. """ - portal_email: Optional[str] = field( + portal_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalEmail"}, ) """The email that is used by the student to login to the portal.""" - position: Optional[str] = field( + position: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Position"}, ) """Entry position in the institution.""" - previous_entry_status_enum: Optional[str] = field( + previous_entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Previous_EntryStatusEnum"}, ) """The previous entry status.""" - tax_exemption_enum: Optional[str] = field( + tax_exemption_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxExemptionEnum"}, ) """Tax exemption.""" - testing: Optional[bool] = field( + testing: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Testing"}, ) """Testing User.""" @@ -748,166 +997,219 @@ class UpdateEntryResponse: Response for Update Entry """ - address_type_id: Optional[int] = field( + address_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AddressTypeID"}, ) """Pointer to this entry's active address record.""" - birth_gender_enum: Optional[str] = field( + birth_gender_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Birth_GenderEnum"}, ) """The gender of the entry at birth.""" - booking_id: Optional[int] = field( + booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingID"}, ) """Pointer to the active booking record.""" - category_id: Optional[int] = field( + category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CategoryID"}, ) """The category that the entry belongs to.""" - conference_email: Optional[str] = field( + conference_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ConferenceEmail"}, ) """ The email that is used to identify a student through Conference registration. """ - contact_id: Optional[int] = field( + contact_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactID"}, ) """Pointer to the contact record.""" - directory_flag_privacy: Optional[bool] = field( + directory_flag_privacy: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DirectoryFlagPrivacy"}, ) """Determines if the entry has elected to remain private.""" - d_o_b: Optional[str] = field(default=None, metadata={"wire_name": "DOB"}) + d_o_b: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "DOB"}, + ) """Date of birth.""" - entry_application_id: Optional[int] = field( + entry_application_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryApplicationID"}, ) """Pointer to the active application record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Unique ID for this Entry field.""" - entry_status_enum: Optional[str] = field( + entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryStatusEnum"}, ) """The status of the entry.""" - event_id: Optional[int] = field( + event_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EventID"}, ) """Pointer to the event record.""" - gender_enum: Optional[str] = field( + gender_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GenderEnum"}, ) """Entry gender.""" - i_d1: Optional[str] = field(default=None, metadata={"wire_name": "ID1"}) + i_d1: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID1"}, + ) """Generic ID field.""" - i_d2: Optional[str] = field(default=None, metadata={"wire_name": "ID2"}) + i_d2: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID2"}, + ) """Generic ID field.""" - i_d3: Optional[str] = field(default=None, metadata={"wire_name": "ID3"}) + i_d3: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID3"}, + ) """Generic ID field.""" - i_d4: Optional[int] = field(default=None, metadata={"wire_name": "ID4"}) + i_d4: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID4"}, + ) """Generic ID field.""" - i_d5: Optional[int] = field(default=None, metadata={"wire_name": "ID5"}) + i_d5: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID5"}, + ) """Generic ID field.""" - last_check_in_out_date: Optional[str] = field( + last_check_in_out_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LastCheckInOutDate"}, ) """The last date a check-in or check-out was performed.""" - name_first: Optional[str] = field( + name_first: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameFirst"}, ) """The first or given name of the entry.""" - name_initials: Optional[str] = field( + name_initials: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameInitials"}, ) """Name initials.""" - name_last: Optional[str] = field( + name_last: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameLast"}, ) """The surname, family name or last name of the entry.""" - name_other: Optional[str] = field( + name_other: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameOther"}, ) """Alternative name.""" - name_preferred: Optional[str] = field( + name_preferred: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NamePreferred"}, ) """Preferred name.""" - name_sharer: Optional[str] = field( + name_sharer: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameSharer"}, ) """Additional occupant name.""" - name_title: Optional[str] = field( + name_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameTitle"}, ) """The title or salutation of the entry.""" - name_web: Optional[str] = field( + name_web: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NameWeb"}, ) """A name to display for this entry on the Web.""" - password: Optional[str] = field( + password: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Password"}, ) """Password""" - pin_number: Optional[int] = field( + pin_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PinNumber"}, ) """Personal Identification Number.""" - portal_auth_provider_user_id: Optional[str] = field( + portal_auth_provider_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalAuthProviderUserID"}, ) """ User identification used to identify the entry in PortalX. This could be an email, username or other identifier. """ - portal_email: Optional[str] = field( + portal_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalEmail"}, ) """The email that is used by the student to login to the portal.""" - position: Optional[str] = field( + position: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Position"}, ) """Entry position in the institution.""" - previous_entry_status_enum: Optional[str] = field( + previous_entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Previous_EntryStatusEnum"}, ) """The previous entry status.""" - tax_exemption_enum: Optional[str] = field( + tax_exemption_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxExemptionEnum"}, ) """Tax exemption.""" - testing: Optional[bool] = field( + testing: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Testing"}, ) """Testing User.""" @@ -919,7 +1221,7 @@ class DeleteResponse: Response for Delete """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -932,77 +1234,83 @@ class SelectEntryCustomFieldInput: Get Entry Custom Field """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - custom_field_definition_id: Optional[int] = field( + custom_field_definition_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomFieldDefinitionID"}, ) """Pointer to the custom field definition record.""" - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - entry_custom_field_id: Optional[int] = field( + entry_custom_field_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryCustomFieldID"}, ) """Unique ID for this entry custom field record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - field_data_type_enum: Optional[str] = field( + field_data_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FieldDataTypeEnum"}, ) """Field data type.""" - value_boolean: Optional[bool] = field( + value_boolean: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueBoolean"}, ) """Boolean value.""" - value_date: Optional[Dict[str, Any]] = field( + value_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueDate"}, ) - value_integer: Optional[int] = field( + value_integer: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueInteger"}, ) """Integer value.""" - value_money: Optional[float] = field( + value_money: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueMoney"}, ) """Money value.""" - value_string: Optional[str] = field( + value_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueString"}, ) """String value.""" @@ -1014,48 +1322,57 @@ class UpdateEntryCustomFieldInput: Update Entry Custom Field """ - custom_field_definition_id: Optional[int] = field( + custom_field_definition_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomFieldDefinitionID"}, ) """Pointer to the custom field definition record.""" - entry_custom_field_id: Optional[int] = field( + entry_custom_field_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryCustomFieldID"}, ) """Unique ID for this entry custom field record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - field_data_type_enum: Optional[str] = field( + field_data_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FieldDataTypeEnum"}, ) """Field data type.""" - value_boolean: Optional[bool] = field( + value_boolean: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueBoolean"}, ) """Boolean value.""" - value_date: Optional[str] = field( + value_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueDate"}, ) """Date value.""" - value_integer: Optional[int] = field( + value_integer: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueInteger"}, ) """Integer value.""" - value_money: Optional[float] = field( + value_money: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueMoney"}, ) """Money value.""" - value_string: Optional[str] = field( + value_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueString"}, ) """String value.""" @@ -1067,48 +1384,57 @@ class UpdateEntryCustomFieldResponse: Response for Update Entry Custom Field """ - custom_field_definition_id: Optional[int] = field( + custom_field_definition_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomFieldDefinitionID"}, ) """Pointer to the custom field definition record.""" - entry_custom_field_id: Optional[int] = field( + entry_custom_field_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryCustomFieldID"}, ) """Unique ID for this entry custom field record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - field_data_type_enum: Optional[str] = field( + field_data_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FieldDataTypeEnum"}, ) """Field data type.""" - value_boolean: Optional[bool] = field( + value_boolean: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueBoolean"}, ) """Boolean value.""" - value_date: Optional[str] = field( + value_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueDate"}, ) """Date value.""" - value_integer: Optional[int] = field( + value_integer: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueInteger"}, ) """Integer value.""" - value_money: Optional[float] = field( + value_money: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueMoney"}, ) """Money value.""" - value_string: Optional[str] = field( + value_string: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ValueString"}, ) """String value.""" @@ -1120,86 +1446,94 @@ class SelectTermInput: Get Term """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - active: Optional[bool] = field( + active: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Active"}, ) """Current active state.""" - active_date_close: Optional[Dict[str, Any]] = field( + active_date_close: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActiveDateClose"}, ) - active_date_open: Optional[Dict[str, Any]] = field( + active_date_open: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActiveDateOpen"}, ) - category_id: Optional[int] = field( + category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CategoryID"}, ) """Pointer to the category record.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Term comments.""" - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Term description.""" - record_type_enum: Optional[str] = field( + record_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecordTypeEnum"}, ) """Record type.""" - term_code: Optional[str] = field( + term_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermCode"}, ) """Term code.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Unique ID for this term record.""" - term_type_id: Optional[int] = field( + term_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermTypeID"}, ) """Pointer to the term type record.""" - web_description: Optional[str] = field( + web_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebDescription"}, ) """Term displayed in the Portal.""" @@ -1211,132 +1545,160 @@ class SelectEntryAddressInput: Get Entry Address """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - active_date_end: Optional[Dict[str, Any]] = field( + active_date_end: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActiveDateEnd"}, ) - active_date_start: Optional[Dict[str, Any]] = field( + active_date_start: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActiveDateStart"}, ) - address_type_id: Optional[int] = field( + address_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AddressTypeID"}, ) """Pointer to the address type record.""" - city: Optional[str] = field(default=None, metadata={"wire_name": "City"}) + city: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "City"}, + ) """City""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Address comments.""" - contact_name: Optional[str] = field( + contact_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactName"}, ) """Contact name.""" - contact_name2: Optional[str] = field( + contact_name2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactName2"}, ) """Contact name 2.""" - country_id: Optional[int] = field( + country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CountryID"}, ) """Pointer to the country record.""" - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - email: Optional[str] = field(default=None, metadata={"wire_name": "Email"}) + email: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Email"}, + ) """Email""" - entry_address_id: Optional[int] = field( + entry_address_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryAddressID"}, ) """Unique ID for this entry address record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - phone: Optional[str] = field(default=None, metadata={"wire_name": "Phone"}) + phone: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Phone"}, + ) """Phone""" - phone_mobile_cell: Optional[str] = field( + phone_mobile_cell: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhoneMobileCell"}, ) """Mobile/Cell""" - phone_other: Optional[str] = field( + phone_other: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhoneOther"}, ) """Alternative phone.""" - phone_other2: Optional[str] = field( + phone_other2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhoneOther2"}, ) """Alternative phone 2.""" - reference: Optional[str] = field( + reference: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reference"}, ) """Reference""" - relationship: Optional[str] = field( + relationship: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Relationship"}, ) """Relationship this address has to the entry.""" - salutation: Optional[str] = field( + salutation: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Salutation"}, ) """Salutation""" - state_province: Optional[str] = field( + state_province: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StateProvince"}, ) """State/Province""" - street: Optional[str] = field( + street: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street"}, ) """Street""" - street2: Optional[str] = field( + street2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street2"}, ) """Street""" - zip_postcode: Optional[str] = field( + zip_postcode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ZipPostcode"}, ) """Zip/Postcode""" @@ -1348,104 +1710,135 @@ class UpdateEntryAddressInput: Update Entry Address """ - active_date_end: Optional[str] = field( + active_date_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActiveDateEnd"}, ) """End active date.""" - active_date_start: Optional[str] = field( + active_date_start: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActiveDateStart"}, ) """Date when this address becomes active.""" - address_type_id: Optional[int] = field( + address_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AddressTypeID"}, ) """Pointer to the address type record.""" - city: Optional[str] = field(default=None, metadata={"wire_name": "City"}) + city: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "City"}, + ) """City""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Address comments.""" - contact_name: Optional[str] = field( + contact_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactName"}, ) """Contact name.""" - contact_name2: Optional[str] = field( + contact_name2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactName2"}, ) """Contact name 2.""" - country_id: Optional[int] = field( + country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CountryID"}, ) """Pointer to the country record.""" - email: Optional[str] = field(default=None, metadata={"wire_name": "Email"}) + email: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Email"}, + ) """Email""" - entry_address_id: Optional[int] = field( + entry_address_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryAddressID"}, ) """Unique ID for this entry address record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - phone: Optional[str] = field(default=None, metadata={"wire_name": "Phone"}) + phone: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Phone"}, + ) """Phone""" - phone_mobile_cell: Optional[str] = field( + phone_mobile_cell: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhoneMobileCell"}, ) """Mobile/Cell""" - phone_other: Optional[str] = field( + phone_other: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhoneOther"}, ) """Alternative phone.""" - phone_other2: Optional[str] = field( + phone_other2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhoneOther2"}, ) """Alternative phone 2.""" - reference: Optional[str] = field( + reference: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reference"}, ) """Reference""" - relationship: Optional[str] = field( + relationship: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Relationship"}, ) """Relationship this address has to the entry.""" - salutation: Optional[str] = field( + salutation: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Salutation"}, ) """Salutation""" - state_province: Optional[str] = field( + state_province: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StateProvince"}, ) """State/Province""" - street: Optional[str] = field( + street: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street"}, ) """Street""" - street2: Optional[str] = field( + street2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street2"}, ) """Street""" - zip_postcode: Optional[str] = field( + zip_postcode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ZipPostcode"}, ) """Zip/Postcode""" @@ -1457,104 +1850,135 @@ class UpdateEntryAddressResponse: Response for Update Entry Address """ - active_date_end: Optional[str] = field( + active_date_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActiveDateEnd"}, ) """End active date.""" - active_date_start: Optional[str] = field( + active_date_start: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ActiveDateStart"}, ) """Date when this address becomes active.""" - address_type_id: Optional[int] = field( + address_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AddressTypeID"}, ) """Pointer to the address type record.""" - city: Optional[str] = field(default=None, metadata={"wire_name": "City"}) + city: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "City"}, + ) """City""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Address comments.""" - contact_name: Optional[str] = field( + contact_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactName"}, ) """Contact name.""" - contact_name2: Optional[str] = field( + contact_name2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactName2"}, ) """Contact name 2.""" - country_id: Optional[int] = field( + country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CountryID"}, ) """Pointer to the country record.""" - email: Optional[str] = field(default=None, metadata={"wire_name": "Email"}) + email: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Email"}, + ) """Email""" - entry_address_id: Optional[int] = field( + entry_address_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryAddressID"}, ) """Unique ID for this entry address record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - phone: Optional[str] = field(default=None, metadata={"wire_name": "Phone"}) + phone: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Phone"}, + ) """Phone""" - phone_mobile_cell: Optional[str] = field( + phone_mobile_cell: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhoneMobileCell"}, ) """Mobile/Cell""" - phone_other: Optional[str] = field( + phone_other: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhoneOther"}, ) """Alternative phone.""" - phone_other2: Optional[str] = field( + phone_other2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhoneOther2"}, ) """Alternative phone 2.""" - reference: Optional[str] = field( + reference: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reference"}, ) """Reference""" - relationship: Optional[str] = field( + relationship: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Relationship"}, ) """Relationship this address has to the entry.""" - salutation: Optional[str] = field( + salutation: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Salutation"}, ) """Salutation""" - state_province: Optional[str] = field( + state_province: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StateProvince"}, ) """State/Province""" - street: Optional[str] = field( + street: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street"}, ) """Street""" - street2: Optional[str] = field( + street2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street2"}, ) """Street""" - zip_postcode: Optional[str] = field( + zip_postcode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ZipPostcode"}, ) """Zip/Postcode""" @@ -1566,295 +1990,351 @@ class SelectEntryApplicationInput: Get Entry Application """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - allocate_option_enum: Optional[str] = field( + allocate_option_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateOptionEnum"}, ) """Allocate option.""" - application_date: Optional[Dict[str, Any]] = field( + application_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApplicationDate"}, ) - application_status_id: Optional[int] = field( + application_status_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApplicationStatusID"}, ) """Pointer to the application status record.""" - cancel_date: Optional[Dict[str, Any]] = field( + cancel_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CancelDate"}, ) - classification_id: Optional[int] = field( + classification_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClassificationID"}, ) """Pointer to the classification record.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Application comments.""" - comments_internal: Optional[str] = field( + comments_internal: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CommentsInternal"}, ) """Internal comments.""" - complete_date: Optional[Dict[str, Any]] = field( + complete_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompleteDate"}, ) - contract_signed_date: Optional[Dict[str, Any]] = field( + contract_signed_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractSignedDate"}, ) - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_bit3: Optional[bool] = field( + custom_bit3: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit3"}, ) """Custom boolean field value.""" - custom_bit4: Optional[bool] = field( + custom_bit4: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit4"}, ) """Custom boolean field value.""" - custom_date1: Optional[Dict[str, Any]] = field( + custom_date1: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) - custom_date2: Optional[Dict[str, Any]] = field( + custom_date2: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) - custom_date3: Optional[Dict[str, Any]] = field( + custom_date3: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate3"}, ) - custom_date4: Optional[Dict[str, Any]] = field( + custom_date4: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate4"}, ) - date_created: Optional[Dict[str, Any]] = field( + date_created: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateCreated"}, ) - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - enquiry_date: Optional[Dict[str, Any]] = field( + enquiry_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnquiryDate"}, ) - entry_application_id: Optional[int] = field( + entry_application_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryApplicationID"}, ) """Unique ID for this entry application record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - expected_arrival_date: Optional[Dict[str, Any]] = field( + expected_arrival_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedArrivalDate"}, ) - expected_arrival_date_latest: Optional[Dict[str, Any]] = field( + expected_arrival_date_latest: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedArrivalDateLatest"}, ) - expected_departure_date: Optional[Dict[str, Any]] = field( + expected_departure_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedDepartureDate"}, ) - offered_date: Optional[Dict[str, Any]] = field( + offered_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferedDate"}, ) - offer_reply_date: Optional[Dict[str, Any]] = field( + offer_reply_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyDate"}, ) - offer_reply_enum: Optional[str] = field( + offer_reply_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyEnum"}, ) """Offer reply.""" - offer_reply_reason: Optional[str] = field( + offer_reply_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyReason"}, ) """Offer reply reason.""" - offer_sent_date: Optional[Dict[str, Any]] = field( + offer_sent_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferSentDate"}, ) - portal_tracking_only: Optional[bool] = field( + portal_tracking_only: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalTrackingOnly"}, ) """Whether this application is just for the portal to track progress.""" - preference_comments: Optional[str] = field( + preference_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreferenceComments"}, ) """Preference comments.""" - rating: Optional[str] = field( + rating: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Rating"}, ) """Application rating.""" - received_date: Optional[Dict[str, Any]] = field( + received_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDate"}, ) - received_deposit: Optional[bool] = field( + received_deposit: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit"}, ) """Indicates if the deposit has been received.""" - received_deposit_waived: Optional[bool] = field( + received_deposit_waived: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositWaived"}, ) """Date deposit was waived.""" - received_deposit_payment_id: Optional[int] = field( + received_deposit_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit_PaymentID"}, ) """Pointer to the payment record for the received fee.""" - received_deposit_web_payment_id: Optional[int] = field( + received_deposit_web_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit_WebPaymentID"}, ) """Most recent fee payment that was attempted.""" - received_deposit_amount: Optional[float] = field( + received_deposit_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositAmount"}, ) """Received deposit amount.""" - received_deposit_date: Optional[Dict[str, Any]] = field( + received_deposit_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositDate"}, ) - received_fee: Optional[bool] = field( + received_fee: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee"}, ) """Indicates if the fee has been received.""" - received_fee_payment_id: Optional[int] = field( + received_fee_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee_PaymentID"}, ) """Pointer to the payment record for the received fee.""" - received_fee_web_payment_id: Optional[int] = field( + received_fee_web_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee_WebPaymentID"}, ) """Most recent fee payment that was attempted.""" - received_fee_amount: Optional[float] = field( + received_fee_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFeeAmount"}, ) """Received fee amount.""" - received_fee_date: Optional[Dict[str, Any]] = field( + received_fee_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFeeDate"}, ) - received_photo_date: Optional[Dict[str, Any]] = field( + received_photo_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedPhotoDate"}, ) - returning: Optional[bool] = field( + returning: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Returning"}, ) """Indicates if the entry has been here before and is returning.""" - room_mate_description: Optional[str] = field( + room_mate_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateDescription"}, ) """ Description the applicant can write which is displayed in the roommate module. """ - roommate_group_id: Optional[int] = field( + roommate_group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoommateGroupID"}, ) """Pointer to the Roommate group record.""" - room_mate_group_sort_order: Optional[int] = field( + room_mate_group_sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateGroupSortOrder"}, ) """Order that group members should be processed in.""" - room_mate_show_in_search: Optional[bool] = field( + room_mate_show_in_search: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateShowInSearch"}, ) """Whether to include this applicant in roommate searches.""" - room_preference_comments: Optional[str] = field( + room_preference_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomPreferenceComments"}, ) """Room preference comments.""" - room_selection_number: Optional[int] = field( + room_selection_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSelectionNumber"}, ) """Room selection number.""" - room_selection_timeslot: Optional[str] = field( + room_selection_timeslot: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSelectionTimeslot"}, ) """Room selection timeslot.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Defines the period this application is for.""" - web: Optional[bool] = field(default=None, metadata={"wire_name": "Web"}) + web: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Web"}, + ) """Indicates if this application was created on the web.""" @@ -1864,280 +2344,334 @@ class CreateEntryApplicationInput: Create Entry Application """ - allocate_option_enum: Optional[str] = field( + allocate_option_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateOptionEnum"}, ) """Allocate option.""" - application_date: Optional[str] = field( + application_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApplicationDate"}, ) """Date of application.""" - application_status_id: Optional[int] = field( + application_status_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApplicationStatusID"}, ) """Pointer to the application status record.""" - cancel_date: Optional[str] = field( + cancel_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CancelDate"}, ) """Cancellation date.""" - classification_id: Optional[int] = field( + classification_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClassificationID"}, ) """Pointer to the classification record.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Application comments.""" - comments_internal: Optional[str] = field( + comments_internal: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CommentsInternal"}, ) """Internal comments.""" - complete_date: Optional[str] = field( + complete_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompleteDate"}, ) """Completion date.""" - contract_signed_date: Optional[str] = field( + contract_signed_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractSignedDate"}, ) """Date contract was signed.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_bit3: Optional[bool] = field( + custom_bit3: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit3"}, ) """Custom boolean field value.""" - custom_bit4: Optional[bool] = field( + custom_bit4: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit4"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_date3: Optional[str] = field( + custom_date3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate3"}, ) """Custom date field value.""" - custom_date4: Optional[str] = field( + custom_date4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate4"}, ) """Custom date field value.""" - enquiry_date: Optional[str] = field( + enquiry_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnquiryDate"}, ) """Date of enquiry.""" - entry_application_id: Optional[int] = field( + entry_application_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryApplicationID"}, ) """Unique ID for this entry application record.""" - entry_id: Optional[int] = field( - default=None, - metadata={"wire_name": "EntryID"}, - ) + entry_id: int = dataclass_field(metadata={"wire_name": "EntryID"}) """Pointer to the entry record.""" - expected_arrival_date: Optional[str] = field( + expected_arrival_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedArrivalDate"}, ) """Date entry is expected to arrive.""" - expected_arrival_date_latest: Optional[str] = field( + expected_arrival_date_latest: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedArrivalDateLatest"}, ) """Latest expected arrival date.""" - expected_departure_date: Optional[str] = field( + expected_departure_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedDepartureDate"}, ) """Date entry is expected to depart.""" - offered_date: Optional[str] = field( + offered_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferedDate"}, ) """Date application was offered.""" - offer_reply_date: Optional[str] = field( + offer_reply_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyDate"}, ) """Date offer was replied to.""" - offer_reply_enum: Optional[str] = field( + offer_reply_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyEnum"}, ) """Offer reply.""" - offer_reply_reason: Optional[str] = field( + offer_reply_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyReason"}, ) """Offer reply reason.""" - offer_sent_date: Optional[str] = field( + offer_sent_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferSentDate"}, ) """Date offer sent.""" - portal_tracking_only: Optional[bool] = field( + portal_tracking_only: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalTrackingOnly"}, ) """Whether this application is just for the portal to track progress.""" - preference_comments: Optional[str] = field( + preference_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreferenceComments"}, ) """Preference comments.""" - rating: Optional[str] = field( + rating: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Rating"}, ) """Application rating.""" - received_date: Optional[str] = field( + received_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDate"}, ) """Date received.""" - received_deposit: Optional[bool] = field( + received_deposit: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit"}, ) """Indicates if the deposit has been received.""" - received_deposit_payment_id: Optional[int] = field( + received_deposit_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit_PaymentID"}, ) """Pointer to the payment record for the received deposit.""" - received_deposit_web_payment_id: Optional[int] = field( + received_deposit_web_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit_WebPaymentID"}, ) """Most recent deposit payment that was attempted.""" - received_deposit_amount: Optional[float] = field( + received_deposit_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositAmount"}, ) """Received deposit amount.""" - received_deposit_date: Optional[str] = field( + received_deposit_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositDate"}, ) """Date deposit was received.""" - received_deposit_waived: Optional[bool] = field( + received_deposit_waived: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositWaived"}, ) """Date deposit was waived.""" - received_fee: Optional[bool] = field( + received_fee: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee"}, ) """Indicates if the fee has been received.""" - received_fee_payment_id: Optional[int] = field( + received_fee_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee_PaymentID"}, ) """Pointer to the payment record for the received fee.""" - received_fee_web_payment_id: Optional[int] = field( + received_fee_web_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee_WebPaymentID"}, ) """Most recent fee payment that was attempted.""" - received_fee_amount: Optional[float] = field( + received_fee_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFeeAmount"}, ) """Received fee amount.""" - received_fee_date: Optional[str] = field( + received_fee_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFeeDate"}, ) """Date fee was received.""" - received_photo_date: Optional[str] = field( + received_photo_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedPhotoDate"}, ) """Date photo was received.""" - returning: Optional[bool] = field( + returning: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Returning"}, ) """Indicates if the entry has been here before and is returning.""" - room_mate_description: Optional[str] = field( + room_mate_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateDescription"}, ) """ Description the applicant can write which is displayed in the roommate module. """ - roommate_group_id: Optional[int] = field( + roommate_group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoommateGroupID"}, ) """Pointer to the Roommate group record.""" - room_mate_group_sort_order: Optional[int] = field( + room_mate_group_sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateGroupSortOrder"}, ) """Order that group members should be processed in.""" - room_mate_show_in_search: Optional[bool] = field( + room_mate_show_in_search: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateShowInSearch"}, ) """Whether to include this applicant in roommate searches.""" - room_preference_comments: Optional[str] = field( + room_preference_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomPreferenceComments"}, ) """Room preference comments.""" - room_selection_number: Optional[int] = field( + room_selection_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSelectionNumber"}, ) """Room selection number.""" - room_selection_timeslot: Optional[str] = field( + room_selection_timeslot: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSelectionTimeslot"}, ) """Room selection timeslot.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Defines the period this application is for.""" - web: Optional[bool] = field(default=None, metadata={"wire_name": "Web"}) + web: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Web"}, + ) """Indicates if this application was created on the web.""" @@ -2147,280 +2681,338 @@ class CreateEntryApplicationResponse: Response for Create Entry Application """ - allocate_option_enum: Optional[str] = field( + allocate_option_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateOptionEnum"}, ) """Allocate option.""" - application_date: Optional[str] = field( + application_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApplicationDate"}, ) """Date of application.""" - application_status_id: Optional[int] = field( + application_status_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApplicationStatusID"}, ) """Pointer to the application status record.""" - cancel_date: Optional[str] = field( + cancel_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CancelDate"}, ) """Cancellation date.""" - classification_id: Optional[int] = field( + classification_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClassificationID"}, ) """Pointer to the classification record.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Application comments.""" - comments_internal: Optional[str] = field( + comments_internal: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CommentsInternal"}, ) """Internal comments.""" - complete_date: Optional[str] = field( + complete_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompleteDate"}, ) """Completion date.""" - contract_signed_date: Optional[str] = field( + contract_signed_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractSignedDate"}, ) """Date contract was signed.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_bit3: Optional[bool] = field( + custom_bit3: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit3"}, ) """Custom boolean field value.""" - custom_bit4: Optional[bool] = field( + custom_bit4: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit4"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_date3: Optional[str] = field( + custom_date3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate3"}, ) """Custom date field value.""" - custom_date4: Optional[str] = field( + custom_date4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate4"}, ) """Custom date field value.""" - entry_application_id: Optional[int] = field( + entry_application_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryApplicationID"}, ) """Unique ID for this entry application record.""" - enquiry_date: Optional[str] = field( + enquiry_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnquiryDate"}, ) """Date of enquiry.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - expected_arrival_date: Optional[str] = field( + expected_arrival_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedArrivalDate"}, ) """Date entry is expected to arrive.""" - expected_arrival_date_latest: Optional[str] = field( + expected_arrival_date_latest: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedArrivalDateLatest"}, ) """Latest expected arrival date.""" - expected_departure_date: Optional[str] = field( + expected_departure_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedDepartureDate"}, ) """Date entry is expected to depart.""" - offered_date: Optional[str] = field( + offered_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferedDate"}, ) """Date application was offered.""" - offer_reply_date: Optional[str] = field( + offer_reply_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyDate"}, ) """Date offer was replied to.""" - offer_reply_enum: Optional[str] = field( + offer_reply_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyEnum"}, ) """Offer reply.""" - offer_reply_reason: Optional[str] = field( + offer_reply_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyReason"}, ) """Offer reply reason.""" - offer_sent_date: Optional[str] = field( + offer_sent_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferSentDate"}, ) """Date offer sent.""" - portal_tracking_only: Optional[bool] = field( + portal_tracking_only: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalTrackingOnly"}, ) """Whether this application is just for the portal to track progress.""" - preference_comments: Optional[str] = field( + preference_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreferenceComments"}, ) """Preference comments.""" - rating: Optional[str] = field( + rating: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Rating"}, ) """Application rating.""" - received_date: Optional[str] = field( + received_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDate"}, ) """Date received.""" - received_deposit: Optional[bool] = field( + received_deposit: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit"}, ) """Indicates if the deposit has been received.""" - received_deposit_payment_id: Optional[int] = field( + received_deposit_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit_PaymentID"}, ) """Pointer to the payment record for the received deposit.""" - received_deposit_web_payment_id: Optional[int] = field( + received_deposit_web_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit_WebPaymentID"}, ) """Most recent deposit payment that was attempted.""" - received_deposit_amount: Optional[float] = field( + received_deposit_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositAmount"}, ) """Received deposit amount.""" - received_deposit_date: Optional[str] = field( + received_deposit_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositDate"}, ) """Date deposit was received.""" - received_deposit_waived: Optional[bool] = field( + received_deposit_waived: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositWaived"}, ) """Date deposit was waived.""" - received_fee: Optional[bool] = field( + received_fee: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee"}, ) """Indicates if the fee has been received.""" - received_fee_payment_id: Optional[int] = field( + received_fee_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee_PaymentID"}, ) """Pointer to the payment record for the received fee.""" - received_fee_web_payment_id: Optional[int] = field( + received_fee_web_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee_WebPaymentID"}, ) """Most recent fee payment that was attempted.""" - received_fee_amount: Optional[float] = field( + received_fee_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFeeAmount"}, ) """Received fee amount.""" - received_fee_date: Optional[str] = field( + received_fee_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFeeDate"}, ) """Date fee was received.""" - received_photo_date: Optional[str] = field( + received_photo_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedPhotoDate"}, ) """Date photo was received.""" - returning: Optional[bool] = field( + returning: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Returning"}, ) """Indicates if the entry has been here before and is returning.""" - room_mate_description: Optional[str] = field( + room_mate_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateDescription"}, ) """ Description the applicant can write which is displayed in the roommate module. """ - roommate_group_id: Optional[int] = field( + roommate_group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoommateGroupID"}, ) """Pointer to the Roommate group record.""" - room_mate_group_sort_order: Optional[int] = field( + room_mate_group_sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateGroupSortOrder"}, ) """Order that group members should be processed in.""" - room_mate_show_in_search: Optional[bool] = field( + room_mate_show_in_search: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateShowInSearch"}, ) """Whether to include this applicant in roommate searches.""" - room_preference_comments: Optional[str] = field( + room_preference_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomPreferenceComments"}, ) """Room preference comments.""" - room_selection_number: Optional[int] = field( + room_selection_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSelectionNumber"}, ) """Room selection number.""" - room_selection_timeslot: Optional[str] = field( + room_selection_timeslot: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSelectionTimeslot"}, ) """Room selection timeslot.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Defines the period this application is for.""" - web: Optional[bool] = field(default=None, metadata={"wire_name": "Web"}) + web: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Web"}, + ) """Indicates if this application was created on the web.""" @@ -2430,280 +3022,338 @@ class UpdateEntryApplicationInput: Update Entry Application """ - allocate_option_enum: Optional[str] = field( + allocate_option_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateOptionEnum"}, ) """Allocate option.""" - application_date: Optional[str] = field( + application_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApplicationDate"}, ) """Date of application.""" - application_status_id: Optional[int] = field( + application_status_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApplicationStatusID"}, ) """Pointer to the application status record.""" - cancel_date: Optional[str] = field( + cancel_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CancelDate"}, ) """Cancellation date.""" - classification_id: Optional[int] = field( + classification_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClassificationID"}, ) """Pointer to the classification record.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Application comments.""" - comments_internal: Optional[str] = field( + comments_internal: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CommentsInternal"}, ) """Internal comments.""" - complete_date: Optional[str] = field( + complete_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompleteDate"}, ) """Completion date.""" - contract_signed_date: Optional[str] = field( + contract_signed_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractSignedDate"}, ) """Date contract was signed.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_bit3: Optional[bool] = field( + custom_bit3: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit3"}, ) """Custom boolean field value.""" - custom_bit4: Optional[bool] = field( + custom_bit4: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit4"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_date3: Optional[str] = field( + custom_date3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate3"}, ) """Custom date field value.""" - custom_date4: Optional[str] = field( + custom_date4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate4"}, ) """Custom date field value.""" - entry_application_id: Optional[int] = field( + entry_application_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryApplicationID"}, ) """Unique ID for this entry application record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - enquiry_date: Optional[str] = field( + enquiry_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnquiryDate"}, ) """Date of enquiry.""" - expected_arrival_date: Optional[str] = field( + expected_arrival_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedArrivalDate"}, ) """Date entry is expected to arrive.""" - expected_arrival_date_latest: Optional[str] = field( + expected_arrival_date_latest: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedArrivalDateLatest"}, ) """Latest expected arrival date.""" - expected_departure_date: Optional[str] = field( + expected_departure_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedDepartureDate"}, ) """Date entry is expected to depart.""" - offered_date: Optional[str] = field( + offered_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferedDate"}, ) """Date application was offered.""" - offer_reply_date: Optional[str] = field( + offer_reply_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyDate"}, ) """Date offer was replied to.""" - offer_reply_enum: Optional[str] = field( + offer_reply_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyEnum"}, ) """Offer reply.""" - offer_reply_reason: Optional[str] = field( + offer_reply_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyReason"}, ) """Offer reply reason.""" - offer_sent_date: Optional[str] = field( + offer_sent_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferSentDate"}, ) """Date offer sent.""" - portal_tracking_only: Optional[bool] = field( + portal_tracking_only: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalTrackingOnly"}, ) """Whether this application is just for the portal to track progress.""" - preference_comments: Optional[str] = field( + preference_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreferenceComments"}, ) """Preference comments.""" - rating: Optional[str] = field( + rating: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Rating"}, ) """Application rating.""" - received_date: Optional[str] = field( + received_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDate"}, ) """Date received.""" - received_deposit: Optional[bool] = field( + received_deposit: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit"}, ) """Indicates if the deposit has been received.""" - received_deposit_payment_id: Optional[int] = field( + received_deposit_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit_PaymentID"}, ) """Pointer to the payment record for the received deposit.""" - received_deposit_web_payment_id: Optional[int] = field( + received_deposit_web_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit_WebPaymentID"}, ) """Most recent deposit payment that was attempted.""" - received_deposit_amount: Optional[float] = field( + received_deposit_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositAmount"}, ) """Received deposit amount.""" - received_deposit_date: Optional[str] = field( + received_deposit_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositDate"}, ) """Date deposit was received.""" - received_deposit_waived: Optional[bool] = field( + received_deposit_waived: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositWaived"}, ) """Date deposit was waived.""" - received_fee: Optional[bool] = field( + received_fee: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee"}, ) """Indicates if the fee has been received.""" - received_fee_payment_id: Optional[int] = field( + received_fee_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee_PaymentID"}, ) """Pointer to the payment record for the received fee.""" - received_fee_web_payment_id: Optional[int] = field( + received_fee_web_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee_WebPaymentID"}, ) """Most recent fee payment that was attempted.""" - received_fee_amount: Optional[float] = field( + received_fee_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFeeAmount"}, ) """Received fee amount.""" - received_fee_date: Optional[str] = field( + received_fee_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFeeDate"}, ) """Date fee was received.""" - received_photo_date: Optional[str] = field( + received_photo_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedPhotoDate"}, ) """Date photo was received.""" - returning: Optional[bool] = field( + returning: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Returning"}, ) """Indicates if the entry has been here before and is returning.""" - room_mate_description: Optional[str] = field( + room_mate_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateDescription"}, ) """ Description the applicant can write which is displayed in the roommate module. """ - roommate_group_id: Optional[int] = field( + roommate_group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoommateGroupID"}, ) """Pointer to the Roommate group record.""" - room_mate_group_sort_order: Optional[int] = field( + room_mate_group_sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateGroupSortOrder"}, ) """Order that group members should be processed in.""" - room_mate_show_in_search: Optional[bool] = field( + room_mate_show_in_search: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateShowInSearch"}, ) """Whether to include this applicant in roommate searches.""" - room_preference_comments: Optional[str] = field( + room_preference_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomPreferenceComments"}, ) """Room preference comments.""" - room_selection_number: Optional[int] = field( + room_selection_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSelectionNumber"}, ) """Room selection number.""" - room_selection_timeslot: Optional[str] = field( + room_selection_timeslot: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSelectionTimeslot"}, ) """Room selection timeslot.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Defines the period this application is for.""" - web: Optional[bool] = field(default=None, metadata={"wire_name": "Web"}) + web: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Web"}, + ) """Indicates if this application was created on the web.""" @@ -2713,280 +3363,338 @@ class UpdateEntryApplicationResponse: Response for Update Entry Application """ - allocate_option_enum: Optional[str] = field( + allocate_option_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateOptionEnum"}, ) """Allocate option.""" - application_date: Optional[str] = field( + application_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApplicationDate"}, ) """Date of application.""" - application_status_id: Optional[int] = field( + application_status_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ApplicationStatusID"}, ) """Pointer to the application status record.""" - cancel_date: Optional[str] = field( + cancel_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CancelDate"}, ) """Cancellation date.""" - classification_id: Optional[int] = field( + classification_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClassificationID"}, ) """Pointer to the classification record.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Application comments.""" - comments_internal: Optional[str] = field( + comments_internal: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CommentsInternal"}, ) """Internal comments.""" - complete_date: Optional[str] = field( + complete_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompleteDate"}, ) """Completion date.""" - contract_signed_date: Optional[str] = field( + contract_signed_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractSignedDate"}, ) """Date contract was signed.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_bit3: Optional[bool] = field( + custom_bit3: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit3"}, ) """Custom boolean field value.""" - custom_bit4: Optional[bool] = field( + custom_bit4: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit4"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_date3: Optional[str] = field( + custom_date3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate3"}, ) """Custom date field value.""" - custom_date4: Optional[str] = field( + custom_date4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate4"}, ) """Custom date field value.""" - entry_application_id: Optional[int] = field( + entry_application_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryApplicationID"}, ) """Unique ID for this entry application record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - enquiry_date: Optional[str] = field( + enquiry_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnquiryDate"}, ) """Date of enquiry.""" - expected_arrival_date: Optional[str] = field( + expected_arrival_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedArrivalDate"}, ) """Date entry is expected to arrive.""" - expected_arrival_date_latest: Optional[str] = field( + expected_arrival_date_latest: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedArrivalDateLatest"}, ) """Latest expected arrival date.""" - expected_departure_date: Optional[str] = field( + expected_departure_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedDepartureDate"}, ) """Date entry is expected to depart.""" - offered_date: Optional[str] = field( + offered_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferedDate"}, ) """Date application was offered.""" - offer_reply_date: Optional[str] = field( + offer_reply_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyDate"}, ) """Date offer was replied to.""" - offer_reply_enum: Optional[str] = field( + offer_reply_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyEnum"}, ) """Offer reply.""" - offer_reply_reason: Optional[str] = field( + offer_reply_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferReplyReason"}, ) """Offer reply reason.""" - offer_sent_date: Optional[str] = field( + offer_sent_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OfferSentDate"}, ) """Date offer sent.""" - portal_tracking_only: Optional[bool] = field( + portal_tracking_only: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PortalTrackingOnly"}, ) """Whether this application is just for the portal to track progress.""" - preference_comments: Optional[str] = field( + preference_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreferenceComments"}, ) """Preference comments.""" - rating: Optional[str] = field( + rating: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Rating"}, ) """Application rating.""" - received_date: Optional[str] = field( + received_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDate"}, ) """Date received.""" - received_deposit: Optional[bool] = field( + received_deposit: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit"}, ) """Indicates if the deposit has been received.""" - received_deposit_payment_id: Optional[int] = field( + received_deposit_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit_PaymentID"}, ) """Pointer to the payment record for the received deposit.""" - received_deposit_web_payment_id: Optional[int] = field( + received_deposit_web_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDeposit_WebPaymentID"}, ) """Most recent deposit payment that was attempted.""" - received_deposit_amount: Optional[float] = field( + received_deposit_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositAmount"}, ) """Received deposit amount.""" - received_deposit_date: Optional[str] = field( + received_deposit_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositDate"}, ) """Date deposit was received.""" - received_deposit_waived: Optional[bool] = field( + received_deposit_waived: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedDepositWaived"}, ) """Date deposit was waived.""" - received_fee: Optional[bool] = field( + received_fee: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee"}, ) """Indicates if the fee has been received.""" - received_fee_payment_id: Optional[int] = field( + received_fee_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee_PaymentID"}, ) """Pointer to the payment record for the received fee.""" - received_fee_web_payment_id: Optional[int] = field( + received_fee_web_payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFee_WebPaymentID"}, ) """Most recent fee payment that was attempted.""" - received_fee_amount: Optional[float] = field( + received_fee_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFeeAmount"}, ) """Received fee amount.""" - received_fee_date: Optional[str] = field( + received_fee_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedFeeDate"}, ) """Date fee was received.""" - received_photo_date: Optional[str] = field( + received_photo_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReceivedPhotoDate"}, ) """Date photo was received.""" - returning: Optional[bool] = field( + returning: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Returning"}, ) """Indicates if the entry has been here before and is returning.""" - room_mate_description: Optional[str] = field( + room_mate_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateDescription"}, ) """ Description the applicant can write which is displayed in the roommate module. """ - roommate_group_id: Optional[int] = field( + roommate_group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoommateGroupID"}, ) """Pointer to the Roommate group record.""" - room_mate_group_sort_order: Optional[int] = field( + room_mate_group_sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateGroupSortOrder"}, ) """Order that group members should be processed in.""" - room_mate_show_in_search: Optional[bool] = field( + room_mate_show_in_search: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomMateShowInSearch"}, ) """Whether to include this applicant in roommate searches.""" - room_preference_comments: Optional[str] = field( + room_preference_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomPreferenceComments"}, ) """Room preference comments.""" - room_selection_number: Optional[int] = field( + room_selection_number: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSelectionNumber"}, ) """Room selection number.""" - room_selection_timeslot: Optional[str] = field( + room_selection_timeslot: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSelectionTimeslot"}, ) """Room selection timeslot.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Defines the period this application is for.""" - web: Optional[bool] = field(default=None, metadata={"wire_name": "Web"}) + web: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Web"}, + ) """Indicates if this application was created on the web.""" @@ -2996,264 +3704,314 @@ class SelectTermSessionInput: Get Term Session """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - booking_type_id: Optional[int] = field( + booking_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingTypeID"}, ) """Pointer to the booking type record.""" - cancel_booking_default_end_booking_reason_id: Optional[int] = field( + cancel_booking_default_end_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CancelBookingDefaultEnd_BookingReasonID"}, ) """The default booking end reason when cancelling a booking.""" - cancel_booking_update_end_booking_reason_boolean_ask_enum: Optional[str] = field( + cancel_booking_update_end_booking_reason_boolean_ask_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CancelBookingUpdateEndBookingReason_BooleanAskEnum"}, ) """Update booking end reason on booking cancel.""" - check_in_date: Optional[Dict[str, Any]] = field( + check_in_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDate"}, ) - check_in_date_actual_decrease_boolean_ask_enum: Optional[str] = field( + check_in_date_actual_decrease_boolean_ask_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDateActualDecrease_BooleanAskEnum"}, ) """ Update CheckInDateActual if check-in date moves backward (in the past). """ - check_in_date_actual_increase_boolean_ask_enum: Optional[str] = field( + check_in_date_actual_increase_boolean_ask_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDateActualIncrease_BooleanAskEnum"}, ) """ Update CheckInDateActual if check-in date moves forward (in the future). """ - check_in_default_start_booking_reason_id: Optional[int] = field( + check_in_default_start_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDefaultStart_BookingReasonID"}, ) """The default booking start reason when checking in.""" - check_in_update_start_booking_reason_boolean_ask_enum: Optional[str] = field( + check_in_update_start_booking_reason_boolean_ask_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInUpdateStartBookingReason_BooleanAskEnum"}, ) """Update booking start reason on check-in.""" - check_out_date: Optional[Dict[str, Any]] = field( + check_out_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDate"}, ) - check_out_date_actual_decrease_boolean_ask_enum: Optional[str] = field( + check_out_date_actual_decrease_boolean_ask_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDateActualDecrease_BooleanAskEnum"}, ) """ Update CheckOutDateActual if check-in date moves backward (in the past). """ - check_out_date_actual_increase_boolean_ask_enum: Optional[str] = field( + check_out_date_actual_increase_boolean_ask_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDateActualIncrease_BooleanAskEnum"}, ) """ Update CheckOutDateActual if check-in date moves forward (in the future). """ - check_out_default_end_booking_reason_id: Optional[int] = field( + check_out_default_end_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDefaultEnd_BookingReasonID"}, ) """The default booking end reason when checking out.""" - check_out_update_end_booking_reason_boolean_ask_enum: Optional[str] = field( + check_out_update_end_booking_reason_boolean_ask_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutUpdateEndBookingReason_BooleanAskEnum"}, ) """Update booking end reason on check-out.""" - contract_date_check_in_decrease_boolean_ask_enum: Optional[str] = field( + contract_date_check_in_decrease_boolean_ask_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateCheckInDecrease_BooleanAskEnum"}, ) """Update Charge Dates if check-in date moves backward (in the past).""" - contract_date_check_in_increase_boolean_ask_enum: Optional[str] = field( + contract_date_check_in_increase_boolean_ask_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateCheckInIncrease_BooleanAskEnum"}, ) """Update Charge Dates if check-in date moves forward (in the future).""" - contract_date_check_out_decrease_boolean_ask_enum: Optional[str] = field( + contract_date_check_out_decrease_boolean_ask_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateCheckOutDecrease_BooleanAskEnum"}, ) """Update Charge Dates if check-out date moves backward (in the past).""" - contract_date_check_out_increase_boolean_ask_enum: Optional[str] = field( + contract_date_check_out_increase_boolean_ask_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateCheckOutIncrease_BooleanAskEnum"}, ) """Update Charge Dates if check-out date moves forward (in the future).""" - contract_date_end: Optional[Dict[str, Any]] = field( + contract_date_end: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateEnd"}, ) - contract_date_start: Optional[Dict[str, Any]] = field( + contract_date_start: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateStart"}, ) - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_date1: Optional[Dict[str, Any]] = field( + custom_date1: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) - custom_date2: Optional[Dict[str, Any]] = field( + custom_date2: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Term description.""" - end_booking_reason_id: Optional[int] = field( + end_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "End_BookingReasonID"}, ) """Pointer to the end booking reason record.""" - entry_status_enum: Optional[str] = field( + entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryStatusEnum"}, ) """Entry status.""" - e_t_a: Optional[str] = field(default=None, metadata={"wire_name": "ETA"}) + e_t_a: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETA"}, + ) """Minutes since midnight for estimated time of arrival.""" - e_t_d: Optional[str] = field(default=None, metadata={"wire_name": "ETD"}) + e_t_d: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETD"}, + ) """Minutes since midnight for estimated time of departure.""" - housekeeping_id: Optional[int] = field( + housekeeping_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HousekeepingID"}, ) """Pointer to the house-keeping record.""" - record_type_enum: Optional[str] = field( + record_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecordTypeEnum"}, ) """Record type.""" - room_location_fixed: Optional[bool] = field( + room_location_fixed: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationFixed"}, ) """Fixed room location.""" - room_location_id: Optional[int] = field( + room_location_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationID"}, ) """Pointer to the address room location record.""" - room_rate_amount: Optional[float] = field( + room_rate_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateAmount"}, ) """Room rate amount.""" - room_rate_id: Optional[int] = field( + room_rate_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateID"}, ) """Pointer to the room rate record.""" - room_type_id: Optional[int] = field( + room_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomTypeID"}, ) """Pointer to the room type record.""" - start_booking_reason_id: Optional[int] = field( + start_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Start_BookingReasonID"}, ) """Pointer to the start booking reason record.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Pointer to the term record.""" - term_session_code: Optional[str] = field( + term_session_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermSessionCode"}, ) """Term session code.""" - term_session_id: Optional[int] = field( + term_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermSessionID"}, ) """Unique ID for this term session record.""" - use_active_booking_as_template: Optional[bool] = field( + use_active_booking_as_template: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UseActiveBookingAsTemplate"}, ) """Indicates if the active booking should be used as a template.""" - web_description: Optional[str] = field( + web_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebDescription"}, ) """Term Session displayed in PortalX.""" @@ -3265,463 +4023,551 @@ class SelectEntryDetailInput: Get Entry Detail """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - academic_hold: Optional[bool] = field( + academic_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AcademicHold"}, ) """Indicates if the academic hold flag has been set.""" - account_payment_type_id: Optional[int] = field( + account_payment_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Account_PaymentTypeID"}, ) """Pointer to the payment type record.""" - account_hold: Optional[bool] = field( + account_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountHold"}, ) """Indicates if the account hold flag has been set.""" - account_bank_name: Optional[str] = field( + account_bank_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountBankName"}, ) """Account bank name.""" - account_bank_number: Optional[str] = field( + account_bank_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountBankNumber"}, ) """Account bank number.""" - account_code: Optional[str] = field( + account_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountCode"}, ) """Account code.""" - account_comments: Optional[str] = field( + account_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountComments"}, ) """Account comments.""" - account_detail1: Optional[str] = field( + account_detail1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail1"}, ) """Account detail.""" - account_detail2: Optional[str] = field( + account_detail2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail2"}, ) """Account detail.""" - account_detail3: Optional[str] = field( + account_detail3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail3"}, ) """Account detail.""" - account_detail4: Optional[str] = field( + account_detail4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail4"}, ) """Account detail.""" - account_due_date: Optional[Dict[str, Any]] = field( + account_due_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDueDate"}, ) - athlete: Optional[bool] = field( + athlete: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Athlete"}, ) """Indicates if the athlete flag has been set.""" - athlete_team: Optional[str] = field( + athlete_team: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AthleteTeam"}, ) """Athlete team.""" - attendee_status_enum: Optional[str] = field( + attendee_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AttendeeStatusEnum"}, ) """Attendee status.""" - career: Optional[str] = field( + career: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Career"}, ) """Intended career.""" - career_comments: Optional[str] = field( + career_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CareerComments"}, ) """Reasons for choosing intended career.""" - citizenship_country_id: Optional[int] = field( + citizenship_country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Citizenship_CountryID"}, ) """Pointer to the citizenship record.""" - classification_id: Optional[int] = field( + classification_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClassificationID"}, ) """Pointer to the classification record.""" - classification_override: Optional[bool] = field( + classification_override: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClassificationOverride"}, ) """Classification override.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Comments.""" - country_of_birth_country_id: Optional[int] = field( + country_of_birth_country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CountryOfBirth_CountryID"}, ) """Pointer to the country of birth record.""" - country_of_residence_country_id: Optional[int] = field( + country_of_residence_country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CountryOfResidence_CountryID"}, ) """Pointer to the country of residence record.""" - cumulative_g_p_a: Optional[float] = field( + cumulative_g_p_a: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CumulativeGPA"}, ) """Cumulative GPA.""" - cumulative_hours: Optional[float] = field( + cumulative_hours: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CumulativeHours"}, ) """Cumulative hours.""" - current_g_p_a: Optional[float] = field( + current_g_p_a: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentGPA"}, ) """Current GPA.""" - current_hours: Optional[float] = field( + current_hours: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentHours"}, ) """Current hours.""" - current_major: Optional[str] = field( + current_major: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentMajor"}, ) """The major chosen by the Entry.""" - current_minor: Optional[str] = field( + current_minor: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentMinor"}, ) """The minor chosen by the Entry.""" - date_entry: Optional[Dict[str, Any]] = field( + date_entry: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateEntry"}, ) - date_exit: Optional[Dict[str, Any]] = field( + date_exit: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateExit"}, ) - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - deceased: Optional[bool] = field( + deceased: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Deceased"}, ) """Indicates if the Entry is deceased.""" - deceased_date: Optional[Dict[str, Any]] = field( + deceased_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DeceasedDate"}, ) - dietary: Optional[str] = field( + dietary: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Dietary"}, ) """Dietary requirements.""" - disability: Optional[str] = field( + disability: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Disability"}, ) """Disability.""" - employment_details: Optional[str] = field( + employment_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmploymentDetails"}, ) """Employment details.""" - enrollment_class: Optional[str] = field( + enrollment_class: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentClass"}, ) """First year, freshman, sophomore, etc.""" - enrollment_level: Optional[str] = field( + enrollment_level: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentLevel"}, ) """Undergraduate, post graduate, etc.""" - enrollment_status: Optional[str] = field( + enrollment_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentStatus"}, ) """Newly admitted, current, active, etc.""" - enrollment_term: Optional[str] = field( + enrollment_term: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentTerm"}, ) """Spring, fall, post graduate, etc.""" - enrollment_year: Optional[int] = field( + enrollment_year: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentYear"}, ) """Year/Level of enrollment.""" - entry_detail_id: Optional[int] = field( + entry_detail_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryDetailID"}, ) """Unique ID for this entry detail record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - ethnicity: Optional[str] = field( + ethnicity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Ethnicity"}, ) """Ethnicity.""" - event_registration_fee_id: Optional[int] = field( + event_registration_fee_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EventRegistrationFeeID"}, ) """Pointer to the event registration fee record.""" - expected_graduation_date: Optional[Dict[str, Any]] = field( + expected_graduation_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedGraduationDate"}, ) - financial_comments: Optional[str] = field( + financial_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FinancialComments"}, ) """Financial support comments.""" - financial_support_id: Optional[int] = field( + financial_support_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FinancialSupportID"}, ) """Pointer to the financial support record.""" - hear_about_us: Optional[str] = field( + hear_about_us: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HearAboutUs"}, ) """How did the Entry hear about us.""" - honors_indicator: Optional[bool] = field( + honors_indicator: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HonorsIndicator"}, ) """Honors indicator.""" - immunizations_hold: Optional[bool] = field( + immunizations_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImmunizationsHold"}, ) """Immunizations hold.""" - incident_hold: Optional[bool] = field( + incident_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IncidentHold"}, ) """Incident hold.""" - incident_hold_comments: Optional[str] = field( + incident_hold_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IncidentHoldComments"}, ) """Incident hold comments.""" - international: Optional[bool] = field( + international: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "International"}, ) """Indicates if the Entry is considered an international student.""" - international_details: Optional[str] = field( + international_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InternationalDetails"}, ) """International details.""" - living_with_dependents: Optional[bool] = field( + living_with_dependents: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LivingWithDependents"}, ) """Living with dependents.""" - married: Optional[bool] = field( + married: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Married"}, ) """Indicates if the Entry is married.""" - medical: Optional[str] = field( + medical: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Medical"}, ) """Medical details.""" - nationality_id: Optional[int] = field( + nationality_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NationalityID"}, ) """Pointer to the nationality record.""" - occupation: Optional[str] = field( + occupation: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Occupation"}, ) """Occupation.""" - photo_path: Optional[str] = field( + photo_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhotoPath"}, ) """Photo path.""" - previous_member_name: Optional[str] = field( + previous_member_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMemberName"}, ) """Previous member name.""" - previous_member_relationship: Optional[str] = field( + previous_member_relationship: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMemberRelationship"}, ) """Previous member relationship.""" - previous_membership: Optional[str] = field( + previous_membership: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMembership"}, ) """Previous membership.""" - previous_membership_years: Optional[str] = field( + previous_membership_years: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMembershipYears"}, ) """Previous membership years.""" - previous_member_years: Optional[str] = field( + previous_member_years: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMemberYears"}, ) """Previous member years.""" - profile_interests: Optional[str] = field( + profile_interests: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ProfileInterests"}, ) """Profile interests.""" - region_of_birth_id: Optional[int] = field( + region_of_birth_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RegionOfBirthID"}, ) """Pointer to the Region of birth record.""" - religion: Optional[str] = field( + religion: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Religion"}, ) """Religion.""" - residency: Optional[str] = field( + residency: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Residency"}, ) """Residency.""" - resident_status: Optional[str] = field( + resident_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResidentStatus"}, ) """Resident status.""" - resident_year: Optional[int] = field( + resident_year: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResidentYear"}, ) """Resident year.""" - situation_response_comments: Optional[str] = field( + situation_response_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseComments"}, ) """Situation response comments.""" - situation_response_detail: Optional[str] = field( + situation_response_detail: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseDetail"}, ) """Situation response detail.""" - situation_response_enum: Optional[str] = field( + situation_response_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseEnum"}, ) """Situation response.""" - situation_response_expiry_date: Optional[Dict[str, Any]] = field( + situation_response_expiry_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseExpiryDate"}, ) - situation_response_modified_date: Optional[Dict[str, Any]] = field( + situation_response_modified_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseModifiedDate"}, ) - situation_response_situation: Optional[str] = field( + situation_response_situation: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseSituation"}, ) """Situation response situation.""" - special_needs: Optional[str] = field( + special_needs: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SpecialNeeds"}, ) """Special needs.""" - staff_id: Optional[int] = field( + staff_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StaffID"}, ) """Pointer to the staff record.""" - uses_screen_reader: Optional[bool] = field( + uses_screen_reader: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UsesScreenReader"}, ) """Uses screen reader.""" - vehicle_details: Optional[str] = field( + vehicle_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VehicleDetails"}, ) """Vehicle details.""" - vehicle_permit: Optional[str] = field( + vehicle_permit: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VehiclePermit"}, ) """Vehicle permit.""" - vehicle_registration: Optional[str] = field( + vehicle_registration: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VehicleRegistration"}, ) """Vehicle registration.""" - veteran_status: Optional[str] = field( + veteran_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VeteranStatus"}, ) """Veteran status.""" - visa: Optional[bool] = field(default=None, metadata={"wire_name": "Visa"}) + visa: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Visa"}, + ) """Indicates if the Entry holds a visa.""" - visa_details: Optional[str] = field( + visa_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VisaDetails"}, ) """Visa details.""" - visitor_hold: Optional[bool] = field( + visitor_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VisitorHold"}, ) """Visitor hold.""" @@ -3733,440 +4579,531 @@ class UpdateEntryDetailInput: Update Entry Detail """ - academic_hold: Optional[bool] = field( + academic_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AcademicHold"}, ) """Indicates if the academic hold flag has been set.""" - account_payment_type_id: Optional[int] = field( + account_payment_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Account_PaymentTypeID"}, ) """Pointer to the preferred payment type record.""" - account_bank_name: Optional[str] = field( + account_bank_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountBankName"}, ) """Account bank name.""" - account_bank_number: Optional[str] = field( + account_bank_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountBankNumber"}, ) """Account bank number.""" - account_code: Optional[str] = field( + account_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountCode"}, ) """Account code.""" - account_comments: Optional[str] = field( + account_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountComments"}, ) """Account comments.""" - account_detail1: Optional[str] = field( + account_detail1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail1"}, ) """Account detail.""" - account_detail2: Optional[str] = field( + account_detail2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail2"}, ) """Account detail.""" - account_detail3: Optional[str] = field( + account_detail3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail3"}, ) """Account detail.""" - account_detail4: Optional[str] = field( + account_detail4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail4"}, ) """Account detail.""" - account_due_date: Optional[str] = field( + account_due_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDueDate"}, ) """Paid to date.""" - account_hold: Optional[bool] = field( + account_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountHold"}, ) """Indicates if the account hold flag has been set.""" - athlete: Optional[bool] = field( + athlete: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Athlete"}, ) """Indicates if the athlete flag has been set.""" - athlete_team: Optional[str] = field( + athlete_team: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AthleteTeam"}, ) """Athlete team.""" - attendee_status_enum: Optional[str] = field( + attendee_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AttendeeStatusEnum"}, ) """Attendee status.""" - career: Optional[str] = field( + career: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Career"}, ) """Intended career.""" - career_comments: Optional[str] = field( + career_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CareerComments"}, ) """Reasons for choosing intended career.""" - citizenship_country_id: Optional[int] = field( + citizenship_country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Citizenship_CountryID"}, ) """Pointer to the citizenship record.""" - classification_id: Optional[int] = field( + classification_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClassificationID"}, ) """Pointer to the classification record.""" - classification_override: Optional[bool] = field( + classification_override: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClassificationOverride"}, ) """Classification override.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Comments.""" - country_of_birth_country_id: Optional[int] = field( + country_of_birth_country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CountryOfBirth_CountryID"}, ) """Pointer to the country of birth record.""" - country_of_residence_country_id: Optional[int] = field( + country_of_residence_country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CountryOfResidence_CountryID"}, ) """Pointer to the country of residence record.""" - cumulative_g_p_a: Optional[float] = field( + cumulative_g_p_a: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CumulativeGPA"}, ) """Cumulative GPA.""" - cumulative_hours: Optional[float] = field( + cumulative_hours: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CumulativeHours"}, ) """Cumulative hours.""" - current_g_p_a: Optional[float] = field( + current_g_p_a: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentGPA"}, ) """Current GPA.""" - current_hours: Optional[float] = field( + current_hours: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentHours"}, ) """Current hours.""" - current_major: Optional[str] = field( + current_major: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentMajor"}, ) """The major chosen by the Entry.""" - current_minor: Optional[str] = field( + current_minor: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentMinor"}, ) """The minor chosen by the Entry.""" - date_entry: Optional[str] = field( + date_entry: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateEntry"}, ) """Entry date.""" - date_exit: Optional[str] = field( + date_exit: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateExit"}, ) """Exit date.""" - deceased: Optional[bool] = field( + deceased: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Deceased"}, ) """Indicates if the Entry is deceased.""" - deceased_date: Optional[str] = field( + deceased_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DeceasedDate"}, ) """Deceased date.""" - dietary: Optional[str] = field( + dietary: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Dietary"}, ) """Dietary requirements.""" - disability: Optional[str] = field( + disability: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Disability"}, ) """Disability.""" - employment_details: Optional[str] = field( + employment_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmploymentDetails"}, ) """Employment details.""" - enrollment_class: Optional[str] = field( + enrollment_class: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentClass"}, ) """First year, freshman, sophomore, etc.""" - enrollment_level: Optional[str] = field( + enrollment_level: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentLevel"}, ) """Undergraduate, post graduate, etc.""" - enrollment_status: Optional[str] = field( + enrollment_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentStatus"}, ) """Newly admitted, current, active, etc.""" - enrollment_term: Optional[str] = field( + enrollment_term: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentTerm"}, ) """Spring, fall, post graduate, etc.""" - enrollment_year: Optional[int] = field( + enrollment_year: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentYear"}, ) """Year/Level of enrollment.""" - entry_detail_id: Optional[int] = field( + entry_detail_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryDetailID"}, ) """Unique ID for this entry detail record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - ethnicity: Optional[str] = field( + ethnicity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Ethnicity"}, ) """Ethnicity.""" - event_registration_fee_id: Optional[int] = field( + event_registration_fee_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EventRegistrationFeeID"}, ) """Pointer to the Event registration fee record.""" - expected_graduation_date: Optional[str] = field( + expected_graduation_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedGraduationDate"}, ) """Expected graduation date.""" - financial_comments: Optional[str] = field( + financial_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FinancialComments"}, ) """Financial support comments.""" - financial_support_id: Optional[int] = field( + financial_support_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FinancialSupportID"}, ) """Pointer to the financial support record.""" - hear_about_us: Optional[str] = field( + hear_about_us: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HearAboutUs"}, ) """How did the Entry hear about us.""" - honors_indicator: Optional[bool] = field( + honors_indicator: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HonorsIndicator"}, ) """Honors indicator.""" - immunizations_hold: Optional[bool] = field( + immunizations_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImmunizationsHold"}, ) """Immunizations hold.""" - incident_hold: Optional[bool] = field( + incident_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IncidentHold"}, ) """Incident hold.""" - incident_hold_comments: Optional[str] = field( + incident_hold_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IncidentHoldComments"}, ) """Incident hold comments.""" - international: Optional[bool] = field( + international: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "International"}, ) """Indicates if the Entry is considered an international student.""" - international_details: Optional[str] = field( + international_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InternationalDetails"}, ) """International details.""" - living_with_dependents: Optional[bool] = field( + living_with_dependents: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LivingWithDependents"}, ) """Living with dependents.""" - married: Optional[bool] = field( + married: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Married"}, ) """Indicates if the Entry is married.""" - medical: Optional[str] = field( + medical: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Medical"}, ) """Medical details.""" - nationality_id: Optional[int] = field( + nationality_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NationalityID"}, ) """Pointer to the nationality record.""" - occupation: Optional[str] = field( + occupation: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Occupation"}, ) """Occupation.""" - photo_path: Optional[str] = field( + photo_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhotoPath"}, ) """Photo path.""" - previous_member_name: Optional[str] = field( + previous_member_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMemberName"}, ) """Previous member name.""" - previous_member_relationship: Optional[str] = field( + previous_member_relationship: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMemberRelationship"}, ) """Previous member relationship.""" - previous_membership: Optional[str] = field( + previous_membership: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMembership"}, ) """Previous membership.""" - previous_membership_years: Optional[str] = field( + previous_membership_years: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMembershipYears"}, ) """Previous membership years.""" - previous_member_years: Optional[str] = field( + previous_member_years: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMemberYears"}, ) """Previous member years.""" - profile_interests: Optional[str] = field( + profile_interests: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ProfileInterests"}, ) """Profile interests.""" - region_of_birth_id: Optional[int] = field( + region_of_birth_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RegionOfBirthID"}, ) """Pointer to the region of birth record.""" - religion: Optional[str] = field( + religion: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Religion"}, ) """Religion.""" - residency: Optional[str] = field( + residency: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Residency"}, ) """Residency.""" - resident_status: Optional[str] = field( + resident_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResidentStatus"}, ) """Resident status.""" - resident_year: Optional[int] = field( + resident_year: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResidentYear"}, ) """Resident year.""" - situation_response_comments: Optional[str] = field( + situation_response_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseComments"}, ) """Situation response comments.""" - situation_response_detail: Optional[str] = field( + situation_response_detail: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseDetail"}, ) """Situation response detail.""" - situation_response_enum: Optional[str] = field( + situation_response_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseEnum"}, ) """Situation response.""" - situation_response_expiry_date: Optional[str] = field( + situation_response_expiry_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseExpiryDate"}, ) """The date when the response ends (e.g because the emergency is over)""" - situation_response_modified_date: Optional[str] = field( + situation_response_modified_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseModifiedDate"}, ) """The date the response was last modified.""" - situation_response_situation: Optional[str] = field( + situation_response_situation: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseSituation"}, ) """Situation response situation.""" - special_needs: Optional[str] = field( + special_needs: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SpecialNeeds"}, ) """Special needs.""" - staff_id: Optional[int] = field( + staff_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StaffID"}, ) """Pointer to the staff record.""" - uses_screen_reader: Optional[bool] = field( + uses_screen_reader: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UsesScreenReader"}, ) """Uses screen reader.""" - vehicle_details: Optional[str] = field( + vehicle_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VehicleDetails"}, ) """Vehicle details.""" - vehicle_permit: Optional[str] = field( + vehicle_permit: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VehiclePermit"}, ) """Vehicle permit.""" - vehicle_registration: Optional[str] = field( + vehicle_registration: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VehicleRegistration"}, ) """Vehicle registration.""" - veteran_status: Optional[str] = field( + veteran_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VeteranStatus"}, ) """Veteran status.""" - visa: Optional[bool] = field(default=None, metadata={"wire_name": "Visa"}) + visa: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Visa"}, + ) """Indicates if the Entry holds a visa.""" - visa_details: Optional[str] = field( + visa_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VisaDetails"}, ) """Visa details.""" - visitor_hold: Optional[bool] = field( + visitor_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VisitorHold"}, ) """Visitor hold.""" @@ -4178,440 +5115,531 @@ class UpdateEntryDetailResponse: Response for Update Entry Detail """ - academic_hold: Optional[bool] = field( + academic_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AcademicHold"}, ) """Indicates if the academic hold flag has been set.""" - account_payment_type_id: Optional[int] = field( + account_payment_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Account_PaymentTypeID"}, ) """Pointer to the preferred payment type record.""" - account_bank_name: Optional[str] = field( + account_bank_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountBankName"}, ) """Account bank name.""" - account_bank_number: Optional[str] = field( + account_bank_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountBankNumber"}, ) """Account bank number.""" - account_code: Optional[str] = field( + account_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountCode"}, ) """Account code.""" - account_comments: Optional[str] = field( + account_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountComments"}, ) """Account comments.""" - account_detail1: Optional[str] = field( + account_detail1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail1"}, ) """Account detail.""" - account_detail2: Optional[str] = field( + account_detail2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail2"}, ) """Account detail.""" - account_detail3: Optional[str] = field( + account_detail3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail3"}, ) """Account detail.""" - account_detail4: Optional[str] = field( + account_detail4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDetail4"}, ) """Account detail.""" - account_due_date: Optional[str] = field( + account_due_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountDueDate"}, ) """Paid to date.""" - account_hold: Optional[bool] = field( + account_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountHold"}, ) """Indicates if the account hold flag has been set.""" - athlete: Optional[bool] = field( + athlete: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Athlete"}, ) """Indicates if the athlete flag has been set.""" - athlete_team: Optional[str] = field( + athlete_team: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AthleteTeam"}, ) """Athlete team.""" - attendee_status_enum: Optional[str] = field( + attendee_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AttendeeStatusEnum"}, ) """Attendee status.""" - career: Optional[str] = field( + career: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Career"}, ) """Intended career.""" - career_comments: Optional[str] = field( + career_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CareerComments"}, ) """Reasons for choosing intended career.""" - citizenship_country_id: Optional[int] = field( + citizenship_country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Citizenship_CountryID"}, ) """Pointer to the citizenship record.""" - classification_id: Optional[int] = field( + classification_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClassificationID"}, ) """Pointer to the classification record.""" - classification_override: Optional[bool] = field( + classification_override: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ClassificationOverride"}, ) """Classification override.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Comments.""" - country_of_birth_country_id: Optional[int] = field( + country_of_birth_country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CountryOfBirth_CountryID"}, ) """Pointer to the country of birth record.""" - country_of_residence_country_id: Optional[int] = field( + country_of_residence_country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CountryOfResidence_CountryID"}, ) """Pointer to the country of residence record.""" - cumulative_g_p_a: Optional[float] = field( + cumulative_g_p_a: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CumulativeGPA"}, ) """Cumulative GPA.""" - cumulative_hours: Optional[float] = field( + cumulative_hours: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CumulativeHours"}, ) """Cumulative hours.""" - current_g_p_a: Optional[float] = field( + current_g_p_a: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentGPA"}, ) """Current GPA.""" - current_hours: Optional[float] = field( + current_hours: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentHours"}, ) """Current hours.""" - current_major: Optional[str] = field( + current_major: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentMajor"}, ) """The major chosen by the Entry.""" - current_minor: Optional[str] = field( + current_minor: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CurrentMinor"}, ) """The minor chosen by the Entry.""" - date_entry: Optional[str] = field( + date_entry: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateEntry"}, ) """Entry date.""" - date_exit: Optional[str] = field( + date_exit: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateExit"}, ) """Exit date.""" - deceased: Optional[bool] = field( + deceased: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Deceased"}, ) """Indicates if the Entry is deceased.""" - deceased_date: Optional[str] = field( + deceased_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DeceasedDate"}, ) """Deceased date.""" - dietary: Optional[str] = field( + dietary: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Dietary"}, ) """Dietary requirements.""" - disability: Optional[str] = field( + disability: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Disability"}, ) """Disability.""" - employment_details: Optional[str] = field( + employment_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmploymentDetails"}, ) """Employment details.""" - enrollment_class: Optional[str] = field( + enrollment_class: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentClass"}, ) """First year, freshman, sophomore, etc.""" - enrollment_level: Optional[str] = field( + enrollment_level: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentLevel"}, ) """Undergraduate, post graduate, etc.""" - enrollment_status: Optional[str] = field( + enrollment_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentStatus"}, ) """Newly admitted, current, active, etc.""" - enrollment_term: Optional[str] = field( + enrollment_term: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentTerm"}, ) """Spring, fall, post graduate, etc.""" - enrollment_year: Optional[int] = field( + enrollment_year: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentYear"}, ) """Year/Level of enrollment.""" - entry_detail_id: Optional[int] = field( + entry_detail_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryDetailID"}, ) """Unique ID for this entry detail record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - ethnicity: Optional[str] = field( + ethnicity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Ethnicity"}, ) """Ethnicity.""" - event_registration_fee_id: Optional[int] = field( + event_registration_fee_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EventRegistrationFeeID"}, ) """Pointer to the event registration fee record.""" - expected_graduation_date: Optional[str] = field( + expected_graduation_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExpectedGraduationDate"}, ) """Expected graduation date.""" - financial_comments: Optional[str] = field( + financial_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FinancialComments"}, ) """Financial support comments.""" - financial_support_id: Optional[int] = field( + financial_support_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FinancialSupportID"}, ) """Pointer to the financial support fee record.""" - hear_about_us: Optional[str] = field( + hear_about_us: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HearAboutUs"}, ) """How did the Entry hear about us.""" - honors_indicator: Optional[bool] = field( + honors_indicator: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HonorsIndicator"}, ) """Honors indicator.""" - immunizations_hold: Optional[bool] = field( + immunizations_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ImmunizationsHold"}, ) """Immunizations hold.""" - incident_hold: Optional[bool] = field( + incident_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IncidentHold"}, ) """Incident hold.""" - incident_hold_comments: Optional[str] = field( + incident_hold_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IncidentHoldComments"}, ) """Incident hold comments.""" - international: Optional[bool] = field( + international: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "International"}, ) """Indicates if the Entry is considered an international student.""" - international_details: Optional[str] = field( + international_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InternationalDetails"}, ) """International details.""" - living_with_dependents: Optional[bool] = field( + living_with_dependents: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "LivingWithDependents"}, ) """Living with dependents.""" - married: Optional[bool] = field( + married: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Married"}, ) """Indicates if the Entry is married.""" - medical: Optional[str] = field( + medical: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Medical"}, ) """Medical details.""" - nationality_id: Optional[int] = field( + nationality_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NationalityID"}, ) """Pointer to the nationality record.""" - occupation: Optional[str] = field( + occupation: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Occupation"}, ) """Occupation.""" - photo_path: Optional[str] = field( + photo_path: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PhotoPath"}, ) """Photo path.""" - previous_member_name: Optional[str] = field( + previous_member_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMemberName"}, ) """Previous member name.""" - previous_member_relationship: Optional[str] = field( + previous_member_relationship: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMemberRelationship"}, ) """Previous member relationship.""" - previous_membership: Optional[str] = field( + previous_membership: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMembership"}, ) """Previous membership.""" - previous_membership_years: Optional[str] = field( + previous_membership_years: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMembershipYears"}, ) """Previous membership years.""" - previous_member_years: Optional[str] = field( + previous_member_years: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PreviousMemberYears"}, ) """Previous member years.""" - profile_interests: Optional[str] = field( + profile_interests: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ProfileInterests"}, ) """Profile interests.""" - region_of_birth_id: Optional[int] = field( + region_of_birth_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RegionOfBirthID"}, ) """Pointer to the region of birth record.""" - religion: Optional[str] = field( + religion: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Religion"}, ) """Religion.""" - residency: Optional[str] = field( + residency: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Residency"}, ) """Residency.""" - resident_status: Optional[str] = field( + resident_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResidentStatus"}, ) """Resident status.""" - resident_year: Optional[int] = field( + resident_year: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResidentYear"}, ) """Resident year.""" - situation_response_comments: Optional[str] = field( + situation_response_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseComments"}, ) """Situation response comments.""" - situation_response_detail: Optional[str] = field( + situation_response_detail: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseDetail"}, ) """Situation response detail.""" - situation_response_enum: Optional[str] = field( + situation_response_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseEnum"}, ) """Situation response.""" - situation_response_expiry_date: Optional[str] = field( + situation_response_expiry_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseExpiryDate"}, ) """The date when the response ends (e.g. because the emergency is over)""" - situation_response_modified_date: Optional[str] = field( + situation_response_modified_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseModifiedDate"}, ) """The date the response was last modified.""" - situation_response_situation: Optional[str] = field( + situation_response_situation: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SituationResponseSituation"}, ) """Situation response situation.""" - special_needs: Optional[str] = field( + special_needs: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SpecialNeeds"}, ) """Special needs.""" - staff_id: Optional[int] = field( + staff_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StaffID"}, ) """Pointer to the staff record.""" - uses_screen_reader: Optional[bool] = field( + uses_screen_reader: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UsesScreenReader"}, ) """Uses screen reader.""" - vehicle_details: Optional[str] = field( + vehicle_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VehicleDetails"}, ) """Vehicle details.""" - vehicle_permit: Optional[str] = field( + vehicle_permit: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VehiclePermit"}, ) """Vehicle permit.""" - vehicle_registration: Optional[str] = field( + vehicle_registration: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VehicleRegistration"}, ) """Vehicle registration.""" - veteran_status: Optional[str] = field( + veteran_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VeteranStatus"}, ) """Veteran status.""" - visa: Optional[bool] = field(default=None, metadata={"wire_name": "Visa"}) + visa: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Visa"}, + ) """Indicates if the Entry holds a visa.""" - visa_details: Optional[str] = field( + visa_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VisaDetails"}, ) """Visa details.""" - visitor_hold: Optional[bool] = field( + visitor_hold: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "VisitorHold"}, ) """Visitor hold.""" @@ -4623,191 +5651,231 @@ class SelectEntryEnrollmentInput: Get Entry Enrollment """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - campus: Optional[str] = field( + campus: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Campus"}, ) """Campus where entry is enrolled.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Enrollment comments.""" - course_id: Optional[int] = field( + course_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CourseID"}, ) """Pointer to the course record.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_date1: Optional[Dict[str, Any]] = field( + custom_date1: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) - custom_date2: Optional[Dict[str, Any]] = field( + custom_date2: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - date_end: Optional[Dict[str, Any]] = field( + date_end: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateEnd"}, ) - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - date_start: Optional[Dict[str, Any]] = field( + date_start: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateStart"}, ) - department: Optional[str] = field( + department: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Department"}, ) """Department entry is enrolled in.""" - enrollment_field: Optional[str] = field( + enrollment_field: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentField"}, ) """Field of enrollment.""" - enrollment_order: Optional[int] = field( + enrollment_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentOrder"}, ) """Enrollment order.""" - enrollment_type_enum: Optional[str] = field( + enrollment_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentTypeEnum"}, ) """Enrollment type.""" - entry_enrollment_id: Optional[int] = field( + entry_enrollment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryEnrollmentID"}, ) """Unique ID for this entry enrollment record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - faculty: Optional[str] = field( + faculty: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Faculty"}, ) """Course faculty.""" - full_time: Optional[bool] = field( + full_time: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FullTime"}, ) """Indicates if the entry is enrolled full time.""" - graduation_date: Optional[Dict[str, Any]] = field( + graduation_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GraduationDate"}, ) - institution: Optional[str] = field( + institution: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Institution"}, ) """Course institution.""" - is_enrolled: Optional[bool] = field( + is_enrolled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsEnrolled"}, ) """Indicates if the entry is enrolled.""" - major: Optional[str] = field(default=None, metadata={"wire_name": "Major"}) + major: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Major"}, + ) """Course Major.""" - major_category: Optional[str] = field( + major_category: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MajorCategory"}, ) """Major category.""" - minor: Optional[str] = field(default=None, metadata={"wire_name": "Minor"}) + minor: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Minor"}, + ) """Course Minor.""" - post_grad: Optional[bool] = field( + post_grad: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PostGrad"}, ) """Indicates if this is a post graduate course.""" - sequence: Optional[int] = field( + sequence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sequence"}, ) """Sequence""" - subjects: Optional[str] = field( + subjects: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subjects"}, ) """The subjects the entry is enrolled in.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Pointer to the term record.""" - years: Optional[str] = field(default=None, metadata={"wire_name": "Years"}) + years: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Years"}, + ) """Years enrolled.""" @@ -4817,166 +5885,205 @@ class CreateEntryEnrollmentInput: Create Entry Enrollment """ - campus: Optional[str] = field( + campus: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Campus"}, ) """Campus where entry is enrolled.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Enrollment comments.""" - course_id: Optional[int] = field( + course_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CourseID"}, ) """Pointer to the course record.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - date_end: Optional[str] = field( + date_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateEnd"}, ) """Date enrollment ends.""" - date_start: Optional[str] = field( + date_start: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateStart"}, ) """Date enrollment starts.""" - department: Optional[str] = field( + department: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Department"}, ) """Department entry is enrolled in.""" - enrollment_field: Optional[str] = field( + enrollment_field: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentField"}, ) """Field of enrollment.""" - enrollment_order: Optional[int] = field( + enrollment_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentOrder"}, ) """Enrollment order.""" - enrollment_type_enum: Optional[str] = field( + enrollment_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentTypeEnum"}, ) """Enrollment type.""" - entry_enrollment_id: Optional[int] = field( + entry_enrollment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryEnrollmentID"}, ) """Unique ID for this entry enrollment record.""" - entry_id: Optional[int] = field( - default=None, - metadata={"wire_name": "EntryID"}, - ) + entry_id: int = dataclass_field(metadata={"wire_name": "EntryID"}) """Pointer to the entry record.""" - faculty: Optional[str] = field( + faculty: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Faculty"}, ) """Course faculty.""" - full_time: Optional[bool] = field( + full_time: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FullTime"}, ) """Indicates if the entry is enrolled full time.""" - graduation_date: Optional[str] = field( + graduation_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GraduationDate"}, ) """Date of graduation.""" - institution: Optional[str] = field( + institution: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Institution"}, ) """Course institution.""" - is_enrolled: Optional[bool] = field( + is_enrolled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsEnrolled"}, ) """Indicates if the entry is enrolled.""" - major: Optional[str] = field(default=None, metadata={"wire_name": "Major"}) + major: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Major"}, + ) """Course Major.""" - major_category: Optional[str] = field( + major_category: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MajorCategory"}, ) """Major category.""" - minor: Optional[str] = field(default=None, metadata={"wire_name": "Minor"}) + minor: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Minor"}, + ) """Course Minor.""" - post_grad: Optional[bool] = field( + post_grad: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PostGrad"}, ) """Indicates if this is a post graduate course.""" - sequence: Optional[int] = field( + sequence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sequence"}, ) """Sequence""" - subjects: Optional[str] = field( + subjects: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subjects"}, ) """The subjects the entry is enrolled in.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Pointer to the term record.""" - years: Optional[str] = field(default=None, metadata={"wire_name": "Years"}) + years: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Years"}, + ) """Years enrolled.""" @@ -4986,166 +6093,209 @@ class CreateEntryEnrollmentResponse: Response for Create Entry Enrollment """ - campus: Optional[str] = field( + campus: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Campus"}, ) """Campus where entry is enrolled.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Enrollment comments.""" - course_id: Optional[int] = field( + course_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CourseID"}, ) """Pointer to the course record.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - date_end: Optional[str] = field( + date_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateEnd"}, ) """Date enrollment ends.""" - date_start: Optional[str] = field( + date_start: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateStart"}, ) """Date enrollment starts.""" - department: Optional[str] = field( + department: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Department"}, ) """Department entry is enrolled in.""" - enrollment_field: Optional[str] = field( + enrollment_field: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentField"}, ) """Field of enrollment.""" - enrollment_order: Optional[int] = field( + enrollment_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentOrder"}, ) """Enrollment order.""" - enrollment_type_enum: Optional[str] = field( + enrollment_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentTypeEnum"}, ) """Enrollment type.""" - entry_enrollment_id: Optional[int] = field( + entry_enrollment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryEnrollmentID"}, ) """Unique ID for this entry enrollment record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - faculty: Optional[str] = field( + faculty: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Faculty"}, ) """Course faculty.""" - full_time: Optional[bool] = field( + full_time: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FullTime"}, ) """Indicates if the entry is enrolled full time.""" - graduation_date: Optional[str] = field( + graduation_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GraduationDate"}, ) """Date of graduation.""" - institution: Optional[str] = field( + institution: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Institution"}, ) """Course institution.""" - is_enrolled: Optional[bool] = field( + is_enrolled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsEnrolled"}, ) """Indicates if the entry is enrolled.""" - major: Optional[str] = field(default=None, metadata={"wire_name": "Major"}) + major: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Major"}, + ) """Course Major.""" - major_category: Optional[str] = field( + major_category: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MajorCategory"}, ) """Major category.""" - minor: Optional[str] = field(default=None, metadata={"wire_name": "Minor"}) + minor: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Minor"}, + ) """Course Minor.""" - post_grad: Optional[bool] = field( + post_grad: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PostGrad"}, ) """Indicates if this is a post graduate course.""" - sequence: Optional[int] = field( + sequence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sequence"}, ) """Sequence""" - subjects: Optional[str] = field( + subjects: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subjects"}, ) """The subjects the entry is enrolled in.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Pointer to the term record.""" - years: Optional[str] = field(default=None, metadata={"wire_name": "Years"}) + years: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Years"}, + ) """Years enrolled.""" @@ -5155,166 +6305,209 @@ class UpdateEntryEnrollmentInput: Update Entry Enrollment """ - campus: Optional[str] = field( + campus: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Campus"}, ) """Campus where entry is enrolled.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Enrollment comments.""" - course_id: Optional[int] = field( + course_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CourseID"}, ) """Pointer to the course record.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - date_end: Optional[str] = field( + date_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateEnd"}, ) """Date enrollment ends.""" - date_start: Optional[str] = field( + date_start: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateStart"}, ) """Date enrollment starts.""" - department: Optional[str] = field( + department: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Department"}, ) """Department entry is enrolled in.""" - enrollment_field: Optional[str] = field( + enrollment_field: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentField"}, ) """Field of enrollment.""" - enrollment_order: Optional[int] = field( + enrollment_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentOrder"}, ) """Enrollment order.""" - enrollment_type_enum: Optional[str] = field( + enrollment_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentTypeEnum"}, ) """Enrollment type.""" - entry_enrollment_id: Optional[int] = field( + entry_enrollment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryEnrollmentID"}, ) """Unique ID for this entry enrollment record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - faculty: Optional[str] = field( + faculty: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Faculty"}, ) """Course faculty.""" - full_time: Optional[bool] = field( + full_time: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FullTime"}, ) """Indicates if the entry is enrolled full time.""" - graduation_date: Optional[str] = field( + graduation_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GraduationDate"}, ) """Date of graduation.""" - institution: Optional[str] = field( + institution: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Institution"}, ) """Course institution.""" - is_enrolled: Optional[bool] = field( + is_enrolled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsEnrolled"}, ) """Indicates if the entry is enrolled.""" - major: Optional[str] = field(default=None, metadata={"wire_name": "Major"}) + major: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Major"}, + ) """Course Major.""" - major_category: Optional[str] = field( + major_category: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MajorCategory"}, ) """Major category.""" - minor: Optional[str] = field(default=None, metadata={"wire_name": "Minor"}) + minor: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Minor"}, + ) """Course Minor.""" - post_grad: Optional[bool] = field( + post_grad: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PostGrad"}, ) """Indicates if this is a post graduate course.""" - sequence: Optional[int] = field( + sequence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sequence"}, ) """Sequence""" - subjects: Optional[str] = field( + subjects: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subjects"}, ) """The subjects the entry is enrolled in.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Pointer to the term record.""" - years: Optional[str] = field(default=None, metadata={"wire_name": "Years"}) + years: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Years"}, + ) """Years enrolled.""" @@ -5324,166 +6517,209 @@ class UpdateEntryEnrollmentResponse: Response for Update Entry Enrollment """ - campus: Optional[str] = field( + campus: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Campus"}, ) """Campus where entry is enrolled.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Enrollment comments.""" - course_id: Optional[int] = field( + course_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CourseID"}, ) """Pointer to the course record.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - date_end: Optional[str] = field( + date_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateEnd"}, ) """Date enrollment ends.""" - date_start: Optional[str] = field( + date_start: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateStart"}, ) """Date enrollment starts.""" - department: Optional[str] = field( + department: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Department"}, ) """Department entry is enrolled in.""" - enrollment_field: Optional[str] = field( + enrollment_field: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentField"}, ) """Field of enrollment.""" - enrollment_order: Optional[int] = field( + enrollment_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentOrder"}, ) """Enrollment order.""" - enrollment_type_enum: Optional[str] = field( + enrollment_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EnrollmentTypeEnum"}, ) """Enrollment type.""" - entry_enrollment_id: Optional[int] = field( + entry_enrollment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryEnrollmentID"}, ) """Unique ID for this entry enrollment record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - faculty: Optional[str] = field( + faculty: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Faculty"}, ) """Course faculty.""" - full_time: Optional[bool] = field( + full_time: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FullTime"}, ) """Indicates if the entry is enrolled full time.""" - graduation_date: Optional[str] = field( + graduation_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GraduationDate"}, ) """Date of graduation.""" - institution: Optional[str] = field( + institution: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Institution"}, ) """Course institution.""" - is_enrolled: Optional[bool] = field( + is_enrolled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsEnrolled"}, ) """Indicates if the entry is enrolled.""" - major: Optional[str] = field(default=None, metadata={"wire_name": "Major"}) + major: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Major"}, + ) """Course Major.""" - major_category: Optional[str] = field( + major_category: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MajorCategory"}, ) """Major category.""" - minor: Optional[str] = field(default=None, metadata={"wire_name": "Minor"}) + minor: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Minor"}, + ) """Course Minor.""" - post_grad: Optional[bool] = field( + post_grad: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PostGrad"}, ) """Indicates if this is a post graduate course.""" - sequence: Optional[int] = field( + sequence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sequence"}, ) """Sequence""" - subjects: Optional[str] = field( + subjects: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subjects"}, ) """The subjects the entry is enrolled in.""" - term_id: Optional[int] = field( + term_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermID"}, ) """Pointer to the term record.""" - years: Optional[str] = field(default=None, metadata={"wire_name": "Years"}) + years: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Years"}, + ) """Years enrolled.""" @@ -5493,331 +6729,396 @@ class SelectBookingInput: Get Booking """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - additional_occupant_count: Optional[int] = field( + additional_occupant_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AdditionalOccupantCount"}, ) """The number of additional human occupants in this booking.""" - auto_allocation_detail: Optional[str] = field( + auto_allocation_detail: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AutoAllocationDetail"}, ) """Details of the auto allocation.""" - booking_id: Optional[int] = field( + booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingID"}, ) """Unique ID for this booking record.""" - booking_link_type_enum: Optional[str] = field( + booking_link_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingLinkTypeEnum"}, ) """Booking link type.""" - booking_type_id: Optional[int] = field( + booking_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingTypeID"}, ) """Pointer to the booking type record.""" - check_in_date: Optional[Dict[str, Any]] = field( + check_in_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDate"}, ) - check_in_date_actual: Optional[Dict[str, Any]] = field( + check_in_date_actual: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDateActual"}, ) - check_out_date: Optional[Dict[str, Any]] = field( + check_out_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDate"}, ) - check_out_date_actual: Optional[Dict[str, Any]] = field( + check_out_date_actual: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDateActual"}, ) - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Comments""" - contract_date_end: Optional[Dict[str, Any]] = field( + contract_date_end: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateEnd"}, ) - contract_date_start: Optional[Dict[str, Any]] = field( + contract_date_start: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateStart"}, ) - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_bit3: Optional[bool] = field( + custom_bit3: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit3"}, ) """Custom boolean field value.""" - custom_bit4: Optional[bool] = field( + custom_bit4: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit4"}, ) """Custom boolean field value.""" - custom_date1: Optional[Dict[str, Any]] = field( + custom_date1: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) - custom_date2: Optional[Dict[str, Any]] = field( + custom_date2: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) - custom_date3: Optional[Dict[str, Any]] = field( + custom_date3: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate3"}, ) - custom_date4: Optional[Dict[str, Any]] = field( + custom_date4: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate4"}, ) - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - custom_string7: Optional[str] = field( + custom_string7: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString7"}, ) """Custom string field value.""" - custom_string8: Optional[str] = field( + custom_string8: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString8"}, ) """Custom string field value.""" - custom_string9: Optional[str] = field( + custom_string9: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString9"}, ) """Custom string field value.""" - custom_string10: Optional[str] = field( + custom_string10: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString10"}, ) """Custom string field value.""" - date_billed: Optional[Dict[str, Any]] = field( + date_billed: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateBilled"}, ) - date_charged_to: Optional[Dict[str, Any]] = field( + date_charged_to: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateChargedTo"}, ) - date_created: Optional[Dict[str, Any]] = field( + date_created: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateCreated"}, ) - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - date_modified_billing: Optional[Dict[str, Any]] = field( + date_modified_billing: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModifiedBilling"}, ) - emotional_support_animal_count: Optional[int] = field( + emotional_support_animal_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmotionalSupportAnimalCount"}, ) """ The number of additional Emotional Support Animal occupants in this booking. """ - end_booking_reason_id: Optional[int] = field( + end_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "End_BookingReasonID"}, ) """The reason this booking finished.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - entry_invitation_id: Optional[int] = field( + entry_invitation_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryInvitationID"}, ) """Identifies the entry invitation that the booking is created for.""" - entry_status_enum: Optional[str] = field( + entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryStatusEnum"}, ) """The status of the booking.""" - e_t_a: Optional[str] = field(default=None, metadata={"wire_name": "ETA"}) + e_t_a: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETA"}, + ) """Minutes since midnight for estimated time of arrival.""" - e_t_d: Optional[str] = field(default=None, metadata={"wire_name": "ETD"}) + e_t_d: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETD"}, + ) """Minutes since midnight for estimated time of departure.""" - excess: Optional[float] = field( + excess: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Excess"}, ) """Amount of excess.""" - group_id: Optional[int] = field( + group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GroupID"}, ) """Pointer to the group record.""" - housekeeping_id: Optional[int] = field( + housekeeping_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HousekeepingID"}, ) """The housekeeping rules that should be applied to this booking.""" - number_of_children: Optional[int] = field( + number_of_children: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfChildren"}, ) """The number of children in the booking.""" - number_of_children_free: Optional[int] = field( + number_of_children_free: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfChildrenFree"}, ) """The number of children that are free to stay.""" - number_of_guests: Optional[int] = field( + number_of_guests: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfGuests"}, ) """The number of guests in the booking.""" - number_of_guests_free: Optional[int] = field( + number_of_guests_free: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfGuestsFree"}, ) """The number of guests that are free to stay.""" - paid_to: Optional[Dict[str, Any]] = field( + paid_to: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaidTo"}, ) - pet_count: Optional[int] = field( + pet_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PetCount"}, ) """The number of additional pet occupants in this booking.""" - resv_charge_to_entry: Optional[bool] = field( + resv_charge_to_entry: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResvChargeToEntry"}, ) """ Whether reservation charges are charged to the entry or group master account. """ - room_location_fixed: Optional[bool] = field( + room_location_fixed: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationFixed"}, ) """ Indicates if the location was manually selected, and should not be changed by Auto Room Allocations. """ - room_location_id: Optional[int] = field( + room_location_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationID"}, ) """Pointer to the room location record.""" - room_rate_amount: Optional[float] = field( + room_rate_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateAmount"}, ) """Actual dollar amount of room rate.""" - room_rate_id: Optional[int] = field( + room_rate_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateID"}, ) """Selected room rate.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Pointer to the room space record.""" - room_type_id: Optional[int] = field( + room_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomTypeID"}, ) """Pointer to the room type record.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - service_animal_count: Optional[int] = field( + service_animal_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ServiceAnimalCount"}, ) """The number of additional Service Animal occupants in this booking.""" - special_requirement: Optional[str] = field( + special_requirement: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SpecialRequirement"}, ) """Special requirements for this booking.""" - start_booking_reason_id: Optional[int] = field( + start_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Start_BookingReasonID"}, ) """Reason for this booking (normal, room change etc.).""" - term_session_id: Optional[int] = field( + term_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermSessionID"}, ) """Pointer to the term session record.""" @@ -5829,306 +7130,368 @@ class CreateBookingInput: Create Booking """ - additional_occupant_count: Optional[int] = field( + additional_occupant_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AdditionalOccupantCount"}, ) """The number of additional human occupants in this booking.""" - auto_allocation_detail: Optional[str] = field( + auto_allocation_detail: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AutoAllocationDetail"}, ) """Details of the auto allocation.""" - booking_id: Optional[int] = field( + booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingID"}, ) """Unique ID for this booking record.""" - booking_link_type_enum: Optional[str] = field( + booking_link_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingLinkTypeEnum"}, ) """Booking link type.""" - booking_type_id: Optional[int] = field( + booking_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingTypeID"}, ) """Pointer to the booking type record.""" - check_in_date: Optional[str] = field( + check_in_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDate"}, ) """Main (contract) check-in date.""" - check_in_date_actual: Optional[str] = field( + check_in_date_actual: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDateActual"}, ) """Actual date the entry arrives.""" - check_out_date: Optional[str] = field( + check_out_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDate"}, ) """Main (contract) check-out date.""" - check_out_date_actual: Optional[str] = field( + check_out_date_actual: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDateActual"}, ) """Actual date the entry departs.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Comments""" - contract_date_end: Optional[str] = field( + contract_date_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateEnd"}, ) """Contact chargeable date end.""" - contract_date_start: Optional[str] = field( + contract_date_start: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateStart"}, ) """Contact chargeable date start.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_bit3: Optional[bool] = field( + custom_bit3: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit3"}, ) """Custom boolean field value.""" - custom_bit4: Optional[bool] = field( + custom_bit4: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit4"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_date3: Optional[str] = field( + custom_date3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate3"}, ) """Custom date field value.""" - custom_date4: Optional[str] = field( + custom_date4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate4"}, ) """Custom date field value.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - custom_string7: Optional[str] = field( + custom_string7: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString7"}, ) """Custom string field value.""" - custom_string8: Optional[str] = field( + custom_string8: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString8"}, ) """Custom string field value.""" - custom_string9: Optional[str] = field( + custom_string9: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString9"}, ) """Custom string field value.""" - custom_string10: Optional[str] = field( + custom_string10: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString10"}, ) """Custom string field value.""" - date_billed: Optional[str] = field( + date_billed: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateBilled"}, ) """Date when this booking was processed for billing.""" - date_charged_to: Optional[str] = field( + date_charged_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateChargedTo"}, ) """Date this booking has been charged up to (using reservation charges).""" - emotional_support_animal_count: Optional[int] = field( + emotional_support_animal_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmotionalSupportAnimalCount"}, ) """ The number of additional Emotional Support Animal occupants in this booking. """ - end_booking_reason_id: Optional[int] = field( + end_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "End_BookingReasonID"}, ) """The reason this booking finished.""" - entry_id: Optional[int] = field( - default=None, - metadata={"wire_name": "EntryID"}, - ) + entry_id: int = dataclass_field(metadata={"wire_name": "EntryID"}) """Pointer to the entry record.""" - entry_invitation_id: Optional[int] = field( + entry_invitation_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryInvitationID"}, ) """Identifies the entry invitation that the booking is created for.""" - entry_status_enum: Optional[str] = field( + entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryStatusEnum"}, ) """The status of the booking.""" - e_t_a: Optional[str] = field(default=None, metadata={"wire_name": "ETA"}) + e_t_a: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETA"}, + ) """Date and time of estimated arrival.""" - e_t_d: Optional[str] = field(default=None, metadata={"wire_name": "ETD"}) + e_t_d: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETD"}, + ) """Date and time of estimated departure.""" - excess: Optional[float] = field( + excess: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Excess"}, ) """Amount of excess.""" - group_id: Optional[int] = field( + group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GroupID"}, ) """Pointer to the group record.""" - housekeeping_id: Optional[int] = field( + housekeeping_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HousekeepingID"}, ) """The housekeeping rules that should be applied to this booking.""" - number_of_children: Optional[int] = field( + number_of_children: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfChildren"}, ) """The number of children in the booking.""" - number_of_children_free: Optional[int] = field( + number_of_children_free: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfChildrenFree"}, ) """The number of children that are free to stay.""" - number_of_guests: Optional[int] = field( + number_of_guests: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfGuests"}, ) """The number of guests in the booking.""" - number_of_guests_free: Optional[int] = field( + number_of_guests_free: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfGuestsFree"}, ) """The number of guests that are free to stay.""" - paid_to: Optional[str] = field( + paid_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaidTo"}, ) """Date the booking is paid to.""" - pet_count: Optional[int] = field( + pet_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PetCount"}, ) """The number of additional pet occupants in this booking.""" - resv_charge_to_entry: Optional[bool] = field( + resv_charge_to_entry: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResvChargeToEntry"}, ) """ Whether reservation charges are charged to the entry or group master account. """ - room_location_fixed: Optional[bool] = field( + room_location_fixed: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationFixed"}, ) """ Indicates if the location was manually selected, and should not be changed by Auto Room Allocations. """ - room_location_id: Optional[int] = field( + room_location_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationID"}, ) """Pointer to the room location record.""" - room_rate_amount: Optional[float] = field( + room_rate_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateAmount"}, ) """Actual dollar amount of room rate.""" - room_rate_id: Optional[int] = field( + room_rate_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateID"}, ) """Selected room rate.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Pointer to the room space record.""" - room_type_id: Optional[int] = field( + room_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomTypeID"}, ) """Pointer to the room type record.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - service_animal_count: Optional[int] = field( + service_animal_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ServiceAnimalCount"}, ) """The number of additional Service Animal occupants in this booking.""" - special_requirement: Optional[str] = field( + special_requirement: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SpecialRequirement"}, ) """Special requirements for this booking.""" - start_booking_reason_id: Optional[int] = field( + start_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Start_BookingReasonID"}, ) """Reason for this booking (normal, room change etc.).""" - term_session_id: Optional[int] = field( + term_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermSessionID"}, ) """Pointer to the term session record.""" @@ -6140,311 +7503,378 @@ class CreateBookingResponse: Response for Create Booking """ - additional_occupant_count: Optional[int] = field( + additional_occupant_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AdditionalOccupantCount"}, ) """The number of additional human occupants in this booking.""" - auto_allocation_detail: Optional[str] = field( + auto_allocation_detail: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AutoAllocationDetail"}, ) """Details of the auto allocation.""" - booking_id: Optional[int] = field( + booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingID"}, ) """Unique ID for this booking record.""" - booking_link_type_enum: Optional[str] = field( + booking_link_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingLinkTypeEnum"}, ) """Booking link type.""" - booking_type_id: Optional[int] = field( + booking_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingTypeID"}, ) """Pointer to the booking type record.""" - check_in_date: Optional[str] = field( + check_in_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDate"}, ) """Main (contract) check-in date.""" - check_in_date_actual: Optional[str] = field( + check_in_date_actual: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDateActual"}, ) """Actual date the entry arrives.""" - check_out_date: Optional[str] = field( + check_out_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDate"}, ) """Main (contract) check-out date.""" - check_out_date_actual: Optional[str] = field( + check_out_date_actual: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDateActual"}, ) """Actual date the entry departs.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Comments""" - contract_date_end: Optional[str] = field( + contract_date_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateEnd"}, ) """Contact chargeable date end.""" - contract_date_start: Optional[str] = field( + contract_date_start: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateStart"}, ) """Contact chargeable date start.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_bit3: Optional[bool] = field( + custom_bit3: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit3"}, ) """Custom boolean field value.""" - custom_bit4: Optional[bool] = field( + custom_bit4: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit4"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_date3: Optional[str] = field( + custom_date3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate3"}, ) """Custom date field value.""" - custom_date4: Optional[str] = field( + custom_date4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate4"}, ) """Custom date field value.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - custom_string7: Optional[str] = field( + custom_string7: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString7"}, ) """Custom string field value.""" - custom_string8: Optional[str] = field( + custom_string8: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString8"}, ) """Custom string field value.""" - custom_string9: Optional[str] = field( + custom_string9: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString9"}, ) """Custom string field value.""" - custom_string10: Optional[str] = field( + custom_string10: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString10"}, ) """Custom string field value.""" - date_billed: Optional[str] = field( + date_billed: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateBilled"}, ) """Date when this booking was processed for billing.""" - date_charged_to: Optional[str] = field( + date_charged_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateChargedTo"}, ) """Date this booking has been charged up to (using reservation charges).""" - date_modified_billing: Optional[str] = field( + date_modified_billing: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModifiedBilling"}, ) """Indicates when critical booking fields are modified.""" - emotional_support_animal_count: Optional[int] = field( + emotional_support_animal_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmotionalSupportAnimalCount"}, ) """ The number of additional Emotional Support Animal occupants in this booking. """ - end_booking_reason_id: Optional[int] = field( + end_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "End_BookingReasonID"}, ) """The reason this booking finished.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - entry_invitation_id: Optional[int] = field( + entry_invitation_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryInvitationID"}, ) """Identifies the entry invitation that the booking is created for.""" - entry_status_enum: Optional[str] = field( + entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryStatusEnum"}, ) """The status of the booking.""" - e_t_a: Optional[str] = field(default=None, metadata={"wire_name": "ETA"}) + e_t_a: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETA"}, + ) """Date and time of estimated arrival.""" - e_t_d: Optional[str] = field(default=None, metadata={"wire_name": "ETD"}) + e_t_d: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETD"}, + ) """Date and time of estimated departure.""" - excess: Optional[float] = field( + excess: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Excess"}, ) """Amount of excess.""" - group_id: Optional[int] = field( + group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GroupID"}, ) """Pointer to the group record.""" - housekeeping_id: Optional[int] = field( + housekeeping_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HousekeepingID"}, ) """The housekeeping rules that should be applied to this booking.""" - number_of_children: Optional[int] = field( + number_of_children: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfChildren"}, ) """The number of children in the booking.""" - number_of_children_free: Optional[int] = field( + number_of_children_free: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfChildrenFree"}, ) """The number of children that are free to stay.""" - number_of_guests: Optional[int] = field( + number_of_guests: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfGuests"}, ) """The number of guests in the booking.""" - number_of_guests_free: Optional[int] = field( + number_of_guests_free: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfGuestsFree"}, ) """The number of guests that are free to stay.""" - paid_to: Optional[str] = field( + paid_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaidTo"}, ) """Date the booking is paid to.""" - pet_count: Optional[int] = field( + pet_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PetCount"}, ) """The number of additional pet occupants in this booking.""" - resv_charge_to_entry: Optional[bool] = field( + resv_charge_to_entry: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResvChargeToEntry"}, ) """ Whether reservation charges are charged to the entry or group master account. """ - room_location_fixed: Optional[bool] = field( + room_location_fixed: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationFixed"}, ) """ Indicates if the location was manually selected, and should not be changed by Auto Room Allocations. """ - room_location_id: Optional[int] = field( + room_location_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationID"}, ) """Pointer to the room location record.""" - room_rate_amount: Optional[float] = field( + room_rate_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateAmount"}, ) """Actual dollar amount of room rate.""" - room_rate_id: Optional[int] = field( + room_rate_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateID"}, ) """Selected room rate.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Pointer to the room space record.""" - room_type_id: Optional[int] = field( + room_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomTypeID"}, ) """Pointer to the room type record.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - service_animal_count: Optional[int] = field( + service_animal_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ServiceAnimalCount"}, ) """The number of additional Service Animal occupants in this booking.""" - special_requirement: Optional[str] = field( + special_requirement: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SpecialRequirement"}, ) """Special requirements for this booking.""" - start_booking_reason_id: Optional[int] = field( + start_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Start_BookingReasonID"}, ) """Reason for this booking (normal, room change etc.).""" - term_session_id: Optional[int] = field( + term_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermSessionID"}, ) """Pointer to the term session record.""" @@ -6456,306 +7886,372 @@ class UpdateBookingInput: Update Booking """ - additional_occupant_count: Optional[int] = field( + additional_occupant_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AdditionalOccupantCount"}, ) """The number of additional human occupants in this booking.""" - auto_allocation_detail: Optional[str] = field( + auto_allocation_detail: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AutoAllocationDetail"}, ) """Details of the auto allocation.""" - booking_id: Optional[int] = field( + booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingID"}, ) """Unique ID for this booking record.""" - booking_link_type_enum: Optional[str] = field( + booking_link_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingLinkTypeEnum"}, ) """Booking link type.""" - booking_type_id: Optional[int] = field( + booking_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingTypeID"}, ) """Pointer to the booking type record.""" - check_in_date: Optional[str] = field( + check_in_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDate"}, ) """Main (contract) check-in date.""" - check_in_date_actual: Optional[str] = field( + check_in_date_actual: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDateActual"}, ) """Actual date the entry arrives.""" - check_out_date: Optional[str] = field( + check_out_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDate"}, ) """Main (contract) check-out date.""" - check_out_date_actual: Optional[str] = field( + check_out_date_actual: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDateActual"}, ) """Actual date the entry departs.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Comments""" - contract_date_end: Optional[str] = field( + contract_date_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateEnd"}, ) """Contact chargeable date end.""" - contract_date_start: Optional[str] = field( + contract_date_start: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateStart"}, ) """Contact chargeable date start.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_bit3: Optional[bool] = field( + custom_bit3: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit3"}, ) """Custom boolean field value.""" - custom_bit4: Optional[bool] = field( + custom_bit4: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit4"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_date3: Optional[str] = field( + custom_date3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate3"}, ) """Custom date field value.""" - custom_date4: Optional[str] = field( + custom_date4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate4"}, ) """Custom date field value.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - custom_string7: Optional[str] = field( + custom_string7: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString7"}, ) """Custom string field value.""" - custom_string8: Optional[str] = field( + custom_string8: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString8"}, ) """Custom string field value.""" - custom_string9: Optional[str] = field( + custom_string9: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString9"}, ) """Custom string field value.""" - custom_string10: Optional[str] = field( + custom_string10: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString10"}, ) """Custom string field value.""" - date_billed: Optional[str] = field( + date_billed: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateBilled"}, ) """Date when this booking was processed for billing.""" - date_charged_to: Optional[str] = field( + date_charged_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateChargedTo"}, ) """Date this booking has been charged up to (using reservation charges).""" - emotional_support_animal_count: Optional[int] = field( + emotional_support_animal_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmotionalSupportAnimalCount"}, ) """ The number of additional Emotional Support Animal occupants in this booking. """ - end_booking_reason_id: Optional[int] = field( + end_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "End_BookingReasonID"}, ) """The reason this booking finished.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - entry_invitation_id: Optional[int] = field( + entry_invitation_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryInvitationID"}, ) """Identifies the entry invitation that the booking is created for.""" - entry_status_enum: Optional[str] = field( + entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryStatusEnum"}, ) """The status of the booking.""" - e_t_a: Optional[str] = field(default=None, metadata={"wire_name": "ETA"}) + e_t_a: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETA"}, + ) """Date and time of estimated arrival.""" - e_t_d: Optional[str] = field(default=None, metadata={"wire_name": "ETD"}) + e_t_d: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETD"}, + ) """Date and time of estimated departure.""" - excess: Optional[float] = field( + excess: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Excess"}, ) """Amount of excess.""" - group_id: Optional[int] = field( + group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GroupID"}, ) """Pointer to the group record.""" - housekeeping_id: Optional[int] = field( + housekeeping_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HousekeepingID"}, ) """The housekeeping rules that should be applied to this booking.""" - number_of_children: Optional[int] = field( + number_of_children: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfChildren"}, ) """The number of children in the booking.""" - number_of_children_free: Optional[int] = field( + number_of_children_free: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfChildrenFree"}, ) """The number of children that are free to stay.""" - number_of_guests: Optional[int] = field( + number_of_guests: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfGuests"}, ) """The number of guests in the booking.""" - number_of_guests_free: Optional[int] = field( + number_of_guests_free: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfGuestsFree"}, ) """The number of guests that are free to stay.""" - paid_to: Optional[str] = field( + paid_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaidTo"}, ) """Date the booking is paid to.""" - pet_count: Optional[int] = field( + pet_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PetCount"}, ) """The number of additional pet occupants in this booking.""" - resv_charge_to_entry: Optional[bool] = field( + resv_charge_to_entry: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResvChargeToEntry"}, ) """ Whether reservation charges are charged to the entry or group master account. """ - room_location_fixed: Optional[bool] = field( + room_location_fixed: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationFixed"}, ) """ Indicates if the location was manually selected, and should not be changed by Auto Room Allocations. """ - room_location_id: Optional[int] = field( + room_location_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationID"}, ) """Pointer to the room location record.""" - room_rate_amount: Optional[float] = field( + room_rate_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateAmount"}, ) """Actual dollar amount of room rate.""" - room_rate_id: Optional[int] = field( + room_rate_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateID"}, ) """Selected room rate.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Pointer to the room space record.""" - room_type_id: Optional[int] = field( + room_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomTypeID"}, ) """Pointer to the room type record.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - service_animal_count: Optional[int] = field( + service_animal_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ServiceAnimalCount"}, ) """The number of additional Service Animal occupants in this booking.""" - special_requirement: Optional[str] = field( + special_requirement: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SpecialRequirement"}, ) """Special requirements for this booking.""" - start_booking_reason_id: Optional[int] = field( + start_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Start_BookingReasonID"}, ) """Reason for this booking (normal, room change etc.).""" - term_session_id: Optional[int] = field( + term_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermSessionID"}, ) """Pointer to the term session record.""" @@ -6767,311 +8263,378 @@ class UpdateBookingResponse: Response for Update Booking """ - additional_occupant_count: Optional[int] = field( + additional_occupant_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AdditionalOccupantCount"}, ) """The number of additional human occupants in this booking.""" - auto_allocation_detail: Optional[str] = field( + auto_allocation_detail: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AutoAllocationDetail"}, ) """Details of the auto allocation.""" - booking_id: Optional[int] = field( + booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingID"}, ) """Unique ID for this booking record.""" - booking_link_type_enum: Optional[str] = field( + booking_link_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingLinkTypeEnum"}, ) """Booking link type.""" - booking_type_id: Optional[int] = field( + booking_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BookingTypeID"}, ) """Pointer to the booking type record.""" - check_in_date: Optional[str] = field( + check_in_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDate"}, ) """Main (contract) check-in date.""" - check_in_date_actual: Optional[str] = field( + check_in_date_actual: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckInDateActual"}, ) """Actual date the entry arrives.""" - check_out_date: Optional[str] = field( + check_out_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDate"}, ) """Main (contract) check-out date.""" - check_out_date_actual: Optional[str] = field( + check_out_date_actual: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckOutDateActual"}, ) """Actual date the entry departs.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Comments""" - contract_date_end: Optional[str] = field( + contract_date_end: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateEnd"}, ) """Contact chargeable date end.""" - contract_date_start: Optional[str] = field( + contract_date_start: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDateStart"}, ) """Contact chargeable date start.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_bit3: Optional[bool] = field( + custom_bit3: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit3"}, ) """Custom boolean field value.""" - custom_bit4: Optional[bool] = field( + custom_bit4: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit4"}, ) """Custom boolean field value.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date field value.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date field value.""" - custom_date3: Optional[str] = field( + custom_date3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate3"}, ) """Custom date field value.""" - custom_date4: Optional[str] = field( + custom_date4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate4"}, ) """Custom date field value.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - custom_string7: Optional[str] = field( + custom_string7: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString7"}, ) """Custom string field value.""" - custom_string8: Optional[str] = field( + custom_string8: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString8"}, ) """Custom string field value.""" - custom_string9: Optional[str] = field( + custom_string9: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString9"}, ) """Custom string field value.""" - custom_string10: Optional[str] = field( + custom_string10: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString10"}, ) """Custom string field value.""" - date_billed: Optional[str] = field( + date_billed: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateBilled"}, ) """Date when this booking was processed for billing.""" - date_charged_to: Optional[str] = field( + date_charged_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateChargedTo"}, ) """Date this booking has been charged up to (using reservation charges).""" - date_modified_billing: Optional[str] = field( + date_modified_billing: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModifiedBilling"}, ) """Indicates when critical booking fields are modified.""" - emotional_support_animal_count: Optional[int] = field( + emotional_support_animal_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EmotionalSupportAnimalCount"}, ) """ The number of additional Emotional Support Animal occupants in this booking. """ - end_booking_reason_id: Optional[int] = field( + end_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "End_BookingReasonID"}, ) """The reason this booking finished.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - entry_invitation_id: Optional[int] = field( + entry_invitation_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryInvitationID"}, ) """Identifies the entry invitation that the booking is created for.""" - entry_status_enum: Optional[str] = field( + entry_status_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryStatusEnum"}, ) """The status of the booking.""" - e_t_a: Optional[str] = field(default=None, metadata={"wire_name": "ETA"}) + e_t_a: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETA"}, + ) """Date and time of estimated arrival.""" - e_t_d: Optional[str] = field(default=None, metadata={"wire_name": "ETD"}) + e_t_d: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ETD"}, + ) """Date and time of estimated departure.""" - excess: Optional[float] = field( + excess: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Excess"}, ) """Amount of excess.""" - group_id: Optional[int] = field( + group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GroupID"}, ) """Pointer to the group record.""" - housekeeping_id: Optional[int] = field( + housekeeping_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "HousekeepingID"}, ) """The housekeeping rules that should be applied to this booking.""" - number_of_children: Optional[int] = field( + number_of_children: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfChildren"}, ) """The number of children in the booking.""" - number_of_children_free: Optional[int] = field( + number_of_children_free: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfChildrenFree"}, ) """The number of children that are free to stay.""" - number_of_guests: Optional[int] = field( + number_of_guests: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfGuests"}, ) """The number of guests in the booking.""" - number_of_guests_free: Optional[int] = field( + number_of_guests_free: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NumberOfGuestsFree"}, ) """The number of guests that are free to stay.""" - paid_to: Optional[str] = field( + paid_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaidTo"}, ) """Date the booking is paid to.""" - pet_count: Optional[int] = field( + pet_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PetCount"}, ) """The number of additional pet occupants in this booking.""" - resv_charge_to_entry: Optional[bool] = field( + resv_charge_to_entry: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ResvChargeToEntry"}, ) """ Whether reservation charges are charged to the entry or group master account. """ - room_location_fixed: Optional[bool] = field( + room_location_fixed: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationFixed"}, ) """ Indicates if the location was manually selected, and should not be changed by Auto Room Allocations. """ - room_location_id: Optional[int] = field( + room_location_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationID"}, ) """Pointer to the room location record.""" - room_rate_amount: Optional[float] = field( + room_rate_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateAmount"}, ) """Actual dollar amount of room rate.""" - room_rate_id: Optional[int] = field( + room_rate_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateID"}, ) """Selected room rate.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Pointer to the room space record.""" - room_type_id: Optional[int] = field( + room_type_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomTypeID"}, ) """Pointer to the room type record.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - service_animal_count: Optional[int] = field( + service_animal_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ServiceAnimalCount"}, ) """The number of additional Service Animal occupants in this booking.""" - special_requirement: Optional[str] = field( + special_requirement: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SpecialRequirement"}, ) """Special requirements for this booking.""" - start_booking_reason_id: Optional[int] = field( + start_booking_reason_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Start_BookingReasonID"}, ) """Reason for this booking (normal, room change etc.).""" - term_session_id: Optional[int] = field( + term_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermSessionID"}, ) """Pointer to the term session record.""" @@ -7083,138 +8646,159 @@ class SelectRoomSpaceInput: Get Room Space """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - allocate_exclude: Optional[bool] = field( + allocate_exclude: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateExclude"}, ) """Room Allocation - Do not include room in allocations.""" - allocate_sort_order: Optional[int] = field( + allocate_sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateSortOrder"}, ) """Room Allocation - Allows allocating nicer rooms first.""" - bathrooms: Optional[int] = field( + bathrooms: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Bathrooms"}, ) """The number of bathrooms available.""" - bed_capacity: Optional[int] = field( + bed_capacity: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BedCapacity"}, ) """The number of beds available.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Room space comments.""" - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """The actual room name.""" - extension_id: Optional[int] = field( + extension_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExtensionID"}, ) """Link to extension table. 0 means no phone in the room.""" - hold: Optional[bool] = field(default=None, metadata={"wire_name": "Hold"}) + hold: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Hold"}, + ) """ Space is held for any reason. Will warn the user when allocating this space. """ - networked: Optional[bool] = field( + networked: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Networked"}, ) """Indicates if the room space is networked.""" - record_type_enum: Optional[str] = field( + record_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecordTypeEnum"}, ) """Record type.""" - room_base_id: Optional[int] = field( + room_base_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomBaseID"}, ) """Pointer to the room base record.""" - room_id: Optional[int] = field( + room_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomID"}, ) """Pointer to the room record.""" - room_rate_id: Optional[int] = field( + room_rate_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateID"}, ) """Default tariff rate.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Unique ID for this room space record.""" - room_space_type_enum: Optional[str] = field( + room_space_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceTypeEnum"}, ) """Room space type.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - sort_order: Optional[int] = field( + sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SortOrder"}, ) """Use to control where the room space is shown when part of a list.""" - street: Optional[str] = field( + street: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street"}, ) """Street""" - street2: Optional[str] = field( + street2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street2"}, ) """Street""" - web_description: Optional[str] = field( + web_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebDescription"}, ) """The room space displayed in the Portal.""" - zip_postcode: Optional[str] = field( + zip_postcode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ZipPostcode"}, ) """Zip/Postcode""" @@ -7226,108 +8810,132 @@ class CreateRoomSpaceInput: Create Room Space """ - allocate_exclude: Optional[bool] = field( + allocate_exclude: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateExclude"}, ) """Room Allocation - Do not include room in allocations.""" - allocate_sort_order: Optional[int] = field( + allocate_sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateSortOrder"}, ) """Room Allocation - Allows allocating nicer rooms first.""" - bathrooms: Optional[int] = field( + bathrooms: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Bathrooms"}, ) """The number of bathrooms available.""" - bed_capacity: Optional[int] = field( + bed_capacity: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BedCapacity"}, ) """The number of beds available.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Room space comments.""" - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """The actual room name.""" - extension_id: Optional[int] = field( + extension_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExtensionID"}, ) """Link to extension table. 0 means no phone in the room.""" - hold: Optional[bool] = field(default=None, metadata={"wire_name": "Hold"}) + hold: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Hold"}, + ) """ Space is held for any reason. Will warn the user when allocating this space. """ - networked: Optional[bool] = field( + networked: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Networked"}, ) """Indicates if the room space is networked.""" - record_type_enum: Optional[str] = field( + record_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecordTypeEnum"}, ) """Record type.""" - room_base_id: Optional[int] = field( + room_base_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomBaseID"}, ) """Pointer to the room base record.""" - room_id: Optional[int] = field( + room_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomID"}, ) """Pointer to the room record.""" - room_rate_id: Optional[int] = field( + room_rate_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateID"}, ) """Default tariff rate.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Unique ID for this room space record.""" - room_space_type_enum: Optional[str] = field( + room_space_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceTypeEnum"}, ) """Room space type.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - sort_order: Optional[int] = field( + sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SortOrder"}, ) """Use to control where the room space is shown when part of a list.""" - street: Optional[str] = field( + street: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street"}, ) """Street""" - street2: Optional[str] = field( + street2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street2"}, ) """Street""" - web_description: Optional[str] = field( + web_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebDescription"}, ) """The room space displayed in the Portal.""" - zip_postcode: Optional[str] = field( + zip_postcode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ZipPostcode"}, ) """Zip/Postcode""" @@ -7339,108 +8947,132 @@ class CreateRoomSpaceResponse: Response for Create Room Space """ - allocate_exclude: Optional[bool] = field( + allocate_exclude: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateExclude"}, ) """Room Allocation - Do not include room in allocations.""" - allocate_sort_order: Optional[int] = field( + allocate_sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateSortOrder"}, ) """Room Allocation - allows allocating nicer rooms first.""" - bathrooms: Optional[int] = field( + bathrooms: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Bathrooms"}, ) """The number of bathrooms available.""" - bed_capacity: Optional[int] = field( + bed_capacity: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "BedCapacity"}, ) """The number of beds available.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Room space comments.""" - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """The actual room name.""" - extension_id: Optional[int] = field( + extension_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExtensionID"}, ) """Link to extension table. 0 means no phone in the room.""" - hold: Optional[bool] = field(default=None, metadata={"wire_name": "Hold"}) + hold: Optional[bool] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Hold"}, + ) """ Space is held for any reason. Will warn the user when allocating this space. """ - networked: Optional[bool] = field( + networked: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Networked"}, ) """Indicates if the room space is networked.""" - record_type_enum: Optional[str] = field( + record_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecordTypeEnum"}, ) """Record type.""" - room_base_id: Optional[int] = field( + room_base_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomBaseID"}, ) """Pointer to the room base record.""" - room_id: Optional[int] = field( + room_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomID"}, ) """Pointer to the room record.""" - room_rate_id: Optional[int] = field( + room_rate_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomRateID"}, ) """Default tariff rate.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Unique ID for this room space record.""" - room_space_type_enum: Optional[str] = field( + room_space_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceTypeEnum"}, ) """Room space type.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - sort_order: Optional[int] = field( + sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SortOrder"}, ) """Use to control where the room space is shown when part of a list.""" - street: Optional[str] = field( + street: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street"}, ) """Street""" - street2: Optional[str] = field( + street2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Street2"}, ) """Street""" - web_description: Optional[str] = field( + web_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebDescription"}, ) """The room space displayed in the Portal.""" - zip_postcode: Optional[str] = field( + zip_postcode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ZipPostcode"}, ) """Zip/Postcode""" @@ -7452,178 +9084,208 @@ class SelectRoomLocationInput: Get Room Location """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - allocate_sort_order: Optional[int] = field( + allocate_sort_order: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AllocateSortOrder"}, ) """Allocate sort order.""" - category_id: Optional[int] = field( + category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CategoryID"}, ) """Pointer to the category record.""" - city: Optional[str] = field(default=None, metadata={"wire_name": "City"}) + city: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "City"}, + ) """City""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Room location comments.""" - country_id: Optional[int] = field( + country_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CountryID"}, ) """Pointer to the country record.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom boolean field value.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom boolean field value.""" - custom_date1: Optional[Dict[str, Any]] = field( + custom_date1: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) - custom_date2: Optional[Dict[str, Any]] = field( + custom_date2: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string field value.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string field value.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string field value.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string field value.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string field value.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string field value.""" - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Room location description.""" - gender_type_enum: Optional[str] = field( + gender_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "GenderTypeEnum"}, ) """Gender type suitability.""" - lease: Optional[bool] = field( + lease: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Lease"}, ) """Indicates if the room location is leased.""" - managed_externally: Optional[bool] = field( + managed_externally: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ManagedExternally"}, ) """Indicates if the room location is managed externally.""" - non_residential: Optional[bool] = field( + non_residential: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NonResidential"}, ) """Indicates if the room location is non residential.""" - record_type_enum: Optional[str] = field( + record_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecordTypeEnum"}, ) """Record type.""" - room_location_area_id: Optional[int] = field( + room_location_area_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationAreaID"}, ) """Pointer to the room location area record.""" - room_location_id: Optional[int] = field( + room_location_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomLocationID"}, ) """Unique ID for this room location record.""" - state_province: Optional[str] = field( + state_province: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StateProvince"}, ) """State/Province""" - view_on_web: Optional[bool] = field( + view_on_web: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ViewOnWeb"}, ) """Indicates if the room space is viewable on the web.""" - web_comments: Optional[str] = field( + web_comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebComments"}, ) """Comments to display if visible on the web.""" - web_description: Optional[str] = field( + web_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebDescription"}, ) """Description to display if visible on the web.""" - web_image_alt_text: Optional[str] = field( + web_image_alt_text: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebImageAltText"}, ) """Alternate text to display for the image when displayed on the web.""" - web_image_location: Optional[str] = field( + web_image_location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebImageLocation"}, ) """Path for the web image.""" - zip_postcode: Optional[str] = field( + zip_postcode: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ZipPostcode"}, ) """Zip/Postcode.""" @@ -7635,192 +9297,225 @@ class SelectTransactionInput: Get Transaction """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - amount: Optional[float] = field( + amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Amount"}, ) """The total amount for this transaction (including tax).""" - call_type_enum: Optional[str] = field( + call_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CallTypeEnum"}, ) """Call type.""" - charge_group_id: Optional[int] = field( + charge_group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeGroupID"}, ) """Pointer to the charge group record.""" - charge_item_id: Optional[int] = field( + charge_item_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeItemID"}, ) """Pointer to the charge item record.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Transaction comments.""" - created_by_security_user_id: Optional[int] = field( + created_by_security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedBy_SecurityUserID"}, ) """Pointer to the created by security user record.""" - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Transaction description.""" - due_date: Optional[Dict[str, Any]] = field( + due_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DueDate"}, ) - duration: Optional[int] = field( + duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Duration"}, ) """Phone call duration in seconds.""" - end_of_session_id: Optional[int] = field( + end_of_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndOfSessionID"}, ) """Pointer to the end of session record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - excess: Optional[float] = field( + excess: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Excess"}, ) """Excess amount.""" - extension: Optional[int] = field( + extension: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Extension"}, ) """Extension qty.""" - external_id: Optional[int] = field( + external_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExternalID"}, ) """ Stores the (unique) ID from an external system - for imported transactions. """ - external_receipt_id: Optional[str] = field( + external_receipt_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExternalReceiptID"}, ) """Pointer to the external receipt record.""" - invoice_id: Optional[int] = field( + invoice_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InvoiceID"}, ) """Pointer to the invoice record.""" - paid_from: Optional[Dict[str, Any]] = field( + paid_from: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaidFrom"}, ) - paid_to: Optional[Dict[str, Any]] = field( + paid_to: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaidTo"}, ) - payment_id: Optional[int] = field( + payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaymentID"}, ) """Pointer to the payment record.""" - processed_date: Optional[Dict[str, Any]] = field( + processed_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ProcessedDate"}, ) - reference_booking_id: Optional[int] = field( + reference_booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reference_BookingID"}, ) """The booking (if any) that this transaction relates to.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - table_id: Optional[int] = field( + table_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableID"}, ) """Link to a referencing record (e.g. a BookingID for pro-rating).""" - table_name: Optional[str] = field( + table_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableName"}, ) """Reference link table.""" - tag: Optional[str] = field(default=None, metadata={"wire_name": "Tag"}) + tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Tag"}, + ) """Transaction tag.""" - tag_finance: Optional[str] = field( + tag_finance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TagFinance"}, ) """Finance tag.""" - tax_amount: Optional[float] = field( + tax_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxAmount"}, ) """Tax amount""" - tax_amount2: Optional[float] = field( + tax_amount2: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxAmount2"}, ) """Tax amount""" - tax_amount3: Optional[float] = field( + tax_amount3: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxAmount3"}, ) """Tax amount""" - term_session_id: Optional[int] = field( + term_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermSessionID"}, ) """Pointer to the term session record.""" - transaction_date: Optional[Dict[str, Any]] = field( + transaction_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TransactionDate"}, ) - transaction_id: Optional[int] = field( + transaction_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TransactionID"}, ) """Unique ID for this transaction record.""" - transaction_type_enum: Optional[str] = field( + transaction_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TransactionTypeEnum"}, ) """Transaction type.""" @@ -7832,162 +9527,191 @@ class CreateTransactionInput: Create Transaction """ - amount: Optional[float] = field( - default=None, - metadata={"wire_name": "Amount"}, - ) + amount: float = dataclass_field(metadata={"wire_name": "Amount"}) """The total amount for this transaction (including tax).""" - call_type_enum: Optional[str] = field( + call_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CallTypeEnum"}, ) """Call type.""" - charge_group_id: Optional[int] = field( - default=None, + charge_group_id: int = dataclass_field( metadata={"wire_name": "ChargeGroupID"}, ) """Pointer to the charge group record.""" - charge_item_id: Optional[int] = field( + charge_item_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeItemID"}, ) """This is only required for Adjustments and Charges.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Transaction comments.""" - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Transaction description.""" - due_date: Optional[str] = field( + due_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DueDate"}, ) """Due date.""" - duration: Optional[int] = field( + duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Duration"}, ) """Phone call duration in seconds.""" - end_of_session_id: Optional[int] = field( + end_of_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndOfSessionID"}, ) """Pointer to the end of session record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - excess: Optional[float] = field( + excess: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Excess"}, ) """Excess amount.""" - extension: Optional[int] = field( + extension: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Extension"}, ) """Extension qty.""" - external_id: Optional[int] = field( + external_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExternalID"}, ) """ Stores the (unique) ID from an external system - for imported transactions. """ - external_receipt_id: Optional[str] = field( + external_receipt_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExternalReceiptID"}, ) """Pointer to the external receipt record.""" - invoice_id: Optional[int] = field( + invoice_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InvoiceID"}, ) """Pointer to the invoice record.""" - paid_from: Optional[str] = field( + paid_from: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaidFrom"}, ) """Paid from date.""" - paid_to: Optional[str] = field( + paid_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaidTo"}, ) """Paid to date.""" - payment_id: Optional[int] = field( + payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaymentID"}, ) """Pointer to the payment record.""" - processed_date: Optional[str] = field( + processed_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ProcessedDate"}, ) """Date transaction was processed.""" - reference_booking_id: Optional[int] = field( + reference_booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reference_BookingID"}, ) """The booking (if any) that this transaction relates to.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - table_id: Optional[int] = field( + table_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableID"}, ) """Link to a referencing record (e.g. a BookingID for pro-rating).""" - table_name: Optional[str] = field( + table_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableName"}, ) """Reference link table.""" - tag: Optional[str] = field(default=None, metadata={"wire_name": "Tag"}) + tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Tag"}, + ) """Transaction tag.""" - tag_finance: Optional[str] = field( + tag_finance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TagFinance"}, ) """Finance tag.""" - tax_amount: Optional[float] = field( + tax_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxAmount"}, ) """Tax amount""" - tax_amount2: Optional[float] = field( + tax_amount2: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxAmount2"}, ) """Tax amount""" - tax_amount3: Optional[float] = field( + tax_amount3: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxAmount3"}, ) """Tax amount""" - term_session_id: Optional[int] = field( + term_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermSessionID"}, ) """Pointer to the term session record.""" - transaction_date: Optional[str] = field( + transaction_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TransactionDate"}, ) """Date of the transaction.""" - transaction_id: Optional[int] = field( + transaction_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TransactionID"}, ) """Unique ID for this transaction record.""" - transaction_type_enum: Optional[str] = field( + transaction_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TransactionTypeEnum"}, ) """Transaction type.""" @@ -7999,162 +9723,197 @@ class CreateTransactionResponse: Response for Create Transaction """ - amount: Optional[float] = field( + amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Amount"}, ) """The total amount for this transaction (including tax).""" - call_type_enum: Optional[str] = field( + call_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CallTypeEnum"}, ) """Call type.""" - charge_group_id: Optional[int] = field( + charge_group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeGroupID"}, ) """Pointer to the charge group record.""" - charge_item_id: Optional[int] = field( + charge_item_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeItemID"}, ) """Pointer to the charge item record.""" - comments: Optional[str] = field( + comments: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """Transaction comments.""" - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Transaction description.""" - due_date: Optional[str] = field( + due_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DueDate"}, ) """Due date.""" - duration: Optional[int] = field( + duration: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Duration"}, ) """Phone call duration in seconds.""" - end_of_session_id: Optional[int] = field( + end_of_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EndOfSessionID"}, ) """Pointer to the end of session record.""" - entry_id: Optional[int] = field( + entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "EntryID"}, ) """Pointer to the entry record.""" - excess: Optional[float] = field( + excess: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Excess"}, ) """Excess amount.""" - extension: Optional[int] = field( + extension: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Extension"}, ) """Extension qty.""" - external_id: Optional[int] = field( + external_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExternalID"}, ) """ Stores the (unique) ID from an external system - for imported transactions. """ - external_receipt_id: Optional[str] = field( + external_receipt_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ExternalReceiptID"}, ) """Pointer to the external receipt record.""" - invoice_id: Optional[int] = field( + invoice_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "InvoiceID"}, ) """Pointer to the invoice record.""" - paid_from: Optional[str] = field( + paid_from: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaidFrom"}, ) """Paid from date.""" - paid_to: Optional[str] = field( + paid_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaidTo"}, ) """Paid to date.""" - payment_id: Optional[int] = field( + payment_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PaymentID"}, ) """Pointer to the payment record.""" - processed_date: Optional[str] = field( + processed_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ProcessedDate"}, ) """Date transaction was processed.""" - reference_booking_id: Optional[int] = field( + reference_booking_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Reference_BookingID"}, ) """The booking (if any) that this transaction relates to.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - table_id: Optional[int] = field( + table_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableID"}, ) """Link to a referencing record (e.g. a BookingID for pro-rating).""" - table_name: Optional[str] = field( + table_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TableName"}, ) """Reference link table.""" - tag: Optional[str] = field(default=None, metadata={"wire_name": "Tag"}) + tag: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Tag"}, + ) """Transaction tag.""" - tag_finance: Optional[str] = field( + tag_finance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TagFinance"}, ) """Finance tag.""" - tax_amount: Optional[float] = field( + tax_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxAmount"}, ) """Tax amount""" - tax_amount2: Optional[float] = field( + tax_amount2: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxAmount2"}, ) """Tax amount""" - tax_amount3: Optional[float] = field( + tax_amount3: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TaxAmount3"}, ) """Tax amount""" - term_session_id: Optional[int] = field( + term_session_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TermSessionID"}, ) """Pointer to the term session record.""" - transaction_date: Optional[str] = field( + transaction_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TransactionDate"}, ) """Date of the transaction.""" - transaction_id: Optional[int] = field( + transaction_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TransactionID"}, ) """Unique ID for this transaction record.""" - transaction_type_enum: Optional[str] = field( + transaction_type_enum: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TransactionTypeEnum"}, ) """Transaction type.""" @@ -8166,286 +9925,339 @@ class SelectRoomSpaceMaintenanceInput: Get Room Space Maintenance """ - return_empty_array_on_no_result: Optional[bool] = field( + return_empty_array_on_no_result: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_returnEmptyArrayOnNoResult"}, ) """ Determines whether an empty array should be returned when there is no result. """ - page_size: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageSize"}, - ) + page_size: int = dataclass_field(metadata={"wire_name": "_pageSize"}) """Maximum number of records to return.""" - page_index: Optional[int] = field( - default=None, - metadata={"wire_name": "_pageIndex"}, - ) + page_index: int = dataclass_field(metadata={"wire_name": "_pageIndex"}) """Index of the first record to return.""" - orderby: Optional[str] = field( + orderby: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_orderby"}, ) """ Sort by one or more fields in ascending order. Fields must be separated by commas with no spaces (e.g. field1,field2). """ - account_code: Optional[str] = field( + account_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountCode"}, ) """Account code.""" - cause: Optional[str] = field(default=None, metadata={"wire_name": "Cause"}) + cause: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cause"}, + ) """Cause.""" - charge: Optional[bool] = field( + charge: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Charge"}, ) """Indicates if a charge should be applied.""" - charge_entry_id: Optional[int] = field( + charge_entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Charge_EntryID"}, ) """Pointer to the charge entry record.""" - charge_amount: Optional[float] = field( + charge_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeAmount"}, ) """Charge amount.""" - charge_invoiced: Optional[bool] = field( + charge_invoiced: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeInvoiced"}, ) """Indicates if the charge has been invoiced.""" - charge_invoice_number: Optional[str] = field( + charge_invoice_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeInvoiceNumber"}, ) """Charge invoice number.""" - charge_type: Optional[str] = field( + charge_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeType"}, ) """Charge type.""" - complete_date: Optional[Dict[str, Any]] = field( + complete_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompleteDate"}, ) - contact_id: Optional[int] = field( + contact_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactID"}, ) """Pointer to the contact record.""" - contract_date: Optional[Dict[str, Any]] = field( + contract_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDate"}, ) - contractor_cost: Optional[float] = field( + contractor_cost: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorCost"}, ) """Contractor cost.""" - contractor_cost_estimate: Optional[float] = field( + contractor_cost_estimate: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorCostEstimate"}, ) """Contractor cost estimate.""" - contractor_date: Optional[Dict[str, Any]] = field( + contractor_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorDate"}, ) - contractor_e_t_a: Optional[str] = field( + contractor_e_t_a: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorETA"}, ) """Contractor ETA.""" - contractor_order_number: Optional[str] = field( + contractor_order_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorOrderNumber"}, ) """Contractor order number.""" - created_by_security_user_id: Optional[int] = field( + created_by_security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedBy_SecurityUserID"}, ) """Pointer to the security user record.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom bit 1.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom bit 2.""" - custom_date1: Optional[Dict[str, Any]] = field( + custom_date1: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) - custom_date2: Optional[Dict[str, Any]] = field( + custom_date2: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string 1.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string 2.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string 3.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string 4.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string 5.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string 6.""" - date_created: Optional[Dict[str, Any]] = field( + date_created: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateCreated"}, ) - date_due: Optional[Dict[str, Any]] = field( + date_due: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateDue"}, ) - date_modified: Optional[Dict[str, Any]] = field( + date_modified: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) - date_reported: Optional[Dict[str, Any]] = field( + date_reported: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateReported"}, ) - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Description.""" - job_sent: Optional[bool] = field( + job_sent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobSent"}, ) """Indicates if a job has been sent.""" - job_status: Optional[str] = field( + job_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobStatus"}, ) """Job status.""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location.""" - occupant_entry_id: Optional[int] = field( + occupant_entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Occupant_EntryID"}, ) """Pointer to the occupant entry record.""" - occupant_entry_name: Optional[str] = field( + occupant_entry_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantEntryName"}, ) """Occupant entry name.""" - occupant_present: Optional[bool] = field( + occupant_present: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantPresent"}, ) """Indicates if an occupant is present.""" - occupant_present_reason: Optional[str] = field( + occupant_present_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantPresentReason"}, ) """Occupant present reason.""" - other_service_number: Optional[str] = field( + other_service_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OtherServiceNumber"}, ) """Other service number.""" - priority_id: Optional[int] = field( + priority_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PriorityID"}, ) """Pointer to the priority record.""" - repair_description: Optional[str] = field( + repair_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RepairDescription"}, ) """Repair description.""" - reported_by_name: Optional[str] = field( + reported_by_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReportedByName"}, ) """Reported by name.""" - reported_by_phone: Optional[str] = field( + reported_by_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReportedByPhone"}, ) """Reported by phone.""" - room_space_closed_id: Optional[int] = field( + room_space_closed_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceClosedID"}, ) """Pointer to the room space closed record.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Pointer to the room space record.""" - room_space_maintenance_category_id: Optional[int] = field( + room_space_maintenance_category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceCategoryID"}, ) """Pointer to the room space maintenance category record.""" - room_space_maintenance_id: Optional[int] = field( + room_space_maintenance_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceID"}, ) """Unique ID for this room space maintenance record.""" - room_space_maintenance_item_id: Optional[int] = field( + room_space_maintenance_item_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceItemID"}, ) """Pointer to the room space maintenance item record.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - start_date: Optional[Dict[str, Any]] = field( + start_date: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDate"}, ) - status: Optional[str] = field( + status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Status"}, ) """Status.""" - technician: Optional[str] = field( + technician: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Technician"}, ) """Technician.""" - view_on_web: Optional[bool] = field( + view_on_web: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ViewOnWeb"}, ) """Indicates if the room space maintenance is viewable on the web.""" @@ -8457,255 +10269,305 @@ class CreateRoomSpaceMaintenanceInput: Create Room Space Maintenance """ - account_code: Optional[str] = field( + account_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountCode"}, ) """Account code.""" - cause: Optional[str] = field(default=None, metadata={"wire_name": "Cause"}) + cause: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cause"}, + ) """Cause.""" - charge: Optional[bool] = field( + charge: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Charge"}, ) """Indicates if a charge should be applied.""" - charge_entry_id: Optional[int] = field( + charge_entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Charge_EntryID"}, ) """Pointer to the charge entry record.""" - charge_amount: Optional[float] = field( + charge_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeAmount"}, ) """Charge amount.""" - charge_invoiced: Optional[bool] = field( + charge_invoiced: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeInvoiced"}, ) """Indicates if the charge has been invoiced.""" - charge_invoice_number: Optional[str] = field( + charge_invoice_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeInvoiceNumber"}, ) """Charge invoice number.""" - charge_type: Optional[str] = field( + charge_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeType"}, ) """Charge type.""" - complete_date: Optional[str] = field( + complete_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompleteDate"}, ) """Complete date.""" - contact_id: Optional[int] = field( + contact_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactID"}, ) """Pointer to the contact record.""" - contract_date: Optional[str] = field( + contract_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDate"}, ) """Contract date.""" - contractor_cost: Optional[float] = field( + contractor_cost: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorCost"}, ) """Contractor cost.""" - contractor_cost_estimate: Optional[float] = field( + contractor_cost_estimate: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorCostEstimate"}, ) """Contractor cost estimate.""" - contractor_date: Optional[str] = field( + contractor_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorDate"}, ) """Contractor date.""" - contractor_e_t_a: Optional[str] = field( + contractor_e_t_a: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorETA"}, ) """Contractor ETA.""" - contractor_order_number: Optional[str] = field( + contractor_order_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorOrderNumber"}, ) """Contractor order number.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom bit 1.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom bit 2.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date 1.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date 2.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string 1.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string 2.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string 3.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string 4.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string 5.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string 6.""" - date_due: Optional[str] = field( + date_due: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateDue"}, ) """Date due.""" - date_reported: Optional[str] = field( + date_reported: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateReported"}, ) """Date reported.""" - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Description.""" - job_sent: Optional[bool] = field( + job_sent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobSent"}, ) """Indicates if a job has been sent.""" - job_status: Optional[str] = field( + job_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobStatus"}, ) """Job status.""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location.""" - occupant_entry_id: Optional[int] = field( + occupant_entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Occupant_EntryID"}, ) """Pointer to the occupant entry record.""" - occupant_entry_name: Optional[str] = field( + occupant_entry_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantEntryName"}, ) """Occupant entry name.""" - occupant_present: Optional[bool] = field( + occupant_present: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantPresent"}, ) """Indicates if an occupant is present.""" - occupant_present_reason: Optional[str] = field( + occupant_present_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantPresentReason"}, ) """Occupant present reason.""" - other_service_number: Optional[str] = field( + other_service_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OtherServiceNumber"}, ) """Other service number.""" - priority_id: Optional[int] = field( + priority_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PriorityID"}, ) """Pointer to the priority record.""" - repair_description: Optional[str] = field( + repair_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RepairDescription"}, ) """Repair description.""" - reported_by_name: Optional[str] = field( + reported_by_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReportedByName"}, ) """Reported by name.""" - reported_by_phone: Optional[str] = field( + reported_by_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReportedByPhone"}, ) """Reported by phone.""" - room_space_closed_id: Optional[int] = field( + room_space_closed_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceClosedID"}, ) """Pointer to the room space closed record.""" - room_space_id: Optional[int] = field( - default=None, - metadata={"wire_name": "RoomSpaceID"}, - ) + room_space_id: int = dataclass_field(metadata={"wire_name": "RoomSpaceID"}) """Pointer to the room space record.""" - room_space_maintenance_category_id: Optional[int] = field( + room_space_maintenance_category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceCategoryID"}, ) """Pointer to the room space maintenance category record.""" - room_space_maintenance_id: Optional[int] = field( + room_space_maintenance_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceID"}, ) """Unique ID for this room space maintenance record.""" - room_space_maintenance_item_id: Optional[int] = field( + room_space_maintenance_item_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceItemID"}, ) """Pointer to the room space maintenance item record.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDate"}, ) """Start date.""" - status: Optional[str] = field( + status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Status"}, ) """Status.""" - technician: Optional[str] = field( + technician: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Technician"}, ) """Technician.""" - view_on_web: Optional[bool] = field( + view_on_web: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ViewOnWeb"}, ) """Indicates if the room space maintenance is viewable on the web.""" @@ -8717,270 +10579,327 @@ class CreateRoomSpaceMaintenanceResponse: Response for Create Room Space Maintenance """ - account_code: Optional[str] = field( + account_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountCode"}, ) """Account code.""" - cause: Optional[str] = field(default=None, metadata={"wire_name": "Cause"}) + cause: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cause"}, + ) """Cause.""" - charge: Optional[bool] = field( + charge: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Charge"}, ) """Indicates if a charge should be applied.""" - charge_entry_id: Optional[int] = field( + charge_entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Charge_EntryID"}, ) """Pointer to the charge entry record.""" - charge_amount: Optional[float] = field( + charge_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeAmount"}, ) """Charge amount.""" - charge_invoiced: Optional[bool] = field( + charge_invoiced: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeInvoiced"}, ) """Indicates if the charge has been invoiced.""" - charge_invoice_number: Optional[str] = field( + charge_invoice_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeInvoiceNumber"}, ) """Charge invoice number.""" - charge_type: Optional[str] = field( + charge_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeType"}, ) """Charge type.""" - complete_date: Optional[str] = field( + complete_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompleteDate"}, ) """Complete date.""" - contact_id: Optional[int] = field( + contact_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactID"}, ) """Pointer to the contact record.""" - contract_date: Optional[str] = field( + contract_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDate"}, ) """Contract date.""" - contractor_cost: Optional[float] = field( + contractor_cost: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorCost"}, ) """Contractor cost.""" - contractor_cost_estimate: Optional[float] = field( + contractor_cost_estimate: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorCostEstimate"}, ) """Contractor cost estimate.""" - contractor_date: Optional[str] = field( + contractor_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorDate"}, ) """Contractor date.""" - contractor_e_t_a: Optional[str] = field( + contractor_e_t_a: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorETA"}, ) """Contractor ETA.""" - contractor_order_number: Optional[str] = field( + contractor_order_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorOrderNumber"}, ) """Contractor order number.""" - created_by_security_user_id: Optional[int] = field( + created_by_security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedBy_SecurityUserID"}, ) """Pointer to the security user record.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom bit 1.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom bit 2.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date 1.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date 2.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string 1.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string 2.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string 3.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string 4.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string 5.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string 6.""" - date_created: Optional[str] = field( + date_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateCreated"}, ) """Date created.""" - date_due: Optional[str] = field( + date_due: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateDue"}, ) """Date due.""" - date_modified: Optional[str] = field( + date_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) """Date modified.""" - date_reported: Optional[str] = field( + date_reported: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateReported"}, ) """Date reported.""" - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Description.""" - job_sent: Optional[bool] = field( + job_sent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobSent"}, ) """Indicates if a job has been sent.""" - job_status: Optional[str] = field( + job_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobStatus"}, ) """Job status.""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location.""" - occupant_entry_id: Optional[int] = field( + occupant_entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Occupant_EntryID"}, ) """Pointer to the occupant entry record.""" - occupant_entry_name: Optional[str] = field( + occupant_entry_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantEntryName"}, ) """Occupant entry name.""" - occupant_present: Optional[bool] = field( + occupant_present: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantPresent"}, ) """Indicates if an occupant is present.""" - occupant_present_reason: Optional[str] = field( + occupant_present_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantPresentReason"}, ) """Occupant present reason.""" - other_service_number: Optional[str] = field( + other_service_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OtherServiceNumber"}, ) """Other service number.""" - priority_id: Optional[int] = field( + priority_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PriorityID"}, ) """Pointer to the priority record.""" - repair_description: Optional[str] = field( + repair_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RepairDescription"}, ) """Repair description.""" - reported_by_name: Optional[str] = field( + reported_by_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReportedByName"}, ) """Reported by name.""" - reported_by_phone: Optional[str] = field( + reported_by_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReportedByPhone"}, ) """Reported by phone.""" - room_space_closed_id: Optional[int] = field( + room_space_closed_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceClosedID"}, ) """Pointer to the room space closed record.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Pointer to the room space record.""" - room_space_maintenance_category_id: Optional[int] = field( + room_space_maintenance_category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceCategoryID"}, ) """Pointer to the room space maintenance category record.""" - room_space_maintenance_id: Optional[int] = field( + room_space_maintenance_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceID"}, ) """Unique ID for this room space maintenance record.""" - room_space_maintenance_item_id: Optional[int] = field( + room_space_maintenance_item_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceItemID"}, ) """Pointer to the room space maintenance item record.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDate"}, ) """Start date.""" - status: Optional[str] = field( + status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Status"}, ) """Status.""" - technician: Optional[str] = field( + technician: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Technician"}, ) """Technician.""" - view_on_web: Optional[bool] = field( + view_on_web: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ViewOnWeb"}, ) """Indicates if the room space maintenance is viewable on the web.""" @@ -8992,255 +10911,309 @@ class UpdateRoomSpaceMaintenanceInput: Update Room Space Maintenance """ - account_code: Optional[str] = field( + account_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountCode"}, ) """Account code.""" - cause: Optional[str] = field(default=None, metadata={"wire_name": "Cause"}) + cause: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cause"}, + ) """Cause.""" - charge: Optional[bool] = field( + charge: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Charge"}, ) """Indicates if a charge should be applied.""" - charge_entry_id: Optional[int] = field( + charge_entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Charge_EntryID"}, ) """Pointer to the charge entry record.""" - charge_amount: Optional[float] = field( + charge_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeAmount"}, ) """Charge amount.""" - charge_invoiced: Optional[bool] = field( + charge_invoiced: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeInvoiced"}, ) """Indicates if the charge has been invoiced.""" - charge_invoice_number: Optional[str] = field( + charge_invoice_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeInvoiceNumber"}, ) """Charge invoice number.""" - charge_type: Optional[str] = field( + charge_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeType"}, ) """Charge type.""" - complete_date: Optional[str] = field( + complete_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompleteDate"}, ) """Complete date.""" - contact_id: Optional[int] = field( + contact_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactID"}, ) """Pointer to the contact record.""" - contract_date: Optional[str] = field( + contract_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDate"}, ) """Contract date.""" - contractor_cost: Optional[float] = field( + contractor_cost: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorCost"}, ) """Contractor cost.""" - contractor_cost_estimate: Optional[float] = field( + contractor_cost_estimate: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorCostEstimate"}, ) """Contractor cost estimate.""" - contractor_date: Optional[str] = field( + contractor_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorDate"}, ) """Contractor date.""" - contractor_e_t_a: Optional[str] = field( + contractor_e_t_a: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorETA"}, ) """Contractor ETA.""" - contractor_order_number: Optional[str] = field( + contractor_order_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorOrderNumber"}, ) """Contractor order number.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom bit 1.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom bit 2.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date 1.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date 2.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string 1.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string 2.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string 3.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string 4.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string 5.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string 6.""" - date_due: Optional[str] = field( + date_due: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateDue"}, ) """Date due.""" - date_reported: Optional[str] = field( + date_reported: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateReported"}, ) """Date reported.""" - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Description.""" - job_sent: Optional[bool] = field( + job_sent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobSent"}, ) """Indicates if a job has been sent.""" - job_status: Optional[str] = field( + job_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobStatus"}, ) """Job status.""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location.""" - occupant_entry_id: Optional[int] = field( + occupant_entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Occupant_EntryID"}, ) """Pointer to the occupant entry record.""" - occupant_entry_name: Optional[str] = field( + occupant_entry_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantEntryName"}, ) """Occupant entry name.""" - occupant_present: Optional[bool] = field( + occupant_present: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantPresent"}, ) """Indicates if an occupant is present.""" - occupant_present_reason: Optional[str] = field( + occupant_present_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantPresentReason"}, ) """Occupant present reason.""" - other_service_number: Optional[str] = field( + other_service_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OtherServiceNumber"}, ) """Other service number.""" - priority_id: Optional[int] = field( + priority_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PriorityID"}, ) """Pointer to the priority record.""" - repair_description: Optional[str] = field( + repair_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RepairDescription"}, ) """Repair description.""" - reported_by_name: Optional[str] = field( + reported_by_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReportedByName"}, ) """Reported by name.""" - reported_by_phone: Optional[str] = field( + reported_by_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReportedByPhone"}, ) """Reported by phone.""" - room_space_closed_id: Optional[int] = field( + room_space_closed_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceClosedID"}, ) """Pointer to the room space closed record.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Pointer to the room space record.""" - room_space_maintenance_category_id: Optional[int] = field( + room_space_maintenance_category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceCategoryID"}, ) """Pointer to the room space maintenance category record.""" - room_space_maintenance_id: Optional[int] = field( + room_space_maintenance_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceID"}, ) """Unique ID for this room space maintenance record.""" - room_space_maintenance_item_id: Optional[int] = field( + room_space_maintenance_item_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceItemID"}, ) """Pointer to the room space maintenance item record.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDate"}, ) """Start date.""" - status: Optional[str] = field( + status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Status"}, ) """Status.""" - technician: Optional[str] = field( + technician: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Technician"}, ) """Technician.""" - view_on_web: Optional[bool] = field( + view_on_web: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ViewOnWeb"}, ) """Indicates if the room space maintenance is viewable on the web.""" @@ -9252,270 +11225,327 @@ class UpdateRoomSpaceMaintenanceResponse: Response for Update Room Space Maintenance """ - account_code: Optional[str] = field( + account_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "AccountCode"}, ) """Account code.""" - cause: Optional[str] = field(default=None, metadata={"wire_name": "Cause"}) + cause: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Cause"}, + ) """Cause.""" - charge: Optional[bool] = field( + charge: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Charge"}, ) """Indicates if a charge should be applied.""" - charge_entry_id: Optional[int] = field( + charge_entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Charge_EntryID"}, ) """Pointer to the charge entry record.""" - charge_amount: Optional[float] = field( + charge_amount: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeAmount"}, ) """Charge amount.""" - charge_invoiced: Optional[bool] = field( + charge_invoiced: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeInvoiced"}, ) """Indicates if the charge has been invoiced.""" - charge_invoice_number: Optional[str] = field( + charge_invoice_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeInvoiceNumber"}, ) """Charge invoice number.""" - charge_type: Optional[str] = field( + charge_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ChargeType"}, ) """Charge type.""" - complete_date: Optional[str] = field( + complete_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CompleteDate"}, ) """Complete date.""" - contact_id: Optional[int] = field( + contact_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContactID"}, ) """Pointer to the contact record.""" - contract_date: Optional[str] = field( + contract_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractDate"}, ) """Contract date.""" - contractor_cost: Optional[float] = field( + contractor_cost: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorCost"}, ) """Contractor cost.""" - contractor_cost_estimate: Optional[float] = field( + contractor_cost_estimate: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorCostEstimate"}, ) """Contractor cost estimate.""" - contractor_date: Optional[str] = field( + contractor_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorDate"}, ) """Contractor date.""" - contractor_e_t_a: Optional[str] = field( + contractor_e_t_a: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorETA"}, ) """Contractor ETA.""" - contractor_order_number: Optional[str] = field( + contractor_order_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ContractorOrderNumber"}, ) """Contractor order number.""" - created_by_security_user_id: Optional[int] = field( + created_by_security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedBy_SecurityUserID"}, ) """Pointer to the security user record.""" - custom_bit1: Optional[bool] = field( + custom_bit1: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit1"}, ) """Custom bit 1.""" - custom_bit2: Optional[bool] = field( + custom_bit2: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomBit2"}, ) """Custom bit 2.""" - custom_date1: Optional[str] = field( + custom_date1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate1"}, ) """Custom date 1.""" - custom_date2: Optional[str] = field( + custom_date2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomDate2"}, ) """Custom date 2.""" - custom_string1: Optional[str] = field( + custom_string1: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString1"}, ) """Custom string 1.""" - custom_string2: Optional[str] = field( + custom_string2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString2"}, ) """Custom string 2.""" - custom_string3: Optional[str] = field( + custom_string3: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString3"}, ) """Custom string 3.""" - custom_string4: Optional[str] = field( + custom_string4: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString4"}, ) """Custom string 4.""" - custom_string5: Optional[str] = field( + custom_string5: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString5"}, ) """Custom string 5.""" - custom_string6: Optional[str] = field( + custom_string6: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CustomString6"}, ) """Custom string 6.""" - date_created: Optional[str] = field( + date_created: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateCreated"}, ) """Date created.""" - date_due: Optional[str] = field( + date_due: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateDue"}, ) """Date due.""" - date_modified: Optional[str] = field( + date_modified: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateModified"}, ) """Date modified.""" - date_reported: Optional[str] = field( + date_reported: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DateReported"}, ) """Date reported.""" - description: Optional[str] = field( + description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """Description.""" - job_sent: Optional[bool] = field( + job_sent: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobSent"}, ) """Indicates if a job has been sent.""" - job_status: Optional[str] = field( + job_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "JobStatus"}, ) """Job status.""" - location: Optional[str] = field( + location: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Location"}, ) """Location.""" - occupant_entry_id: Optional[int] = field( + occupant_entry_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Occupant_EntryID"}, ) """Pointer to the occupant entry record.""" - occupant_entry_name: Optional[str] = field( + occupant_entry_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantEntryName"}, ) """Occupant entry name.""" - occupant_present: Optional[bool] = field( + occupant_present: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantPresent"}, ) """Indicates if an occupant is present.""" - occupant_present_reason: Optional[str] = field( + occupant_present_reason: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OccupantPresentReason"}, ) """Occupant present reason.""" - other_service_number: Optional[str] = field( + other_service_number: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OtherServiceNumber"}, ) """Other service number.""" - priority_id: Optional[int] = field( + priority_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "PriorityID"}, ) """Pointer to the priority record.""" - repair_description: Optional[str] = field( + repair_description: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RepairDescription"}, ) """Repair description.""" - reported_by_name: Optional[str] = field( + reported_by_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReportedByName"}, ) """Reported by name.""" - reported_by_phone: Optional[str] = field( + reported_by_phone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReportedByPhone"}, ) """Reported by phone.""" - room_space_closed_id: Optional[int] = field( + room_space_closed_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceClosedID"}, ) """Pointer to the room space closed record.""" - room_space_id: Optional[int] = field( + room_space_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceID"}, ) """Pointer to the room space record.""" - room_space_maintenance_category_id: Optional[int] = field( + room_space_maintenance_category_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceCategoryID"}, ) """Pointer to the room space maintenance category record.""" - room_space_maintenance_id: Optional[int] = field( + room_space_maintenance_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceID"}, ) """Unique ID for this room space maintenance record.""" - room_space_maintenance_item_id: Optional[int] = field( + room_space_maintenance_item_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RoomSpaceMaintenanceItemID"}, ) """Pointer to the room space maintenance item record.""" - security_user_id: Optional[int] = field( + security_user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "SecurityUserID"}, ) """Pointer to the security user record.""" - start_date: Optional[str] = field( + start_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDate"}, ) """Start date.""" - status: Optional[str] = field( + status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Status"}, ) """Status.""" - technician: Optional[str] = field( + technician: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Technician"}, ) """Technician.""" - view_on_web: Optional[bool] = field( + view_on_web: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ViewOnWeb"}, ) """Indicates if the room space maintenance is viewable on the web.""" @@ -9532,7 +11562,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -9549,8 +11579,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -9571,7 +11601,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -9586,46 +11616,163 @@ def __init__( def connector_name(self) -> str: return "starrezrestv1" - async def select_entry_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_select_entry( self, - input: SelectEntryInput, + input: SelectEntryInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Entry Retrieves one or more records from the Entry table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectEntry`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/select/entry.json" + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def create_entry_async( + async def create_entry( self, - input: CreateEntryInput, + input: CreateEntryInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -9636,10 +11783,26 @@ async def create_entry_async( Create Entry Creates a new record in the Entry table. + + Swagger operation ID: `CreateEntry`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/create/entry.json" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -9653,6 +11816,7 @@ async def create_entry_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -9660,9 +11824,9 @@ async def create_entry_async( return json.loads(response.text) - async def update_entry_async( + async def update_entry( self, - input: UpdateEntryInput, + input: UpdateEntryInput | Mapping[str, Any], entry_id: int, *, timeout: Optional[float] = None, @@ -9674,13 +11838,30 @@ async def update_entry_async( Update Entry Updates an existing record in the Entry table. + + Swagger operation ID: `UpdateEntry`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + entry_id: The ID of the Entry record to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/update/entry.json/{quote(str(entry_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -9694,6 +11875,7 @@ async def update_entry_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -9701,7 +11883,7 @@ async def update_entry_async( return json.loads(response.text) - async def delete_async( + async def delete( self, table_name: str, row_id: int, @@ -9715,6 +11897,22 @@ async def delete_async( Delete Deletes a record from the specified table. + + Swagger operation ID: `Delete`. + + Args: + table_name: Name of the table to delete record from. + row_id: Row ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -9723,7 +11921,7 @@ async def delete_async( f"/{quote(str(row_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -9737,6 +11935,7 @@ async def delete_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -9744,48 +11943,88 @@ async def delete_async( return json.loads(response.text) - async def select_entry_custom_field_async( + def list_select_entry_custom_field( self, - input: SelectEntryCustomFieldInput, + input: SelectEntryCustomFieldInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Entry Custom Field Retrieves one or more records from the Entry Custom Field table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectEntryCustomField`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/select/EntryCustomField.json" ) + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def update_entry_custom_field_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def update_entry_custom_field( self, - input: UpdateEntryCustomFieldInput, + input: UpdateEntryCustomFieldInput | Mapping[str, Any], entry_custom_field_id: int, *, timeout: Optional[float] = None, @@ -9797,6 +12036,24 @@ async def update_entry_custom_field_async( Update Entry Custom Field Updates an existing record in the Entry Custom Field table. + + Swagger operation ID: `UpdateEntryCustomField`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + entry_custom_field_id: The ID of the Entry Custom Field record to + update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -9805,7 +12062,7 @@ async def update_entry_custom_field_async( f"/{quote(str(entry_custom_field_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -9819,6 +12076,7 @@ async def update_entry_custom_field_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -9826,85 +12084,165 @@ async def update_entry_custom_field_async( return json.loads(response.text) - async def select_term_async( + def list_select_term( self, - input: SelectTermInput, + input: SelectTermInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Term Retrieves one or more records from the Term table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectTerm`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/select/Term.json" + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def select_entry_address_async( + return AsyncItemPaged(get_next, extract_data) + + def list_select_entry_address( self, - input: SelectEntryAddressInput, + input: SelectEntryAddressInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Entry Address Retrieves one or more records from the Entry Address table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectEntryAddress`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/select/EntryAddress.json" ) + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def update_entry_address_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def update_entry_address( self, - input: UpdateEntryAddressInput, + input: UpdateEntryAddressInput | Mapping[str, Any], entry_address_id: int, *, timeout: Optional[float] = None, @@ -9916,6 +12254,23 @@ async def update_entry_address_async( Update Entry Address Updates an existing record in the Entry Address table. + + Swagger operation ID: `UpdateEntryAddress`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + entry_address_id: The ID of the Entry Address record to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -9924,7 +12279,7 @@ async def update_entry_address_async( f"/{quote(str(entry_address_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -9938,6 +12293,7 @@ async def update_entry_address_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -9945,48 +12301,88 @@ async def update_entry_address_async( return json.loads(response.text) - async def select_entry_application_async( + def list_select_entry_application( self, - input: SelectEntryApplicationInput, + input: SelectEntryApplicationInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Entry Application Retrieves one or more records from the Entry Application table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectEntryApplication`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/select/EntryApplication.json" ) + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def create_entry_application_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_entry_application( self, - input: CreateEntryApplicationInput, + input: CreateEntryApplicationInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -9997,12 +12393,28 @@ async def create_entry_application_async( Create Entry Application Creates a new record in the Entry Application table. + + Swagger operation ID: `CreateEntryApplication`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/create/entryapplication.json" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -10016,6 +12428,7 @@ async def create_entry_application_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -10023,9 +12436,9 @@ async def create_entry_application_async( return json.loads(response.text) - async def update_entry_application_async( + async def update_entry_application( self, - input: UpdateEntryApplicationInput, + input: UpdateEntryApplicationInput | Mapping[str, Any], entry_application_id: int, *, timeout: Optional[float] = None, @@ -10037,6 +12450,24 @@ async def update_entry_application_async( Update Entry Application Updates an existing record in the Entry Application table. + + Swagger operation ID: `UpdateEntryApplication`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + entry_application_id: The ID of the Entry Application record to + update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -10045,7 +12476,7 @@ async def update_entry_application_async( f"/{quote(str(entry_application_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -10059,6 +12490,7 @@ async def update_entry_application_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -10066,83 +12498,163 @@ async def update_entry_application_async( return json.loads(response.text) - async def select_term_session_async( + def list_select_term_session( self, - input: SelectTermSessionInput, + input: SelectTermSessionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Term Session Retrieves one or more records from the Term Session table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectTermSession`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/select/TermSession.json" + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def select_entry_detail_async( + def list_select_entry_detail( self, - input: SelectEntryDetailInput, + input: SelectEntryDetailInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Entry Detail Retrieves one or more records from the Entry Detail table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectEntryDetail`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/select/EntryDetail.json" + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def update_entry_detail_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def update_entry_detail( self, - input: UpdateEntryDetailInput, + input: UpdateEntryDetailInput | Mapping[str, Any], entry_detail_id: int, *, timeout: Optional[float] = None, @@ -10154,13 +12666,30 @@ async def update_entry_detail_async( Update Entry Detail Updates an existing record in the Entry Detail table. + + Swagger operation ID: `UpdateEntryDetail`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + entry_detail_id: The ID of the Entry Detail record to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/update/entrydetail.json/{quote(str(entry_detail_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -10174,6 +12703,7 @@ async def update_entry_detail_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -10181,48 +12711,88 @@ async def update_entry_detail_async( return json.loads(response.text) - async def select_entry_enrollment_async( + def list_select_entry_enrollment( self, - input: SelectEntryEnrollmentInput, + input: SelectEntryEnrollmentInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Entry Enrollment Retrieves one or more records from the Entry Enrollment table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectEntryEnrollment`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/select/EntryEnrollment.json" ) + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def create_entry_enrollment_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_entry_enrollment( self, - input: CreateEntryEnrollmentInput, + input: CreateEntryEnrollmentInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -10233,12 +12803,28 @@ async def create_entry_enrollment_async( Create Entry Enrollment Creates a new record in the Entry Enrollment table. + + Swagger operation ID: `CreateEntryEnrollment`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/create/entryenrollment.json" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -10252,6 +12838,7 @@ async def create_entry_enrollment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -10259,9 +12846,9 @@ async def create_entry_enrollment_async( return json.loads(response.text) - async def update_entry_enrollment_async( + async def update_entry_enrollment( self, - input: UpdateEntryEnrollmentInput, + input: UpdateEntryEnrollmentInput | Mapping[str, Any], entry_enrollment_id: int, *, timeout: Optional[float] = None, @@ -10273,6 +12860,24 @@ async def update_entry_enrollment_async( Update Entry Enrollment Updates an existing record in the Entry Enrollment table. + + Swagger operation ID: `UpdateEntryEnrollment`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + entry_enrollment_id: The ID of the Entry Enrollment record to + update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -10281,7 +12886,7 @@ async def update_entry_enrollment_async( f"/{quote(str(entry_enrollment_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -10295,6 +12900,7 @@ async def update_entry_enrollment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -10302,46 +12908,86 @@ async def update_entry_enrollment_async( return json.loads(response.text) - async def select_booking_async( + def list_select_booking( self, - input: SelectBookingInput, + input: SelectBookingInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Booking Retrieves one or more records from the Booking table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectBooking`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/select/Booking.json" + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def create_booking_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_booking( self, - input: CreateBookingInput, + input: CreateBookingInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -10352,10 +12998,26 @@ async def create_booking_async( Create Booking Creates a new record in the Booking table. + + Swagger operation ID: `CreateBooking`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/create/booking.json" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -10369,6 +13031,7 @@ async def create_booking_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -10376,9 +13039,9 @@ async def create_booking_async( return json.loads(response.text) - async def update_booking_async( + async def update_booking( self, - input: UpdateBookingInput, + input: UpdateBookingInput | Mapping[str, Any], booking_id: int, *, timeout: Optional[float] = None, @@ -10390,13 +13053,30 @@ async def update_booking_async( Update Booking Updates an existing record in the Booking table. + + Swagger operation ID: `UpdateBooking`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + booking_id: The ID of the Booking record to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/update/booking.json/{quote(str(booking_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -10410,6 +13090,7 @@ async def update_booking_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -10417,46 +13098,86 @@ async def update_booking_async( return json.loads(response.text) - async def select_room_space_async( + def list_select_room_space( self, - input: SelectRoomSpaceInput, + input: SelectRoomSpaceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Room Space Retrieves one or more records from the Room Space table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectRoomSpace`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/select/RoomSpace.json" + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def create_room_space_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_room_space( self, - input: CreateRoomSpaceInput, + input: CreateRoomSpaceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -10467,10 +13188,26 @@ async def create_room_space_async( Create Room Space Creates a new record in the Room Space table. + + Swagger operation ID: `CreateRoomSpace`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/create/roomspace.json" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -10484,6 +13221,7 @@ async def create_room_space_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -10491,85 +13229,165 @@ async def create_room_space_async( return json.loads(response.text) - async def select_room_location_async( + def list_select_room_location( self, - input: SelectRoomLocationInput, + input: SelectRoomLocationInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Room Location Retrieves one or more records from the Room Location table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectRoomLocation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/select/RoomLocation.json" ) + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def select_transaction_async( + def list_select_transaction( self, - input: SelectTransactionInput, + input: SelectTransactionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Transaction Retrieves one or more records from the Transaction table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectTransaction`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/select/Transaction.json" + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def create_transaction_async( + async def create_transaction( self, - input: CreateTransactionInput, + input: CreateTransactionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -10580,10 +13398,26 @@ async def create_transaction_async( Create Transaction Creates a new record in the Transaction table. + + Swagger operation ID: `CreateTransaction`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/create/transaction.json" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -10597,6 +13431,7 @@ async def create_transaction_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -10604,48 +13439,88 @@ async def create_transaction_async( return json.loads(response.text) - async def select_room_space_maintenance_async( + def list_select_room_space_maintenance( self, - input: SelectRoomSpaceMaintenanceInput, + input: SelectRoomSpaceMaintenanceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Room Space Maintenance Retrieves one or more records from the Room Space Maintenance table. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SelectRoomSpaceMaintenance`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/select/RoomSpaceMaintenance.json" ) + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def create_room_space_maintenance_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_room_space_maintenance( self, - input: CreateRoomSpaceMaintenanceInput, + input: CreateRoomSpaceMaintenanceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -10656,12 +13531,28 @@ async def create_room_space_maintenance_async( Create Room Space Maintenance Creates a new record in the Room Space Maintenance table. + + Swagger operation ID: `CreateRoomSpaceMaintenance`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/create/roomspacemaintenance.json" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -10675,6 +13566,7 @@ async def create_room_space_maintenance_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -10682,9 +13574,9 @@ async def create_room_space_maintenance_async( return json.loads(response.text) - async def update_room_space_maintenance_async( + async def update_room_space_maintenance( self, - input: UpdateRoomSpaceMaintenanceInput, + input: UpdateRoomSpaceMaintenanceInput | Mapping[str, Any], room_space_maintenance_id: int, *, timeout: Optional[float] = None, @@ -10696,6 +13588,24 @@ async def update_room_space_maintenance_async( Update Room Space Maintenance Updates an existing record in the Room Space Maintenance table. + + Swagger operation ID: `UpdateRoomSpaceMaintenance`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + room_space_maintenance_id: The ID of the Room Space Maintenance + record to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -10704,7 +13614,7 @@ async def update_room_space_maintenance_async( f"/{quote(str(room_space_maintenance_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -10718,6 +13628,7 @@ async def update_room_space_maintenance_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/tallyfy.py b/src/azure/connectors/tallyfy.py index faba5c68..ff1ea7b4 100644 --- a/src/azure/connectors/tallyfy.py +++ b/src/azure/connectors/tallyfy.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,121 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "TallyfyClient", + "AccessToken", + "AccountInput", + "AccountsInput", + "AddTagInput", + "Address", + "AlertIssues", + "Asset", + "AssetSubject", + "BillInput", + "Branding", + "BrandingInput", + "Capture", + "CaptureInput", + "CheckUrlInput", + "Checklist", + "ChecklistInput", + "Client", + "Comment", + "CommentOn", + "CommentTaskInput", + "CommentTaskResponse", + "CompletedOneOffTaskInput", + "CompletedOneOffTaskResponse", + "CompletedProcessTask", + "CompletedProcessTaskInput", + "CompletedProcessTaskResponse", + "CreateChecklistInput", + "CreateCommentInput", + "CreateGroupInput", + "CreateGuestsTasksComment", + "CreateRoleInput", + "CreateRunInput", + "CreateRunResponse", + "CreateStandaloneTaskInput", + "CreateStepInput", + "CreateTagInput", + "CreateTaskInput", + "CreateTaskResponse", + "Date", + "DueDateInput", + "EditStepTypeInput", + "EditStepTypeResponse", + "EditTaskDeadlineInput", + "EditTaskDeadlineResponse", + "Error", + "File", + "GenericObject", + "GetOrganizationUsersResponse", + "GetUserOrganizationsResponse", + "GetUserTasksResponse", + "Group", + "IntegrationS3Input", + "InviteInput", + "InviteUserToOrganizationInput", + "InviteUserToOrganizationResponse", + "LoginInput", + "Message", + "Organization", + "OrganizationInput", + "OrganizationSettings", + "OwnerInput", + "Pagination", + "Passwordreset", + "Passwordreseterro", + "PowerbuilderInput", + "Preference", + "PreferenceInput", + "PrerunData", + "RegisterInput", + "RemoveAssigneeResponse", + "RemoveGuestResponse", + "ReopenOneOffTaskResponse", + "ReopenProcessTaskResponse", + "RequestDate", + "ResetPasswordInput", + "Role", + "Run", + "RunAlerts", + "RunCollaborators", + "RunMetaInput", + "RunRatingsInput", + "RunView", + "RunViewInput", + "Section", + "SectionCreateInput", + "SectionInput", + "StandaloneTask", + "Step", + "StepCondition", + "StepConditionTerm", + "StepDeadline", + "StepMeta", + "StepOwner", + "SubcriptionInput", + "Tag", + "TaskGuest", + "TaskMeta", + "TaskMetaInput", + "TaskObject", + "TasksList", + "TasksListMeta", + "Thread", + "ThreadInput", + "ThreadResolveInput", + "UpdateGuestsTasksInput", + "UpdateStandaloneTaskInput", + "UpdateTaskInput", + "User", +] + # Type Definitions @@ -29,9 +143,9 @@ class GetUserTasksResponse: Response for Get a member's tasks """ - data: Optional[List[Dict[str, Any]]] = None + data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """data""" - meta: Optional[Dict[str, Any]] = None + meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """meta""" @@ -41,15 +155,15 @@ class InviteUserToOrganizationInput: Invite a new member to your organization """ - first_name: Optional[str] = None + first_name: str """Invitee's first name""" - last_name: Optional[str] = None + last_name: str """invitee's last name""" - email: Optional[str] = None + email: str """invitee's work email address""" - message: Optional[str] = None + message: str """Message to add""" - role: Optional[str] = None + role: str """Role""" @@ -59,7 +173,7 @@ class InviteUserToOrganizationResponse: Response for Invite a new member to your organization """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -69,11 +183,11 @@ class CreateRunInput: Launch a Process """ - name: Optional[str] = None + name: str """Name to give the new Process""" - checklist_id: Optional[str] = None + checklist_id: str """ID of the Blueprint to start the process""" - summary: Optional[str] = None + summary: Optional[str] = dataclass_field(default=None, kw_only=True) """Summary notes to include with the Process""" @@ -83,7 +197,7 @@ class CreateRunResponse: Response for Launch a Process """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -93,9 +207,9 @@ class CompletedOneOffTaskInput: Complete One Off Task """ - task_id: Optional[str] = None + task_id: str """Task ID""" - is_approved: Optional[bool] = None + is_approved: Optional[bool] = dataclass_field(default=None, kw_only=True) """starred""" @@ -105,7 +219,7 @@ class CompletedOneOffTaskResponse: Response for Complete One Off Task """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -118,7 +232,7 @@ class ReopenOneOffTaskResponse: Response for Reopen One Off Task """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -131,9 +245,9 @@ class CompletedProcessTaskInput: Complete process task """ - task_id: Optional[str] = None + task_id: str """Task ID""" - is_approved: Optional[bool] = None + is_approved: Optional[bool] = dataclass_field(default=None, kw_only=True) """starred""" @@ -143,7 +257,7 @@ class CompletedProcessTaskResponse: Response for Complete process task """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -156,7 +270,7 @@ class ReopenProcessTaskResponse: Response for Reopen process Task """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -169,9 +283,9 @@ class CommentTaskInput: Add comment, report issue, resolve issue on a task """ - content: Optional[str] = None + content: str """Comment content""" - label: Optional[str] = None + label: str """Comment label""" @@ -181,7 +295,7 @@ class CommentTaskResponse: Response for Add comment, report issue, resolve issue on a task """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -194,15 +308,15 @@ class CreateTaskInput: Create a task """ - owners: Optional[Dict[str, Any]] = None + owners: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """owners""" - task_type: Optional[str] = None + task_type: str """Task type""" - deadline: Optional[str] = None + deadline: str """task deadline, in date-time format""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Task's description""" - name: Optional[str] = None + name: str """task name""" @@ -212,7 +326,7 @@ class CreateTaskResponse: Response for Create a task """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" @@ -222,8 +336,9 @@ class EditTaskDeadlineInput: Edit task deadline """ - deadline: Optional[str] = field( + deadline: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Deadline"}, ) """New task deadline""" @@ -235,7 +350,7 @@ class EditTaskDeadlineResponse: Response for Edit task deadline """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -248,7 +363,7 @@ class RemoveGuestResponse: Response for Remove guest assigned """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -261,7 +376,7 @@ class RemoveAssigneeResponse: Response for Remove assignee """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -274,8 +389,9 @@ class EditStepTypeInput: Edit step type """ - step_type: Optional[str] = field( + step_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "stepType"}, ) """New step type""" @@ -287,7 +403,7 @@ class EditStepTypeResponse: Response for Edit step type """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -300,9 +416,9 @@ class GetUserOrganizationsResponse: Response for Get user's organizations """ - data: Optional[List[Dict[str, Any]]] = None + data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """data""" - meta: Optional[Dict[str, Any]] = None + meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """meta""" @@ -312,7 +428,7 @@ class GetOrganizationUsersResponse: Response for Get organization's users """ - data: Optional[List[Dict[str, Any]]] = None + data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """data""" @@ -322,8 +438,8 @@ class Error: Definition: error """ - error: Optional[bool] = None - message: Optional[str] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) + message: str Date = str @@ -338,13 +454,13 @@ class Address: Definition: Address """ - address1: Optional[str] = None - address2: Optional[str] = None - city: Optional[str] = None - state: Optional[str] = None - zip: Optional[str] = None - country: Optional[str] = None - phone: Optional[str] = None + address1: Optional[str] = dataclass_field(default=None, kw_only=True) + address2: Optional[str] = dataclass_field(default=None, kw_only=True) + city: Optional[str] = dataclass_field(default=None, kw_only=True) + state: Optional[str] = dataclass_field(default=None, kw_only=True) + zip: Optional[str] = dataclass_field(default=None, kw_only=True) + country: Optional[str] = dataclass_field(default=None, kw_only=True) + phone: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -353,8 +469,8 @@ class LoginInput: Definition: loginInput """ - email: Optional[str] = None - password: Optional[str] = None + email: str + password: str @dataclass @@ -363,11 +479,11 @@ class File: Definition: File """ - name: Optional[str] = None - url: Optional[str] = None - extension: Optional[str] = None - size: Optional[int] = None - last_modified: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + url: Optional[str] = dataclass_field(default=None, kw_only=True) + extension: Optional[str] = dataclass_field(default=None, kw_only=True) + size: Optional[int] = dataclass_field(default=None, kw_only=True) + last_modified: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -376,14 +492,14 @@ class RegisterInput: Definition: registerInput """ - first_name: Optional[str] = None - last_name: Optional[str] = None - email: Optional[str] = None - password: Optional[str] = None - company_name: Optional[str] = None - timezone: Optional[str] = None - plan_code: Optional[str] = None - coupon_code: Optional[str] = None + first_name: str + last_name: str + email: str + password: str + company_name: str + timezone: Optional[str] = dataclass_field(default=None, kw_only=True) + plan_code: str + coupon_code: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -392,9 +508,9 @@ class ResetPasswordInput: Definition: resetPasswordInput """ - password: Optional[str] = None - password_confirmation: Optional[str] = None - code: Optional[str] = None + password: Optional[str] = dataclass_field(default=None, kw_only=True) + password_confirmation: Optional[str] = dataclass_field(default=None, kw_only=True) + code: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -403,19 +519,24 @@ class OrganizationInput: Definition: organizationInput """ - name: Optional[str] = None - address1: Optional[str] = None - address2: Optional[str] = None - address3: Optional[str] = None - slug: Optional[str] = None - welcome_title: Optional[str] = None - welcome_description: Optional[str] = None - industry: Optional[str] = None - country: Optional[str] = None - state: Optional[str] = None - city: Optional[str] = None - zipcode: Optional[str] = None - settings: Optional[OrganizationSettings] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + address1: Optional[str] = dataclass_field(default=None, kw_only=True) + address2: Optional[str] = dataclass_field(default=None, kw_only=True) + address3: Optional[str] = dataclass_field(default=None, kw_only=True) + slug: Optional[str] = dataclass_field(default=None, kw_only=True) + welcome_title: Optional[str] = dataclass_field(default=None, kw_only=True) + welcome_description: Optional[str] = dataclass_field(default=None, kw_only=True) + industry: Optional[str] = dataclass_field(default=None, kw_only=True) + country: Optional[str] = dataclass_field(default=None, kw_only=True) + state: Optional[str] = dataclass_field(default=None, kw_only=True) + city: Optional[str] = dataclass_field(default=None, kw_only=True) + zipcode: Optional[str] = dataclass_field(default=None, kw_only=True) + settings: Optional[ + OrganizationSettings | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -424,9 +545,14 @@ class OrganizationSettings: Definition: organizationSettings """ - determine_deadline: Optional[GenericObject] = None - workdays: Optional[List[str]] = None - holidays: Optional[List[str]] = None + determine_deadline: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + workdays: Optional[List[str]] = dataclass_field(default=None, kw_only=True) + holidays: Optional[List[str]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -435,7 +561,7 @@ class BillInput: Definition: billInput """ - token_id: Optional[str] = None + token_id: str @dataclass @@ -444,8 +570,8 @@ class SubcriptionInput: Definition: subcriptionInput """ - plan_code: Optional[str] = None - coupon_code: Optional[str] = None + plan_code: Optional[str] = dataclass_field(default=None, kw_only=True) + coupon_code: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -454,9 +580,9 @@ class AccountInput: Definition: accountInput """ - email: Optional[str] = None - cc_emails: Optional[str] = None - address: Optional[Address] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) + cc_emails: Optional[str] = dataclass_field(default=None, kw_only=True) + address: Optional[Address | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -465,10 +591,10 @@ class RunView: Definition: RunView """ - name: Optional[str] = None - is_active: Optional[int] = None - filter_type: Optional[str] = None - criteria: Optional[List[str]] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + is_active: Optional[int] = dataclass_field(default=None, kw_only=True) + filter_type: Optional[str] = dataclass_field(default=None, kw_only=True) + criteria: Optional[List[str]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -477,10 +603,10 @@ class RunViewInput: Definition: runViewInput """ - name: Optional[str] = None - filter_type: Optional[str] = None - is_active: Optional[int] = None - criteria: Optional[List[Dict[str, Any]]] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + filter_type: Optional[str] = dataclass_field(default=None, kw_only=True) + is_active: Optional[int] = dataclass_field(default=None, kw_only=True) + criteria: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -489,9 +615,14 @@ class PreferenceInput: Definition: preferenceInput """ - slug: Optional[str] = None - value: Optional[str] = None - metadata: Optional[GenericObject] = None + slug: Optional[str] = dataclass_field(default=None, kw_only=True) + value: Optional[str] = dataclass_field(default=None, kw_only=True) + metadata: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -500,15 +631,15 @@ class AccountsInput: Definition: accountsInput """ - email: Optional[str] = None - first_name: Optional[str] = None - last_name: Optional[str] = None - username: Optional[str] = None - phone: Optional[str] = None - job_title: Optional[str] = None - job_description: Optional[str] = None - timezone: Optional[str] = None - country_id: Optional[int] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) + first_name: Optional[str] = dataclass_field(default=None, kw_only=True) + last_name: Optional[str] = dataclass_field(default=None, kw_only=True) + username: Optional[str] = dataclass_field(default=None, kw_only=True) + phone: Optional[str] = dataclass_field(default=None, kw_only=True) + job_title: Optional[str] = dataclass_field(default=None, kw_only=True) + job_description: Optional[str] = dataclass_field(default=None, kw_only=True) + timezone: Optional[str] = dataclass_field(default=None, kw_only=True) + country_id: Optional[int] = dataclass_field(default=None, kw_only=True) @dataclass @@ -517,9 +648,9 @@ class InviteInput: Definition: inviteInput """ - first_name: Optional[str] = None - last_name: Optional[str] = None - email: Optional[str] = None + first_name: Optional[str] = dataclass_field(default=None, kw_only=True) + last_name: Optional[str] = dataclass_field(default=None, kw_only=True) + email: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -528,7 +659,7 @@ class Passwordreset: Definition: passwordreset """ - new_password: Optional[str] = None + new_password: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -537,9 +668,9 @@ class Passwordreseterro: Definition: passwordreseterro """ - error: Optional[bool] = None - message: Optional[str] = None - code: Optional[str] = None + error: Optional[bool] = dataclass_field(default=None, kw_only=True) + message: Optional[str] = dataclass_field(default=None, kw_only=True) + code: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -548,7 +679,7 @@ class CheckUrlInput: Definition: checkUrlInput """ - url: Optional[str] = None + url: str @dataclass @@ -557,8 +688,12 @@ class AssetSubject: Definition: AssetSubject """ - id: Optional[int] = None - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + id: Optional[int] = dataclass_field(default=None, kw_only=True) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) @dataclass @@ -567,12 +702,17 @@ class Asset: Definition: Asset """ - id: Optional[str] = None - filename: Optional[str] = None - version: Optional[int] = None - step_id: Optional[str] = None - uploaded_from: Optional[str] = None - subject: Optional[AssetSubject] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + filename: Optional[str] = dataclass_field(default=None, kw_only=True) + version: Optional[int] = dataclass_field(default=None, kw_only=True) + step_id: Optional[str] = dataclass_field(default=None, kw_only=True) + uploaded_from: Optional[str] = dataclass_field(default=None, kw_only=True) + subject: Optional[ + AssetSubject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -581,13 +721,18 @@ class CaptureInput: Definition: CaptureInput """ - alias: Optional[str] = None - field_type: Optional[str] = None - guidance: Optional[str] = None - label: Optional[str] = None - position: Optional[int] = None - required: Optional[bool] = None - options: Optional[List[GenericObject]] = None + alias: Optional[str] = dataclass_field(default=None, kw_only=True) + field_type: Optional[str] = dataclass_field(default=None, kw_only=True) + guidance: Optional[str] = dataclass_field(default=None, kw_only=True) + label: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) + required: Optional[bool] = dataclass_field(default=None, kw_only=True) + options: Optional[ + List[GenericObject | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -596,18 +741,18 @@ class Capture: Definition: Capture """ - id: Optional[int] = None - step_id: Optional[int] = None - alias: Optional[str] = None - field_type: Optional[str] = None - guidance: Optional[str] = None - label: Optional[str] = None - position: Optional[int] = None - required: Optional[bool] = None - options: Optional[str] = None - created_at: Optional[RequestDate] = None - last_updated: Optional[RequestDate] = None - archived_at: Optional[RequestDate] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) + step_id: Optional[int] = dataclass_field(default=None, kw_only=True) + alias: Optional[str] = dataclass_field(default=None, kw_only=True) + field_type: Optional[str] = dataclass_field(default=None, kw_only=True) + guidance: Optional[str] = dataclass_field(default=None, kw_only=True) + label: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) + required: Optional[bool] = dataclass_field(default=None, kw_only=True) + options: Optional[str] = dataclass_field(default=None, kw_only=True) + created_at: Optional[RequestDate] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[RequestDate] = dataclass_field(default=None, kw_only=True) + archived_at: Optional[RequestDate] = dataclass_field(default=None, kw_only=True) @dataclass @@ -616,11 +761,11 @@ class BrandingInput: Definition: brandingInput """ - bg_color: Optional[str] = None - text_color: Optional[str] = None - alternate_color: Optional[str] = None - bright_shade: Optional[str] = None - dark_shade: Optional[str] = None + bg_color: Optional[str] = dataclass_field(default=None, kw_only=True) + text_color: Optional[str] = dataclass_field(default=None, kw_only=True) + alternate_color: Optional[str] = dataclass_field(default=None, kw_only=True) + bright_shade: Optional[str] = dataclass_field(default=None, kw_only=True) + dark_shade: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -629,12 +774,12 @@ class Branding: Definition: Branding """ - bg_color: Optional[str] = None - text_color: Optional[str] = None - alternate_color: Optional[str] = None - bright_shade: Optional[str] = None - dark_shade: Optional[str] = None - updated_at: Optional[Date] = None + bg_color: Optional[str] = dataclass_field(default=None, kw_only=True) + text_color: Optional[str] = dataclass_field(default=None, kw_only=True) + alternate_color: Optional[str] = dataclass_field(default=None, kw_only=True) + bright_shade: Optional[str] = dataclass_field(default=None, kw_only=True) + dark_shade: Optional[str] = dataclass_field(default=None, kw_only=True) + updated_at: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -643,7 +788,7 @@ class ChecklistInput: Definition: checklistInput """ - checklist: Optional[Checklist] = None + checklist: Optional[Checklist | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -652,8 +797,8 @@ class PowerbuilderInput: Definition: powerbuilderInput """ - id: Optional[str] = None - steps: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + steps: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -662,19 +807,34 @@ class CreateChecklistInput: Definition: createChecklistInput """ - title: Optional[str] = None - summary: Optional[str] = None - privacy: Optional[str] = None - settings: Optional[GenericObject] = None - contributors: Optional[List[int]] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) + summary: Optional[str] = dataclass_field(default=None, kw_only=True) + privacy: Optional[str] = dataclass_field(default=None, kw_only=True) + settings: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + contributors: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """The list of users who can update the checklist.""" - tags: Optional[List[str]] = None - start_run_permissions: Optional[GenericObject] = None + tags: Optional[List[str]] = dataclass_field(default=None, kw_only=True) + start_run_permissions: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of groups and users who can access the run.""" - prerun: Optional[GenericObject] = None - user_id: Optional[int] = None + prerun: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + user_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Template creator ID""" - owner_id: Optional[int] = None + owner_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Template Owner ID""" @@ -684,23 +844,38 @@ class Checklist: Definition: Checklist """ - id: Optional[str] = None - title: Optional[str] = None - summary: Optional[str] = None - privacy: Optional[str] = None - starred: Optional[int] = None - settings: Optional[GenericObject] = None - contributors: Optional[List[int]] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + title: Optional[str] = dataclass_field(default=None, kw_only=True) + summary: Optional[str] = dataclass_field(default=None, kw_only=True) + privacy: Optional[str] = dataclass_field(default=None, kw_only=True) + starred: Optional[int] = dataclass_field(default=None, kw_only=True) + settings: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + contributors: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """The list of users who can update the Blueprint.""" - statistics: Optional[GenericObject] = None - created_by: Optional[int] = None - owner_id: Optional[int] = None + statistics: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + created_by: Optional[int] = dataclass_field(default=None, kw_only=True) + owner_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Template Owner ID""" - created_at: Optional[Date] = None - last_updated: Optional[Date] = None - archived_at: Optional[Date] = None - created_ago: Optional[str] = None - steps: Optional[List[Step]] = None + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[Date] = dataclass_field(default=None, kw_only=True) + archived_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + created_ago: Optional[str] = dataclass_field(default=None, kw_only=True) + steps: Optional[ + List[Step | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -709,8 +884,12 @@ class CommentOn: Definition: comment_on """ - id: Optional[int] = None - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + id: Optional[int] = dataclass_field(default=None, kw_only=True) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) @dataclass @@ -719,8 +898,13 @@ class CreateCommentInput: Definition: createCommentInput """ - comment_on: Optional[CommentOn] = None - content: Optional[str] = None + comment_on: Optional[ + CommentOn | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + content: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -729,13 +913,18 @@ class Comment: Definition: Comment """ - id: Optional[int] = None - comment_on: Optional[CommentOn] = None - content: Optional[str] = None - replies_count: Optional[int] = None - author_id: Optional[int] = None - metadata: Optional[str] = None - archived_at: Optional[str] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) + comment_on: Optional[ + CommentOn | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + content: Optional[str] = dataclass_field(default=None, kw_only=True) + replies_count: Optional[int] = dataclass_field(default=None, kw_only=True) + author_id: Optional[int] = dataclass_field(default=None, kw_only=True) + metadata: Optional[str] = dataclass_field(default=None, kw_only=True) + archived_at: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -744,8 +933,8 @@ class CreateGroupInput: Definition: createGroupInput """ - name: Optional[str] = None - users: Optional[List[int]] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + users: Optional[List[int]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -754,10 +943,10 @@ class Group: Definition: Group """ - id: Optional[int] = None - name: Optional[str] = None - created_at: Optional[Date] = None - updated_at: Optional[Date] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) + name: Optional[str] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + updated_at: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -766,11 +955,11 @@ class IntegrationS3Input: Definition: integrationS3Input """ - aws_key: Optional[str] = None - aws_secret: Optional[str] = None - aws_region: Optional[str] = None - aws_bucket: Optional[str] = None - aws_account_id: Optional[str] = None + aws_key: Optional[str] = dataclass_field(default=None, kw_only=True) + aws_secret: Optional[str] = dataclass_field(default=None, kw_only=True) + aws_region: Optional[str] = dataclass_field(default=None, kw_only=True) + aws_bucket: Optional[str] = dataclass_field(default=None, kw_only=True) + aws_account_id: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -779,19 +968,29 @@ class Message: Definition: Message """ - id: Optional[int] = None - thread_id: Optional[str] = None - label: Optional[str] = None - thread_last_updated_at: Optional[str] = None - updated_at: Optional[Date] = None - content: Optional[str] = None - sent_by: Optional[int] = None - sent_at: Optional[Date] = None - created_ago: Optional[str] = None - sent_to: Optional[List[int]] = None - author_name: Optional[str] = None - author: Optional[GenericObject] = None - subject: Optional[GenericObject] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) + thread_id: Optional[str] = dataclass_field(default=None, kw_only=True) + label: Optional[str] = dataclass_field(default=None, kw_only=True) + thread_last_updated_at: Optional[str] = dataclass_field(default=None, kw_only=True) + updated_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + content: Optional[str] = dataclass_field(default=None, kw_only=True) + sent_by: Optional[int] = dataclass_field(default=None, kw_only=True) + sent_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + created_ago: Optional[str] = dataclass_field(default=None, kw_only=True) + sent_to: Optional[List[int]] = dataclass_field(default=None, kw_only=True) + author_name: Optional[str] = dataclass_field(default=None, kw_only=True) + author: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + subject: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -800,20 +999,20 @@ class Organization: Definition: Organization """ - id: Optional[int] = None - name: Optional[str] = None - address1: Optional[str] = None - address2: Optional[str] = None - address3: Optional[str] = None - slug: Optional[str] = None - welcome_title: Optional[str] = None - welcome_description: Optional[str] = None - created_on: Optional[Date] = None - last_updated: Optional[Date] = None - user_status: Optional[str] = None - joined_on: Optional[Date] = None - disabled_on: Optional[Date] = None - last_accessed: Optional[Date] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) + name: Optional[str] = dataclass_field(default=None, kw_only=True) + address1: Optional[str] = dataclass_field(default=None, kw_only=True) + address2: Optional[str] = dataclass_field(default=None, kw_only=True) + address3: Optional[str] = dataclass_field(default=None, kw_only=True) + slug: Optional[str] = dataclass_field(default=None, kw_only=True) + welcome_title: Optional[str] = dataclass_field(default=None, kw_only=True) + welcome_description: Optional[str] = dataclass_field(default=None, kw_only=True) + created_on: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[Date] = dataclass_field(default=None, kw_only=True) + user_status: Optional[str] = dataclass_field(default=None, kw_only=True) + joined_on: Optional[Date] = dataclass_field(default=None, kw_only=True) + disabled_on: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_accessed: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -822,10 +1021,15 @@ class Preference: Definition: Preference """ - slug: Optional[str] = None - value: Optional[str] = None - metadata: Optional[GenericObject] = None - last_updated: Optional[Date] = None + slug: Optional[str] = dataclass_field(default=None, kw_only=True) + value: Optional[str] = dataclass_field(default=None, kw_only=True) + metadata: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + last_updated: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -834,8 +1038,8 @@ class RunRatingsInput: Definition: runRatingsInput """ - rating: Optional[float] = None - comment: Optional[str] = None + rating: Optional[float] = dataclass_field(default=None, kw_only=True) + comment: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -844,8 +1048,8 @@ class CreateRoleInput: Definition: createRoleInput """ - name: Optional[str] = None - permissions: Optional[List[str]] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + permissions: Optional[List[str]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -854,11 +1058,16 @@ class Role: Definition: Role """ - id: Optional[int] = None - name: Optional[str] = None - permissions: Optional[GenericObject] = None - created_at: Optional[Date] = None - updated_at: Optional[Date] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) + name: Optional[str] = dataclass_field(default=None, kw_only=True) + permissions: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + updated_at: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -867,8 +1076,8 @@ class RunCollaborators: Definition: runCollaborators """ - members: Optional[List[int]] = None - guests: Optional[List[str]] = None + members: Optional[List[int]] = dataclass_field(default=None, kw_only=True) + guests: Optional[List[str]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -877,7 +1086,7 @@ class OwnerInput: Definition: ownerInput """ - owners: Optional[Any] = None + owners: Optional[Any] = dataclass_field(default=None, kw_only=True) @dataclass @@ -886,7 +1095,7 @@ class DueDateInput: Definition: dueDateInput """ - deadline: Optional[str] = None + deadline: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -895,17 +1104,17 @@ class PrerunData: Definition: PrerunData """ - id: Optional[str] = None - alias: Optional[str] = None - created_at: Optional[Date] = None - field_type: Optional[str] = None - field_value: Optional[str] = None - label: Optional[str] = None - updated_at: Optional[Date] = None - options: Optional[str] = None - position: Optional[int] = None - required: Optional[bool] = None - value: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + alias: Optional[str] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + field_type: Optional[str] = dataclass_field(default=None, kw_only=True) + field_value: Optional[str] = dataclass_field(default=None, kw_only=True) + label: Optional[str] = dataclass_field(default=None, kw_only=True) + updated_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + options: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) + required: Optional[bool] = dataclass_field(default=None, kw_only=True) + value: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -914,17 +1123,27 @@ class AlertIssues: Definition: AlertIssues """ - id: Optional[str] = None - task_id: Optional[str] = None - label: Optional[str] = None - content: Optional[str] = None - sent_to: Optional[GenericObject] = None - sent_by: Optional[int] = None - created_at: Optional[Date] = None - created_ago: Optional[str] = None - recent_updated_at: Optional[Date] = None - author: Optional[GenericObject] = None - resolve_id: Optional[int] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + task_id: Optional[str] = dataclass_field(default=None, kw_only=True) + label: Optional[str] = dataclass_field(default=None, kw_only=True) + content: Optional[str] = dataclass_field(default=None, kw_only=True) + sent_to: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + sent_by: Optional[int] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + created_ago: Optional[str] = dataclass_field(default=None, kw_only=True) + recent_updated_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + author: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + resolve_id: Optional[int] = dataclass_field(default=None, kw_only=True) @dataclass @@ -933,7 +1152,12 @@ class RunAlerts: Definition: RunAlerts """ - issues: Optional[List[AlertIssues]] = None + issues: Optional[ + List[AlertIssues | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -942,27 +1166,37 @@ class Run: Definition: Run """ - id: Optional[str] = None - checklist_id: Optional[str] = None - name: Optional[str] = None - summary: Optional[str] = None - status: Optional[str] = None - progress: Optional[GenericObject] = None - started_by: Optional[int] = None - owner_id: Optional[int] = None - prerun: Optional[List[PrerunData]] = None - alerts: Optional[RunAlerts] = None - starred: Optional[bool] = None - created_at: Optional[Date] = None - started_at: Optional[Date] = None - last_updated: Optional[Date] = None - last_synced: Optional[Date] = None - completed_at: Optional[Date] = None - archived_at: Optional[Date] = None - due_date_passed: Optional[bool] = None - collaborators: Optional[List[int]] = None - due_soon: Optional[bool] = None - max_task_deadline: Optional[Date] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + checklist_id: Optional[str] = dataclass_field(default=None, kw_only=True) + name: Optional[str] = dataclass_field(default=None, kw_only=True) + summary: Optional[str] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) + progress: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + started_by: Optional[int] = dataclass_field(default=None, kw_only=True) + owner_id: Optional[int] = dataclass_field(default=None, kw_only=True) + prerun: Optional[ + List[PrerunData | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + alerts: Optional[RunAlerts | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + starred: Optional[bool] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + started_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_synced: Optional[Date] = dataclass_field(default=None, kw_only=True) + completed_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + archived_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + due_date_passed: Optional[bool] = dataclass_field(default=None, kw_only=True) + collaborators: Optional[List[int]] = dataclass_field(default=None, kw_only=True) + due_soon: Optional[bool] = dataclass_field(default=None, kw_only=True) + max_task_deadline: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -971,10 +1205,10 @@ class RunMetaInput: Definition: runMetaInput """ - run_id: Optional[str] = None - category: Optional[str] = None - slug: Optional[str] = None - value: Optional[str] = None + run_id: Optional[str] = dataclass_field(default=None, kw_only=True) + category: Optional[str] = dataclass_field(default=None, kw_only=True) + slug: Optional[str] = dataclass_field(default=None, kw_only=True) + value: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -983,11 +1217,16 @@ class Section: Definition: Section """ - id: Optional[str] = None - checklist_id: Optional[str] = None - name: Optional[str] = None - position: Optional[int] = None - condition: Optional[GenericObject] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + checklist_id: Optional[str] = dataclass_field(default=None, kw_only=True) + name: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) + condition: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -996,9 +1235,14 @@ class SectionInput: Definition: SectionInput """ - name: Optional[str] = None - position: Optional[int] = None - condition: Optional[StepCondition] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) + condition: Optional[ + StepCondition | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1007,8 +1251,8 @@ class SectionCreateInput: Definition: SectionCreateInput """ - name: Optional[str] = None - position: Optional[int] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1017,28 +1261,33 @@ class StandaloneTask: Definition: StandaloneTask """ - id: Optional[str] = None - title: Optional[str] = None - run_id: Optional[str] = None - step_id: Optional[str] = None - alias: Optional[str] = None - taskdata: Optional[GenericObject] = None - owners: Optional[StepOwner] = None - is_completable: Optional[int] = None - status: Optional[str] = None - position: Optional[int] = None - deadline: Optional[Date] = None - created_at: Optional[Date] = None - last_updated: Optional[Date] = None - archived_at: Optional[Date] = None - completed_at: Optional[Date] = None - starter_id: Optional[int] = None - completer_id: Optional[int] = None - name: Optional[str] = None - description: Optional[str] = None - owner_id: Optional[int] = None - task_type: Optional[str] = None - is_accepted: Optional[int] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + title: Optional[str] = dataclass_field(default=None, kw_only=True) + run_id: Optional[str] = dataclass_field(default=None, kw_only=True) + step_id: Optional[str] = dataclass_field(default=None, kw_only=True) + alias: Optional[str] = dataclass_field(default=None, kw_only=True) + taskdata: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + owners: Optional[StepOwner | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + is_completable: Optional[int] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) + deadline: Optional[Date] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[Date] = dataclass_field(default=None, kw_only=True) + archived_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + completed_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + starter_id: Optional[int] = dataclass_field(default=None, kw_only=True) + completer_id: Optional[int] = dataclass_field(default=None, kw_only=True) + name: Optional[str] = dataclass_field(default=None, kw_only=True) + description: Optional[str] = dataclass_field(default=None, kw_only=True) + owner_id: Optional[int] = dataclass_field(default=None, kw_only=True) + task_type: Optional[str] = dataclass_field(default=None, kw_only=True) + is_accepted: Optional[int] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1047,11 +1296,11 @@ class CreateStandaloneTaskInput: Definition: createStandaloneTaskInput """ - owners: Optional[StepOwner] = None - task_type: Optional[str] = None - deadline: Optional[RequestDate] = None - description: Optional[str] = None - name: Optional[str] = None + owners: Optional[StepOwner | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + task_type: Optional[str] = dataclass_field(default=None, kw_only=True) + deadline: Optional[RequestDate] = dataclass_field(default=None, kw_only=True) + description: Optional[str] = dataclass_field(default=None, kw_only=True) + name: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1060,13 +1309,18 @@ class UpdateStandaloneTaskInput: Definition: updateStandaloneTaskInput """ - taskdata: Optional[GenericObject] = None - owners: Optional[StepOwner] = None - name: Optional[str] = None - description: Optional[str] = None - task_type: Optional[str] = None - status: Optional[str] = None - deadline: Optional[RequestDate] = None + taskdata: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + owners: Optional[StepOwner | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + name: Optional[str] = dataclass_field(default=None, kw_only=True) + description: Optional[str] = dataclass_field(default=None, kw_only=True) + task_type: Optional[str] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) + deadline: Optional[RequestDate] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1075,8 +1329,8 @@ class StepOwner: Definition: stepOwner """ - users: Optional[List[int]] = None - guests: Optional[List[str]] = None + users: Optional[List[int]] = dataclass_field(default=None, kw_only=True) + guests: Optional[List[str]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1085,10 +1339,10 @@ class StepDeadline: Definition: stepDeadline """ - value: Optional[int] = None - unit: Optional[str] = None - option: Optional[str] = None - step: Optional[str] = None + value: Optional[int] = dataclass_field(default=None, kw_only=True) + unit: Optional[str] = dataclass_field(default=None, kw_only=True) + option: Optional[str] = dataclass_field(default=None, kw_only=True) + step: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1097,11 +1351,11 @@ class StepConditionTerm: Definition: StepConditionTerm """ - subject_id: Optional[str] = None - subject_type: Optional[str] = None - operation: Optional[str] = None - statement: Optional[str] = None - logic: Optional[str] = None + subject_id: Optional[str] = dataclass_field(default=None, kw_only=True) + subject_type: Optional[str] = dataclass_field(default=None, kw_only=True) + operation: Optional[str] = dataclass_field(default=None, kw_only=True) + statement: Optional[str] = dataclass_field(default=None, kw_only=True) + logic: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1110,8 +1364,13 @@ class StepCondition: Definition: StepCondition """ - terms: Optional[List[StepConditionTerm]] = None - flag: Optional[str] = None + terms: Optional[ + List[StepConditionTerm | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + flag: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1120,18 +1379,43 @@ class CreateStepInput: Definition: createStepInput """ - title: Optional[str] = None - checklist_id: Optional[str] = None - summary: Optional[str] = None - rationale: Optional[str] = None - position: Optional[int] = None - owners: Optional[StepOwner] = None - invisibility: Optional[GenericObject] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) + checklist_id: Optional[str] = dataclass_field(default=None, kw_only=True) + summary: Optional[str] = dataclass_field(default=None, kw_only=True) + rationale: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) + owners: Optional[StepOwner | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + invisibility: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of groups the step is invisible to.""" - settings: Optional[GenericObject] = None - metadata: Optional[GenericObject] = None - condition: Optional[StepCondition] = None - captures: Optional[List[CaptureInput]] = None + settings: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + metadata: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + condition: Optional[ + StepCondition | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + captures: Optional[ + List[CaptureInput | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1140,23 +1424,53 @@ class Step: Definition: Step """ - id: Optional[int] = None - checklist_id: Optional[str] = None - summary: Optional[str] = None - title: Optional[str] = None - rationale: Optional[str] = None - position: Optional[int] = None - owners: Optional[StepOwner] = None - invisibility: Optional[GenericObject] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) + checklist_id: Optional[str] = dataclass_field(default=None, kw_only=True) + summary: Optional[str] = dataclass_field(default=None, kw_only=True) + title: Optional[str] = dataclass_field(default=None, kw_only=True) + rationale: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) + owners: Optional[StepOwner | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + invisibility: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of groups the step is invisible to.""" - settings: Optional[GenericObject] = None - metadata: Optional[GenericObject] = None - deadline: Optional[StepDeadline] = None - captures: Optional[GenericObject] = None - condition: Optional[GenericObject] = None - created_at: Optional[RequestDate] = None - last_updated: Optional[RequestDate] = None - archived_at: Optional[RequestDate] = None + settings: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + metadata: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + deadline: Optional[ + StepDeadline | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + captures: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + condition: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + created_at: Optional[RequestDate] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[RequestDate] = dataclass_field(default=None, kw_only=True) + archived_at: Optional[RequestDate] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1165,13 +1479,13 @@ class StepMeta: Definition: StepMeta """ - step_id: Optional[str] = None - category: Optional[str] = None - slug: Optional[str] = None - value: Optional[str] = None - created_at: Optional[Date] = None - last_updated: Optional[Date] = None - archived_at: Optional[Date] = None + step_id: Optional[str] = dataclass_field(default=None, kw_only=True) + category: Optional[str] = dataclass_field(default=None, kw_only=True) + slug: Optional[str] = dataclass_field(default=None, kw_only=True) + value: Optional[str] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[Date] = dataclass_field(default=None, kw_only=True) + archived_at: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1180,11 +1494,11 @@ class Tag: Definition: Tag """ - id: Optional[str] = None - title: Optional[str] = None - items: Optional[int] = None - created_at: Optional[Date] = None - deleted_at: Optional[Date] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + title: Optional[str] = dataclass_field(default=None, kw_only=True) + items: Optional[int] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + deleted_at: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1193,7 +1507,7 @@ class CreateTagInput: Definition: createTagInput """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1202,9 +1516,9 @@ class AddTagInput: Definition: addTagInput """ - tag_id: Optional[str] = None - subject_id: Optional[str] = None - subject_type: Optional[str] = None + tag_id: Optional[str] = dataclass_field(default=None, kw_only=True) + subject_id: Optional[str] = dataclass_field(default=None, kw_only=True) + subject_type: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1213,24 +1527,29 @@ class TaskObject: Definition: Task """ - id: Optional[str] = None - title: Optional[str] = None - run_id: Optional[str] = None - step_id: Optional[str] = None - alias: Optional[str] = None - taskdata: Optional[GenericObject] = None - owners: Optional[StepOwner] = None - is_completable: Optional[bool] = None - status: Optional[str] = None - position: Optional[int] = None - deadline: Optional[Date] = None - created_at: Optional[Date] = None - last_updated: Optional[Date] = None - archived_at: Optional[Date] = None - completed_at: Optional[Date] = None - starter_id: Optional[int] = None - completer_id: Optional[int] = None - run_status: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + title: Optional[str] = dataclass_field(default=None, kw_only=True) + run_id: Optional[str] = dataclass_field(default=None, kw_only=True) + step_id: Optional[str] = dataclass_field(default=None, kw_only=True) + alias: Optional[str] = dataclass_field(default=None, kw_only=True) + taskdata: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + owners: Optional[StepOwner | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + is_completable: Optional[bool] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) + deadline: Optional[Date] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[Date] = dataclass_field(default=None, kw_only=True) + archived_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + completed_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + starter_id: Optional[int] = dataclass_field(default=None, kw_only=True) + completer_id: Optional[int] = dataclass_field(default=None, kw_only=True) + run_status: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1239,12 +1558,12 @@ class Pagination: Definition: Pagination """ - total: Optional[int] = None - count: Optional[int] = None - per_page: Optional[int] = None - current_page: Optional[int] = None - total_pages: Optional[int] = None - links: Optional[GenericObject] = None + total: Optional[int] = dataclass_field(default=None, kw_only=True) + count: Optional[int] = dataclass_field(default=None, kw_only=True) + per_page: Optional[int] = dataclass_field(default=None, kw_only=True) + current_page: Optional[int] = dataclass_field(default=None, kw_only=True) + total_pages: Optional[int] = dataclass_field(default=None, kw_only=True) + links: Optional[GenericObject | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1253,9 +1572,14 @@ class TasksListMeta: Definition: TasksListMeta """ - overdue_tasks: Optional[int] = None - tasks_due_soon: Optional[int] = None - pagination: Optional[Pagination] = None + overdue_tasks: Optional[int] = dataclass_field(default=None, kw_only=True) + tasks_due_soon: Optional[int] = dataclass_field(default=None, kw_only=True) + pagination: Optional[ + Pagination | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1264,8 +1588,13 @@ class TasksList: Definition: TasksList """ - data: Optional[List[TaskObject]] = None - meta: Optional[TasksListMeta] = None + data: Optional[ + List[TaskObject | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + meta: Optional[TasksListMeta | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1274,25 +1603,35 @@ class CompletedProcessTask: Definition: CompletedProcessTask """ - id: Optional[str] = None - title: Optional[str] = None - run_id: Optional[str] = None - step_id: Optional[str] = None - alias: Optional[str] = None - taskdata: Optional[GenericObject] = None - owners: Optional[StepOwner] = None - is_completable: Optional[bool] = None - status: Optional[str] = None - position: Optional[int] = None - deadline: Optional[Date] = None - created_at: Optional[Date] = None - last_updated: Optional[Date] = None - archived_at: Optional[Date] = None - completed_at: Optional[Date] = None - starter_id: Optional[int] = None - completer_id: Optional[int] = None - run_status: Optional[str] = None - tasks_changed_by_rules: Optional[GenericObject] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) + title: Optional[str] = dataclass_field(default=None, kw_only=True) + run_id: Optional[str] = dataclass_field(default=None, kw_only=True) + step_id: Optional[str] = dataclass_field(default=None, kw_only=True) + alias: Optional[str] = dataclass_field(default=None, kw_only=True) + taskdata: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + owners: Optional[StepOwner | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + is_completable: Optional[bool] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) + deadline: Optional[Date] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[Date] = dataclass_field(default=None, kw_only=True) + archived_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + completed_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + starter_id: Optional[int] = dataclass_field(default=None, kw_only=True) + completer_id: Optional[int] = dataclass_field(default=None, kw_only=True) + run_status: Optional[str] = dataclass_field(default=None, kw_only=True) + tasks_changed_by_rules: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1301,12 +1640,17 @@ class UpdateTaskInput: Definition: updateTaskInput """ - taskdata: Optional[GenericObject] = None - threads: Optional[Dict[str, Any]] = None - owners: Optional[StepOwner] = None - status: Optional[str] = None - position: Optional[int] = None - deadline: Optional[Date] = None + taskdata: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + threads: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + owners: Optional[StepOwner | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) + position: Optional[int] = dataclass_field(default=None, kw_only=True) + deadline: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1315,19 +1659,34 @@ class TaskGuest: Definition: TaskGuest """ - alias: Optional[str] = None - organization: Optional[GenericObject] = None - taskdata: Optional[GenericObject] = None - threads: Optional[GenericObject] = None - status: Optional[str] = None - is_completable: Optional[bool] = None - deadline: Optional[Date] = None - created_at: Optional[Date] = None - last_updated: Optional[Date] = None - completed_at: Optional[Date] = None - step: Optional[Step] = None - step_id: Optional[int] = None - guest_email: Optional[str] = None + alias: Optional[str] = dataclass_field(default=None, kw_only=True) + organization: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + taskdata: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + threads: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + status: Optional[str] = dataclass_field(default=None, kw_only=True) + is_completable: Optional[bool] = dataclass_field(default=None, kw_only=True) + deadline: Optional[Date] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[Date] = dataclass_field(default=None, kw_only=True) + completed_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + step: Optional[Step | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + step_id: Optional[int] = dataclass_field(default=None, kw_only=True) + guest_email: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1336,8 +1695,13 @@ class UpdateGuestsTasksInput: Definition: updateGuestsTasksInput """ - taskdata: Optional[GenericObject] = None - status: Optional[str] = None + taskdata: Optional[ + GenericObject | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + status: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1346,7 +1710,7 @@ class CreateGuestsTasksComment: Definition: createGuestsTasksComment """ - content: Optional[str] = None + content: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1355,8 +1719,8 @@ class TaskMetaInput: Definition: TaskMetaInput """ - slug: Optional[str] = None - value: Optional[GenericObject] = None + slug: Optional[str] = dataclass_field(default=None, kw_only=True) + value: Optional[GenericObject | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1365,12 +1729,12 @@ class TaskMeta: Definition: TaskMeta """ - task_id: Optional[str] = None - slug: Optional[str] = None - value: Optional[str] = None - created_at: Optional[Date] = None - last_updated: Optional[Date] = None - archived_at: Optional[Date] = None + task_id: Optional[str] = dataclass_field(default=None, kw_only=True) + slug: Optional[str] = dataclass_field(default=None, kw_only=True) + value: Optional[str] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[Date] = dataclass_field(default=None, kw_only=True) + archived_at: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1379,7 +1743,7 @@ class ThreadInput: Definition: threadInput """ - content: Optional[str] = None + content: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1388,8 +1752,8 @@ class ThreadResolveInput: Definition: threadResolveInput """ - thread_id: Optional[str] = None - content: Optional[str] = None + thread_id: Optional[str] = dataclass_field(default=None, kw_only=True) + content: Optional[str] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1398,14 +1762,14 @@ class Thread: Definition: Thread """ - id: Optional[int] = None - label: Optional[str] = None - sent_by: Optional[int] = None - content: Optional[str] = None - created_at: Optional[Date] = None - sent_to: Optional[List[int]] = None - last_updated_at: Optional[Date] = None - archived_at: Optional[Date] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) + label: Optional[str] = dataclass_field(default=None, kw_only=True) + sent_by: Optional[int] = dataclass_field(default=None, kw_only=True) + content: Optional[str] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + sent_to: Optional[List[int]] = dataclass_field(default=None, kw_only=True) + last_updated_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + archived_at: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1414,23 +1778,23 @@ class User: Definition: User """ - id: Optional[int] = None - email: Optional[str] = None - username: Optional[str] = None - first_name: Optional[str] = None - last_name: Optional[str] = None - full_name: Optional[str] = None - phone: Optional[str] = None - job_title: Optional[str] = None - job_description: Optional[str] = None - profile_pic: Optional[str] = None - locale: Optional[str] = None - active: Optional[bool] = None - is_suspended: Optional[bool] = None - country: Optional[str] = None - created_at: Optional[Date] = None - last_updated: Optional[Date] = None - last_login_at: Optional[Date] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) + email: Optional[str] = dataclass_field(default=None, kw_only=True) + username: Optional[str] = dataclass_field(default=None, kw_only=True) + first_name: Optional[str] = dataclass_field(default=None, kw_only=True) + last_name: Optional[str] = dataclass_field(default=None, kw_only=True) + full_name: Optional[str] = dataclass_field(default=None, kw_only=True) + phone: Optional[str] = dataclass_field(default=None, kw_only=True) + job_title: Optional[str] = dataclass_field(default=None, kw_only=True) + job_description: Optional[str] = dataclass_field(default=None, kw_only=True) + profile_pic: Optional[str] = dataclass_field(default=None, kw_only=True) + locale: Optional[str] = dataclass_field(default=None, kw_only=True) + active: Optional[bool] = dataclass_field(default=None, kw_only=True) + is_suspended: Optional[bool] = dataclass_field(default=None, kw_only=True) + country: Optional[str] = dataclass_field(default=None, kw_only=True) + created_at: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_updated: Optional[Date] = dataclass_field(default=None, kw_only=True) + last_login_at: Optional[Date] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1439,10 +1803,10 @@ class AccessToken: Definition: AccessToken """ - access_token: Optional[str] = None - token_type: Optional[str] = None - expire: Optional[int] = None - expires_in: Optional[int] = None + access_token: Optional[str] = dataclass_field(default=None, kw_only=True) + token_type: Optional[str] = dataclass_field(default=None, kw_only=True) + expire: Optional[int] = dataclass_field(default=None, kw_only=True) + expires_in: Optional[int] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1451,7 +1815,7 @@ class GenericObject: Definition: GenericObject """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1464,8 +1828,8 @@ class Client: Definition: Client """ - name: Optional[str] = None - redirect: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) + redirect: Optional[str] = dataclass_field(default=None, kw_only=True) # Client Class @@ -1479,7 +1843,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1496,8 +1860,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1518,7 +1882,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1533,17 +1897,94 @@ def __init__( def connector_name(self) -> str: return "tallyfy" - async def get_user_tasks_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def get_user_tasks( self, org: str, user_id: int, + *, q: Optional[str] = None, status: Optional[str] = None, sort: Optional[str] = None, tag: Optional[str] = None, page: Optional[int] = None, per_page: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1553,6 +1994,29 @@ async def get_user_tasks_async( Get a member's tasks Get all tasks that belong to a specific member + + Swagger operation ID: `Get_User_Tasks`. + + Args: + org: Organization Id. + user_id: Member Id. + q: Search Tasks by their Process name. + status: You can search all Tasks by status. + sort: Add minus sign (-) before sort value if you want to sort + records in descending order. Ex: sort=-improvements. + tag: Search Tasks by Tag name. + page: Which results page to retrieve. Default is 1. + per_page: How many Tasks per page. Default is 10. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1596,7 +2060,7 @@ async def get_user_tasks_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1610,6 +2074,7 @@ async def get_user_tasks_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1617,9 +2082,9 @@ async def get_user_tasks_async( return json.loads(response.text) - async def invite_user_to_organization_async( + async def invite_user_to_organization( self, - input: InviteUserToOrganizationInput, + input: InviteUserToOrganizationInput | Mapping[str, Any], org: str, *, timeout: Optional[float] = None, @@ -1631,13 +2096,30 @@ async def invite_user_to_organization_async( Invite a new member to your organization Invite a new member to your organization + + Swagger operation ID: `Invite_User_To_Organization`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + org: Organization Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/organizations/{quote(str(org), safe='')}/users/invite" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1651,6 +2133,7 @@ async def invite_user_to_organization_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1658,9 +2141,9 @@ async def invite_user_to_organization_async( return json.loads(response.text) - async def create_run_async( + async def create_run( self, - input: CreateRunInput, + input: CreateRunInput | Mapping[str, Any], org: str, *, timeout: Optional[float] = None, @@ -1672,13 +2155,30 @@ async def create_run_async( Launch a Process Launch a process using a blueprint + + Swagger operation ID: `Create_Run`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + org: Organization Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/organizations/{quote(str(org), safe='')}/runs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1692,6 +2192,7 @@ async def create_run_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1699,9 +2200,9 @@ async def create_run_async( return json.loads(response.text) - async def completed_one_off_task_async( + async def completed_one_off_task( self, - input: CompletedOneOffTaskInput, + input: CompletedOneOffTaskInput | Mapping[str, Any], org: str, *, timeout: Optional[float] = None, @@ -1713,13 +2214,30 @@ async def completed_one_off_task_async( Complete One Off Task Complete one off task + + Swagger operation ID: `Completed_One_Off_Task`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + org: Organization Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/organizations/{quote(str(org), safe='')}/completed-tasks" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1733,6 +2251,7 @@ async def completed_one_off_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1740,7 +2259,7 @@ async def completed_one_off_task_async( return json.loads(response.text) - async def reopen_one_off_task_async( + async def reopen_one_off_task( self, org: str, task: str, @@ -1754,6 +2273,22 @@ async def reopen_one_off_task_async( Reopen One Off Task Reopen one off task + + Swagger operation ID: `Reopen_One_Off_Task`. + + Args: + org: Organization Id. + task: Task Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1763,7 +2298,7 @@ async def reopen_one_off_task_async( f"/{quote(str(task), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1777,6 +2312,7 @@ async def reopen_one_off_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1784,9 +2320,9 @@ async def reopen_one_off_task_async( return json.loads(response.text) - async def completed_process_task_async( + async def completed_process_task( self, - input: CompletedProcessTaskInput, + input: CompletedProcessTaskInput | Mapping[str, Any], org: str, run: str, *, @@ -1799,6 +2335,24 @@ async def completed_process_task_async( Complete process task Complete process task + + Swagger operation ID: `Completed_Process_Task`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + org: Organization Id. + run: Run Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1809,7 +2363,7 @@ async def completed_process_task_async( f"/completed-tasks" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1823,6 +2377,7 @@ async def completed_process_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1830,7 +2385,7 @@ async def completed_process_task_async( return json.loads(response.text) - async def reopen_process_task_async( + async def reopen_process_task( self, org: str, run: str, @@ -1845,6 +2400,23 @@ async def reopen_process_task_async( Reopen process Task Reopen process task + + Swagger operation ID: `Reopen_Process_Task`. + + Args: + org: Organization Id. + run: Run Id. + task: Task Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1856,7 +2428,7 @@ async def reopen_process_task_async( f"/{quote(str(task), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1870,6 +2442,7 @@ async def reopen_process_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1877,9 +2450,9 @@ async def reopen_process_task_async( return json.loads(response.text) - async def comment_task_async( + async def comment_task( self, - input: CommentTaskInput, + input: CommentTaskInput | Mapping[str, Any], org: str, task: str, *, @@ -1892,6 +2465,24 @@ async def comment_task_async( Add comment, report issue, resolve issue on a task task deadline, in date-time format + + Swagger operation ID: `Comment_Task`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + org: Organization Id. + task: Task Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1902,7 +2493,7 @@ async def comment_task_async( f"/comment" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1916,6 +2507,7 @@ async def comment_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1923,9 +2515,9 @@ async def comment_task_async( return json.loads(response.text) - async def create_task_async( + async def create_task( self, - input: CreateTaskInput, + input: CreateTaskInput | Mapping[str, Any], org: str, *, timeout: Optional[float] = None, @@ -1937,6 +2529,23 @@ async def create_task_async( Create a task Create Task + + Swagger operation ID: `Create_Task`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + org: Organization Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1947,7 +2556,7 @@ async def create_task_async( f"/tasks" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1961,6 +2570,7 @@ async def create_task_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1968,9 +2578,9 @@ async def create_task_async( return json.loads(response.text) - async def edit_task_deadline_async( + async def edit_task_deadline( self, - input: EditTaskDeadlineInput, + input: EditTaskDeadlineInput | Mapping[str, Any], org: str, task: str, *, @@ -1983,6 +2593,24 @@ async def edit_task_deadline_async( Edit task deadline Edit deadline of a task + + Swagger operation ID: `Edit_Task_Deadline`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + org: Organization Id. + task: Task id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1995,7 +2623,7 @@ async def edit_task_deadline_async( f"/edit-deadline" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2009,6 +2637,7 @@ async def edit_task_deadline_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2016,7 +2645,7 @@ async def edit_task_deadline_async( return json.loads(response.text) - async def remove_guest_async( + async def remove_guest( self, org: str, task: str, @@ -2031,6 +2660,23 @@ async def remove_guest_async( Remove guest assigned Remove guest of a task + + Swagger operation ID: `Remove_Guest`. + + Args: + org: Organization Id. + task: Task id. + guest: Guest email. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2044,7 +2690,7 @@ async def remove_guest_async( f"/{quote(str(guest), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2058,6 +2704,7 @@ async def remove_guest_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2065,7 +2712,7 @@ async def remove_guest_async( return json.loads(response.text) - async def remove_assignee_async( + async def remove_assignee( self, org: str, task: str, @@ -2080,6 +2727,23 @@ async def remove_assignee_async( Remove assignee Remove assignee of a task + + Swagger operation ID: `Remove_Assignee`. + + Args: + org: Organization Id. + task: Task id. + member: Member id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2093,7 +2757,7 @@ async def remove_assignee_async( f"/{quote(str(member), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2107,6 +2771,7 @@ async def remove_assignee_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2114,9 +2779,9 @@ async def remove_assignee_async( return json.loads(response.text) - async def edit_step_type_async( + async def edit_step_type( self, - input: EditStepTypeInput, + input: EditStepTypeInput | Mapping[str, Any], org: str, blueprint: str, step: str, @@ -2130,6 +2795,25 @@ async def edit_step_type_async( Edit step type Edit step type + + Swagger operation ID: `Edit_Step_Type`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + org: Organization Id. + blueprint: Blueprint id. + step: Step id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2144,7 +2828,7 @@ async def edit_step_type_async( f"/edit-step-type" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2158,6 +2842,7 @@ async def edit_step_type_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2165,7 +2850,7 @@ async def edit_step_type_async( return json.loads(response.text) - async def get_user_organizations_async( + async def get_user_organizations( self, *, timeout: Optional[float] = None, @@ -2177,10 +2862,24 @@ async def get_user_organizations_async( Get user's organizations Get user's organizations + + Swagger operation ID: `Get_User_Organizations`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/me/organizations" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2194,6 +2893,7 @@ async def get_user_organizations_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2201,7 +2901,7 @@ async def get_user_organizations_async( return json.loads(response.text) - async def get_organization_users_async( + def list_organization_users( self, org: str, *, @@ -2209,34 +2909,73 @@ async def get_organization_users_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get organization's users Get all users belonging to an organization + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Get_Organization_Users`. + + Args: + org: Organization Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/organizations/{quote(str(org), safe='')}/users" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("data", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/teams.py b/src/azure/connectors/teams.py index fd50fd32..65d92635 100644 --- a/src/azure/connectors/teams.py +++ b/src/azure/connectors/teams.py @@ -5,11 +5,13 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Literal, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core import MatchConditions +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +20,170 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "TeamsClient", + "Activities", + "AddMemberToChannelInput", + "AddMemberToChatInput", + "AddMemberToTagInput", + "AddMemberToTagResponseSchema", + "AddMemberToTeamInput", + "AddSectionItemInput", + "AiInsightActionItem", + "AiInsightCollectionResponse", + "AiInsightDetailResponse", + "AiInsightMeetingNote", + "AiInsightMeetingNoteSubpoint", + "AiInsightMentionEvent", + "AiInsightResponse", + "AiInsightViewpoint", + "AiInsightWebhookResponseSchema", + "ArchiveChannelInput", + "AssociatedTeamInfo", + "AsyncOperationResponse", + "AtMentionBotResponse", + "AtMentionTagResponse", + "AtMentionUser", + "BotIdForChat", + "BotMentionRequest", + "CallEventWebhookResponseSchema", + "CallRecordingCollectionResponse", + "CallRecordingResponse", + "CallTranscriptCollectionResponse", + "CallTranscriptResponse", + "CardResponseTriggerMetadata", + "ChannelIdForTeam", + "ChannelIds", + "ChannelWithOwnerTeamId", + "ChatId", + "ChatMessage", + "ChatMessageList", + "ChatMessageWebhookResponseSchema", + "ComposeMessageTriggerMetadata", + "ConnectorMetadata", + "CreateATeamInput", + "CreateATeamResponse", + "CreateChannelInput", + "CreateChannelResponse", + "CreateSectionInput", + "CreateTagInput", + "CreateTagResponseSchema", + "DiscoverySettings", + "DraftOpenShift", + "DraftShift", + "DynamicAiInsightTriggerRequest", + "DynamicAtMentionWebhookTriggerResponseSchema", + "DynamicCallEventTriggerRequest", + "DynamicCardResponseTriggerResult", + "DynamicChannelAdaptiveCardRequest", + "DynamicChannelFlowContinuationSubscriptionResult", + "DynamicChannelNotificationRequest", + "DynamicComposeMessageTriggerResult", + "DynamicGatherInputSubscriptionResult", + "DynamicGetMessageDetailsResponseSchema", + "DynamicGetMessageDetailsSchema", + "DynamicKeywordWebhookTriggerResponseSchema", + "DynamicListMembersSchema", + "DynamicNewMessageWebhookTriggerResponseSchema", + "DynamicPostCardAndWaitRequest", + "DynamicPostCardRequest", + "DynamicPostConversationNotificationRequest", + "DynamicPostFeedNotificationRequest", + "DynamicPostGatherInputToConversationResponse", + "DynamicPostMessageRequest", + "DynamicPostToConversationResponse", + "DynamicRecordingTriggerRequest", + "DynamicReplyCardRequest", + "DynamicReplyMessageRequest", + "DynamicResponseSchema", + "DynamicSelectedMessageTriggerResult", + "DynamicTranscriptTriggerRequest", + "DynamicUpdateCardRequest", + "DynamicUserAdaptiveCardRequest", + "DynamicUserFlowContinuationSubscriptionResult", + "DynamicUserMessageWithOptionsSubscriptionRequest", + "DynamicUserMessageWithOptionsSubscriptionResult", + "DynamicUserNotificationRequest", + "DynamicWebhookTriggerRequestSchema", + "EditOpenShiftRequest", + "FunSettings", + "GetAllAssociatedTeamsResponse", + "GetAllChannelsForTeamResponse", + "GetAllTeamsResponse", + "GetChannelResponse", + "GetChannelsForGroupResponse", + "GetChatsResponse", + "GetFlowContinuationSubscriptionWithPosterOutputMetadataInput", + "GetMessageDetailsSchema", + "GetMessageLocationsResponse", + "GetMessagesFromConversationResponse", + "GetOnlineMeetingResponse", + "GetTagMembersResponseSchema", + "GetTagsResponseSchema", + "GetTeamResponse", + "GetTimeOffReasonsResponse", + "GuestSettings", + "LastModifiedBy", + "ListMembersResponseSchema", + "ListMembersSchema", + "ListRepliesResponseSchema", + "ListSectionItemsResponse", + "ListSectionsResponse", + "MemberSettings", + "MessageId", + "MessageReactionWebhookResponseSchema", + "MessagingSettings", + "MoveSectionItemInput", + "NewChat", + "NewChatResponse", + "NewMeeting", + "NewMeetingResponse", + "ObjectEntity", + "ObjectWithoutType", + "OfferShiftRequestResponse", + "OnGroupMemberChangeResponse", + "OpenShiftChangeRequestResponse", + "OpenShiftResponse", + "PostCardAndWaitForResponseInput", + "PostCardAndWaitSchema", + "PostCardSchema", + "PostFeedSchema", + "PostMessageSchema", + "PostMessageToSelfRequest", + "PostToConversationResponse", + "RecordingWebhookResponseSchema", + "ScheduleResponse", + "SchedulingGroupResponse", + "SectionItemConflictError", + "SectionItemResponse", + "SectionResponse", + "SelectedMessageTriggerMetadata", + "SharedOpenShift", + "SharedShift", + "ShiftResponse", + "SingleTagMemberTriggerRequest", + "SingleTagTriggerRequest", + "SwapShiftsChangeRequestResponse", + "TagMemberWebhookResponseSchema", + "TagWebhookResponseSchema", + "TeamsIdentitySet", + "ThemeEditor", + "TimeOffRequestResponse", + "TranscriptWebhookResponseSchema", + "UnifiedActionSchema", + "UpdateChannelPropertiesInput", + "UpdateSectionInput", + "UpdateTagInput", + "VirtualAgentBots", + "WebhookChatMessageTriggerInput", + "WebhookRequest", + "WebhookTriggerSchema", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,128 +193,149 @@ class NewMeetingResponse: Response for Create a Teams meeting """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier for the event""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """Timestamp the event was created""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """Timestamp the event was last modified""" - categories: Optional[List[Any]] = None + categories: Optional[List[Any]] = dataclass_field(default=None, kw_only=True) """The categories associated with the event""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timeZone"}, ) """Time zone of the event""" - reminder_minutes_before_start: Optional[int] = field( + reminder_minutes_before_start: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderMinutesBeforeStart"}, ) """ The number of minutes before the event start time that the reminder alert occurs """ - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """Set to true if an alert is set to remind the user of the event""" - has_attachments: Optional[bool] = field( + has_attachments: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "hasAttachments"}, ) """Set to true if the event has attachments""" - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """The text of the event's subject line""" - body_preview: Optional[str] = field( + body_preview: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "bodyPreview"}, ) """The preview of the message associated with the event""" - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """ The importance of the event. The possible values are: low, normal, high """ - sensitivity: Optional[str] = None + sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True) """Sensitivity of the event""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAllDay"}, ) """Set to true if the event lasts all day""" - is_cancelled: Optional[bool] = field( + is_cancelled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isCancelled"}, ) """Set to true if the event has been canceled""" - is_organizer: Optional[bool] = field( + is_organizer: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOrganizer"}, ) """Set to true if the calendar owner is the organizer of the event""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseRequested"}, ) """The organizer would like an invitee to send a response to the event""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showAs"}, ) """ The status to show. Possible values are: free, tentative, busy, oof, workingElsewhere, unknown. """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ The event type. Possible values are: singleInstance, occurrence, exception, seriesMaster """ - web_link: Optional[str] = field( + web_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webLink"}, ) """The URL to open the event in Outlook on the web.""" - online_meeting_url: Optional[str] = field( + online_meeting_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onlineMeetingUrl"}, ) """A URL for an online meeting""" - allow_new_time_proposals: Optional[bool] = field( + allow_new_time_proposals: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowNewTimeProposals"}, ) """ True if the meeting organizer allows invitees to propose a new time when responding """ - recurrence: Optional[Dict[str, Any]] = None + recurrence: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The recurrence pattern for the event""" - response_status: Optional[Dict[str, Any]] = field( + response_status: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseStatus"}, ) """Indicates the type of response sent in response to an event message""" - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The body of the message associated with the event""" - start: Optional[Dict[str, Any]] = None + start: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The start date, time, and time zone of the event""" - end: Optional[Dict[str, Any]] = None + end: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The date, time, and time zone that the event ends""" - location: Optional[Dict[str, Any]] = None + location: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The location of the event""" - attendees: Optional[List[Dict[str, Any]]] = None + attendees: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """The collection of attendees for the event""" - organizer: Optional[Dict[str, Any]] = None + organizer: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Organizer""" - online_meeting: Optional[Dict[str, Any]] = field( + online_meeting: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "onlineMeeting"}, ) """Details for an attendee to join the meeting online.""" @@ -162,11 +347,12 @@ class GetAllTeamsResponse: Response for List joined teams """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of the teams you are a member of""" @@ -176,11 +362,17 @@ class GetAllAssociatedTeamsResponse: Response for List associated teams """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[AssociatedTeamInfo]] = None + value: Optional[ + List[AssociatedTeamInfo | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of the teams you are associated with""" @@ -190,11 +382,17 @@ class GetChannelsForGroupResponse: Response for List channels """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[GetChannelResponse]] = None + value: Optional[ + List[GetChannelResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of one or more channels for a specific team""" @@ -204,15 +402,13 @@ class CreateChannelInput: Create a channel """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Optional textual description for the channel""" - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """Channel name as it appears in Microsoft Teams""" - membership_type: Optional[str] = field( + membership_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "membershipType"}, ) """ @@ -228,17 +424,19 @@ class CreateChannelResponse: Response for Create a channel """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Optional textual description for the channel""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Channel name as it appears in Microsoft Teams""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The channel's unique identifier""" - membership_type: Optional[str] = field( + membership_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "membershipType"}, ) """The type of channel membership""" @@ -250,39 +448,45 @@ class GetChannelResponse: Response for Get details for a specific channel in a team """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique identifier of the channel""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The name of the channel""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the channel, optional""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address for sending messages to the channel""" - tenant_id: Optional[str] = field( + tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tenantId"}, ) """The ID of the Microsoft Entra tenant.""" - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """A hyperlink for the channel in Microsoft Teams""" - files_folder_web_url: Optional[str] = field( + files_folder_web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filesFolderWebUrl"}, ) """The SharePoint folder URL of the channel""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """Timestamp at which the channel was created. Read only""" - membership_type: Optional[str] = field( + membership_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "membershipType"}, ) """The channel membership type""" @@ -294,12 +498,13 @@ class UpdateChannelPropertiesInput: Update channel """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The new display name for the channel.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The new description for the channel.""" @@ -309,8 +514,9 @@ class ArchiveChannelInput: Archive a channel """ - should_set_spo_site_read_only_for_members: Optional[bool] = field( + should_set_spo_site_read_only_for_members: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shouldSetSpoSiteReadOnlyForMembers"}, ) """ @@ -325,7 +531,7 @@ class AsyncOperationResponse: Response for Archive a channel """ - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status of the asynchronous operation""" @@ -335,11 +541,17 @@ class GetAllChannelsForTeamResponse: Response for List all channels """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[ChannelWithOwnerTeamId]] = None + value: Optional[ + List[ChannelWithOwnerTeamId | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of one or more channels for a specific team""" @@ -349,11 +561,12 @@ class GetChatsResponse: Response for List chats """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of one or more chats you are a part of""" @@ -363,8 +576,9 @@ class AtMentionTagResponse: Response for Get an @mention token for a team tag """ - at_mention: Optional[str] = field( + at_mention: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "atMention"}, ) """ @@ -379,22 +593,25 @@ class GetMessagesFromConversationResponse: Response for Get messages in a channel """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) """@odata.context""" - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.count"}, ) """@odata.count""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """@odata.nextLink""" - value: Optional[ChatMessageList] = None + value: Optional[ChatMessageList] = dataclass_field(default=None, kw_only=True) @dataclass @@ -403,7 +620,7 @@ class DynamicGetMessageDetailsResponseSchema: Response for Get message details """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -416,7 +633,7 @@ class ListRepliesResponseSchema: Response for List replies of a channel message """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List replies response""" @@ -426,11 +643,11 @@ class ListMembersResponseSchema: Response for List chat or channel members """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List members response""" -ChatMessageList = List["ChatMessage"] +ChatMessageList = List["ChatMessage | Mapping[str, Any]"] @dataclass @@ -439,8 +656,9 @@ class WebhookChatMessageTriggerInput: When a new chat message is added """ - notification_url: Optional[str] = field( + notification_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationUrl"}, ) @@ -451,48 +669,57 @@ class GetTeamResponse: Response for Get a team """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique identifier of the team""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The name of the team""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the team, optional""" - internal_id: Optional[str] = field( + internal_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "internalId"}, ) """The internal ID of the team""" - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """A hyperlink that will go to the team in the Microsoft Teams client""" - is_archived: Optional[bool] = field( + is_archived: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isArchived"}, ) """Whether this team is in read-only mode""" - member_settings: Optional[MemberSettings] = field( + member_settings: Optional[MemberSettings | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "memberSettings"}, ) - guest_settings: Optional[GuestSettings] = field( + guest_settings: Optional[GuestSettings | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "guestSettings"}, ) - messaging_settings: Optional[MessagingSettings] = field( + messaging_settings: Optional[MessagingSettings | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "messagingSettings"}, ) - fun_settings: Optional[FunSettings] = field( + fun_settings: Optional[FunSettings | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "funSettings"}, ) - discovery_settings: Optional[DiscoverySettings] = field( + discovery_settings: Optional[DiscoverySettings | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "discoverySettings"}, ) @@ -503,8 +730,9 @@ class AtMentionUser: Response for Get an @mention token for a user """ - at_mention: Optional[str] = field( + at_mention: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "atMention"}, ) """ @@ -521,7 +749,7 @@ class NewChatResponse: Response for Create a chat """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The chat's unique identifier""" @@ -531,61 +759,66 @@ class ChatMessage: Response for Post a message to myself """ - attachments: Optional[List[Dict[str, Any]]] = None + attachments: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """attachments""" - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Plaintext representation of the content of the message""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """Timestamp of when the chat message was created""" - deleted: Optional[bool] = None + deleted: Optional[bool] = dataclass_field(default=None, kw_only=True) """deleted""" - etag: Optional[str] = None + etag: Optional[str] = dataclass_field(default=None, kw_only=True) """Version number of the chat message.""" - from_: Optional[Dict[str, Any]] = field( + from_: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "from"}, ) """The message sender""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the message""" - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """ The importance of the message. The possible values are: normal, high, urgent. """ - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """ Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed """ - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """Locale of the chat message set by the client.""" - mentions: Optional[List[Dict[str, Any]]] = None + mentions: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """ List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel. """ - message_type: Optional[str] = field( + message_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "messageType"}, ) """The type of chat message""" - reactions: Optional[List[Dict[str, Any]]] = None + reactions: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Reactions for this chat message (for example, Like)""" - reply_to_id: Optional[str] = field( + reply_to_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "replyToId"}, ) """ID of the parent message of the thread""" - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """The subject of the chat message, optional""" - summary: Optional[str] = None + summary: Optional[str] = dataclass_field(default=None, kw_only=True) """ Summary text of the message that could be used for push notifications and summary views or fall back views @@ -598,14 +831,11 @@ class CreateATeamInput: Create a team """ - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """The name of the team""" - description: Optional[str] = None + description: str """An optional description for the team""" - visibility: Optional[str] = None + visibility: Optional[str] = dataclass_field(default=None, kw_only=True) """The visibility of the the team""" @@ -615,8 +845,9 @@ class CreateATeamResponse: Response for Create a team """ - new_team_id: Optional[str] = field( + new_team_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "newTeamId"}, ) """Team ID of the team that was just created""" @@ -628,12 +859,9 @@ class AddMemberToTeamInput: Add a member to a team """ - user_id: Optional[str] = field( - default=None, - metadata={"wire_name": "userId"}, - ) + user_id: str = dataclass_field(metadata={"wire_name": "userId"}) """User principal name or Microsoft Entra ID to add""" - owner: Optional[bool] = None + owner: Optional[bool] = dataclass_field(default=None, kw_only=True) """True, if the user should be a team owner""" @@ -643,12 +871,9 @@ class AddMemberToChannelInput: Add a member to a channel """ - user_id: Optional[str] = field( - default=None, - metadata={"wire_name": "userId"}, - ) + user_id: str = dataclass_field(metadata={"wire_name": "userId"}) """User principal name or Microsoft Entra ID to add""" - owner: Optional[bool] = None + owner: Optional[bool] = dataclass_field(default=None, kw_only=True) """True, if the user should be a channel owner""" @@ -658,15 +883,17 @@ class PostToConversationResponse: Response for Post message in a chat or channel """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique message ID""" - message_link: Optional[str] = field( + message_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "messageLink"}, ) """Link to the message in Microsoft Teams""" - conversation_id: Optional[str] = field( + conversation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "conversationId"}, ) """The chat's unique identifier""" @@ -678,11 +905,10 @@ class PostCardAndWaitForResponseInput: Post adaptive card and wait for a response """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "notificationUrl"}, ) - body: Optional[Dict[str, Any]] = None + body: Dict[str, Any] @dataclass @@ -691,7 +917,7 @@ class DynamicPostGatherInputToConversationResponse: Response for Post adaptive card and wait for a response """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -704,7 +930,7 @@ class ObjectWithoutType: Response for Send a Microsoft Graph HTTP request """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -717,15 +943,13 @@ class AddMemberToChatInput: Add a user to a chat """ - user_id: Optional[str] = field( - default=None, - metadata={"wire_name": "userId"}, - ) + user_id: str = dataclass_field(metadata={"wire_name": "userId"}) """User principal name or Microsoft Entra ID to add""" - owner: Optional[bool] = None + owner: Optional[bool] = dataclass_field(default=None, kw_only=True) """True, if the user should be a chat owner""" - visible_history_start_date_time: Optional[str] = field( + visible_history_start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "visibleHistoryStartDateTime"}, ) """ @@ -740,72 +964,84 @@ class GetOnlineMeetingResponse: Response for Get an online meeting """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique identifier of the online meeting""" - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """The subject of the online meeting""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """The start time of the meeting in UTC""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """The end time of the meeting in UTC""" - creation_date_time: Optional[str] = field( + creation_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creationDateTime"}, ) """The creation time of the meeting in UTC""" - join_web_url: Optional[str] = field( + join_web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "joinWebUrl"}, ) """The URL used to join the meeting online""" - join_meeting_id_settings: Optional[Dict[str, Any]] = field( + join_meeting_id_settings: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "joinMeetingIdSettings"}, ) """Settings related to the join meeting ID""" - participants: Optional[Dict[str, Any]] = None + participants: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The participants of the meeting""" - audio_conferencing: Optional[Dict[str, Any]] = field( + audio_conferencing: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "audioConferencing"}, ) """Phone call-in information for the meeting""" - is_entry_exit_announced: Optional[bool] = field( + is_entry_exit_announced: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isEntryExitAnnounced"}, ) """ Whether announce notifications are enabled for callers joining or leaving the meeting """ - allowed_presenters: Optional[str] = field( + allowed_presenters: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowedPresenters"}, ) """Specifies who can be a presenter in the meeting""" - lobby_bypass_settings: Optional[Dict[str, Any]] = field( + lobby_bypass_settings: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lobbyBypassSettings"}, ) """Specifies which participants can bypass the meeting lobby""" - record_automatically: Optional[bool] = field( + record_automatically: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordAutomatically"}, ) """Indicates whether to record the meeting automatically""" - allow_meeting_chat: Optional[str] = field( + allow_meeting_chat: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowMeetingChat"}, ) """Specifies the mode of meeting chat""" - meeting_options_web_url: Optional[str] = field( + meeting_options_web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingOptionsWebUrl"}, ) """A URL for the organizer to change settings for the meeting""" @@ -817,11 +1053,17 @@ class CallTranscriptCollectionResponse: Response for List meeting transcripts """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[CallTranscriptResponse]] = None + value: Optional[ + List[CallTranscriptResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of transcripts""" @@ -831,30 +1073,35 @@ class CallTranscriptResponse: Response for Get meeting transcript """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The transcript ID""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The date and time when the transcript was created""" - transcript_content_url: Optional[str] = field( + transcript_content_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "transcriptContentUrl"}, ) """The URL to access the transcript content""" - meeting_id: Optional[str] = field( + meeting_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingId"}, ) """The meeting ID""" - meeting_organizer_id: Optional[str] = field( + meeting_organizer_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingOrganizerId"}, ) """The meeting organizer's user ID""" - call_id: Optional[str] = field( + call_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callId"}, ) """The call ID""" @@ -866,11 +1113,17 @@ class CallRecordingCollectionResponse: Response for List meeting recordings """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[CallRecordingResponse]] = None + value: Optional[ + List[CallRecordingResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of recordings""" @@ -880,30 +1133,35 @@ class CallRecordingResponse: Response for Get meeting recording """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The recording ID""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The date and time when the recording was created""" - recording_content_url: Optional[str] = field( + recording_content_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordingContentUrl"}, ) """The URL to access the recording content""" - meeting_id: Optional[str] = field( + meeting_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingId"}, ) """The meeting ID""" - meeting_organizer_id: Optional[str] = field( + meeting_organizer_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingOrganizerId"}, ) """The meeting organizer's user ID""" - call_id: Optional[str] = field( + call_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callId"}, ) """The call ID""" @@ -915,19 +1173,26 @@ class ListSectionsResponse: Response for List sections """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - microsoft_graph_sections_version: Optional[str] = field( + microsoft_graph_sections_version: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@microsoft.graph.sectionsVersion"}, ) """ Version identifier for the sections hierarchy. Pass as If-Match on Create, Update, Delete, Add Item, Remove Item, and Move Item operations. """ - value: Optional[List[SectionResponse]] = None + value: Optional[ + List[SectionResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of sections""" @@ -937,26 +1202,26 @@ class CreateSectionInput: Create a section """ - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """The display name of the section""" - display_icon: Optional[Dict[str, Any]] = field( + display_icon: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayIcon"}, ) """ The display icon for the section. Only iconType is writable; other fields are populated by the service. """ - is_expanded: Optional[bool] = field( + is_expanded: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isExpanded"}, ) """Whether the section is expanded""" - sort_type: Optional[str] = field( + sort_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortType"}, ) """The sort type for the section""" @@ -968,48 +1233,56 @@ class SectionResponse: Response for Create a section """ - etag: Optional[str] = field( + etag: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.etag"}, ) """ ETag for the sections collection. Pass as If-Match on Create, Update, and Delete. """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The section ID""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The display name of the section""" - display_icon: Optional[Dict[str, Any]] = field( + display_icon: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayIcon"}, ) """The display icon for the section""" - is_expanded: Optional[bool] = field( + is_expanded: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isExpanded"}, ) """Whether the section is expanded""" - sort_type: Optional[str] = field( + sort_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortType"}, ) """The sort type for the section""" - section_type: Optional[str] = field( + section_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sectionType"}, ) """The type of section""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The date and time when the section was created""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """The date and time when the section was last modified""" @@ -1021,26 +1294,30 @@ class UpdateSectionInput: Update a section """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The display name of the section""" - display_icon: Optional[Dict[str, Any]] = field( + display_icon: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayIcon"}, ) """ The display icon for the section. Only iconType is writable; other fields are populated by the service. """ - is_expanded: Optional[bool] = field( + is_expanded: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isExpanded"}, ) """Whether the section is expanded""" - sort_type: Optional[str] = field( + sort_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortType"}, ) """The sort type for the section""" @@ -1052,11 +1329,17 @@ class ListSectionItemsResponse: Response for List section items """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[SectionItemResponse]] = None + value: Optional[ + List[SectionItemResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of section items""" @@ -1066,7 +1349,7 @@ class AddSectionItemInput: Add an item to a section """ - id: Optional[str] = None + id: str """ The conversation ID of the chat, channel, meeting, or community to add to the section. For community items, the service automatically normalizes the @@ -1080,31 +1363,35 @@ class SectionItemResponse: Response for Add an item to a section """ - etag: Optional[str] = field( + etag: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.etag"}, ) """ ETag for the section items collection. Pass as If-Match on Add, Remove, and Move. """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """ The unique identifier of the item. Corresponds to the conversation ID of the underlying chat, channel, meeting, or community. """ - item_type: Optional[str] = field( + item_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "itemType"}, ) """The type of the item""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The date and time when the item was added to the section""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """The date and time when the item was last modified""" @@ -1116,8 +1403,7 @@ class MoveSectionItemInput: Move a section item """ - target_section_id: Optional[str] = field( - default=None, + target_section_id: str = dataclass_field( metadata={"wire_name": "targetSectionId"}, ) """The ID of the section to move the item to""" @@ -1129,11 +1415,12 @@ class GetTagsResponseSchema: Response for List all tags for a team """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1142,12 +1429,9 @@ class CreateTagInput: Create a tag for a team """ - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """The name of the tag as it appears to the user in Microsoft Teams.""" - members: Optional[str] = None + members: str """ List of users' IDs separated by semi-colons, identifier must be in a format like '550e8400-e29b-41d4-a716-446655440000'. @@ -1160,24 +1444,28 @@ class CreateTagResponseSchema: Response for Create a tag for a team """ - type_: Optional[str] = field( + type_: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.type"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the tag""" - team_id: Optional[str] = field( + team_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamId"}, ) """ID of the team in which the tag is defined""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The name of the tag as it appears to the user in Microsoft Teams.""" - member_count: Optional[int] = field( + member_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "memberCount"}, ) """The number of users assigned to the tag""" @@ -1189,10 +1477,7 @@ class UpdateTagInput: Update a team tag """ - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """The new name of the tag as it appears to the user in Microsoft Teams.""" @@ -1202,10 +1487,7 @@ class AddMemberToTagInput: Add a member to a team tag """ - user_id: Optional[str] = field( - default=None, - metadata={"wire_name": "userId"}, - ) + user_id: str = dataclass_field(metadata={"wire_name": "userId"}) """ The user's ID of the member to add to the tag, must be in a format like '550e8400-e29b-41d4-a716-446655440000'. @@ -1218,8 +1500,9 @@ class AddMemberToTagResponseSchema: Response for Add a member to a team tag """ - user_id: Optional[str] = field( + user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userId"}, ) """User ID of the member added to the tag""" @@ -1231,7 +1514,7 @@ class GetTagMembersResponseSchema: Response for List the members of a team tag """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1240,11 +1523,17 @@ class AiInsightCollectionResponse: Response for List AI insights """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[AiInsightResponse]] = None + value: Optional[ + List[AiInsightResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of AI insights""" @@ -1254,34 +1543,40 @@ class AiInsightDetailResponse: Response for Get AI insight """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The AI insight ID""" - call_id: Optional[str] = field( + call_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callId"}, ) """The call ID""" - content_correlation_id: Optional[str] = field( + content_correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentCorrelationId"}, ) """The content correlation ID""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The date and time when the AI insight was created""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """The date and time when the AI insight ended""" - recap_url: Optional[str] = field( + recap_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recapUrl"}, ) """ @@ -1289,20 +1584,27 @@ class AiInsightDetailResponse: the underlying callAiInsight resource returned by the fetch. Present when the underlying resource provides it; otherwise absent. """ - meeting_notes: Optional[List[AiInsightMeetingNote]] = field( + meeting_notes: Optional[List[AiInsightMeetingNote | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingNotes"}, ) """ Detailed notes of the meeting discussion generated by Microsoft Teams Copilot. """ - action_items: Optional[List[AiInsightActionItem]] = field( + action_items: Optional[List[AiInsightActionItem | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "actionItems"}, ) """Action items generated from the meeting conversation.""" - viewpoint: Optional[AiInsightViewpoint] = None + viewpoint: Optional[ + AiInsightViewpoint | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -1311,7 +1613,7 @@ class GetMessageLocationsResponse: Response for Conversation location for where to post """ - locations: Optional[List[Dict[str, Any]]] = None + locations: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """valid locations to post a message or reply, make verbose""" @@ -1321,7 +1623,7 @@ class GetMessageDetailsSchema: Response for Get message details response schema """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1330,7 +1632,7 @@ class ListMembersSchema: Response for List members input schema """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1339,7 +1641,7 @@ class PostFeedSchema: Response for Get feed notification input metadata """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1348,7 +1650,7 @@ class UnifiedActionSchema: Response for Get unified action input metadata """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1357,9 +1659,9 @@ class ConnectorMetadata: Response for Get message with options subscription input metadata """ - metadatatype: Optional[str] = None - activitytype: Optional[str] = None - schema: Optional[ObjectEntity] = None + metadatatype: Optional[str] = dataclass_field(default=None, kw_only=True) + activitytype: Optional[str] = dataclass_field(default=None, kw_only=True) + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1368,7 +1670,7 @@ class WebhookTriggerSchema: Response for Input schema for webhook trigger """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1377,7 +1679,7 @@ class DynamicResponseSchema: Response for Get response schema """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) GetFlowContinuationSubscriptionWithPosterOutputMetadataInput = str @@ -1389,7 +1691,7 @@ class ObjectEntity: Response for Get subscription scope input schema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1402,7 +1704,7 @@ class PostMessageSchema: Definition: PostMessageSchema """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1411,7 +1713,7 @@ class PostCardSchema: Definition: PostCardSchema """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1420,7 +1722,7 @@ class PostCardAndWaitSchema: Definition: PostCardAndWaitSchema """ - schema: Optional[ObjectEntity] = None + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -1429,7 +1731,7 @@ class DynamicGetMessageDetailsSchema: Definition: DynamicGetMessageDetailsSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1442,7 +1744,7 @@ class DynamicListMembersSchema: Definition: DynamicListMembersSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1455,7 +1757,7 @@ class DynamicUserNotificationRequest: Definition: DynamicUserNotificationRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1468,7 +1770,7 @@ class DynamicPostConversationNotificationRequest: Definition: DynamicPostConversationNotificationRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1481,7 +1783,7 @@ class DynamicChannelNotificationRequest: Definition: DynamicChannelNotificationRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1494,7 +1796,7 @@ class DynamicPostFeedNotificationRequest: Definition: DynamicPostFeedNotificationRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1507,7 +1809,7 @@ class DynamicPostMessageRequest: Definition: DynamicPostMessageRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1520,7 +1822,7 @@ class DynamicReplyMessageRequest: Definition: DynamicReplyMessageRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1533,7 +1835,7 @@ class DynamicPostCardRequest: Definition: DynamicPostCardRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1546,7 +1848,7 @@ class DynamicPostCardAndWaitRequest: Definition: DynamicPostCardAndWaitRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1559,7 +1861,7 @@ class DynamicReplyCardRequest: Definition: DynamicReplyCardRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1572,7 +1874,7 @@ class DynamicUpdateCardRequest: Definition: DynamicUpdateCardRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1585,7 +1887,7 @@ class DynamicUserAdaptiveCardRequest: Definition: DynamicUserAdaptiveCardRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1598,7 +1900,7 @@ class DynamicChannelAdaptiveCardRequest: Definition: DynamicChannelAdaptiveCardRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1611,7 +1913,7 @@ class DynamicUserMessageWithOptionsSubscriptionRequest: Definition: DynamicUserMessageWithOptionsSubscriptionRequest """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1624,7 +1926,7 @@ class DynamicUserMessageWithOptionsSubscriptionResult: Definition: DynamicUserMessageWithOptionsSubscriptionResult """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1637,7 +1939,7 @@ class DynamicSelectedMessageTriggerResult: Definition: DynamicSelectedMessageTriggerResult """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1650,7 +1952,7 @@ class DynamicComposeMessageTriggerResult: Definition: DynamicComposeMessageTriggerResult """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1663,7 +1965,7 @@ class DynamicCardResponseTriggerResult: Definition: DynamicCardResponseTriggerResult """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1676,47 +1978,56 @@ class MessageReactionWebhookResponseSchema: Definition: MessageReactionWebhookResponseSchema """ - thread_type: Optional[str] = field( + thread_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "threadType"}, ) - chat_id: Optional[str] = field( + chat_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "chatId"}, ) """The chat's unique identifier""" - team_id: Optional[str] = field( + team_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamId"}, ) """The team's unique identifier""" - channel_id: Optional[str] = field( + channel_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "channelId"}, ) """The channel's unique identifier""" - message_id: Optional[str] = field( + message_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "messageId"}, ) """Id of the message which was reacted""" - reply_to_id: Optional[str] = field( + reply_to_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "replyToId"}, ) """ID of the parent message of the thread""" - message_link: Optional[str] = field( + message_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "messageLink"}, ) """Link to the message which was reacted""" - user_id: Optional[str] = field( + user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userId"}, ) """Reacting user's Id""" - message_reaction: Optional[str] = field( + message_reaction: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "messageReaction"}, ) """Message reaction used""" @@ -1728,11 +2039,11 @@ class TeamsIdentitySet: Definition: TeamsIdentitySet """ - application: Optional[Dict[str, Any]] = None + application: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Application identity (bot or service)""" - device: Optional[Dict[str, Any]] = None + device: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Device identity""" - user: Optional[Dict[str, Any]] = None + user: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """User identity""" @@ -1742,15 +2053,17 @@ class CallEventWebhookResponseSchema: Definition: CallEventWebhookResponseSchema """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Event identifier""" - id_2: Optional[str] = field( + id_2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.id"}, ) """OData identifier""" - type_: Optional[str] = field( + type_: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.type"}, ) """ @@ -1758,56 +2071,64 @@ class CallEventWebhookResponseSchema: meeting-specific fields are flattened onto the base type by notification delivery). """ - call_event_type: Optional[str] = field( + call_event_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callEventType"}, ) """Type of call event""" - event_date_time: Optional[str] = field( + event_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventDateTime"}, ) """When the event occurred""" - call_conversation_id: Optional[str] = field( + call_conversation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callConversationId"}, ) """Call conversation identifier""" - join_web_url: Optional[str] = field( + join_web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "joinWebUrl"}, ) """ Meeting join URL (populated when the call is associated with an online meeting) """ - chat_info: Optional[Dict[str, Any]] = field( + chat_info: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "chatInfo"}, ) """ Chat information for the meeting (populated when the call is associated with an online meeting) """ - organizer_meeting_info: Optional[Dict[str, Any]] = field( + organizer_meeting_info: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "organizerMeetingInfo"}, ) """ Organizer info (populated when the call is associated with an online meeting) """ - transcription_state: Optional[Dict[str, Any]] = field( + transcription_state: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "transcriptionState"}, ) """Transcription state (set on transcriptionStateUpdated events)""" - recording_state: Optional[Dict[str, Any]] = field( + recording_state: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordingState"}, ) """Recording state (set on recordingStateUpdated events)""" - participants: Optional[List[Dict[str, Any]]] = None + participants: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Participants (set on rosterUpdated events)""" @@ -1817,44 +2138,52 @@ class TranscriptWebhookResponseSchema: Definition: TranscriptWebhookResponseSchema """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Transcript identifier""" - id_2: Optional[str] = field( + id_2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.id"}, ) """OData identifier""" - meeting_id: Optional[str] = field( + meeting_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingId"}, ) """Online meeting identifier (empty for ad-hoc call transcripts)""" - call_id: Optional[str] = field( + call_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callId"}, ) """Call identifier (set for ad-hoc call transcripts)""" - content_correlation_id: Optional[str] = field( + content_correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentCorrelationId"}, ) """Content correlation identifier""" - meeting_organizer: Optional[TeamsIdentitySet] = field( + meeting_organizer: Optional[TeamsIdentitySet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingOrganizer"}, ) - transcript_content_url: Optional[str] = field( + transcript_content_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "transcriptContentUrl"}, ) """URL to download the transcript content""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """When the transcript was created (UTC)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """When the transcript ended (UTC)""" @@ -1866,20 +2195,23 @@ class AiInsightWebhookResponseSchema: Definition: AiInsightWebhookResponseSchema """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """AI insight identifier""" - id_2: Optional[str] = field( + id_2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.id"}, ) """OData identifier""" - meeting_id: Optional[str] = field( + meeting_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingId"}, ) """Online meeting identifier (empty for ad-hoc call AI insights)""" - call_id: Optional[str] = field( + call_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callId"}, ) """Call identifier (set for ad-hoc call AI insights)""" @@ -1891,44 +2223,52 @@ class RecordingWebhookResponseSchema: Definition: RecordingWebhookResponseSchema """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Recording identifier""" - id_2: Optional[str] = field( + id_2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.id"}, ) """OData identifier""" - meeting_id: Optional[str] = field( + meeting_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingId"}, ) """Online meeting identifier (empty for ad-hoc call recordings)""" - call_id: Optional[str] = field( + call_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callId"}, ) """Call identifier (set for ad-hoc call recordings)""" - content_correlation_id: Optional[str] = field( + content_correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentCorrelationId"}, ) """Content correlation identifier""" - meeting_organizer: Optional[TeamsIdentitySet] = field( + meeting_organizer: Optional[TeamsIdentitySet | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "meetingOrganizer"}, ) - recording_content_url: Optional[str] = field( + recording_content_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recordingContentUrl"}, ) """URL to download the recording content""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """When the recording was created (UTC)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """When the recording ended (UTC)""" @@ -1940,7 +2280,7 @@ class ChatMessageWebhookResponseSchema: Definition: ChatMessageWebhookResponseSchema """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Message details response""" @@ -1950,7 +2290,7 @@ class DynamicWebhookTriggerRequestSchema: Definition: DynamicWebhookTriggerRequestSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1963,7 +2303,7 @@ class DynamicKeywordWebhookTriggerResponseSchema: Definition: DynamicKeywordWebhookTriggerResponseSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1976,7 +2316,7 @@ class DynamicAtMentionWebhookTriggerResponseSchema: Definition: DynamicAtMentionWebhookTriggerResponseSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -1989,7 +2329,7 @@ class DynamicNewMessageWebhookTriggerResponseSchema: Definition: DynamicNewMessageWebhookTriggerResponseSchema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -2002,7 +2342,7 @@ class DynamicPostToConversationResponse: Definition: DynamicPostToConversationResponse """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -2015,7 +2355,7 @@ class MessageId: Definition: MessageId """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique message identifier""" @@ -2025,7 +2365,7 @@ class DynamicUserFlowContinuationSubscriptionResult: Definition: DynamicUserFlowContinuationSubscriptionResult """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -2038,7 +2378,7 @@ class DynamicChannelFlowContinuationSubscriptionResult: Definition: DynamicChannelFlowContinuationSubscriptionResult """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -2051,7 +2391,7 @@ class DynamicGatherInputSubscriptionResult: Definition: DynamicGatherInputSubscriptionResult """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -2064,15 +2404,17 @@ class AssociatedTeamInfo: Definition: AssociatedTeamInfo """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique identifier of the team""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The name of the team""" - tenant_id: Optional[str] = field( + tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tenantId"}, ) """The ID of the Microsoft Entra tenant this team belongs to""" @@ -2084,44 +2426,51 @@ class ChannelWithOwnerTeamId: Definition: ChannelWithOwnerTeamId """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique identifier of the channel""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The name of the channel""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the channel, optional""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address for sending messages to the channel""" - tenant_id: Optional[str] = field( + tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tenantId"}, ) """The ID of the Microsoft Entra tenant.""" - web_url: Optional[str] = field( + web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webUrl"}, ) """A hyperlink for the channel in Microsoft Teams""" - files_folder_web_url: Optional[str] = field( + files_folder_web_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filesFolderWebUrl"}, ) """The SharePoint folder URL of the channel""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """Timestamp at which the channel was created. Read only""" - membership_type: Optional[str] = field( + membership_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "membershipType"}, ) """The channel membership type""" - owner_team_id: Optional[str] = field( + owner_team_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ownerTeamId"}, ) """The ID of the team that owns the channel""" @@ -2133,8 +2482,7 @@ class WebhookRequest: Definition: WebhookRequest """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "notificationUrl"}, ) """ @@ -2148,11 +2496,12 @@ class GetTimeOffReasonsResponse: Definition: GetTimeOffReasonsResponse """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """The list of time off reasons.""" @@ -2162,67 +2511,79 @@ class TimeOffRequestResponse: Definition: TimeOffRequestResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the TimeOff request.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - assigned_to: Optional[str] = field( + assigned_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedTo"}, ) """The person the request is assigned to: 'manager' or 'recipient'""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """'approved', 'pending' or 'declined'""" - sender_date_time: Optional[str] = field( + sender_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderDateTime"}, ) """Time when the request was sent""" - sender_message: Optional[str] = field( + sender_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderMessage"}, ) """The message from the request sender""" - sender_user_id: Optional[str] = field( + sender_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderUserId"}, ) """The ID of the user that sent the request""" - manager_action_date_time: Optional[str] = field( + manager_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionDateTime"}, ) """Time when the manager responded""" - manager_action_message: Optional[str] = field( + manager_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionMessage"}, ) """The message from the manager""" - manager_user_id: Optional[str] = field( + manager_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerUserId"}, ) """The ID of the manager that responded""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """Start of time requested off""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """End of time requested off""" - time_off_reason_id: Optional[str] = field( + time_off_reason_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timeOffReasonId"}, ) """The ID of the TimeOff Reason""" @@ -2234,72 +2595,85 @@ class OfferShiftRequestResponse: Definition: OfferShiftRequestResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Offer Shift request.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - assigned_to: Optional[str] = field( + assigned_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedTo"}, ) """The person the request is assigned to: 'manager' or 'recipient'""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """'approved', 'pending' or 'declined'""" - sender_date_time: Optional[str] = field( + sender_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderDateTime"}, ) """Time when the request was sent""" - sender_message: Optional[str] = field( + sender_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderMessage"}, ) """The message from the request sender""" - sender_user_id: Optional[str] = field( + sender_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderUserId"}, ) """The ID of the user that sent the request""" - sender_shift_id: Optional[str] = field( + sender_shift_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderShiftId"}, ) """The ID of the shift from the sender""" - recipient_action_date_time: Optional[str] = field( + recipient_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientActionDateTime"}, ) """Time when the recipient responded""" - recipient_action_message: Optional[str] = field( + recipient_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientActionMessage"}, ) """The message from the recipient""" - recipient_user_id: Optional[str] = field( + recipient_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientUserId"}, ) """The ID of the recipient of the request""" - manager_action_date_time: Optional[str] = field( + manager_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionDateTime"}, ) """Time when the manager responded""" - manager_action_message: Optional[str] = field( + manager_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionMessage"}, ) """The message from the manager""" - manager_user_id: Optional[str] = field( + manager_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerUserId"}, ) """The ID of the manager that responded""" @@ -2311,77 +2685,91 @@ class SwapShiftsChangeRequestResponse: Definition: SwapShiftsChangeRequestResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Swap Shift request.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - assigned_to: Optional[str] = field( + assigned_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedTo"}, ) """The person the request is assigned to: 'manager' or 'recipient'""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """'approved', 'pending' or 'declined'""" - sender_date_time: Optional[str] = field( + sender_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderDateTime"}, ) """Time when the request was sent""" - sender_message: Optional[str] = field( + sender_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderMessage"}, ) """The message from the request sender""" - sender_user_id: Optional[str] = field( + sender_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderUserId"}, ) """The ID of the user that sent the request""" - sender_shift_id: Optional[str] = field( + sender_shift_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderShiftId"}, ) """The ID of the shift from the sender""" - recipient_action_date_time: Optional[str] = field( + recipient_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientActionDateTime"}, ) """Time when the recipient responded""" - recipient_action_message: Optional[str] = field( + recipient_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientActionMessage"}, ) """The message from the recipient""" - recipient_user_id: Optional[str] = field( + recipient_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientUserId"}, ) """The ID of the recipient of the request""" - recipient_shift_id: Optional[str] = field( + recipient_shift_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recipientShiftId"}, ) """The ID of the shift from the recipient""" - manager_action_date_time: Optional[str] = field( + manager_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionDateTime"}, ) """Time when the manager responded""" - manager_action_message: Optional[str] = field( + manager_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionMessage"}, ) """The message from the manager""" - manager_user_id: Optional[str] = field( + manager_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerUserId"}, ) """The ID of the manager that responded""" @@ -2393,57 +2781,67 @@ class OpenShiftChangeRequestResponse: Definition: OpenShiftChangeRequestResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the Open Shift Change request.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - assigned_to: Optional[str] = field( + assigned_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedTo"}, ) """The person the request is assigned to: 'manager' or 'recipient'""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """'approved', 'pending' or 'declined'""" - sender_date_time: Optional[str] = field( + sender_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderDateTime"}, ) """Time when the request was sent""" - sender_message: Optional[str] = field( + sender_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderMessage"}, ) """The message from the request sender""" - sender_user_id: Optional[str] = field( + sender_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "senderUserId"}, ) """The ID of the user that sent the request""" - manager_action_date_time: Optional[str] = field( + manager_action_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionDateTime"}, ) """Time when the manager responded""" - manager_action_message: Optional[str] = field( + manager_action_message: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerActionMessage"}, ) """The message from the manager""" - manager_user_id: Optional[str] = field( + manager_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "managerUserId"}, ) """The ID of the manager that responded""" - open_shift_id: Optional[str] = field( + open_shift_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "openShiftId"}, ) """The ID of the open shift being requested""" @@ -2455,13 +2853,15 @@ class EditOpenShiftRequest: Definition: EditOpenShiftRequest """ - scheduling_group_id: Optional[str] = field( + scheduling_group_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "schedulingGroupId"}, ) """Scheduling Group ID""" - shared_open_shift: Optional[Dict[str, Any]] = field( + shared_open_shift: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sharedOpenShift"}, ) @@ -2472,33 +2872,39 @@ class OpenShiftResponse: Definition: OpenShiftResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the open shift.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - scheduling_group_id: Optional[str] = field( + scheduling_group_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "schedulingGroupId"}, ) """Scheduling Group ID""" - last_modified_by: Optional[LastModifiedBy] = field( + last_modified_by: Optional[LastModifiedBy | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedBy"}, ) - shared_open_shift: Optional[SharedOpenShift] = field( + shared_open_shift: Optional[SharedOpenShift | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sharedOpenShift"}, ) - draft_open_shift: Optional[DraftOpenShift] = field( + draft_open_shift: Optional[DraftOpenShift | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "draftOpenShift"}, ) @@ -2509,31 +2915,35 @@ class SharedOpenShift: Definition: SharedOpenShift """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display Name""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Notes""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - theme: Optional[str] = None + theme: Optional[str] = dataclass_field(default=None, kw_only=True) """Theme""" - open_slot_count: Optional[int] = field( + open_slot_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "openSlotCount"}, ) """Open Slot Count""" - activities: Optional[Activities] = None + activities: Optional[Activities] = dataclass_field(default=None, kw_only=True) @dataclass @@ -2542,31 +2952,35 @@ class DraftOpenShift: Definition: DraftOpenShift """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display Name""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Notes""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - theme: Optional[str] = None + theme: Optional[str] = dataclass_field(default=None, kw_only=True) """Theme""" - open_slot_count: Optional[int] = field( + open_slot_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "openSlotCount"}, ) """Open Slot Count""" - activities: Optional[Activities] = None + activities: Optional[Activities] = dataclass_field(default=None, kw_only=True) @dataclass @@ -2575,38 +2989,45 @@ class ShiftResponse: Definition: ShiftResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the shift.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - user_id: Optional[str] = field( + user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userId"}, ) """Assigned To User ID""" - scheduling_group_id: Optional[str] = field( + scheduling_group_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "schedulingGroupId"}, ) """Scheduling Group ID""" - last_modified_by: Optional[LastModifiedBy] = field( + last_modified_by: Optional[LastModifiedBy | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedBy"}, ) - shared_shift: Optional[SharedShift] = field( + shared_shift: Optional[SharedShift | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sharedShift"}, ) - draft_shift: Optional[DraftShift] = field( + draft_shift: Optional[DraftShift | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "draftShift"}, ) @@ -2617,26 +3038,29 @@ class SharedShift: Definition: SharedShift """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display Name""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Notes""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - theme: Optional[str] = None + theme: Optional[str] = dataclass_field(default=None, kw_only=True) """Theme""" - activities: Optional[Activities] = None + activities: Optional[Activities] = dataclass_field(default=None, kw_only=True) @dataclass @@ -2645,26 +3069,29 @@ class DraftShift: Definition: DraftShift """ - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display Name""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Notes""" - start_date_time: Optional[str] = field( + start_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)""" - theme: Optional[str] = None + theme: Optional[str] = dataclass_field(default=None, kw_only=True) """Theme""" - activities: Optional[Activities] = None + activities: Optional[Activities] = dataclass_field(default=None, kw_only=True) @dataclass @@ -2673,20 +3100,23 @@ class ScheduleResponse: Definition: ScheduleResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the schedule.""" - time_zone: Optional[str] = field( + time_zone: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "timeZone"}, ) """The Time Zone of the schedule.""" - provision_status: Optional[str] = field( + provision_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "provisionStatus"}, ) """The Provision Status of the schedule.""" - provision_status_code: Optional[str] = field( + provision_status_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "provisionStatusCode"}, ) """The Provision Status Code of the schedule.""" @@ -2698,7 +3128,7 @@ class PostMessageToSelfRequest: Definition: PostMessageToSelfRequest """ - body: Optional[Dict[str, Any]] = None + body: Dict[str, Any] ThemeEditor = Literal[ @@ -2726,23 +3156,26 @@ class SchedulingGroupResponse: Definition: SchedulingGroupResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the scheduling group.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The display name for the scheduling group.""" - is_active: Optional[bool] = field( + is_active: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isActive"}, ) """ Indicates whether the scheduling group can be used when creating new entities or updating existing ones. """ - user_ids: Optional[List[str]] = field( + user_ids: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userIds"}, ) """List of IDs of users in the scheduling group.""" @@ -2754,17 +3187,11 @@ class BotMentionRequest: Definition: BotMentionRequest """ - bot_id: Optional[str] = field( - default=None, - metadata={"wire_name": "botId"}, - ) + bot_id: str = dataclass_field(metadata={"wire_name": "botId"}) """The bot's unique identifier (GUID)""" - app_id: Optional[str] = field( - default=None, - metadata={"wire_name": "appId"}, - ) + app_id: str = dataclass_field(metadata={"wire_name": "appId"}) """The bot's app identifier (GUID)""" - name: Optional[str] = None + name: str """The bot's display name""" @@ -2774,8 +3201,9 @@ class AtMentionBotResponse: Definition: AtMentionBotResponse """ - at_mention: Optional[str] = field( + at_mention: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "atMention"}, ) """ @@ -2793,7 +3221,7 @@ class ChannelIds: Definition: ChannelIds """ - channel: Optional[ChannelIdForTeam] = None + channel: ChannelIdForTeam ChatId = str @@ -2808,9 +3236,9 @@ class NewChat: Definition: NewChat """ - topic: Optional[str] = None + topic: Optional[str] = dataclass_field(default=None, kw_only=True) """Title, displayed only in group chats""" - members: Optional[str] = None + members: str """User's IDs, separated by semicolons""" @@ -2820,70 +3248,72 @@ class NewMeeting: Definition: NewMeeting """ - subject: Optional[str] = None + subject: str """The text of the event's subject line""" - body: Optional[Dict[str, Any]] = None + body: Dict[str, Any] """The body of the message associated with the event""" - time_zone: Optional[str] = field( - default=None, - metadata={"wire_name": "timeZone"}, - ) + time_zone: str = dataclass_field(metadata={"wire_name": "timeZone"}) """Time zone of the event""" - start: Optional[Dict[str, Any]] = None - end: Optional[Dict[str, Any]] = None - required_attendees: Optional[str] = field( + start: Dict[str, Any] + end: Dict[str, Any] + required_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredAttendees"}, ) """Required attendees for the event separated by semicolons""" - optional_attendees: Optional[str] = field( + optional_attendees: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "optionalAttendees"}, ) """Optional attendees for the event separated by semicolons""" - location: Optional[Dict[str, Any]] = None + location: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The location of the event""" - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """The importance of the event: low, normal or high""" - recurrence: Optional[Dict[str, Any]] = None + recurrence: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The recurrence pattern for the meeting""" - is_all_day: Optional[bool] = field( + is_all_day: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAllDay"}, ) """Set to true if the event lasts all day""" - reminder_minutes_before_start: Optional[int] = field( + reminder_minutes_before_start: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderMinutesBeforeStart"}, ) """ The number of minutes before the event start time that the reminder alert occurs """ - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """Set to true if an alert is set to remind the user of the event""" - show_as: Optional[str] = field( + show_as: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showAs"}, ) """Status to show during the event""" - response_requested: Optional[bool] = field( + response_requested: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "responseRequested"}, ) """ Set to true if the sender would like a response when the event is accepted """ - is_online_meeting: Optional[bool] = field( - default=None, + is_online_meeting: bool = dataclass_field( metadata={"wire_name": "isOnlineMeeting"}, ) """Set to true, if the meeting should have an online meeting provider""" - online_meeting_provider: Optional[str] = field( - default=None, + online_meeting_provider: str = dataclass_field( metadata={"wire_name": "onlineMeetingProvider"}, ) """Represents the online meeting service provider""" @@ -2895,13 +3325,13 @@ class LastModifiedBy: Definition: LastModifiedBy """ - application: Optional[str] = None + application: Optional[str] = dataclass_field(default=None, kw_only=True) """Application""" - device: Optional[str] = None + device: Optional[str] = dataclass_field(default=None, kw_only=True) """Device""" - conversation: Optional[str] = None + conversation: Optional[str] = dataclass_field(default=None, kw_only=True) """Conversation""" - user: Optional[Dict[str, Any]] = None + user: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """User""" @@ -2911,28 +3341,33 @@ class MemberSettings: Definition: MemberSettings """ - allow_create_update_channels: Optional[bool] = field( + allow_create_update_channels: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowCreateUpdateChannels"}, ) """If set to true, members can add and update channels""" - allow_delete_channels: Optional[bool] = field( + allow_delete_channels: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowDeleteChannels"}, ) """If set to true, members can delete channels""" - allow_add_remove_apps: Optional[bool] = field( + allow_add_remove_apps: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowAddRemoveApps"}, ) """If set to true, members can add and remove apps""" - allow_create_update_remove_tabs: Optional[bool] = field( + allow_create_update_remove_tabs: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowCreateUpdateRemoveTabs"}, ) """If set to true, members can add, update, and remove tabs""" - allow_create_update_remove_connectors: Optional[bool] = field( + allow_create_update_remove_connectors: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowCreateUpdateRemoveConnectors"}, ) """If set to true, members can add, update, and remove connectors""" @@ -2944,13 +3379,15 @@ class GuestSettings: Definition: GuestSettings """ - allow_create_update_channels: Optional[bool] = field( + allow_create_update_channels: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowCreateUpdateChannels"}, ) """If set to true, guests can add and update channels""" - allow_delete_channels: Optional[bool] = field( + allow_delete_channels: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowDeleteChannels"}, ) """If set to true, guests can delete channels""" @@ -2962,28 +3399,33 @@ class MessagingSettings: Definition: MessagingSettings """ - allow_user_edit_messages: Optional[bool] = field( + allow_user_edit_messages: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowUserEditMessages"}, ) """If set to true, users can edit their messages""" - allow_user_delete_messages: Optional[bool] = field( + allow_user_delete_messages: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowUserDeleteMessages"}, ) """If set to true, users can delete their messages""" - allow_owner_delete_messages: Optional[bool] = field( + allow_owner_delete_messages: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowOwnerDeleteMessages"}, ) """If set to true, owners can delete any message""" - allow_team_mentions: Optional[bool] = field( + allow_team_mentions: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowTeamMentions"}, ) """If set to true, @team mentions are allowed""" - allow_channel_mentions: Optional[bool] = field( + allow_channel_mentions: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowChannelMentions"}, ) """If set to true, @channel mentions are allowed""" @@ -2995,23 +3437,27 @@ class FunSettings: Definition: FunSettings """ - allow_giphy: Optional[bool] = field( + allow_giphy: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowGiphy"}, ) """If set to true, enables Giphy use""" - giphy_content_rating: Optional[str] = field( + giphy_content_rating: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "giphyContentRating"}, ) """Giphy content rating. Possible values are: moderate, strict""" - allow_stickers_and_memes: Optional[bool] = field( + allow_stickers_and_memes: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowStickersAndMemes"}, ) """If set to true, enables users to include stickers and memes""" - allow_custom_memes: Optional[bool] = field( + allow_custom_memes: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "allowCustomMemes"}, ) """If set to true, enables users to include custom memes""" @@ -3023,8 +3469,9 @@ class DiscoverySettings: Definition: DiscoverySettings """ - show_in_teams_search_and_suggestions: Optional[bool] = field( + show_in_teams_search_and_suggestions: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "showInTeamsSearchAndSuggestions"}, ) """ @@ -3039,12 +3486,14 @@ class SelectedMessageTriggerMetadata: Definition: SelectedMessageTriggerMetadata """ - teams_flow_run_context: Optional[ObjectEntity] = field( + teams_flow_run_context: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TeamsFlowRunContext"}, ) - card_outputs: Optional[ObjectEntity] = field( + card_outputs: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CardOutputs"}, ) @@ -3055,12 +3504,14 @@ class ComposeMessageTriggerMetadata: Definition: ComposeMessageTriggerMetadata """ - teams_flow_run_context: Optional[ObjectEntity] = field( + teams_flow_run_context: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TeamsFlowRunContext"}, ) - card_outputs: Optional[ObjectEntity] = field( + card_outputs: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CardOutputs"}, ) @@ -3071,12 +3522,14 @@ class CardResponseTriggerMetadata: Definition: CardResponseTriggerMetadata """ - teams_flow_run_context: Optional[ObjectEntity] = field( + teams_flow_run_context: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TeamsFlowRunContext"}, ) - card_outputs: Optional[ObjectEntity] = field( + card_outputs: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CardOutputs"}, ) @@ -3087,11 +3540,12 @@ class VirtualAgentBots: Definition: VirtualAgentBots """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of the Microsoft Copilot Studio agents""" @@ -3101,7 +3555,7 @@ class SectionItemConflictError: Definition: SectionItemConflictError """ - error: Optional[Dict[str, Any]] = None + error: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -3110,12 +3564,11 @@ class DynamicCallEventTriggerRequest: Definition: DynamicCallEventTriggerRequest """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "notificationUrl"}, ) """Webhook callback URL""" - scope: Optional[Dict[str, Any]] = None + scope: Dict[str, Any] @dataclass @@ -3124,12 +3577,11 @@ class DynamicTranscriptTriggerRequest: Definition: DynamicTranscriptTriggerRequest """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "notificationUrl"}, ) """Webhook callback URL""" - scope: Optional[Dict[str, Any]] = None + scope: Dict[str, Any] @dataclass @@ -3138,12 +3590,11 @@ class DynamicAiInsightTriggerRequest: Definition: DynamicAiInsightTriggerRequest """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "notificationUrl"}, ) """Webhook callback URL""" - scope: Optional[Dict[str, Any]] = None + scope: Dict[str, Any] @dataclass @@ -3152,12 +3603,11 @@ class DynamicRecordingTriggerRequest: Definition: DynamicRecordingTriggerRequest """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "notificationUrl"}, ) """Webhook callback URL""" - scope: Optional[Dict[str, Any]] = None + scope: Dict[str, Any] @dataclass @@ -3166,20 +3616,13 @@ class SingleTagTriggerRequest: Definition: SingleTagTriggerRequest """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "notificationUrl"}, ) """Webhook callback URL""" - group_id: Optional[str] = field( - default=None, - metadata={"wire_name": "groupId"}, - ) + group_id: str = dataclass_field(metadata={"wire_name": "groupId"}) """The team that owns the tag to monitor""" - tag_id: Optional[str] = field( - default=None, - metadata={"wire_name": "tagId"}, - ) + tag_id: str = dataclass_field(metadata={"wire_name": "tagId"}) """The specific tag to monitor""" @@ -3189,20 +3632,13 @@ class SingleTagMemberTriggerRequest: Definition: SingleTagMemberTriggerRequest """ - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "notificationUrl"}, ) """Webhook callback URL""" - group_id: Optional[str] = field( - default=None, - metadata={"wire_name": "groupId"}, - ) + group_id: str = dataclass_field(metadata={"wire_name": "groupId"}) """The team that owns the tag whose membership to monitor""" - tag_id: Optional[str] = field( - default=None, - metadata={"wire_name": "tagId"}, - ) + tag_id: str = dataclass_field(metadata={"wire_name": "tagId"}) """The specific tag whose membership to monitor""" @@ -3212,42 +3648,49 @@ class TagWebhookResponseSchema: Definition: TagWebhookResponseSchema """ - change_type: Optional[str] = field( + change_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "changeType"}, ) """The tag lifecycle change: 'created', 'updated', or 'deleted'.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The tag identifier.""" - team_id: Optional[str] = field( + team_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamId"}, ) """The team (group) ID that owns the tag.""" - tag_id: Optional[str] = field( + tag_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tagId"}, ) """The tag ID.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Display name of the tag.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the tag.""" - member_count: Optional[int] = field( + member_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "memberCount"}, ) """Number of members in the tag.""" - tag_type: Optional[str] = field( + tag_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tagType"}, ) """Tag type.""" - event_id: Optional[str] = field( + event_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventId"}, ) """ @@ -3262,38 +3705,44 @@ class TagMemberWebhookResponseSchema: Definition: TagMemberWebhookResponseSchema """ - change_type: Optional[str] = field( + change_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "changeType"}, ) """ The membership change: 'created' (member added) or 'deleted' (member removed). """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The tag member identifier.""" - team_id: Optional[str] = field( + team_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamId"}, ) """The team (group) ID that owns the tag.""" - tag_id: Optional[str] = field( + tag_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tagId"}, ) """The tag ID whose membership changed.""" - tenant_id: Optional[str] = field( + tenant_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tenantId"}, ) """Tenant ID of the tag member.""" - user_id: Optional[str] = field( + user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userId"}, ) """User ID of the tag member.""" - event_id: Optional[str] = field( + event_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventId"}, ) """ @@ -3308,25 +3757,29 @@ class AiInsightResponse: Definition: AiInsightResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The AI insight ID""" - call_id: Optional[str] = field( + call_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callId"}, ) """The call ID""" - content_correlation_id: Optional[str] = field( + content_correlation_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "contentCorrelationId"}, ) """The content correlation ID""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """The date and time when the AI insight was created""" - end_date_time: Optional[str] = field( + end_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endDateTime"}, ) """The date and time when the AI insight ended""" @@ -3338,11 +3791,16 @@ class AiInsightMeetingNote: Definition: AiInsightMeetingNote """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the meeting note.""" - text: Optional[str] = None + text: Optional[str] = dataclass_field(default=None, kw_only=True) """Summary text of the meeting note.""" - subpoints: Optional[List[AiInsightMeetingNoteSubpoint]] = None + subpoints: Optional[ + List[AiInsightMeetingNoteSubpoint | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Detailed subpoints of the discussion.""" @@ -3352,9 +3810,9 @@ class AiInsightMeetingNoteSubpoint: Definition: AiInsightMeetingNoteSubpoint """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the subpoint.""" - text: Optional[str] = None + text: Optional[str] = dataclass_field(default=None, kw_only=True) """Text of the subpoint.""" @@ -3364,12 +3822,13 @@ class AiInsightActionItem: Definition: AiInsightActionItem """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the action item.""" - text: Optional[str] = None + text: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the action item.""" - owner_display_name: Optional[str] = field( + owner_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ownerDisplayName"}, ) """Display name of the person assigned the action item.""" @@ -3381,8 +3840,11 @@ class AiInsightViewpoint: Definition: AiInsightViewpoint """ - mention_events: Optional[List[AiInsightMentionEvent]] = field( + mention_events: Optional[ + List[AiInsightMentionEvent | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mentionEvents"}, ) """ @@ -3397,17 +3859,19 @@ class AiInsightMentionEvent: Definition: AiInsightMentionEvent """ - event_date_time: Optional[str] = field( + event_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "eventDateTime"}, ) """The time during the meeting when the mention occurred (UTC).""" - transcript_utterance: Optional[str] = field( + transcript_utterance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "transcriptUtterance"}, ) """The transcript utterance containing the mention.""" - speaker: Optional[Dict[str, Any]] = None + speaker: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """The speaker who made the utterance.""" @@ -3422,7 +3886,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -3439,8 +3903,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -3461,7 +3925,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -3476,16 +3940,92 @@ def __init__( def connector_name(self) -> str: return "teams" + @staticmethod + def _prepare_match_headers( + headers: Optional[Mapping[str, str]], + etag: Optional[str], + match_condition: Optional[MatchConditions], + *, + default_etag: Optional[str], + if_match_required: bool, + ) -> Optional[Mapping[str, str]]: + request_headers = dict(headers) if headers is not None else {} + existing_if_match = next( + (name for name in request_headers if name.lower() == "if-match"), + None, + ) + if etag is None and match_condition is None: + if existing_if_match is not None: + return request_headers + if default_etag is not None: + request_headers["If-Match"] = default_etag + elif if_match_required: + request_headers["If-Match"] = "*" + return request_headers or None + + if existing_if_match is not None: + del request_headers[existing_if_match] + if match_condition is None: + assert etag is not None + request_headers["If-Match"] = etag + elif match_condition == MatchConditions.IfNotModified: + if etag is None: + raise ValueError( + "etag is required for MatchConditions.IfNotModified." + ) + request_headers["If-Match"] = etag + elif match_condition == MatchConditions.Unconditionally: + request_headers["If-Match"] = "*" + else: + raise ValueError( + "If-Match operations support only IfNotModified or Unconditionally." + ) + return request_headers or None + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -3502,7 +4042,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -3515,9 +4059,9 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def create_teams_meeting_async( + async def create_teams_meeting( self, - input: NewMeeting, + input: NewMeeting | Mapping[str, Any], calendarid: str, *, timeout: Optional[float] = None, @@ -3530,13 +4074,30 @@ async def create_teams_meeting_async( Create a meeting with a link at the bottom of the invite to join the meeting online on Microsoft Teams. + + Swagger operation ID: `CreateTeamsMeeting`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + calendarid: Select a value. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/me/calendars/{quote(str(calendarid), safe='')}/events" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3550,6 +4111,7 @@ async def create_teams_meeting_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3557,96 +4119,194 @@ async def create_teams_meeting_async( return json.loads(response.text) - async def get_all_teams_async( + def list_all_teams( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List joined teams Lists all the teams in Microsoft Teams that you are a member of + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllTeams`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/beta/me/joinedTeams" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_all_associated_teams_async( + return AsyncItemPaged(get_next, extract_data) + + def list_all_associated_teams( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List associated teams Lists all the teams you are a direct member of, or are a member of a shared channel that is hosted inside the team. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllAssociatedTeams`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1.0/me/teamwork/associatedTeams" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def get_channels_for_group_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_channels_for_group( self, group_id: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List channels Lists all the channels for a specific team + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetChannelsForGroup`. + + Args: + group_id: Select team. + filter: An OData filter query to restrict the entries returned + (e.g. membershipType eq 'standard'). + orderby: An OData orderBy query option for specifying the order of + entries (e.g., displayName asc). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3665,31 +4325,52 @@ async def get_channels_for_group_async( query_params.append(f"$orderby={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - async def create_channel_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_channel( self, - input: CreateChannelInput, + input: CreateChannelInput | Mapping[str, Any], group_id: str, *, timeout: Optional[float] = None, @@ -3701,13 +4382,30 @@ async def create_channel_async( Create a channel Create a new channel within a specified team + + Swagger operation ID: `CreateChannel`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Select team. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/beta/groups/{quote(str(group_id), safe='')}/channels" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3721,6 +4419,7 @@ async def create_channel_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3728,7 +4427,7 @@ async def create_channel_async( return json.loads(response.text) - async def get_channel_async( + async def get_channel( self, group_id: str, channel_id: str, @@ -3742,6 +4441,22 @@ async def get_channel_async( Get details for a specific channel in a team Get the channel details + + Swagger operation ID: `GetChannel`. + + Args: + group_id: Select team. + channel_id: Channel ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3752,7 +4467,7 @@ async def get_channel_async( f"/{quote(str(channel_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -3766,6 +4481,7 @@ async def get_channel_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3773,9 +4489,9 @@ async def get_channel_async( return json.loads(response.text) - async def update_channel_properties_async( + async def update_channel_properties( self, - input: UpdateChannelPropertiesInput, + input: UpdateChannelPropertiesInput | Mapping[str, Any], group_id: str, channel_id: str, *, @@ -3791,6 +4507,24 @@ async def update_channel_properties_async( properties you provide are changed; omitted properties are left unchanged. For shared channels, the team ID must refer to the host team, which is the team that owns the shared channel. + + Swagger operation ID: `UpdateChannelProperties`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Select team. + channel_id: Channel ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3801,7 +4535,7 @@ async def update_channel_properties_async( f"/{quote(str(channel_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -3815,11 +4549,12 @@ async def update_channel_properties_async( request_url, response.status, response.text, + response=response, ) - async def archive_channel_async( + async def archive_channel( self, - input: ArchiveChannelInput, + input: ArchiveChannelInput | Mapping[str, Any], group_id: str, channel_id: str, *, @@ -3835,6 +4570,24 @@ async def archive_channel_async( send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. Archiving is an asynchronous operation. + + Swagger operation ID: `ArchiveChannel`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Select team. + channel_id: Channel ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3846,7 +4599,7 @@ async def archive_channel_async( f"/archive" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -3860,6 +4613,7 @@ async def archive_channel_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -3867,22 +4621,44 @@ async def archive_channel_async( return json.loads(response.text) - async def get_all_channels_for_team_async( + def list_all_channels_for_team( self, group_id: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all channels Lists all the channels for a specific team, including channels that are shared with the team + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllChannelsForTeam`. + + Args: + group_id: Select team. + filter: An OData filter query to restrict the entries returned + (e.g. membershipType eq 'standard'). + orderby: An OData orderBy query option for specifying the order of + entries (e.g., displayName asc). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3901,29 +4677,50 @@ async def get_all_channels_for_team_async( query_params.append(f"$orderby={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_chats_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_chats( self, chat_type: str, topic: str, @@ -3932,11 +4729,30 @@ async def get_chats_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List chats Lists recent chats you are a part of + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetChats`. + + Args: + chat_type: Filter by type. + topic: Filter by whether or not the topic name is defined. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3950,31 +4766,52 @@ async def get_chats_async( f"/expandmembers" f"/false" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def post_feed_notification_async( + return AsyncItemPaged(get_next, extract_data) + + async def post_feed_notification( self, - input: DynamicPostFeedNotificationRequest, + input: DynamicPostFeedNotificationRequest | Mapping[str, Any], poster: str, notification_type: str, *, @@ -3988,6 +4825,24 @@ async def post_feed_notification_async( Posts a notification to a user's activity feed linking to a chat or team. + + Swagger operation ID: `PostFeedNotification`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + poster: Select an option. + notification_type: Choose notification type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -3999,7 +4854,7 @@ async def post_feed_notification_async( f"/{quote(str(notification_type), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4013,9 +4868,10 @@ async def post_feed_notification_async( request_url, response.status, response.text, + response=response, ) - async def at_mention_tag_async( + async def at_mention_tag( self, group_id: str, tag_id: str, @@ -4030,6 +4886,22 @@ async def at_mention_tag_async( Creates a token that can be inserted into a message or adaptive card sent as a user in a channel to @mention a team tag. + + Swagger operation ID: `AtMentionTag`. + + Args: + group_id: Select team. + tag_id: Select tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4040,7 +4912,7 @@ async def at_mention_tag_async( f"/{quote(str(tag_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4054,6 +4926,7 @@ async def at_mention_tag_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4061,7 +4934,7 @@ async def at_mention_tag_async( return json.loads(response.text) - async def get_messages_from_channel_async( + def list_messages_from_channel( self, group_id: str, channel_id: str, @@ -4070,7 +4943,7 @@ async def get_messages_from_channel_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get messages in a channel @@ -4078,8 +4951,25 @@ async def get_messages_from_channel_async( the team ID must refer to the host team, which is the team that owns the shared channel. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetMessagesFromChannel`. + + Args: + group_id: Select team. + channel_id: Channel ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4090,11 +4980,18 @@ async def get_messages_from_channel_async( f"/{quote(str(channel_id), safe='')}" f"/messages" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -4107,25 +5004,34 @@ async def get_messages_from_channel_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_message_details_async( + async def get_message_details( self, - input: DynamicGetMessageDetailsSchema, + input: DynamicGetMessageDetailsSchema | Mapping[str, Any], message_id: str, thread_type: str, *, @@ -4138,6 +5044,24 @@ async def get_message_details_async( Get message details Gets the details of a message in a chat or a channel. + + Swagger operation ID: `GetMessageDetails`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + message_id: Message ID. + thread_type: Choose message type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4149,7 +5073,7 @@ async def get_message_details_async( f"/{quote(str(thread_type), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4163,6 +5087,7 @@ async def get_message_details_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4170,24 +5095,46 @@ async def get_message_details_async( return json.loads(response.text) - async def list_replies_to_message_async( + def list_replies_to_message( self, group_id: str, channel_id: str, message_id: str, - top: Optional[int] = None, *, + top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List replies of a channel message List replies to a message in a channel in a specific team. For shared channels, the team ID must refer to the host team, which is the team that owns the shared channel. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRepliesToMessage`. + + Args: + group_id: Select team. + channel_id: Channel ID. + message_id: Message ID. + top: The number of latest replies to return. The default value is + 20. The supported value is between 1 and 50. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4208,43 +5155,86 @@ async def list_replies_to_message_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def list_members_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_members( self, - input: DynamicListMembersSchema, + input: DynamicListMembersSchema | Mapping[str, Any], thread_type: str, - filter: Optional[str] = None, *, + filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List chat or channel members List direct members of a group chat or a channel + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListMembers`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + thread_type: Choose message type. + filter: An OData filter query to restrict the entries returned + (e.g. membershipType eq 'standard'). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4262,31 +5252,52 @@ async def list_members_async( query_params.append(f"$filter={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = input + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "POST", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "POST", request_url, body=input, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "POST", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "POST", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def subscribe_user_message_with_options_async( + async def subscribe_user_message_with_options( self, - input: DynamicUserMessageWithOptionsSubscriptionRequest, + input: DynamicUserMessageWithOptionsSubscriptionRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4299,6 +5310,22 @@ async def subscribe_user_message_with_options_async( Send a set of options to a Microsoft Teams user, that they must respond to before the flow will continue. This action will pause the flow until the user response to the options + + Swagger operation ID: `SubscribeUserMessageWithOptions`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4310,7 +5337,7 @@ async def subscribe_user_message_with_options_async( f"/$subscriptions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4324,9 +5351,10 @@ async def subscribe_user_message_with_options_async( request_url, response.status, response.text, + response=response, ) - async def get_team_async( + async def get_team( self, team_id: str, *, @@ -4339,13 +5367,28 @@ async def get_team_async( Get a team Gets the details for a team in Microsoft Teams. + + Swagger operation ID: `GetTeam`. + + Args: + team_id: Select team. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/beta/teams/{quote(str(team_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4359,6 +5402,7 @@ async def get_team_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4366,7 +5410,7 @@ async def get_team_async( return json.loads(response.text) - async def at_mention_user_async( + async def at_mention_user( self, user_id: str, *, @@ -4380,13 +5424,28 @@ async def at_mention_user_async( Creates a token that can be inserted into a message or adaptive card to @mention a user. + + Swagger operation ID: `AtMentionUser`. + + Args: + user_id: Specify a user principal or user ID to @mention. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/users/{quote(str(user_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -4400,6 +5459,7 @@ async def at_mention_user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4407,9 +5467,9 @@ async def at_mention_user_async( return json.loads(response.text) - async def create_chat_async( + async def create_chat( self, - input: NewChat, + input: NewChat | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4420,10 +5480,26 @@ async def create_chat_async( Create a chat Creates a one on one or group chat + + Swagger operation ID: `CreateChat`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/beta/chats" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4437,6 +5513,7 @@ async def create_chat_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4444,25 +5521,47 @@ async def create_chat_async( return json.loads(response.text) - async def get_messages_from_chat_async( + def list_messages_from_chat( self, chat_id: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get messages in a chat Retrieves messages from a one on one or group chat - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetMessagesFromChat`. + + Args: + chat_id: The chat's unique identifier. + filter: An OData filter query to restrict the entries returned + (e.g. membershipType eq 'standard'). + orderby: An OData orderBy query option for specifying the order of + entries (e.g., displayName asc). + top: An OData top query option for specifying the maximum number of + entries returned. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4486,11 +5585,18 @@ async def get_messages_from_chat_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -4503,25 +5609,34 @@ async def get_messages_from_chat_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def post_message_to_self_async( + return AsyncItemPaged(get_next, extract_data) + + async def post_message_to_self( self, - input: PostMessageToSelfRequest, + input: PostMessageToSelfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4533,12 +5648,28 @@ async def post_message_to_self_async( Sends a message to the signed-in user's own Notes chat in Microsoft Teams. + + Swagger operation ID: `PostMessageToSelf`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1.0/chats/48:notes/messages" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4552,6 +5683,7 @@ async def post_message_to_self_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4559,9 +5691,9 @@ async def post_message_to_self_async( return json.loads(response.text) - async def create_a_team_async( + async def create_a_team( self, - input: CreateATeamInput, + input: CreateATeamInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -4572,10 +5704,26 @@ async def create_a_team_async( Create a team Creates a new team in Microsoft Teams + + Swagger operation ID: `CreateATeam`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/beta/teams" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4589,6 +5737,7 @@ async def create_a_team_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4596,21 +5745,43 @@ async def create_a_team_async( return json.loads(response.text) - async def list_team_members_async( + def list_team_members( self, team_id: str, + *, filter: Optional[str] = None, top: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List team members Lists the members of a team in Microsoft Teams + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListTeamMembers`. + + Args: + team_id: Select team. + filter: An OData filter query to restrict the entries returned + (e.g. membershipType eq 'standard'). + top: An OData top query option for specifying the maximum number of + entries returned. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4629,31 +5800,52 @@ async def list_team_members_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def add_member_to_team_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def add_member_to_team( self, - input: AddMemberToTeamInput, + input: AddMemberToTeamInput | Mapping[str, Any], team_id: str, *, timeout: Optional[float] = None, @@ -4665,13 +5857,30 @@ async def add_member_to_team_async( Add a member to a team Adds a member to a team in Microsoft Teams + + Swagger operation ID: `AddMemberToTeam`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + team_id: Select team. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/teams/{quote(str(team_id), safe='')}/members" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4685,9 +5894,10 @@ async def add_member_to_team_async( request_url, response.status, response.text, + response=response, ) - async def remove_member_from_team_async( + async def remove_member_from_team( self, team_id: str, membership_id: str, @@ -4701,6 +5911,24 @@ async def remove_member_from_team_async( Remove a member from a team Removes a member from a team in Microsoft Teams + + Swagger operation ID: `RemoveMemberFromTeam`. + + Args: + team_id: Select team. + membership_id: The membership ID of the member to remove from the + team. Use the 'List team members' action to look up the + membership ID for a user. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4711,7 +5939,7 @@ async def remove_member_from_team_async( f"/{quote(str(membership_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -4725,11 +5953,12 @@ async def remove_member_from_team_async( request_url, response.status, response.text, + response=response, ) - async def add_member_to_channel_async( + async def add_member_to_channel( self, - input: AddMemberToChannelInput, + input: AddMemberToChannelInput | Mapping[str, Any], group_id: str, channel_id: str, *, @@ -4743,6 +5972,24 @@ async def add_member_to_channel_async( Adds a member to a channel in Microsoft Teams. The channel must be a private or shared channel. + + Swagger operation ID: `AddMemberToChannel`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Select team. + channel_id: Channel ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4754,7 +6001,7 @@ async def add_member_to_channel_async( f"/members" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4768,9 +6015,10 @@ async def add_member_to_channel_async( request_url, response.status, response.text, + response=response, ) - async def remove_member_from_channel_async( + async def remove_member_from_channel( self, group_id: str, channel_id: str, @@ -4786,6 +6034,26 @@ async def remove_member_from_channel_async( Removes a direct member from a channel in Microsoft Teams. The channel must be a private or shared channel. + + Swagger operation ID: `RemoveMemberFromChannel`. + + Args: + group_id: Select team. + channel_id: Channel ID. + membership_id: The membership ID of the direct member to remove + from the channel. Use the 'List chat or channel members' action + with thread type 'Channel' to look up the membership ID for a + user. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4798,7 +6066,7 @@ async def remove_member_from_channel_async( f"/{quote(str(membership_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -4812,11 +6080,12 @@ async def remove_member_from_channel_async( request_url, response.status, response.text, + response=response, ) - async def post_message_to_conversation_async( + async def post_message_to_conversation( self, - input: DynamicPostMessageRequest, + input: DynamicPostMessageRequest | Mapping[str, Any], poster: str, location: str, *, @@ -4829,6 +6098,24 @@ async def post_message_to_conversation_async( Post message in a chat or channel Posts a message to a chat or a channel + + Swagger operation ID: `PostMessageToConversation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + poster: Select an option. + location: Select an option. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4842,7 +6129,7 @@ async def post_message_to_conversation_async( f"/{quote(str(location), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4856,6 +6143,7 @@ async def post_message_to_conversation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4863,9 +6151,9 @@ async def post_message_to_conversation_async( return json.loads(response.text) - async def reply_with_message_to_conversation_async( + async def reply_with_message_to_conversation( self, - input: DynamicReplyMessageRequest, + input: DynamicReplyMessageRequest | Mapping[str, Any], poster: str, location: str, *, @@ -4878,9 +6166,27 @@ async def reply_with_message_to_conversation_async( Reply with a message in a channel Replies with a message to a channel's message - """ - request_url = ( - f"{self._connection_runtime_url}" + + Swagger operation ID: `ReplyWithMessageToConversation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + poster: Select an option. + location: Select an option. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. + """ + request_url = ( + f"{self._connection_runtime_url}" f"/v1.0" f"/teams" f"/conversation" @@ -4891,7 +6197,7 @@ async def reply_with_message_to_conversation_async( f"/{quote(str(location), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4905,6 +6211,7 @@ async def reply_with_message_to_conversation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4912,9 +6219,9 @@ async def reply_with_message_to_conversation_async( return json.loads(response.text) - async def post_card_to_conversation_async( + async def post_card_to_conversation( self, - input: DynamicPostCardRequest, + input: DynamicPostCardRequest | Mapping[str, Any], poster: str, location: str, *, @@ -4927,6 +6234,24 @@ async def post_card_to_conversation_async( Post card in a chat or channel Posts a card to a chat or a channel + + Swagger operation ID: `PostCardToConversation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + poster: Select an option. + location: Select an option. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4940,7 +6265,7 @@ async def post_card_to_conversation_async( f"/{quote(str(location), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -4954,6 +6279,7 @@ async def post_card_to_conversation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -4961,9 +6287,9 @@ async def post_card_to_conversation_async( return json.loads(response.text) - async def post_card_and_wait_for_response_async( + async def post_card_and_wait_for_response( self, - input: PostCardAndWaitForResponseInput, + input: PostCardAndWaitForResponseInput | Mapping[str, Any], poster: str, location: str, *, @@ -4977,6 +6303,24 @@ async def post_card_and_wait_for_response_async( Posts an adaptive card to a chat or a channel and waits for a response from any user. This will pause the flow until any user responds. + + Swagger operation ID: `PostCardAndWaitForResponse`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + poster: Select an option. + location: Select an option. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -4991,7 +6335,7 @@ async def post_card_and_wait_for_response_async( f"/$subscriptions" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5005,6 +6349,7 @@ async def post_card_and_wait_for_response_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5012,9 +6357,9 @@ async def post_card_and_wait_for_response_async( return json.loads(response.text) - async def reply_with_card_to_conversation_async( + async def reply_with_card_to_conversation( self, - input: DynamicReplyCardRequest, + input: DynamicReplyCardRequest | Mapping[str, Any], poster: str, location: str, *, @@ -5027,6 +6372,24 @@ async def reply_with_card_to_conversation_async( Reply with an adaptive card in a channel Replies with an adaptive card to a channel's message + + Swagger operation ID: `ReplyWithCardToConversation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + poster: Select an option. + location: Select an option. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5040,7 +6403,7 @@ async def reply_with_card_to_conversation_async( f"/{quote(str(location), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5054,6 +6417,7 @@ async def reply_with_card_to_conversation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5061,9 +6425,9 @@ async def reply_with_card_to_conversation_async( return json.loads(response.text) - async def update_card_in_conversation_async( + async def update_card_in_conversation( self, - input: DynamicUpdateCardRequest, + input: DynamicUpdateCardRequest | Mapping[str, Any], poster: str, location: str, *, @@ -5076,6 +6440,24 @@ async def update_card_in_conversation_async( Update an adaptive card in a chat or channel Updates an existing adaptive card + + Swagger operation ID: `UpdateCardInConversation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + poster: Select an option. + location: Select an option. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5089,7 +6471,7 @@ async def update_card_in_conversation_async( f"/{quote(str(location), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5103,6 +6485,7 @@ async def update_card_in_conversation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5110,7 +6493,7 @@ async def update_card_in_conversation_async( return json.loads(response.text) - async def http_request_async( + async def http_request( self, input: bytes, *, @@ -5127,10 +6510,25 @@ async def http_request_async( /teams, /me, /users 2nd segment: channels, chats, installedApps, messages, pinnedMessages, onlineMeetings. Learn more: https://docs.microsoft.com/en-us/graph/use-the-api + + Swagger operation ID: `HttpRequest`. + + Args: + input: The binary request body. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/httprequest" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -5147,6 +6545,7 @@ async def http_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5154,9 +6553,9 @@ async def http_request_async( return json.loads(response.text) - async def add_member_to_chat_async( + async def add_member_to_chat( self, - input: AddMemberToChatInput, + input: AddMemberToChatInput | Mapping[str, Any], chat_id: str, *, timeout: Optional[float] = None, @@ -5168,13 +6567,30 @@ async def add_member_to_chat_async( Add a user to a chat Adds a user to a chat in Microsoft Teams. + + Swagger operation ID: `AddMemberToChat`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + chat_id: The chat's unique identifier. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/chats/{quote(str(chat_id), safe='')}/members" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5188,9 +6604,10 @@ async def add_member_to_chat_async( request_url, response.status, response.text, + response=response, ) - async def remove_member_from_chat_async( + async def remove_member_from_chat( self, chat_id: str, membership_id: str, @@ -5205,6 +6622,24 @@ async def remove_member_from_chat_async( Removes a member from a chat in Microsoft Teams. Only group chats support member removal. + + Swagger operation ID: `RemoveMemberFromChat`. + + Args: + chat_id: The chat's unique identifier. + membership_id: The membership ID of the member to remove from the + chat. Use the 'List chat or channel members' action with thread + type 'Group chat' to look up the membership ID for a user. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5215,7 +6650,7 @@ async def remove_member_from_chat_async( f"/{quote(str(membership_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5229,9 +6664,10 @@ async def remove_member_from_chat_async( request_url, response.status, response.text, + response=response, ) - async def get_online_meeting_async( + async def get_online_meeting( self, lookup_type: str, lookup_value: str, @@ -5246,6 +6682,23 @@ async def get_online_meeting_async( Retrieves the properties and relationships of an online meeting. You can look up a meeting by meeting ID, join web URL, or join meeting ID. + + Swagger operation ID: `GetOnlineMeeting`. + + Args: + lookup_type: Select how to identify the meeting. + lookup_value: The value corresponding to the selected lookup type + (meeting ID, join web URL, or join meeting ID). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1.0/me/onlineMeetings/lookup" @@ -5262,7 +6715,7 @@ async def get_online_meeting_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5276,6 +6729,7 @@ async def get_online_meeting_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5283,7 +6737,7 @@ async def get_online_meeting_async( return json.loads(response.text) - async def list_meeting_transcripts_async( + def list_meeting_transcripts( self, meeting_id: str, *, @@ -5291,11 +6745,29 @@ async def list_meeting_transcripts_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List meeting transcripts Lists all transcripts for an online meeting + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListMeetingTranscripts`. + + Args: + meeting_id: The online meeting ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5305,29 +6777,50 @@ async def list_meeting_transcripts_async( f"/{quote(str(meeting_id), safe='')}" f"/transcripts" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - async def get_meeting_transcript_async( + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_meeting_transcript( self, meeting_id: str, transcript_id: str, @@ -5341,6 +6834,22 @@ async def get_meeting_transcript_async( Get meeting transcript Gets a specific transcript for an online meeting + + Swagger operation ID: `GetMeetingTranscript`. + + Args: + meeting_id: The online meeting ID. + transcript_id: The transcript ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5352,7 +6861,7 @@ async def get_meeting_transcript_async( f"/{quote(str(transcript_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5366,6 +6875,7 @@ async def get_meeting_transcript_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5373,7 +6883,7 @@ async def get_meeting_transcript_async( return json.loads(response.text) - async def get_meeting_transcript_content_async( + async def get_meeting_transcript_content( self, meeting_id: str, transcript_id: str, @@ -5387,6 +6897,22 @@ async def get_meeting_transcript_content_async( Get meeting transcript content Gets the content of a meeting transcript + + Swagger operation ID: `GetMeetingTranscriptContent`. + + Args: + meeting_id: The online meeting ID. + transcript_id: The transcript ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5399,7 +6925,7 @@ async def get_meeting_transcript_content_async( f"/content" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5413,6 +6939,7 @@ async def get_meeting_transcript_content_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5420,7 +6947,7 @@ async def get_meeting_transcript_content_async( return json.loads(response.text) - async def list_meeting_recordings_async( + def list_meeting_recordings( self, meeting_id: str, *, @@ -5428,11 +6955,29 @@ async def list_meeting_recordings_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List meeting recordings Lists all recordings for an online meeting + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListMeetingRecordings`. + + Args: + meeting_id: The online meeting ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5442,29 +6987,50 @@ async def list_meeting_recordings_async( f"/{quote(str(meeting_id), safe='')}" f"/recordings" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_meeting_recording_async( + async def get_meeting_recording( self, meeting_id: str, recording_id: str, @@ -5478,6 +7044,22 @@ async def get_meeting_recording_async( Get meeting recording Gets a specific recording for an online meeting + + Swagger operation ID: `GetMeetingRecording`. + + Args: + meeting_id: The online meeting ID. + recording_id: The recording ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5489,7 +7071,7 @@ async def get_meeting_recording_async( f"/{quote(str(recording_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5503,6 +7085,7 @@ async def get_meeting_recording_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5510,7 +7093,7 @@ async def get_meeting_recording_async( return json.loads(response.text) - async def get_meeting_recording_content_async( + async def get_meeting_recording_content( self, meeting_id: str, recording_id: str, @@ -5524,6 +7107,22 @@ async def get_meeting_recording_content_async( Get meeting recording content Gets the content stream of a meeting recording + + Swagger operation ID: `GetMeetingRecordingContent`. + + Args: + meeting_id: The online meeting ID. + recording_id: The recording ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5536,7 +7135,7 @@ async def get_meeting_recording_content_async( f"/content" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5550,52 +7149,93 @@ async def get_meeting_recording_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def list_sections_async( + def list_sections( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List sections Lists the current user's teamwork sections + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListSections`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/beta/me/teamwork/sections" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def create_section_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_section( self, - input: CreateSectionInput, + input: CreateSectionInput | Mapping[str, Any], *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5605,12 +7245,38 @@ async def create_section_async( Create a section Creates a new teamwork section for the current user + + Swagger operation ID: `CreateSection`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + etag: The entity tag for the conditional request. + match_condition: The Azure Core match condition. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ + headers = self._prepare_match_headers( + headers, + etag, + match_condition, + default_etag=None, + if_match_required=True, + ) + request_url = ( f"{self._connection_runtime_url}/beta/me/teamwork/sections" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5624,6 +7290,7 @@ async def create_section_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5631,7 +7298,7 @@ async def create_section_async( return json.loads(response.text) - async def get_section_async( + async def get_section( self, section_id: str, *, @@ -5644,13 +7311,28 @@ async def get_section_async( Get a section Gets a specific teamwork section by ID + + Swagger operation ID: `GetSection`. + + Args: + section_id: The section ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/beta/me/teamwork/sections/{quote(str(section_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -5664,6 +7346,7 @@ async def get_section_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5671,11 +7354,13 @@ async def get_section_async( return json.loads(response.text) - async def update_section_async( + async def update_section( self, - input: UpdateSectionInput, + input: UpdateSectionInput | Mapping[str, Any], section_id: str, *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5685,13 +7370,40 @@ async def update_section_async( Update a section Updates a teamwork section for the current user - """ + + Swagger operation ID: `UpdateSection`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + section_id: The section ID. + etag: The entity tag for the conditional request. + match_condition: The Azure Core match condition. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. + """ + headers = self._prepare_match_headers( + headers, + etag, + match_condition, + default_etag=None, + if_match_required=True, + ) + request_url = ( f"{self._connection_runtime_url}" f"/beta/me/teamwork/sections/{quote(str(section_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -5705,6 +7417,7 @@ async def update_section_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5712,10 +7425,12 @@ async def update_section_async( return json.loads(response.text) - async def delete_section_async( + async def delete_section( self, section_id: str, *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5725,13 +7440,38 @@ async def delete_section_async( Delete a section Deletes a teamwork section for the current user + + Swagger operation ID: `DeleteSection`. + + Args: + section_id: The section ID. + etag: The entity tag for the conditional request. + match_condition: The Azure Core match condition. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ + headers = self._prepare_match_headers( + headers, + etag, + match_condition, + default_etag=None, + if_match_required=True, + ) + request_url = ( f"{self._connection_runtime_url}" f"/beta/me/teamwork/sections/{quote(str(section_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5745,9 +7485,10 @@ async def delete_section_async( request_url, response.status, response.text, + response=response, ) - async def list_section_items_async( + def list_section_items( self, section_id: str, *, @@ -5755,12 +7496,30 @@ async def list_section_items_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List section items Lists the items (chats, channels, meetings, communities) in a teamwork section. Each item belongs to exactly one section at a time. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListSectionItems`. + + Args: + section_id: The section ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -5771,33 +7530,56 @@ async def list_section_items_async( f"/{quote(str(section_id), safe='')}" f"/items" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def add_section_item_async( + return AsyncItemPaged(get_next, extract_data) + + async def add_section_item( self, - input: AddSectionItemInput, + input: AddSectionItemInput | Mapping[str, Any], section_id: str, *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5809,7 +7591,34 @@ async def add_section_item_async( Adds an item (chat, channel, meeting, or community) currently in a system-defined section to a user-defined teamwork section. Use Move Section Item to relocate items already in another user-defined section. - """ + + Swagger operation ID: `AddSectionItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + section_id: The section ID. + etag: The entity tag for the conditional request. + match_condition: The Azure Core match condition. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. + """ + headers = self._prepare_match_headers( + headers, + etag, + match_condition, + default_etag=None, + if_match_required=True, + ) + request_url = ( f"{self._connection_runtime_url}" f"/beta" @@ -5820,7 +7629,7 @@ async def add_section_item_async( f"/items" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5834,6 +7643,7 @@ async def add_section_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5841,11 +7651,13 @@ async def add_section_item_async( return json.loads(response.text) - async def remove_section_item_async( + async def remove_section_item( self, section_id: str, section_item_id: str, *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5857,7 +7669,34 @@ async def remove_section_item_async( Removes an item from a user-defined teamwork section. The underlying chat, channel, meeting, or community is not deleted; the item returns to its default system-defined section. - """ + + Swagger operation ID: `RemoveSectionItem`. + + Args: + section_id: The section ID. + section_item_id: The section item ID (the conversation ID of the + underlying chat, channel, meeting, or community). + etag: The entity tag for the conditional request. + match_condition: The Azure Core match condition. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. + """ + headers = self._prepare_match_headers( + headers, + etag, + match_condition, + default_etag=None, + if_match_required=True, + ) + request_url = ( f"{self._connection_runtime_url}" f"/beta" @@ -5869,7 +7708,7 @@ async def remove_section_item_async( f"/{quote(str(section_item_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -5883,14 +7722,17 @@ async def remove_section_item_async( request_url, response.status, response.text, + response=response, ) - async def move_section_item_async( + async def move_section_item( self, - input: MoveSectionItemInput, + input: MoveSectionItemInput | Mapping[str, Any], section_id: str, section_item_id: str, *, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -5903,7 +7745,36 @@ async def move_section_item_async( another user-defined section. Each item can belong to only one section at a time. This action removes the item from its current section and adds it to the target section. - """ + + Swagger operation ID: `MoveSectionItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + section_id: The section ID. + section_item_id: The section item ID (the conversation ID of the + underlying chat, channel, meeting, or community). + etag: The entity tag for the conditional request. + match_condition: The Azure Core match condition. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. + """ + headers = self._prepare_match_headers( + headers, + etag, + match_condition, + default_etag=None, + if_match_required=True, + ) + request_url = ( f"{self._connection_runtime_url}" f"/beta" @@ -5916,7 +7787,7 @@ async def move_section_item_async( f"/move" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -5930,6 +7801,7 @@ async def move_section_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -5937,7 +7809,7 @@ async def move_section_item_async( return json.loads(response.text) - async def get_tags_async( + def list_tags( self, group_id: str, *, @@ -5945,41 +7817,80 @@ async def get_tags_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all tags for a team Lists the team's tags + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTags`. + + Args: + group_id: Select team. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/teams/{quote(str(group_id), safe='')}/tags" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def create_tag_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_tag( self, - input: CreateTagInput, + input: CreateTagInput | Mapping[str, Any], group_id: str, *, timeout: Optional[float] = None, @@ -5991,13 +7902,30 @@ async def create_tag_async( Create a tag for a team Creates a tag in a team + + Swagger operation ID: `CreateTag`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Select team. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/teams/{quote(str(group_id), safe='')}/tags" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6011,6 +7939,7 @@ async def create_tag_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6018,7 +7947,7 @@ async def create_tag_async( return json.loads(response.text) - async def get_tag_async( + async def get_tag( self, group_id: str, tag_id: str, @@ -6032,6 +7961,22 @@ async def get_tag_async( Get a team tag Gets a specific tag by ID from a team + + Swagger operation ID: `GetTag`. + + Args: + group_id: Select team. + tag_id: Select tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6042,7 +7987,7 @@ async def get_tag_async( f"/{quote(str(tag_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6056,6 +8001,7 @@ async def get_tag_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6063,9 +8009,9 @@ async def get_tag_async( return json.loads(response.text) - async def update_tag_async( + async def update_tag( self, - input: UpdateTagInput, + input: UpdateTagInput | Mapping[str, Any], group_id: str, tag_id: str, *, @@ -6078,6 +8024,24 @@ async def update_tag_async( Update a team tag Updates the display name of a tag in a team + + Swagger operation ID: `UpdateTag`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Select team. + tag_id: Select tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6088,7 +8052,7 @@ async def update_tag_async( f"/{quote(str(tag_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -6102,6 +8066,7 @@ async def update_tag_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6109,7 +8074,7 @@ async def update_tag_async( return json.loads(response.text) - async def delete_tag_async( + async def delete_tag( self, group_id: str, tag_id: str, @@ -6123,6 +8088,22 @@ async def delete_tag_async( Delete a team tag Deletes a tag from a team + + Swagger operation ID: `DeleteTag`. + + Args: + group_id: Select team. + tag_id: Select tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6133,7 +8114,7 @@ async def delete_tag_async( f"/{quote(str(tag_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -6147,11 +8128,12 @@ async def delete_tag_async( request_url, response.status, response.text, + response=response, ) - async def add_member_to_tag_async( + async def add_member_to_tag( self, - input: AddMemberToTagInput, + input: AddMemberToTagInput | Mapping[str, Any], group_id: str, tag_id: str, *, @@ -6164,6 +8146,24 @@ async def add_member_to_tag_async( Add a member to a team tag Adds a user to a team tag + + Swagger operation ID: `AddMemberToTag`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + group_id: Select team. + tag_id: Select tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6175,7 +8175,7 @@ async def add_member_to_tag_async( f"/members" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -6189,6 +8189,7 @@ async def add_member_to_tag_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6196,7 +8197,7 @@ async def add_member_to_tag_async( return json.loads(response.text) - async def get_tag_members_async( + def list_tag_members( self, group_id: str, tag_id: str, @@ -6205,11 +8206,30 @@ async def get_tag_members_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List the members of a team tag Lists the members of a team tag + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTagMembers`. + + Args: + group_id: Select team. + tag_id: Select tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6220,29 +8240,50 @@ async def get_tag_members_async( f"/{quote(str(tag_id), safe='')}" f"/members" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def delete_tag_member_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def delete_tag_member( self, group_id: str, tag_id: str, @@ -6257,6 +8298,23 @@ async def delete_tag_member_async( Delete a member from a team tag Deletes a member from a team tag + + Swagger operation ID: `DeleteTagMember`. + + Args: + group_id: Select team. + tag_id: Select tag. + tag_member_id: ID of the member to remove from the tag. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6269,7 +8327,7 @@ async def delete_tag_member_async( f"/{quote(str(tag_member_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -6283,9 +8341,10 @@ async def delete_tag_member_async( request_url, response.status, response.text, + response=response, ) - async def list_call_recordings_async( + def list_call_recordings( self, call_id: str, *, @@ -6293,39 +8352,78 @@ async def list_call_recordings_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List call recordings Lists all recordings for an ad-hoc call + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListCallRecordings`. + + Args: + call_id: The call ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/me/adhocCalls/{quote(str(call_id), safe='')}/recordings" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_call_recording_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_call_recording( self, call_id: str, recording_id: str, @@ -6339,6 +8437,22 @@ async def get_call_recording_async( Get call recording Gets a specific recording for an ad-hoc call + + Swagger operation ID: `GetCallRecording`. + + Args: + call_id: The call ID. + recording_id: The recording ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6350,7 +8464,7 @@ async def get_call_recording_async( f"/{quote(str(recording_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6364,6 +8478,7 @@ async def get_call_recording_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6371,7 +8486,7 @@ async def get_call_recording_async( return json.loads(response.text) - async def get_call_recording_content_async( + async def get_call_recording_content( self, call_id: str, recording_id: str, @@ -6385,6 +8500,22 @@ async def get_call_recording_content_async( Get call recording content Gets the content of a call recording + + Swagger operation ID: `GetCallRecordingContent`. + + Args: + call_id: The call ID. + recording_id: The recording ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6397,7 +8528,7 @@ async def get_call_recording_content_async( f"/content" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6411,11 +8542,12 @@ async def get_call_recording_content_async( request_url, response.status, response.text, + response=response, ) return response.content - async def list_call_transcripts_async( + def list_call_transcripts( self, call_id: str, *, @@ -6423,39 +8555,78 @@ async def list_call_transcripts_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List call transcripts Lists all transcripts for an ad-hoc call + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListCallTranscripts`. + + Args: + call_id: The call ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1.0/me/adhocCalls/{quote(str(call_id), safe='')}/transcripts" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_call_transcript_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_call_transcript( self, call_id: str, transcript_id: str, @@ -6469,6 +8640,22 @@ async def get_call_transcript_async( Get call transcript Gets a specific transcript for an ad-hoc call + + Swagger operation ID: `GetCallTranscript`. + + Args: + call_id: The call ID. + transcript_id: The transcript ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6480,7 +8667,7 @@ async def get_call_transcript_async( f"/{quote(str(transcript_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6494,6 +8681,7 @@ async def get_call_transcript_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6501,7 +8689,7 @@ async def get_call_transcript_async( return json.loads(response.text) - async def get_call_transcript_content_async( + async def get_call_transcript_content( self, call_id: str, transcript_id: str, @@ -6515,6 +8703,22 @@ async def get_call_transcript_content_async( Get call transcript content Gets the content of a call transcript + + Swagger operation ID: `GetCallTranscriptContent`. + + Args: + call_id: The call ID. + transcript_id: The transcript ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6527,7 +8731,7 @@ async def get_call_transcript_content_async( f"/content" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6541,6 +8745,7 @@ async def get_call_transcript_content_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6548,23 +8753,45 @@ async def get_call_transcript_content_async( return json.loads(response.text) - async def get_all_adhoc_call_recordings_async( + def list_all_adhoc_call_recordings( self, + *, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, top: Optional[int] = None, skiptoken: Optional[str] = None, deltatoken: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all ad-hoc call recordings Gets all recordings from ad-hoc calls for the signed-in user + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllAdhocCallRecordings`. + + Args: + start_date_time: The start date and time to filter recordings. + end_date_time: The end date and time to filter recordings. + top: The number of recordings to return. + skiptoken: The skip token for pagination. + deltatoken: The delta token for tracking changes. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6598,45 +8825,88 @@ async def get_all_adhoc_call_recordings_async( query_params.append(f"$deltatoken={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_all_adhoc_call_transcripts_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_all_adhoc_call_transcripts( self, + *, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, top: Optional[int] = None, skiptoken: Optional[str] = None, deltatoken: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all ad-hoc call transcripts Gets all transcripts from ad-hoc calls for the signed-in user + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllAdhocCallTranscripts`. + + Args: + start_date_time: The start date and time to filter transcripts. + end_date_time: The end date and time to filter transcripts. + top: The number of transcripts to return. + skiptoken: The skip token for pagination. + deltatoken: The delta token for tracking changes. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6670,29 +8940,50 @@ async def get_all_adhoc_call_transcripts_async( query_params.append(f"$deltatoken={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_ai_insights_async( + def list_ai_insights( self, meeting_id: str, *, @@ -6700,12 +8991,30 @@ async def list_ai_insights_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List AI insights Lists AI-generated insights for an online meeting. Requires Microsoft 365 Copilot license. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListAiInsights`. + + Args: + meeting_id: The online meeting ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6716,29 +9025,50 @@ async def list_ai_insights_async( f"/{quote(str(meeting_id), safe='')}" f"/aiInsights" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_ai_insight_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_ai_insight( self, meeting_id: str, ai_insight_id: str, @@ -6753,6 +9083,22 @@ async def get_ai_insight_async( Gets a specific AI-generated insight for an online meeting. Requires Microsoft 365 Copilot license. + + Swagger operation ID: `GetAiInsight`. + + Args: + meeting_id: The online meeting ID. + ai_insight_id: The AI insight ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6765,7 +9111,7 @@ async def get_ai_insight_async( f"/{quote(str(ai_insight_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6779,6 +9125,7 @@ async def get_ai_insight_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6786,7 +9133,7 @@ async def get_ai_insight_async( return json.loads(response.text) - async def get_message_locations_async( + def list_message_locations( self, message_type: str, poster: str, @@ -6795,12 +9142,31 @@ async def get_message_locations_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Conversation location for where to post Returns a list of locations to post a message or reply based on who the user is posting as + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMessageLocations`. + + Args: + message_type: Message Type. + poster: Select an option. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6810,29 +9176,50 @@ async def get_message_locations_async( f"/poster" f"/{quote(str(poster), safe='')}" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("locations", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_message_details_input_schema_async( + async def get_message_details_input_schema( self, thread_type: str, *, @@ -6845,6 +9232,21 @@ async def get_message_details_input_schema_async( Get message details response schema Get the schema information for get message details response + + Swagger operation ID: `GetMessageDetailsInputSchema`. + + Args: + thread_type: Choose message type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6854,7 +9256,7 @@ async def get_message_details_input_schema_async( f"/{quote(str(thread_type), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6868,6 +9270,7 @@ async def get_message_details_input_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6875,7 +9278,7 @@ async def get_message_details_input_schema_async( return json.loads(response.text) - async def get_message_details_response_schema_async( + async def get_message_details_response_schema( self, thread_type: str, *, @@ -6888,6 +9291,21 @@ async def get_message_details_response_schema_async( Get message details input metadata Get the schema information for message inputs + + Swagger operation ID: `GetMessageDetailsResponseSchema`. + + Args: + thread_type: Choose message type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6897,7 +9315,7 @@ async def get_message_details_response_schema_async( f"/{quote(str(thread_type), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6911,6 +9329,7 @@ async def get_message_details_response_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6918,7 +9337,7 @@ async def get_message_details_response_schema_async( return json.loads(response.text) - async def list_members_input_schema_async( + async def list_members_input_schema( self, thread_type: str, *, @@ -6931,6 +9350,21 @@ async def list_members_input_schema_async( List members input schema Get the schema information for list members input based on thread type + + Swagger operation ID: `ListMembersInputSchema`. + + Args: + thread_type: Choose message type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6940,7 +9374,7 @@ async def list_members_input_schema_async( f"/{quote(str(thread_type), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -6954,6 +9388,7 @@ async def list_members_input_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -6961,7 +9396,7 @@ async def list_members_input_schema_async( return json.loads(response.text) - async def get_feed_notification_input_schema_async( + async def get_feed_notification_input_schema( self, poster: str, notification_type: str, @@ -6975,6 +9410,22 @@ async def get_feed_notification_input_schema_async( Get feed notification input metadata Get the schema information for feed notification + + Swagger operation ID: `GetFeedNotificationInputSchema`. + + Args: + poster: Select an option. + notification_type: Choose notification type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -6986,7 +9437,7 @@ async def get_feed_notification_input_schema_async( f"/{quote(str(notification_type), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7000,6 +9451,7 @@ async def get_feed_notification_input_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7007,7 +9459,7 @@ async def get_feed_notification_input_schema_async( return json.loads(response.text) - async def get_unified_action_schema_async( + async def get_unified_action_schema( self, action_type: str, poster: str, @@ -7022,6 +9474,23 @@ async def get_unified_action_schema_async( Get unified action input metadata Get the schema information for unified actions + + Swagger operation ID: `GetUnifiedActionSchema`. + + Args: + action_type: Unified Action. + poster: Select an option. + recipient_type: Type of the recipient of the action. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7035,7 +9504,7 @@ async def get_unified_action_schema_async( f"/schema" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7049,6 +9518,7 @@ async def get_unified_action_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7056,7 +9526,7 @@ async def get_unified_action_schema_async( return json.loads(response.text) - async def get_message_with_options_subscription_input_metadata_async( + async def get_message_with_options_subscription_input_metadata( self, recipient_type: str, *, @@ -7070,6 +9540,21 @@ async def get_message_with_options_subscription_input_metadata_async( Get the schema information for the message with options subscription inputs + + Swagger operation ID: `GetMessageWithOptionsSubscriptionInputMetadata`. + + Args: + recipient_type: Type of the recipient of the action. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7082,7 +9567,7 @@ async def get_message_with_options_subscription_input_metadata_async( f"/subscriptioninputs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7096,6 +9581,7 @@ async def get_message_with_options_subscription_input_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7103,7 +9589,7 @@ async def get_message_with_options_subscription_input_metadata_async( return json.loads(response.text) - async def get_message_with_options_subscription_output_metadata_async( + async def get_message_with_options_subscription_output_metadata( self, recipient_type: str, *, @@ -7117,6 +9603,22 @@ async def get_message_with_options_subscription_output_metadata_async( Get the schema information for the message with options subscription outputs + + Swagger operation ID: + `GetMessageWithOptionsSubscriptionOutputMetadata`. + + Args: + recipient_type: Type of the recipient of the action. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7129,7 +9631,7 @@ async def get_message_with_options_subscription_output_metadata_async( f"/subscriptionoutputs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7143,6 +9645,7 @@ async def get_message_with_options_subscription_output_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7150,7 +9653,7 @@ async def get_message_with_options_subscription_output_metadata_async( return json.loads(response.text) - async def get_webhook_trigger_request_schema_async( + async def get_webhook_trigger_request_schema( self, thread_type: str, *, @@ -7163,6 +9666,21 @@ async def get_webhook_trigger_request_schema_async( Input schema for webhook trigger Gets the input schema for webhook trigger + + Swagger operation ID: `GetWebhookTriggerRequestSchema`. + + Args: + thread_type: Choose message type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7173,7 +9691,7 @@ async def get_webhook_trigger_request_schema_async( f"/{quote(str(thread_type), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7187,6 +9705,7 @@ async def get_webhook_trigger_request_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7194,7 +9713,7 @@ async def get_webhook_trigger_request_schema_async( return json.loads(response.text) - async def get_webhook_trigger_response_schema_async( + async def get_webhook_trigger_response_schema( self, trigger_type: str, thread_type: str, @@ -7208,6 +9727,22 @@ async def get_webhook_trigger_response_schema_async( Response schema for webhook trigger Gets the response schema for webhook trigger + + Swagger operation ID: `GetWebhookTriggerResponseSchema`. + + Args: + trigger_type: Trigger type. + thread_type: Choose message type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7220,7 +9755,7 @@ async def get_webhook_trigger_response_schema_async( f"/{quote(str(thread_type), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7234,6 +9769,7 @@ async def get_webhook_trigger_response_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7241,7 +9777,7 @@ async def get_webhook_trigger_response_schema_async( return json.loads(response.text) - async def get_post_to_conversation_response_schema_async( + async def get_post_to_conversation_response_schema( self, action_type: str, poster: str, @@ -7256,6 +9792,23 @@ async def get_post_to_conversation_response_schema_async( Get response schema Get the schema information for unified action responses + + Swagger operation ID: `GetPostToConversationResponseSchema`. + + Args: + action_type: Unified Action. + poster: Select an option. + recipient_type: Type of the recipient of the action. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7270,7 +9823,7 @@ async def get_post_to_conversation_response_schema_async( f"/schema" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7284,6 +9837,7 @@ async def get_post_to_conversation_response_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7291,7 +9845,7 @@ async def get_post_to_conversation_response_schema_async( return json.loads(response.text) - async def get_flow_continuation_subscription_with_poster_output_metadata_async( + async def get_flow_continuation_subscription_with_poster_output_metadata( self, input: GetFlowContinuationSubscriptionWithPosterOutputMetadataInput, poster: str, @@ -7307,6 +9861,24 @@ async def get_flow_continuation_subscription_with_poster_output_metadata_async( Get the schema information for the flow continuation subscription outputs + + Swagger operation ID: + `GetFlowContinuationSubscriptionWithPosterOutputMetadata`. + + Args: + input: The request body. + poster: Select an option. + recipient_type: Type of the recipient of the action. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7321,7 +9893,7 @@ async def get_flow_continuation_subscription_with_poster_output_metadata_async( f"/subscriptionoutputs" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -7335,6 +9907,7 @@ async def get_flow_continuation_subscription_with_poster_output_metadata_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -7342,7 +9915,7 @@ async def get_flow_continuation_subscription_with_poster_output_metadata_async( return json.loads(response.text) - async def get_subscription_scope_schema_async( + async def get_subscription_scope_schema( self, scope_type: str, *, @@ -7356,6 +9929,21 @@ async def get_subscription_scope_schema_async( Returns the input schema for a subscription trigger based on the selected scope type. + + Swagger operation ID: `GetSubscriptionScopeSchema`. + + Args: + scope_type: The selected scope type. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -7366,7 +9954,7 @@ async def get_subscription_scope_schema_async( f"/schema" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -7380,6 +9968,7 @@ async def get_subscription_scope_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/textrequest.py b/src/azure/connectors/textrequest.py index 37911af4..624068f0 100644 --- a/src/azure/connectors/textrequest.py +++ b/src/azure/connectors/textrequest.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,45 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "TextrequestClient", + "BulkUpdateContactsInput", + "CancelPaymentResponse", + "CreateContactInput", + "CreateContactResponse", + "CreateDashboardInput", + "CreateDashboardResponse", + "CreateGroupInput", + "CreateGroupResponse", + "CreatePaymentInput", + "CreatePaymentResponse", + "GetContactByPhoneNumberResponse", + "GetContactsResponse", + "GetConversationsResponse", + "GetDashboardResponse", + "GetDashboardsResponse", + "GetGroupByIdResponse", + "GetGroupsResponse", + "GetMessagesByContactPhoneResponse", + "GetPaymentResponse", + "GetPaymentsResponse", + "GetTagsResponse", + "MarkPaymentPaidResponse", + "SendMessageByPhoneNumberInput", + "SendMessageByPhoneNumberResponse", + "SendPaymentReminderResponse", + "TextingWebhookInput", + "TextingWebhookResponse", + "UpdateDashboardsNameInput", + "UpdateDashboardsNameResponse", + "UpdateGroupInput", + "UpdateGroupResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,12 +67,12 @@ class GetMessagesByContactPhoneResponse: Response for Get a conversation's messages by a contact's phone number """ - meta: Optional[Dict[str, Any]] = None + meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ Metadata about the data returned by this request. This data is returned by all bulk GET requests. """ - items: Optional[List[Dict[str, Any]]] = None + items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of message entities gotten from Text Request.""" @@ -44,26 +82,26 @@ class SendMessageByPhoneNumberInput: Send a message to the contact with the given phone number """ - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """Content of the message to send.""" - sender_name: Optional[str] = None + sender_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ The name of the message sender. This is shown in the TextRequest web app and api when retrieving this message. """ - status_callback: Optional[str] = None + status_callback: Optional[str] = dataclass_field(default=None, kw_only=True) """ Url for the web app to hit with a POST command whenever this message's status goes from undelivered to sent (or error). """ - location_callback: Optional[str] = None + location_callback: Optional[str] = dataclass_field(default=None, kw_only=True) """ Location callback url to hit with a POST command when the user accesses and approves sharing their location with the sender. To include the link, add [Location Request] to the message body. This callback is not required for location requests, but it can be useful for APIs. """ - mms_media: Optional[List[str]] = None + mms_media: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ Array of MMS Media attachments for this message. Attachments must be urls gotten from the post /mms endpoint (not included in this connector). @@ -77,32 +115,32 @@ class SendMessageByPhoneNumberResponse: Response for Send a message to the contact with the given phone number """ - message_id: Optional[str] = None + message_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the message. This value is unique for each message.""" - body: Optional[str] = None + body: Optional[str] = dataclass_field(default=None, kw_only=True) """Content of this message.""" - message_direction: Optional[str] = None + message_direction: Optional[str] = dataclass_field(default=None, kw_only=True) """ Singular character, either R or S, denoting whether this message was received from the contact or sent to them, respectively. """ - response_by_username: Optional[str] = None + response_by_username: Optional[str] = dataclass_field(default=None, kw_only=True) """ Username of the Text Request user that last sent a message to this user. """ - message_timestamp_utc: Optional[str] = None + message_timestamp_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when the message was sent or received by Text Request.""" - delivery_status: Optional[str] = None + delivery_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Current status of this message. This can be 'sending', 'delivered', 'error', or 'send'. """ - delivery_error: Optional[str] = None + delivery_error: Optional[str] = dataclass_field(default=None, kw_only=True) """ Error that caused this message to not be delivered. If the delivery_status is not 'error', this value will be null. """ - mms_media: Optional[List[str]] = None + mms_media: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ List of urls pointing to this message's attachments. All urls will be text-request generated urls. @@ -115,75 +153,80 @@ class GetContactByPhoneNumberResponse: Response for Gets the contact with the specified phone number """ - phone_number: Optional[str] = None + phone_number: Optional[str] = dataclass_field(default=None, kw_only=True) """Phone number of this contact.""" - first_name: Optional[str] = None + first_name: Optional[str] = dataclass_field(default=None, kw_only=True) """First name of this contact.""" - last_name: Optional[str] = None + last_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Last name of this contact.""" - display_name: Optional[str] = None + display_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Full name of this contact. This is the default name displayed in the web app when viewing contacts. """ - is_suppressed: Optional[bool] = None + is_suppressed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether the conversation with this contact are suppressed, and therefore not pushed to the top of the message queue when received. """ - is_archived: Optional[bool] = None + is_archived: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether the conversation with this contact are archived, and therefore cannot be seen when querying conversations (by default). """ - is_blocked: Optional[bool] = None + is_blocked: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether the conversation with this contact are blocked, and therefore not received or stored. """ - suppressed_reason: Optional[str] = None + suppressed_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """ Phrase describing the reason for suppressing contact. If is_suppressed is false, this will be null. """ - note: Optional[str] = None + note: Optional[str] = dataclass_field(default=None, kw_only=True) """ Short phrase describing contact. Used for convenience. This is never shown to the contact. """ - groups: Optional[List[int]] = None + groups: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """Array of integer ids referring to groups this contact belongs to.""" - contact_tags: Optional[List[str]] = None + contact_tags: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Array of guids referring to tags attached to this contact.""" - custom_fields: Optional[List[Dict[str, Any]]] = None + custom_fields: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Array of custom field ids and values defined for this contact.""" - is_resolved: Optional[bool] = None + is_resolved: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether the conversation with this contact is resolved. Any new texts received by this contact will set this false. """ - first_contact_utc: Optional[str] = None + first_contact_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when the first message was sent to this contact.""" - opted_out_utc: Optional[str] = None + opted_out_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when this contact opted out to receiving messages.""" - last_msg_sent_utc: Optional[str] = None + last_msg_sent_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when the last message was sent to this contact.""" - last_msg_received_utc: Optional[str] = None + last_msg_received_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when the last message was received from this contact.""" - total_msgs_sent: Optional[int] = None + total_msgs_sent: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of total messages sent to this contact.""" - total_msgs_received: Optional[int] = None + total_msgs_received: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of total messages received from this contact.""" - response_count: Optional[int] = None + response_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The total number of response messages from the contact.""" - date_created_utc: Optional[str] = None + date_created_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """The timestamp of when ths contact was created.""" - last_contact_date_utc: Optional[str] = None + last_contact_date_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """ The timestamp of when the last message was sent or received from this contact. """ - last_message: Optional[Dict[str, Any]] = None + last_message: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Last message sent to or from this contact.""" @@ -193,44 +236,49 @@ class CreateContactInput: Create or update a contact """ - first_name: Optional[str] = None + first_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The new first name of the contact.""" - last_name: Optional[str] = None + last_name: Optional[str] = dataclass_field(default=None, kw_only=True) """The new last name of the contact.""" - display_name: Optional[str] = None + display_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ The new full name of the contact. This is the default name displayed in the web app when viewing contacts. """ - is_suppressed: Optional[bool] = None + is_suppressed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Determines whether conversations with this contact are suppressed, and therefore not pushed to the top of the message queue when received. """ - is_archived: Optional[bool] = None + is_archived: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Determines whether conversations with this contact are archived, and therefore cannot be seen when querying conversations (by default). """ - is_blocked: Optional[bool] = None + is_blocked: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Determines whether conversations with this contact are blocked, and therefore not received or stored. """ - suppressed_reason: Optional[str] = None + suppressed_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """Phrase describing the reason for suppressing contact.""" - note: Optional[str] = None + note: Optional[str] = dataclass_field(default=None, kw_only=True) """ Short phrase describing contact. Used for convenience. This is never shown to the contact. """ - groups: Optional[List[int]] = None + groups: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """Array of integer ids referring to groups this contact will belong to.""" - contact_tags: Optional[List[str]] = None + contact_tags: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Array of guids referring to tags attached to this contact.""" - custom_fields: Optional[List[Dict[str, Any]]] = None + custom_fields: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Array of custom field ids and values defined for this contact.""" - is_resolved: Optional[bool] = None + is_resolved: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Determines whether the current conversation with this contact is resolved. Any new texts received by this contact will set this false. @@ -243,74 +291,79 @@ class CreateContactResponse: Response for Create or update a contact """ - phone_number: Optional[str] = None + phone_number: Optional[str] = dataclass_field(default=None, kw_only=True) """Phone number of this contact.""" - first_name: Optional[str] = None + first_name: Optional[str] = dataclass_field(default=None, kw_only=True) """First name of this contact.""" - last_name: Optional[str] = None + last_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Last name of this contact.""" - display_name: Optional[str] = None + display_name: Optional[str] = dataclass_field(default=None, kw_only=True) """ Full name of this contact. This is the default name displayed in the web app when viewing contacts. """ - is_suppressed: Optional[bool] = None + is_suppressed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether the conversation with this contact are suppressed, and therefore not pushed to the top of the message queue when received. """ - is_archived: Optional[bool] = None + is_archived: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether the conversation with this contact are archived, and therefore cannot be seen when querying conversations (by default). """ - is_blocked: Optional[bool] = None + is_blocked: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether the conversation with this contact are blocked, and therefore not received or stored. """ - suppressed_reason: Optional[str] = None + suppressed_reason: Optional[str] = dataclass_field(default=None, kw_only=True) """ Phrase describing the reason for suppressing contact. If is_suppressed is false, this will be null. """ - note: Optional[str] = None + note: Optional[str] = dataclass_field(default=None, kw_only=True) """ Short phrase describing contact. Used for convenience. This is never shown to the contact. """ - groups: Optional[List[int]] = None + groups: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """Array of integer ids referring to groups this contact belongs to.""" - contact_tags: Optional[List[str]] = None + contact_tags: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Array of guids referring to tags attached to this contact.""" - custom_fields: Optional[List[Dict[str, Any]]] = None + custom_fields: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Array of custom field ids and values defined for this contact.""" - is_resolved: Optional[bool] = None + is_resolved: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether the conversation with this contact is resolved. Any new texts received by this contact will set this false. """ - first_contact_utc: Optional[str] = None + first_contact_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when the first message was sent to this contact.""" - opted_out_utc: Optional[str] = None + opted_out_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when this contact opted out to receiving messages.""" - last_msg_sent_utc: Optional[str] = None + last_msg_sent_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when the last message was sent to this contact.""" - last_msg_received_utc: Optional[str] = None + last_msg_received_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when the last message was received from this contact.""" - total_msgs_sent: Optional[int] = None + total_msgs_sent: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of total messages sent to this contact.""" - total_msgs_received: Optional[int] = None + total_msgs_received: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of total messages received from this contact.""" - response_count: Optional[int] = None + response_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Total number of response messages from the contact.""" - date_created_utc: Optional[str] = None + date_created_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when ths contact was created.""" - last_contact_date_utc: Optional[str] = None + last_contact_date_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """ Timestamp of when the last message was sent or received from this contact. """ - last_message: Optional[Dict[str, Any]] = None + last_message: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Last message sent to or from this contact.""" @@ -320,12 +373,12 @@ class GetContactsResponse: Response for Get all contacts that match the specified filtering criterion """ - meta: Optional[Dict[str, Any]] = None + meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ Metadata about the data returned by this request. This data is returned by all bulk GET requests. """ - items: Optional[List[Dict[str, Any]]] = None + items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of contact entities gotten from Text Request.""" @@ -338,20 +391,20 @@ class GetGroupByIdResponse: Response for Get a group by its id """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the group.""" - group_member_count: Optional[int] = None + group_member_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of members of the group.""" - is_keyword: Optional[bool] = None + is_keyword: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Wheter this group is a keyword group. Such groups are autogenerated when a user sets up a keyword. Contacts are automatically added when they enroll. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of this group.""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Any notes on this group.""" - last_message_sent_utc: Optional[str] = None + last_message_sent_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when the last group message was sent for this group.""" @@ -361,9 +414,9 @@ class UpdateGroupInput: Updates a group with the given id """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The new name of the group.""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Short phrase describing group. Used for convenience.""" @@ -373,20 +426,20 @@ class UpdateGroupResponse: Response for Updates a group with the given id """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the group.""" - group_member_count: Optional[int] = None + group_member_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of members of the group.""" - is_keyword: Optional[bool] = None + is_keyword: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Wheter this group is a keyword group. Such groups are autogenerated when a user sets up a keyword. Contacts are automatically added when they enroll. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of this group.""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Any notes on this group.""" - last_message_sent_utc: Optional[str] = None + last_message_sent_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when the last group message was sent for this group.""" @@ -396,12 +449,12 @@ class GetGroupsResponse: Response for Gets all groups """ - meta: Optional[Dict[str, Any]] = None + meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ Metadata about the data returned by this request. This data is returned by all bulk GET requests. """ - items: Optional[List[Dict[str, Any]]] = None + items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of group entities gotten from Text Request.""" @@ -411,9 +464,9 @@ class CreateGroupInput: Creates a new group """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The new name of the group.""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Short phrase describing group. Used for convenience.""" @@ -423,20 +476,20 @@ class CreateGroupResponse: Response for Creates a new group """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the group.""" - group_member_count: Optional[int] = None + group_member_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of members of the group.""" - is_keyword: Optional[bool] = None + is_keyword: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Wheter this group is a keyword group. Such groups are autogenerated when a user sets up a keyword. Contacts are automatically added when they enroll. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of this group.""" - notes: Optional[str] = None + notes: Optional[str] = dataclass_field(default=None, kw_only=True) """Any notes on this group.""" - last_message_sent_utc: Optional[str] = None + last_message_sent_utc: Optional[str] = dataclass_field(default=None, kw_only=True) """Timestamp of when the last group message was sent for this group.""" @@ -446,12 +499,12 @@ class GetTagsResponse: Response for Gets all tags """ - meta: Optional[Dict[str, Any]] = None + meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ Metadata about the data returned by this request. This data is returned by all bulk GET requests. """ - items: Optional[List[Dict[str, Any]]] = None + items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of tag entities gotten from Text Request.""" @@ -461,40 +514,40 @@ class GetPaymentResponse: Response for Gets the payment with the specified id """ - payment_id: Optional[int] = None + payment_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the payment.""" - request_date: Optional[str] = None + request_date: Optional[str] = dataclass_field(default=None, kw_only=True) """ The timestamp of when this payment's initial message was queued to be sent. """ - recipient: Optional[str] = None + recipient: Optional[str] = dataclass_field(default=None, kw_only=True) """ The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number. """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments. """ - customer_phone: Optional[str] = None + customer_phone: Optional[str] = dataclass_field(default=None, kw_only=True) """The phone number of the contact who is being sent this payment.""" - amount_requested: Optional[float] = None + amount_requested: Optional[float] = dataclass_field(default=None, kw_only=True) """The amount in dollars requested by this payment.""" - is_past_due: Optional[bool] = None + is_past_due: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether this payment is past the request date.""" - reminder_was_sent: Optional[bool] = None + reminder_was_sent: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether a text reminder has already been sent for this payment.""" - transaction_status: Optional[str] = None + transaction_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ The status of the transaction in authvia. This value starts as Unknown. """ - textrequest_payment_status: Optional[str] = None + textrequest_payment_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ The status of the transaction in Text Request. This represents that status shown in the payments page on the Text Request app. It starts as Sent. """ - reference_number: Optional[str] = None + reference_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ The user-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can @@ -508,40 +561,40 @@ class MarkPaymentPaidResponse: Response for Mark a payment as paid """ - payment_id: Optional[int] = None + payment_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the payment.""" - request_date: Optional[str] = None + request_date: Optional[str] = dataclass_field(default=None, kw_only=True) """ The timestamp of when this payment's initial message was queued to be sent. """ - recipient: Optional[str] = None + recipient: Optional[str] = dataclass_field(default=None, kw_only=True) """ The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number. """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments. """ - customer_phone: Optional[str] = None + customer_phone: Optional[str] = dataclass_field(default=None, kw_only=True) """The phone number of the contact who is being sent this payment.""" - amount_requested: Optional[float] = None + amount_requested: Optional[float] = dataclass_field(default=None, kw_only=True) """The amount in dollars requested by this payment.""" - is_past_due: Optional[bool] = None + is_past_due: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether this payment is past the request date.""" - reminder_was_sent: Optional[bool] = None + reminder_was_sent: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether a text reminder has already been sent for this payment.""" - transaction_status: Optional[str] = None + transaction_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ The status of the transaction in authvia. This value starts as Unknown. """ - textrequest_payment_status: Optional[str] = None + textrequest_payment_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ The status of the transaction in Text Request. This represents that status shown in the payments page on the Text Request app. It starts as Sent. """ - reference_number: Optional[str] = None + reference_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ The user-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can @@ -555,40 +608,40 @@ class SendPaymentReminderResponse: Response for Send a follow-up text reminding the user to pay the specified payment """ - payment_id: Optional[int] = None + payment_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the payment.""" - request_date: Optional[str] = None + request_date: Optional[str] = dataclass_field(default=None, kw_only=True) """ The timestamp of when this payment's initial message was queued to be sent. """ - recipient: Optional[str] = None + recipient: Optional[str] = dataclass_field(default=None, kw_only=True) """ The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number. """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments. """ - customer_phone: Optional[str] = None + customer_phone: Optional[str] = dataclass_field(default=None, kw_only=True) """The phone number of the contact who is being sent this payment.""" - amount_requested: Optional[float] = None + amount_requested: Optional[float] = dataclass_field(default=None, kw_only=True) """The amount in dollars requested by this payment.""" - is_past_due: Optional[bool] = None + is_past_due: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether this payment is past the request date.""" - reminder_was_sent: Optional[bool] = None + reminder_was_sent: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether a text reminder has already been sent for this payment.""" - transaction_status: Optional[str] = None + transaction_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ The status of the transaction in authvia. This value starts as Unknown. """ - textrequest_payment_status: Optional[str] = None + textrequest_payment_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ The status of the transaction in Text Request. This represents that status shown in the payments page on the Text Request app. It starts as Sent. """ - reference_number: Optional[str] = None + reference_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ The user-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can @@ -602,40 +655,40 @@ class CancelPaymentResponse: Response for Cancels the specified payment """ - payment_id: Optional[int] = None + payment_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the payment.""" - request_date: Optional[str] = None + request_date: Optional[str] = dataclass_field(default=None, kw_only=True) """ The timestamp of when this payment's initial message was queued to be sent. """ - recipient: Optional[str] = None + recipient: Optional[str] = dataclass_field(default=None, kw_only=True) """ The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number. """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments. """ - customer_phone: Optional[str] = None + customer_phone: Optional[str] = dataclass_field(default=None, kw_only=True) """The phone number of the contact who is being sent this payment.""" - amount_requested: Optional[float] = None + amount_requested: Optional[float] = dataclass_field(default=None, kw_only=True) """The amount in dollars requested by this payment.""" - is_past_due: Optional[bool] = None + is_past_due: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether this payment is past the request date.""" - reminder_was_sent: Optional[bool] = None + reminder_was_sent: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether a text reminder has already been sent for this payment.""" - transaction_status: Optional[str] = None + transaction_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ The status of the transaction in authvia. This value starts as Unknown. """ - textrequest_payment_status: Optional[str] = None + textrequest_payment_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ The status of the transaction in Text Request. This represents that status shown in the payments page on the Text Request app. It starts as Sent. """ - reference_number: Optional[str] = None + reference_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ The user-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can @@ -649,12 +702,12 @@ class GetPaymentsResponse: Response for Gets all payments """ - meta: Optional[Dict[str, Any]] = None + meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ Metadata about the data returned by this request. This data is returned by all bulk GET requests. """ - items: Optional[List[Dict[str, Any]]] = None + items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of payment entities gotten from Text Request.""" @@ -664,18 +717,18 @@ class CreatePaymentInput: Creates a new payment """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ Description of the payment. Description is not shown to the contact and is only used by internal users for context about payments. """ - customer_phone: Optional[str] = None + customer_phone: Optional[str] = dataclass_field(default=None, kw_only=True) """Phone number of the contact this payment will be sent to.""" - amount_requested: Optional[float] = None + amount_requested: Optional[float] = dataclass_field(default=None, kw_only=True) """The amount in dollars requested by this payment. """ - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """Message text to send to contact along with payment link.""" - reference_number: Optional[str] = None + reference_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ User-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can @@ -689,40 +742,40 @@ class CreatePaymentResponse: Response for Creates a new payment """ - payment_id: Optional[int] = None + payment_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the payment.""" - request_date: Optional[str] = None + request_date: Optional[str] = dataclass_field(default=None, kw_only=True) """ The timestamp of when this payment's initial message was queued to be sent. """ - recipient: Optional[str] = None + recipient: Optional[str] = dataclass_field(default=None, kw_only=True) """ The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number. """ - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """ The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments. """ - customer_phone: Optional[str] = None + customer_phone: Optional[str] = dataclass_field(default=None, kw_only=True) """The phone number of the contact who is being sent this payment.""" - amount_requested: Optional[float] = None + amount_requested: Optional[float] = dataclass_field(default=None, kw_only=True) """The amount in dollars requested by this payment.""" - is_past_due: Optional[bool] = None + is_past_due: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether this payment is past the request date.""" - reminder_was_sent: Optional[bool] = None + reminder_was_sent: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether a text reminder has already been sent for this payment.""" - transaction_status: Optional[str] = None + transaction_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ The status of the transaction in authvia. This value starts as Unknown. """ - textrequest_payment_status: Optional[str] = None + textrequest_payment_status: Optional[str] = dataclass_field(default=None, kw_only=True) """ The status of the transaction in Text Request. This represents that status shown in the payments page on the Text Request app. It starts as Sent. """ - reference_number: Optional[str] = None + reference_number: Optional[str] = dataclass_field(default=None, kw_only=True) """ The user-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can @@ -736,11 +789,11 @@ class GetDashboardResponse: Response for Get info on this specific dashboard """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the dashboard.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the dashboard.""" - phone: Optional[str] = None + phone: Optional[str] = dataclass_field(default=None, kw_only=True) """The texting number associated with this dashboard.""" @@ -750,7 +803,7 @@ class UpdateDashboardsNameInput: Update a specific dashboard's name """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The new name of the dashboard.""" @@ -760,11 +813,11 @@ class UpdateDashboardsNameResponse: Response for Update a specific dashboard's name """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the dashboard.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the dashboard.""" - phone: Optional[str] = None + phone: Optional[str] = dataclass_field(default=None, kw_only=True) """The texting number associated with this dashboard.""" @@ -774,12 +827,12 @@ class GetConversationsResponse: Response for Gets all conversations for this dashboard """ - meta: Optional[Dict[str, Any]] = None + meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ Metadata about the data returned by this request. This data is returned by all bulk GET requests. """ - items: Optional[List[Dict[str, Any]]] = None + items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of conversation entities gotten from Text Request.""" @@ -789,12 +842,12 @@ class GetDashboardsResponse: Response for Get all dashboards in an account """ - meta: Optional[Dict[str, Any]] = None + meta: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ Metadata about the data returned by this request. This data is returned by all bulk GET requests. """ - items: Optional[List[Dict[str, Any]]] = None + items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of dashboard entities gotten from Text Request.""" @@ -804,9 +857,9 @@ class CreateDashboardInput: Create a new dashboard with the given name and phone number """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the dashboard.""" - phone: Optional[str] = None + phone: Optional[str] = dataclass_field(default=None, kw_only=True) """The texting number associated with this dashboard.""" @@ -816,11 +869,11 @@ class CreateDashboardResponse: Response for Create a new dashboard with the given name and phone number """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the dashboard.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the dashboard.""" - phone: Optional[str] = None + phone: Optional[str] = dataclass_field(default=None, kw_only=True) """The texting number associated with this dashboard.""" @@ -830,14 +883,11 @@ class TextingWebhookInput: Triggers when a text is sent or received """ - target_url: Optional[str] = None + target_url: str """Url the webhook will redirect to""" - event: Optional[str] = None + event: str """event""" - http_verb: Optional[str] = field( - default=None, - metadata={"wire_name": "httpVerb"}, - ) + http_verb: str = dataclass_field(metadata={"wire_name": "httpVerb"}) """httpVerb""" @@ -847,11 +897,11 @@ class TextingWebhookResponse: Response for Triggers when a text is sent or received """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The numerical id of the dashboard.""" - target_url: Optional[str] = None + target_url: Optional[str] = dataclass_field(default=None, kw_only=True) """The url the webhook will post to""" - event: Optional[str] = None + event: Optional[str] = dataclass_field(default=None, kw_only=True) """The webhook's associated trigger event""" @@ -866,7 +916,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -883,8 +933,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -905,7 +955,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -920,7 +970,84 @@ def __init__( def connector_name(self) -> str: return "textrequest" - async def get_messages_by_contact_phone_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_messages_by_contact_phone( self, dashboard_id: int, phone_number: str, @@ -931,11 +1058,38 @@ async def get_messages_by_contact_phone_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get a conversation's messages by a contact's phone number Get the conversation between the specified dashboard and phone number. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMessagesByContactPhone`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + phone_number: Phone number of the contact to get messages for. + page: The page of entities to get. When getting values, there is a + max size per page, defined by page_size. If page is greater + than the last page, an empty array will be returned. + page_size: The size of each page to get. When getting values, this + is a max size per page, with accessing subsequent pages done by + the page parameter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -956,31 +1110,52 @@ async def get_messages_by_contact_phone_async( query_params.append(f"page_size={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() - async def send_message_by_phone_number_async( + return AsyncItemPaged(get_next, extract_data) + + async def send_message_by_phone_number( self, - input: SendMessageByPhoneNumberInput, + input: SendMessageByPhoneNumberInput | Mapping[str, Any], dashboard_id: int, phone_number: str, *, @@ -994,6 +1169,26 @@ async def send_message_by_phone_number_async( Sends a message (starting a new conversation if the given phone number has no message history). + + Swagger operation ID: `SendMessageByPhoneNumber`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + phone_number: Phone number of the contact to send a message to. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1004,7 +1199,7 @@ async def send_message_by_phone_number_async( f"/messages" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1018,6 +1213,7 @@ async def send_message_by_phone_number_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1025,7 +1221,7 @@ async def send_message_by_phone_number_async( return json.loads(response.text) - async def archive_conversation_async( + async def archive_conversation( self, dashboard_id: int, phone_number: str, @@ -1046,6 +1242,24 @@ async def archive_conversation_async( you don't plan on talking to in the future. Note that if a customer texts in \"STOP\" to prevent you from sending them any further SMS messages, the conversation is automatically archived. + + Swagger operation ID: `ArchiveConversation`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + phone_number: Phone number of the conversation to archive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1057,7 +1271,7 @@ async def archive_conversation_async( f"/archive" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -1071,6 +1285,7 @@ async def archive_conversation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1078,7 +1293,7 @@ async def archive_conversation_async( return json.loads(response.text) - async def unarchive_conversation_async( + async def unarchive_conversation( self, dashboard_id: int, phone_number: str, @@ -1095,6 +1310,24 @@ async def unarchive_conversation_async( once again appear in the queue. it will also appear in conversations returned by the /conversations endpoint. If a conversation is already unarchived, this method has no effect. + + Swagger operation ID: `UnarchiveConversation`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + phone_number: Phone number of the conversation to archive. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1106,7 +1339,7 @@ async def unarchive_conversation_async( f"/unarchive" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -1120,6 +1353,7 @@ async def unarchive_conversation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1127,7 +1361,7 @@ async def unarchive_conversation_async( return json.loads(response.text) - async def get_contact_by_phone_number_async( + async def get_contact_by_phone_number( self, dashboard_id: int, phone_number: str, @@ -1141,6 +1375,24 @@ async def get_contact_by_phone_number_async( Gets the contact with the specified phone number Gets the contact with the specified phone number + + Swagger operation ID: `GetContactByPhoneNumber`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + phone_number: Phone number of the contact to get. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1150,7 +1402,7 @@ async def get_contact_by_phone_number_async( f"/{quote(str(phone_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1164,6 +1416,7 @@ async def get_contact_by_phone_number_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1171,7 +1424,7 @@ async def get_contact_by_phone_number_async( return json.loads(response.text) - async def delete_contact_async( + async def delete_contact( self, dashboard_id: int, phone_number: str, @@ -1185,6 +1438,24 @@ async def delete_contact_async( Deletes the contact with the specified phone number Deletes the contact with the specified phone number + + Swagger operation ID: `DeleteContact`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + phone_number: Phone number of the contact to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1194,7 +1465,7 @@ async def delete_contact_async( f"/{quote(str(phone_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1208,6 +1479,7 @@ async def delete_contact_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1215,9 +1487,9 @@ async def delete_contact_async( return json.loads(response.text) - async def create_contact_async( + async def create_contact( self, - input: CreateContactInput, + input: CreateContactInput | Mapping[str, Any], dashboard_id: int, phone_number: str, *, @@ -1231,6 +1503,26 @@ async def create_contact_async( Creates or updates a contact (depending on whether one already exists with the given phone number). + + Swagger operation ID: `CreateContact`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + phone_number: Phone number of the contact to create or update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1240,7 +1532,7 @@ async def create_contact_async( f"/{quote(str(phone_number), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1254,6 +1546,7 @@ async def create_contact_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1261,11 +1554,12 @@ async def create_contact_async( return json.loads(response.text) - async def get_contacts_async( + def list_contacts( self, dashboard_id: int, page: int, page_size: int, + *, contact_phone_number: Optional[str] = None, last_message_timestamp_before_utc: Optional[str] = None, last_message_timestamp_after_utc: Optional[str] = None, @@ -1288,18 +1582,100 @@ async def get_contacts_async( custom_field_value2: Optional[str] = None, custom_field_id3: Optional[str] = None, custom_field_value3: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all contacts that match the specified filtering criterion Gets all contacts that match the specified filtering criterion. Only the dashboard specified will be searched; there is no account level search for a number available. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetContacts`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + page: The page of entities to get. When getting values, there is a + max size per page, defined by page_size. If page is greater + than the last page, an empty array will be returned. + page_size: The size of each page to get. When getting values, this + is a max size per page, with accessing subsequent pages done by + the page parameter. + contact_phone_number: Phone number to filter contacts by. + last_message_timestamp_before_utc: Cutoff time for searching + contacts by the last message sent or received. No contacts who + sent messages after this time will be shown. + last_message_timestamp_after_utc: Cutoff time for searching + contacts by the last message sent or received. No contacts + whose last sent message is before this time will be shown. + contact_created_before: Cutoff time for searching contacts by when + they were created. No contacts created after this time will be + shown. + contact_created_after: Cutoff time for searching contacts by when + they were created. No contacts created before this time will be + shown. + is_resolved: Whether to search for contacts whose conversations + have been resolved. + is_blocked: Whether to search for contacts who have been blocked. + is_archived: Whether to search for contacts who have been archived. + is_suppressed: Whether to search for contacts who have been + suppressed. + has_opted_out: Whether to search for contacts who have opted out of + receiving texts. + last_message_sent_before: Cutoff time for searching contacts by + when the last message was sent to the customer. No contacts who + sent messages after this time will be shown. Uses timestamp as + local time. To filter by time stamp in UTC time, use + last_message_sent_before_utc. + last_message_sent_after: Cutoff time for searching contacts by when + the last message was sent to the customer. No contacts whose + last sent message is before this time will be shown. Uses + timestamp as local time. To filter by time stamp in UTC time, + use last_message_sent_after_utc. + last_message_received_before: Cutoff time for searching contacts by + the last message received from the customer. No contacts who + received messages after this time will be shown. Uses timestamp + as local time. To filter by time stamp in UTC time, use + last_message_sent_before_utc. + last_message_received_after: Cutoff time for searching contacts by + the last message received from the customer. No contacts whose + last sent message is before this time will be shown. Uses + timestamp as local time. To filter by time stamp in UTC time, + use last_message_sent_before_utc. + tags: Comma-separated list of guids referring to tags to filter + contacts by. + groups: Comma-separated list of integer ids referring to groups to + filter contacts by. + custom_field_id1: Guid referring to custom field to filter contacts + by. + custom_field_value1: Value referring to custom field to filter + contacts by. + custom_field_id2: Guid referring to second custom field to filter + contacts by. + custom_field_value2: Value referring to second custom field to + filter contacts by. + custom_field_id3: Guid referring to third custom field to filter + contacts by. + custom_field_value3: Value referring to third custom field to + filter contacts by. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1426,29 +1802,50 @@ async def get_contacts_async( query_params.append(f"page_size={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def bulk_update_contacts_async( + async def bulk_update_contacts( self, input: BulkUpdateContactsInput, dashboard_id: int, @@ -1464,13 +1861,31 @@ async def bulk_update_contacts_async( Only the dashboard specified will have contacts added; contacts are organized by dashboard, and there is no account level search for a number available. + + Swagger operation ID: `BulkUpdateContacts`. + + Args: + input: The request body. + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/dashboards/{quote(str(dashboard_id), safe='')}/contacts" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1484,6 +1899,7 @@ async def bulk_update_contacts_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1491,7 +1907,7 @@ async def bulk_update_contacts_async( return json.loads(response.text) - async def get_group_by_id_async( + async def get_group_by_id( self, dashboard_id: int, group_id: int, @@ -1505,6 +1921,24 @@ async def get_group_by_id_async( Get a group by its id Gets the group with the specified id. + + Swagger operation ID: `GetGroupById`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + group_id: The numerical id of the group to get. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1514,7 +1948,7 @@ async def get_group_by_id_async( f"/{quote(str(group_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1528,6 +1962,7 @@ async def get_group_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1535,7 +1970,7 @@ async def get_group_by_id_async( return json.loads(response.text) - async def delete_group_async( + async def delete_group( self, dashboard_id: int, group_id: int, @@ -1551,6 +1986,24 @@ async def delete_group_async( Deletes the group with the specified id. This will succeed even if there are contacts that are members of the group (the contacts will not be deleted). + + Swagger operation ID: `DeleteGroup`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + group_id: The numerical id of the group to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1560,7 +2013,7 @@ async def delete_group_async( f"/{quote(str(group_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1574,6 +2027,7 @@ async def delete_group_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1581,9 +2035,9 @@ async def delete_group_async( return json.loads(response.text) - async def update_group_async( + async def update_group( self, - input: UpdateGroupInput, + input: UpdateGroupInput | Mapping[str, Any], dashboard_id: int, group_id: int, *, @@ -1597,6 +2051,26 @@ async def update_group_async( Updates a group's name using the group's numerical id. If the passed in group id does not exist, the call will fail. + + Swagger operation ID: `UpdateGroup`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + group_id: The numerical id of the group to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1606,7 +2080,7 @@ async def update_group_async( f"/{quote(str(group_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -1620,6 +2094,7 @@ async def update_group_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1627,7 +2102,7 @@ async def update_group_async( return json.loads(response.text) - async def get_groups_async( + def list_groups( self, dashboard_id: int, page: int, @@ -1637,11 +2112,37 @@ async def get_groups_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Gets all groups Gets all groups for the user's account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetGroups`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + page: The page of entities to get. When getting values, there is a + max size per page, defined by page_size. If page is greater + than the last page, an empty array will be returned. + page_size: The size of each page to get. When getting values, this + is a max size per page, with accessing subsequent pages done by + the page parameter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1658,31 +2159,52 @@ async def get_groups_async( query_params.append(f"page_size={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item - async def create_group_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_group( self, - input: CreateGroupInput, + input: CreateGroupInput | Mapping[str, Any], dashboard_id: int, *, timeout: Optional[float] = None, @@ -1694,13 +2216,32 @@ async def create_group_async( Creates a new group Creates a new group with the provided name. + + Swagger operation ID: `CreateGroup`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/dashboards/{quote(str(dashboard_id), safe='')}/groups" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1714,6 +2255,7 @@ async def create_group_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1721,7 +2263,7 @@ async def create_group_async( return json.loads(response.text) - async def get_tags_async( + def list_tags( self, dashboard_id: int, page: int, @@ -1731,12 +2273,38 @@ async def get_tags_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Gets all tags Gets all the tags for this dashboard. Tags are unique between dashboards. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTags`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + page: The page of entities to get. When getting values, there is a + max size per page, defined by page_size. If page is greater + than the last page, an empty array will be returned. + page_size: The size of each page to get. When getting values, this + is a max size per page, with accessing subsequent pages done by + the page parameter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1753,29 +2321,50 @@ async def get_tags_async( query_params.append(f"page_size={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() - async def get_custom_fields_async( + return AsyncItemPaged(get_next, extract_data) + + def list_custom_fields( self, dashboard_id: int, *, @@ -1783,40 +2372,81 @@ async def get_custom_fields_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Gets all custom fields Gets all custom fields for this dashboard. Custom fields are unique between dashboards. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetCustomFields`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/dashboards/{quote(str(dashboard_id), safe='')}/fields" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_payment_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_payment( self, dashboard_id: int, payment_id: int, @@ -1830,6 +2460,24 @@ async def get_payment_async( Gets the payment with the specified id Gets the payment with the specified id. + + Swagger operation ID: `GetPayment`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + payment_id: The numerical id of the payment to get. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1839,7 +2487,7 @@ async def get_payment_async( f"/{quote(str(payment_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1853,6 +2501,7 @@ async def get_payment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1860,7 +2509,7 @@ async def get_payment_async( return json.loads(response.text) - async def mark_payment_paid_async( + async def mark_payment_paid( self, dashboard_id: int, payment_id: int, @@ -1879,6 +2528,24 @@ async def mark_payment_paid_async( endpoint is not required for payments paid through the payments-portal sent through Text Request; that will automatically mark a payment as paid. + + Swagger operation ID: `MarkPaymentPaid`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + payment_id: The numerical id of the payment to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1889,7 +2556,7 @@ async def mark_payment_paid_async( f"/mark_as_paid" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1903,6 +2570,7 @@ async def mark_payment_paid_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1910,7 +2578,7 @@ async def mark_payment_paid_async( return json.loads(response.text) - async def send_payment_reminder_async( + async def send_payment_reminder( self, dashboard_id: int, payment_id: int, @@ -1926,6 +2594,24 @@ async def send_payment_reminder_async( Sends a reminder to the contact to pay the specified payment. The content of the message is auto-generated. To avoid spam, only one reminder can be sent per payment + + Swagger operation ID: `SendPaymentReminder`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + payment_id: The numerical id of the payment to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1936,7 +2622,7 @@ async def send_payment_reminder_async( f"/resend" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1950,6 +2636,7 @@ async def send_payment_reminder_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1957,7 +2644,7 @@ async def send_payment_reminder_async( return json.loads(response.text) - async def cancel_payment_async( + async def cancel_payment( self, dashboard_id: int, payment_id: int, @@ -1973,6 +2660,24 @@ async def cancel_payment_async( Cancels the specified payment, texting the user that the payment has been canceled. Payments cannot be edited, so canceling and issuing a new payment is the best way to correct a payment. + + Swagger operation ID: `CancelPayment`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + payment_id: The numerical id of the payment to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1983,7 +2688,7 @@ async def cancel_payment_async( f"/cancel" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -1997,6 +2702,7 @@ async def cancel_payment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2004,26 +2710,60 @@ async def cancel_payment_async( return json.loads(response.text) - async def get_payments_async( + def list_payments( self, dashboard_id: int, page: int, page_size: int, + *, reference_number: Optional[str] = None, phone_number: Optional[str] = None, sort_type: Optional[str] = None, sort_direction: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Gets all payments Gets all payments, including canceled and paid payments. These can be filtered using the query parameters. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetPayments`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + page: The page of entities to get. When getting values, there is a + max size per page, defined by page_size. If page is greater + than the last page, an empty array will be returned. + page_size: The size of each page to get. When getting values, this + is a max size per page, with accessing subsequent pages done by + the page parameter. + reference_number: User-defined id defined when payments are created + that can be used to quickly find payments. Reference numbers + are not unique; many payments can have the same reference. + phone_number: Phone number of the contact this payment was sent to. + sort_type: Property to sort payments by. Can be \"amount\", + \"contact\", \"date\", \"status\". + sort_direction: Direction to sort payments in. Can be \"desc\" for + greatest to smallest, or \"asc\" for smallest to greatest. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2060,31 +2800,52 @@ async def get_payments_async( query_params.append(f"page_size={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() - async def create_payment_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_payment( self, - input: CreatePaymentInput, + input: CreatePaymentInput | Mapping[str, Any], dashboard_id: int, *, timeout: Optional[float] = None, @@ -2097,13 +2858,32 @@ async def create_payment_async( Creates a new payment with the provided message to the provided contact. + + Swagger operation ID: `CreatePayment`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/dashboards/{quote(str(dashboard_id), safe='')}/payments" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2117,6 +2897,7 @@ async def create_payment_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2124,7 +2905,7 @@ async def create_payment_async( return json.loads(response.text) - async def get_dashboard_async( + async def get_dashboard( self, dashboard_id: int, *, @@ -2137,13 +2918,30 @@ async def get_dashboard_async( Get info on this specific dashboard Returns the name and phone of the dashboard. + + Swagger operation ID: `GetDashboard`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/dashboards/{quote(str(dashboard_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2157,6 +2955,7 @@ async def get_dashboard_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2164,7 +2963,7 @@ async def get_dashboard_async( return json.loads(response.text) - async def delete_dashboard_async( + async def delete_dashboard( self, dashboard_id: int, *, @@ -2177,13 +2976,30 @@ async def delete_dashboard_async( Deletes the specified dashboard Deletes the specified dashboard. + + Swagger operation ID: `DeleteDashboard`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/dashboards/{quote(str(dashboard_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -2197,6 +3013,7 @@ async def delete_dashboard_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2204,9 +3021,9 @@ async def delete_dashboard_async( return json.loads(response.text) - async def update_dashboards_name_async( + async def update_dashboards_name( self, - input: UpdateDashboardsNameInput, + input: UpdateDashboardsNameInput | Mapping[str, Any], dashboard_id: int, *, timeout: Optional[float] = None, @@ -2221,13 +3038,32 @@ async def update_dashboards_name_async( If you want a new number with another dashboard's contacts, you will have to create a new dashboard with a POST and add the contacts with a bulk export/import. + + Swagger operation ID: `UpdateDashboardsName`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/dashboards/{quote(str(dashboard_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2241,6 +3077,7 @@ async def update_dashboards_name_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2248,26 +3085,63 @@ async def update_dashboards_name_async( return json.loads(response.text) - async def get_conversations_async( + def list_conversations( self, dashboard_id: int, + *, tags: Optional[str] = None, show_unresolved_only: Optional[str] = None, include_archived: Optional[str] = None, search: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Gets all conversations for this dashboard Gets all conversations for this dashboard, and includes info on the last message for each conversation. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetConversations`. + + Args: + dashboard_id: The phone number dashboard to work on. A single + account can have several dashboards, representing different + phone lines for customers. + tags: Comma-separated list of guids referring to tags to filter + conversations by. + show_unresolved_only: Whether to only search for contacts whose + conversations have been resolved. If this is false, both + resolved and unresolved conversations will be shown. + include_archived: Whether to include conversations with contacts + that have been archived. + search: Search term for filtering conversations by phone number or + display name. If the search term is less than a full name or + phone number, the search will return all conversations that + partially match it. + page: The page of entities to get. When getting values, there is a + max size per page, defined by page_size. If page is greater + than the last page, an empty array will be returned. + page_size: The size of each page to get. When getting values, this + is a max size per page, with accessing subsequent pages done by + the page parameter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2306,42 +3180,86 @@ async def get_conversations_async( query_params.append(f"page_size={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_dashboards_async( + def list_dashboards( self, + *, page: Optional[int] = None, page_size: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all dashboards in an account Gets all dashboards in an account. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDashboards`. + + Args: + page: The page of entities to get. When getting values, there is a + max size per page, defined by page_size. If page is greater + than the last page, an empty array will be returned. + page_size: The size of each page to get. When getting values, this + is a max size per page, with accessing subsequent pages done by + the page parameter. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/dashboards" query_params = [] @@ -2357,31 +3275,52 @@ async def get_dashboards_async( query_params.append(f"page_size={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() - async def create_dashboard_async( + return AsyncItemPaged(get_next, extract_data) + + async def create_dashboard( self, - input: CreateDashboardInput, + input: CreateDashboardInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -2397,10 +3336,26 @@ async def create_dashboard_async( search for provisioned numbers in a specific area code using GET /dashboards/provisioning. If the phone number is already in use, a Bad Request exception will be thrown. + + Swagger operation ID: `CreateDashboard`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/dashboards" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2414,6 +3369,7 @@ async def create_dashboard_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/ticketmaster.py b/src/azure/connectors/ticketmaster.py index e3ca3b41..cb54e8e4 100644 --- a/src/azure/connectors/ticketmaster.py +++ b/src/azure/connectors/ticketmaster.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Any, Mapping from urllib.parse import quote import json @@ -20,6 +20,23 @@ ConnectorResponseHook, ) +__all__ = [ + "TicketmasterClient", + "AttractionGetResponse", + "AttractionsGetResponse", + "ClassificationGetResponse", + "ClassificationsGetResponse", + "EventGetResponse", + "EventImagesGetResponse", + "EventsGetResponse", + "GenreGetResponse", + "SegmentGetResponse", + "SubGenreGetResponse", + "SuggestionsGetResponse", + "VenueGetResponse", + "VenuesGetResponse", +] + # Type Definitions @@ -29,15 +46,17 @@ class EventsGetResponse: Response for Event search """ - links: Optional[Dict[str, Any]] = field( + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) - embedded: Optional[Dict[str, Any]] = field( + embedded: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_embedded"}, ) - page: Optional[Dict[str, Any]] = None + page: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -46,39 +65,52 @@ class EventGetResponse: Response for Get event details """ - embedded: Optional[Dict[str, Any]] = field( + embedded: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_embedded"}, ) - links: Optional[Dict[str, Any]] = field( + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) - classifications: Optional[List[Dict[str, Any]]] = None - dates: Optional[Dict[str, Any]] = None - id: Optional[str] = None + classifications: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + dates: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - images: Optional[List[Dict[str, Any]]] = None - locale: Optional[str] = None + images: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name.""" - please_note: Optional[str] = field( + please_note: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "pleaseNote"}, ) """The please note.""" - price_ranges: Optional[List[Dict[str, Any]]] = field( + price_ranges: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "priceRanges"}, ) - promoter: Optional[Dict[str, Any]] = None - sales: Optional[Dict[str, Any]] = None - test: Optional[bool] = None + promoter: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + sales: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + test: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether test.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The URL address.""" @@ -88,13 +120,18 @@ class EventImagesGetResponse: Response for Get event images """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - images: Optional[List[Dict[str, Any]]] = None - links: Optional[Dict[str, Any]] = field( + images: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) @@ -105,15 +142,17 @@ class AttractionsGetResponse: Response for Attraction search """ - links: Optional[Dict[str, Any]] = field( + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) - embedded: Optional[Dict[str, Any]] = field( + embedded: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_embedded"}, ) - page: Optional[Dict[str, Any]] = None + page: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -122,20 +161,30 @@ class AttractionGetResponse: Response for Get attraction details """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - test: Optional[bool] = None + test: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether test.""" - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale.""" - images: Optional[List[Dict[str, Any]]] = None - classifications: Optional[List[Dict[str, Any]]] = None - links: Optional[Dict[str, Any]] = field( + images: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + classifications: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) @@ -146,15 +195,17 @@ class ClassificationsGetResponse: Response for Classification search """ - links: Optional[Dict[str, Any]] = field( + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) - embedded: Optional[Dict[str, Any]] = field( + embedded: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_embedded"}, ) - page: Optional[Dict[str, Any]] = None + page: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -163,11 +214,12 @@ class ClassificationGetResponse: Response for Get classification details """ - links: Optional[Dict[str, Any]] = field( + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) - segment: Optional[Dict[str, Any]] = None + segment: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -176,17 +228,19 @@ class GenreGetResponse: Response for Get genre details """ - embedded: Optional[Dict[str, Any]] = field( + embedded: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_embedded"}, ) - links: Optional[Dict[str, Any]] = field( + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name.""" @@ -196,16 +250,18 @@ class SegmentGetResponse: Response for Get segment details """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name.""" - links: Optional[Dict[str, Any]] = field( + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) - embedded: Optional[Dict[str, Any]] = field( + embedded: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_embedded"}, ) @@ -216,15 +272,16 @@ class SubGenreGetResponse: Response for Get sub-genre details """ - links: Optional[Dict[str, Any]] = field( + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name.""" - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale.""" @@ -234,15 +291,17 @@ class VenuesGetResponse: Response for Venue search """ - embedded: Optional[Dict[str, Any]] = field( + embedded: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_embedded"}, ) - links: Optional[Dict[str, Any]] = field( + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) - page: Optional[Dict[str, Any]] = None + page: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -251,31 +310,37 @@ class VenueGetResponse: Response for Get venue details """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name.""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type.""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The identifier.""" - test: Optional[bool] = None + test: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether test.""" - locale: Optional[str] = None + locale: Optional[str] = dataclass_field(default=None, kw_only=True) """The locale.""" - postal_code: Optional[str] = field( + postal_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "postalCode"}, ) """The postal code.""" - timezone: Optional[str] = None + timezone: Optional[str] = dataclass_field(default=None, kw_only=True) """The timezone.""" - city: Optional[Dict[str, Any]] = None - state: Optional[Dict[str, Any]] = None - country: Optional[Dict[str, Any]] = None - address: Optional[Dict[str, Any]] = None - location: Optional[Dict[str, Any]] = None - markets: Optional[List[Dict[str, Any]]] = None - links: Optional[Dict[str, Any]] = field( + city: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + state: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + country: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + address: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + location: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + markets: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) @@ -286,12 +351,14 @@ class SuggestionsGetResponse: Response for Find suggestions """ - links: Optional[Dict[str, Any]] = field( + links: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_links"}, ) - embedded: Optional[Dict[str, Any]] = field( + embedded: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_embedded"}, ) @@ -307,7 +374,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -324,8 +391,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -346,7 +413,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -361,8 +428,9 @@ def __init__( def connector_name(self) -> str: return "ticketmaster" - async def events_get_async( + async def events_get( self, + *, size: Optional[int] = None, id: Optional[str] = None, keyword: Optional[str] = None, @@ -410,7 +478,6 @@ async def events_get_async( preferred_country: Optional[str] = None, include_spellcheck: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -421,6 +488,89 @@ async def events_get_async( Find events and filter your search by location, date, availability, and much more. + + Swagger operation ID: `EventsGet`. + + Args: + size: The page size of the response. + id: The filter for entities by their identifier. + keyword: The keyword to search on. + attraction_id: The filter by attraction identifier. + venue_id: The filter by venue identifier. + postal_code: The filter by postal code or zipcode. + latlong: The filter for events by latitude and longitude. This + filter is deprecated and may be removed in a future release, + please use geoPoint instead. + radius: The radius of the area in which we want to search for + events. + unit: The unit of the radius. + source: The filter for entities by their primary source name or + publishing source name. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + market_id: The filter by market identifier. + start_date_time: The filter with a start date after this date. + end_date_time: The filter with a start date before this date. + include_t_b_a: Indicates whether to include events with date to be + announced (TBA). + include_t_b_d: Indicates whether to include events with a date to + be defined (TBD). + include_test: Indicates whether to include entities flagged as test + in the response. + page: The page number. + sort: The sorting order of the search result. + onsale_start_date_time: The filter with onsale start date after + this date. + onsale_end_date_time: The filter with onsale end date before this + date. + city: The filter by city. + country_code: The filter by country code. + state_code: The filter by state code. + classification_name: The filter by classification name: name of any + segment, genre, sub-genre, type, sub-type. + classification_id: The filter by classification identifier: + identifier of any segment, genre, sub-genre, type, sub-type. + dma_id: The filter by DMA identifier. + local_start_date_time: The filter with event local start date time + within this range. + local_start_end_date_time: The filter for events where event local + start and end date overlap this range. + start_end_date_time: The filter for events where event start and + end date overlap this range. + public_visibility_start_date_time: The filter for events with + public visibility starting. + pre_sale_date_time: The filter for events with a presale start and + end that intersects with this range. + onsale_on_start_date: The filter with onsale start date on this + date. + onsale_on_after_start_date: The filter with onsale range within + this date. + collection_id: The filter by collection identifier. + segment_id: The filter by segment identifier. + segment_name: The filter by segment name. + include_family: The filter by classification that are + family-friendly. + promoter_id: The filter by promoter identifier. + genre_id: The filter by genre identifier. + sub_genre_id: The filter by sub-genre identifier. + type_id: The filter by type identifier. + sub_type_id: The filter by sub-type identifier. + geo_point: The filter for events by geoHash. + preferred_country: The popularity boost by country, default is us. + include_spellcheck: Indicates whether to include spell check + suggestions in the response. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/discovery/v2/events.json" @@ -825,7 +975,7 @@ async def events_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -839,6 +989,7 @@ async def events_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -846,12 +997,12 @@ async def events_get_async( return json.loads(response.text) - async def event_get_async( + async def event_get( self, id: str, + *, locale: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -863,6 +1014,25 @@ async def event_get_async( Get details for a specific event using the unique identifier for the event. This includes the venue and location, the attraction(s), and the Ticketmaster Website URL for purchasing tickets for the event + + Swagger operation ID: `EventGet`. + + Args: + id: The unique identifier for the event. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -893,7 +1063,7 @@ async def event_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -907,6 +1077,7 @@ async def event_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -914,12 +1085,12 @@ async def event_get_async( return json.loads(response.text) - async def event_images_get_async( + async def event_images_get( self, id: str, + *, locale: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -930,6 +1101,25 @@ async def event_images_get_async( Get images for a specific event using the unique identifier for the event. + + Swagger operation ID: `EventImagesGet`. + + Args: + id: The unique identifier for the event. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -960,7 +1150,7 @@ async def event_images_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -974,6 +1164,7 @@ async def event_images_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -981,8 +1172,9 @@ async def event_images_get_async( return json.loads(response.text) - async def attractions_get_async( + async def attractions_get( self, + *, id: Optional[str] = None, keyword: Optional[str] = None, source: Optional[str] = None, @@ -1003,7 +1195,6 @@ async def attractions_get_async( preferred_country: Optional[str] = None, include_spellcheck: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1014,6 +1205,48 @@ async def attractions_get_async( Find attractions (artists, sports, packages, plays and so on) and filter your search by name, and much more. + + Swagger operation ID: `AttractionsGet`. + + Args: + id: The filter for entities by their identifier. + keyword: The keyword to search on. + source: The filter for entities by their primary source name or + publishing source name. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + include_test: Indicates whether to include entities flagged as test + in the response. + size: The page size of the response. + page: The page number. + sort: The sorting order of the search result. + classification_name: The filter for attractions by classification + name. + classification_id: The filter for attractions by classification + identifier. + include_family: The filter by classification that are + family-friendly. + segment_id: The filter for attractions by segment identifier. + genre_id: The filter for attractions by genre identifier. + sub_genre_id: The filter for attractions by sub-genre identifier. + type_id: The filter for attractions by type identifier. + sub_type_id: The filter for attractions by sub-type identifier. + country_code: The filter for attractions by country code. + preferred_country: The popularity boost by country, default is us. + include_spellcheck: Indicates whether to include spell check + suggestions in the response. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/discovery/v2/attractions" @@ -1203,7 +1436,7 @@ async def attractions_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1217,6 +1450,7 @@ async def attractions_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1224,12 +1458,12 @@ async def attractions_get_async( return json.loads(response.text) - async def attraction_get_async( + async def attraction_get( self, id: str, + *, locale: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1240,6 +1474,25 @@ async def attraction_get_async( Get details for a specific attraction using the unique identifier for the attraction. + + Swagger operation ID: `AttractionGet`. + + Args: + id: The unique identifier for the attraction. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1270,7 +1523,7 @@ async def attraction_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1284,6 +1537,7 @@ async def attraction_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1291,8 +1545,9 @@ async def attraction_get_async( return json.loads(response.text) - async def classifications_get_async( + async def classifications_get( self, + *, id: Optional[str] = None, keyword: Optional[str] = None, source: Optional[str] = None, @@ -1305,7 +1560,6 @@ async def classifications_get_async( preferred_country: Optional[str] = None, include_spellcheck: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1316,6 +1570,37 @@ async def classifications_get_async( Find classifications and filter your search by name, and much more. Classifications help define the nature of attractions and events. + + Swagger operation ID: `ClassificationsGet`. + + Args: + id: The filter for entities by their identifier. + keyword: The keyword to search on. + source: The filter for entities by their primary source name or + publishing source name. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + include_test: Indicates whether to include entities flagged as test + in the response. + size: The page size of the response. + page: The page number. + sort: The sorting order of the search result. + country_code: The filter for classifications by country code. + preferred_country: The popularity boost by country, default is us. + include_spellcheck: Indicates whether to include spell check + suggestions in the response. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/discovery/v2/classifications" @@ -1395,7 +1680,7 @@ async def classifications_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1409,6 +1694,7 @@ async def classifications_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1416,12 +1702,12 @@ async def classifications_get_async( return json.loads(response.text) - async def classification_get_async( + async def classification_get( self, id: str, + *, locale: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1432,6 +1718,25 @@ async def classification_get_async( Get details for a specific segment, genre, or sub-genre using its unique identifier. + + Swagger operation ID: `ClassificationGet`. + + Args: + id: The unique identifier for the classification. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1462,7 +1767,7 @@ async def classification_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1476,6 +1781,7 @@ async def classification_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1483,12 +1789,12 @@ async def classification_get_async( return json.loads(response.text) - async def genre_get_async( + async def genre_get( self, id: str, + *, locale: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1498,6 +1804,25 @@ async def genre_get_async( Get genre details Get details for a specific genre using its unique identifier. + + Swagger operation ID: `GenreGet`. + + Args: + id: The unique identifier for the genre. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1528,7 +1853,7 @@ async def genre_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1542,6 +1867,7 @@ async def genre_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1549,12 +1875,12 @@ async def genre_get_async( return json.loads(response.text) - async def segment_get_async( + async def segment_get( self, id: str, + *, locale: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1564,6 +1890,25 @@ async def segment_get_async( Get segment details Get details for a specific segment using its unique identifier. + + Swagger operation ID: `SegmentGet`. + + Args: + id: The unique identifier for the segment. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1594,7 +1939,7 @@ async def segment_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1608,6 +1953,7 @@ async def segment_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1615,12 +1961,12 @@ async def segment_get_async( return json.loads(response.text) - async def sub_genre_get_async( + async def sub_genre_get( self, id: str, + *, locale: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1630,6 +1976,25 @@ async def sub_genre_get_async( Get sub-genre details Get details for a specific sub-genre using its unique identifier. + + Swagger operation ID: `SubGenreGet`. + + Args: + id: The unique identifier for the sub-genre. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1664,7 +2029,7 @@ async def sub_genre_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1678,6 +2043,7 @@ async def sub_genre_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1685,8 +2051,9 @@ async def sub_genre_get_async( return json.loads(response.text) - async def venues_get_async( + async def venues_get( self, + *, id: Optional[str] = None, keyword: Optional[str] = None, latlong: Optional[str] = None, @@ -1704,7 +2071,6 @@ async def venues_get_async( preferred_country: Optional[str] = None, include_spellcheck: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1714,6 +2080,45 @@ async def venues_get_async( Venue search Find venues and filter your search by name, and much more. + + Swagger operation ID: `VenuesGet`. + + Args: + id: The filter for entities by their identifier. + keyword: The keyword to search on. + latlong: The filter for venues by latitude and longitude. This + filter is deprecated and may be removed in a future release, + please use geoPoint instead. + radius: The radius of the area in which we want to search for + venues. + unit: The unit of the radius. + source: The filter for entities by their primary source name or + publishing source name. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + include_test: Indicates whether to include entities flagged as test + in the response. + size: The page size of the response. + page: The page number. + sort: The sorting order of the search result. + country_code: The filter for venues by country code. + state_code: The filter by state / province code. + geo_point: The filter for venues by geoHash. + preferred_country: The popularity boost by country, default is us. + include_spellcheck: Indicates whether to include spell check + suggestions in the response. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/discovery/v2/venues" query_params = [] @@ -1816,7 +2221,7 @@ async def venues_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1830,6 +2235,7 @@ async def venues_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1837,12 +2243,12 @@ async def venues_get_async( return json.loads(response.text) - async def venue_get_async( + async def venue_get( self, id: str, + *, locale: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1853,6 +2259,25 @@ async def venue_get_async( Get details for a specific venue using the unique identifier for the venue. + + Swagger operation ID: `VenueGet`. + + Args: + id: The unique identifier for the venue. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1883,7 +2308,7 @@ async def venue_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1897,6 +2322,7 @@ async def venue_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1904,8 +2330,9 @@ async def venue_get_async( return json.loads(response.text) - async def suggestions_get_async( + async def suggestions_get( self, + *, keyword: Optional[str] = None, latlong: Optional[str] = None, radius: Optional[str] = None, @@ -1925,7 +2352,6 @@ async def suggestions_get_async( local_start_end_date_time: Optional[List[str]] = None, include_spellcheck: Optional[str] = None, domain: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1936,6 +2362,54 @@ async def suggestions_get_async( Find search suggestions and filter your suggestions by location, source, etc. + + Swagger operation ID: `SuggestionsGet`. + + Args: + keyword: The keyword to search on. + latlong: The filter for events by latitude and longitude. This + filter is deprecated and may be removed in a future release, + please use geoPoint instead. + radius: The radius of the area in which we want to search for + events. + unit: The unit of the radius. + source: The filter for entities by their primary source name or + publishing source name. + locale: The locale in ISO code format. Multiple comma-separated + values can be provided. + include_t_b_a: Indicates whether to include events with date to be + announced (TBA). Defaults to no if date parameter sent, yes + otherwise. + include_t_b_d: Indicates whether to include events with a date to + be defined (TBD). Defaults to no if date parameter sent, yes + otherwise. + include_test: Indicates whether to include entities flagged as test + in the response. + size: Size of every entity returned in the response. + country_code: The filter suggestions by country code. + segment_id: The filter suggestions by segment identifier. + geo_point: The filter for events by geoHash. + resource: Which resources to include in the suggest response, + defaults to all resources. + preferred_country: The popularity boost by country, default is us. + start_end_date_time: The filter for events where event start and + end date overlap this range. + local_start_end_date_time: The filter for events where event local + start and end date overlap this range. + include_spellcheck: Indicates whether to include spell check + suggestions in the response. + domain: The filter for entities based on domains they are available + on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/discovery/v2/suggest" query_params = [] @@ -2088,7 +2562,7 @@ async def suggestions_get_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2102,6 +2576,7 @@ async def suggestions_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/todo.py b/src/azure/connectors/todo.py index 7e4bccda..ff4dc79d 100644 --- a/src/azure/connectors/todo.py +++ b/src/azure/connectors/todo.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,24 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "TodoClient", + "CreateToDo", + "CreateToDoBody", + "CreateToDoHtmlBody", + "CreateToDoList", + "CreateToDoListBody", + "ToDo", + "ToDoHtml", + "TodoList", + "UpdateToDo", + "UpdateToDoBody", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,19 +46,22 @@ class TodoList: Response for Update a to-do list """ - etag: Optional[str] = field( + etag: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.etag"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the to-do list.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """Name of the to-do list.""" - wellknown_list_name: Optional[str] = field( + wellknown_list_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "wellknownListName"}, ) """ @@ -49,13 +69,15 @@ class TodoList: well-known list. Possible values are: none, defaultList, flaggedEmails, unknownFutureValue. """ - is_owner: Optional[bool] = field( + is_owner: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOwner"}, ) """True if the user is owner of the given task list.""" - is_shared: Optional[bool] = field( + is_shared: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isShared"}, ) """True if the task list is shared with other users.""" @@ -67,61 +89,70 @@ class ToDo: Response for Add a to-do """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - etag: Optional[str] = field( + etag: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.etag"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the to-do.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """YYYY-MM-DDThh:mm:ssZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """YYYY-MM-DDThh:mm:ssZ (UTC format)""" - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """To-do body that typically contains information about the to-do.""" - body_last_modified_date_time: Optional[str] = field( + body_last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "bodyLastModifiedDateTime"}, ) """YYYY-MM-DDThh:mm:ssZ (UTC format)""" - completed_date_time: Optional[Dict[str, Any]] = field( + completed_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completedDateTime"}, ) """The date in the specified time zone that the task was finished.""" - due_date_time: Optional[Dict[str, Any]] = field( + due_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDateTime"}, ) """The date in the specified time zone that the task is to be finished.""" - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """Low, normal or high.""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """True if an alert is set to remind the user of the to-do.""" - reminder_date_time: Optional[Dict[str, Any]] = field( + reminder_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderDateTime"}, ) """The date and time for a reminder alert of the task to occur.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred. """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Brief description or title of the to-do.""" @@ -131,81 +162,93 @@ class ToDoHtml: Definition: ToDoHtml """ - context: Optional[str] = field( + context: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.context"}, ) - id_2: Optional[str] = field( + id_2: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.id"}, ) - etag: Optional[str] = field( + etag: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.etag"}, ) - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the to-do.""" - created_date_time: Optional[str] = field( + created_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdDateTime"}, ) """YYYY-MM-DDThh:mm:ssZ (UTC format)""" - last_modified_date_time: Optional[str] = field( + last_modified_date_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastModifiedDateTime"}, ) """YYYY-MM-DDThh:mm:ssZ (UTC format)""" - categories: Optional[List[str]] = None + categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """Collection of category names associated with the to-do.""" - assigned_to: Optional[str] = field( + assigned_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedTo"}, ) """Name of the person who has been assigned the to-do.""" - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """To-do body that typically contains information about the to-do.""" - completed_date_time: Optional[Dict[str, Any]] = field( + completed_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completedDateTime"}, ) """Date-time in the UTC time zone when the to-do was finished.""" - due_date_time: Optional[Dict[str, Any]] = field( + due_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDateTime"}, ) """Date in the UTC time zone when the to-do is to be finished.""" - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """Low, normal or high.""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """True if an alert is set to remind the user of the to-do.""" - owner: Optional[str] = None + owner: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the person who created the to-do.""" - parent_folder_id: Optional[str] = field( + parent_folder_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "parentFolderId"}, ) """Unique identifier of the parent folder.""" - reminder_date_time: Optional[Dict[str, Any]] = field( + reminder_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderDateTime"}, ) """ Date-time in the UTC time zone for a reminder alert of the to-do to occur. """ - start_date_time: Optional[Dict[str, Any]] = field( + start_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startDateTime"}, ) """Date in the UTC time zone when the to-do is to begin.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred. """ - subject: Optional[str] = None + subject: Optional[str] = dataclass_field(default=None, kw_only=True) """Brief description or title of the to-do.""" @@ -215,58 +258,64 @@ class CreateToDoBody: Definition: CreateToDoBody """ - due_date_time: Optional[Dict[str, Any]] = field( + due_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DueDateTime"}, ) """Date in the UTC time zone when the to-do is to be finished.""" - reminder_date_time: Optional[Dict[str, Any]] = field( + reminder_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReminderDateTime"}, ) """ Date-time in UTC time zone for a reminder alert of the to-do to occur. """ - start_date_time: Optional[Dict[str, Any]] = field( + start_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDateTime"}, ) """Date in the UTC time zone when the to-do is to begin.""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Low, normal or high.""" - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Brief description or title of the to-do.""" - status: Optional[str] = field( + status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Status"}, ) """ Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred. """ - sensitivity: Optional[str] = field( + sensitivity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sensitivity"}, ) """Indicates the level of privacy for the event.""" - body: Optional[Dict[str, Any]] = field( + body: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Body"}, ) """To-do body that typically contains information about the to-do.""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """Collection of category names associated with the to-do.""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsReminderOn"}, ) """True if an alert is set to remind the user of the to-do.""" @@ -278,58 +327,64 @@ class CreateToDoHtmlBody: Definition: CreateToDoHtmlBody """ - due_date_time: Optional[Dict[str, Any]] = field( + due_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DueDateTime"}, ) """Date in the UTC time zone when the to-do is to be finished.""" - reminder_date_time: Optional[Dict[str, Any]] = field( + reminder_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReminderDateTime"}, ) """ Date-time in UTC time zone for a reminder alert of the to-do to occur. """ - start_date_time: Optional[Dict[str, Any]] = field( + start_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDateTime"}, ) """Date in the UTC time zone when the to-do is to begin.""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Low, normal or high.""" - subject: Optional[str] = field( - default=None, - metadata={"wire_name": "Subject"}, - ) + subject: str = dataclass_field(metadata={"wire_name": "Subject"}) """Brief description or title of the to-do.""" - status: Optional[str] = field( + status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Status"}, ) """ Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred. """ - sensitivity: Optional[str] = field( + sensitivity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sensitivity"}, ) """Indicates the level of privacy for the event.""" - body: Optional[Dict[str, Any]] = field( + body: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Body"}, ) """To-do body that typically contains information about the to-do.""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """Collection of category names associated with the to-do.""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsReminderOn"}, ) """True if an alert is set to remind the user of the to-do.""" @@ -341,58 +396,68 @@ class UpdateToDoBody: Definition: UpdateToDoBody """ - due_date_time: Optional[Dict[str, Any]] = field( + due_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DueDateTime"}, ) """Date in the UTC time zone when the to-do is to be finished.""" - reminder_date_time: Optional[Dict[str, Any]] = field( + reminder_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ReminderDateTime"}, ) """ Date-time in UTC time zone for a reminder alert of the to-do to occur. """ - start_date_time: Optional[Dict[str, Any]] = field( + start_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StartDateTime"}, ) """Date in the UTC time zone when the to-do is to begin.""" - importance: Optional[str] = field( + importance: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Importance"}, ) """Low, normal or high.""" - subject: Optional[str] = field( + subject: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subject"}, ) """Brief description or title of the to-do.""" - status: Optional[str] = field( + status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Status"}, ) """ Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred. """ - sensitivity: Optional[str] = field( + sensitivity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Sensitivity"}, ) """Indicates the level of privacy for the event.""" - body: Optional[Dict[str, Any]] = field( + body: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Body"}, ) """To-do body that typically contains information about the to-do.""" - categories: Optional[List[str]] = field( + categories: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Categories"}, ) """Collection of category names associated with the to-do.""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsReminderOn"}, ) """True if an alert is set to remind the user of the to-do.""" @@ -404,7 +469,7 @@ class CreateToDoListBody: Definition: CreateToDoListBody """ - name: Optional[str] = None + name: str """List name""" @@ -414,34 +479,37 @@ class CreateToDo: Definition: CreateToDo """ - due_date_time: Optional[Dict[str, Any]] = field( + due_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDateTime"}, ) """ Date in the UTC time zone when the to-do is to be finished (note the time portion will be ignored). """ - reminder_date_time: Optional[Dict[str, Any]] = field( + reminder_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderDateTime"}, ) """ Date-time in UTC time zone for a reminder alert of the to-do to occur. """ - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """Low, normal or high.""" - title: Optional[str] = None + title: str """Brief description or title of the to-do.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred. """ - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """To-do body that typically contains information about the to-do.""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """True if an alert is set to remind the user of the to-do.""" @@ -453,34 +521,37 @@ class UpdateToDo: Definition: UpdateToDo """ - due_date_time: Optional[Dict[str, Any]] = field( + due_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueDateTime"}, ) """ Date in the UTC time zone when the to-do is to be finished (note the time portion will be ignored). """ - reminder_date_time: Optional[Dict[str, Any]] = field( + reminder_date_time: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "reminderDateTime"}, ) """ Date-time in UTC time zone for a reminder alert of the to-do to occur. """ - importance: Optional[str] = None + importance: Optional[str] = dataclass_field(default=None, kw_only=True) """Low, normal or high.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Brief description or title of the to-do.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """ Indicates state or progress of the to-do - not started, in progress, completed, waiting on others or deferred. """ - body: Optional[Dict[str, Any]] = None + body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """To-do body that typically contains information about the to-do.""" - is_reminder_on: Optional[bool] = field( + is_reminder_on: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isReminderOn"}, ) """True if an alert is set to remind the user of the to-do.""" @@ -492,10 +563,7 @@ class CreateToDoList: Definition: CreateToDoList """ - display_name: Optional[str] = field( - default=None, - metadata={"wire_name": "displayName"}, - ) + display_name: str = dataclass_field(metadata={"wire_name": "displayName"}) """List name""" @@ -510,7 +578,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -527,8 +595,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -549,7 +617,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -564,9 +632,86 @@ def __init__( def connector_name(self) -> str: return "todo" - async def update_to_do_list_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def update_to_do_list( self, - input: CreateToDoList, + input: CreateToDoList | Mapping[str, Any], folder_id: str, *, timeout: Optional[float] = None, @@ -578,13 +723,30 @@ async def update_to_do_list_async( Update a to-do list This operation is used to update a specific to-do list. + + Swagger operation ID: `UpdateToDoList`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + folder_id: To-do list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/lists/{quote(str(folder_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -598,6 +760,7 @@ async def update_to_do_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -605,7 +768,7 @@ async def update_to_do_list_async( return json.loads(response.text) - async def delete_to_do_list_async( + async def delete_to_do_list( self, folder_id: str, *, @@ -618,13 +781,28 @@ async def delete_to_do_list_async( Delete a to-do list This operation is used to delete a specific to-do list. + + Swagger operation ID: `DeleteToDoList`. + + Args: + folder_id: To-do list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/lists/{quote(str(folder_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -638,11 +816,12 @@ async def delete_to_do_list_async( request_url, response.status, response.text, + response=response, ) - async def create_to_do_async( + async def create_to_do( self, - input: CreateToDo, + input: CreateToDo | Mapping[str, Any], folder_id: str, *, timeout: Optional[float] = None, @@ -654,13 +833,30 @@ async def create_to_do_async( Add a to-do This operation is used to create a to-do in the specified to-do list. + + Swagger operation ID: `CreateToDoV3`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + folder_id: To-do list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/lists/{quote(str(folder_id), safe='')}/tasks" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -674,6 +870,7 @@ async def create_to_do_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -681,9 +878,9 @@ async def create_to_do_async( return json.loads(response.text) - async def create_to_do_list_async( + async def create_to_do_list( self, - input: CreateToDoList, + input: CreateToDoList | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -694,10 +891,26 @@ async def create_to_do_list_async( Create a to-do list This operation is used to create a new to-do list. + + Swagger operation ID: `CreateToDoListV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/lists" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -711,6 +924,7 @@ async def create_to_do_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -718,7 +932,7 @@ async def create_to_do_list_async( return json.loads(response.text) - async def delete_to_do_async( + async def delete_to_do( self, folder_id: str, id: str, @@ -732,6 +946,22 @@ async def delete_to_do_async( Delete to-do This operation is used to delete a task. + + Swagger operation ID: `DeleteToDoV2`. + + Args: + folder_id: To-do list. + id: To-do task. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -741,7 +971,7 @@ async def delete_to_do_async( f"/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -755,45 +985,84 @@ async def delete_to_do_async( request_url, response.status, response.text, + response=response, ) - async def get_all_todo_lists_async( + def list_all_todo_lists( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List all to-do lists Returns a list of all the to-do lists. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAllTodoListsV2`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/lists" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def get_to_do_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_to_do( self, folder_id: str, id: str, @@ -807,6 +1076,22 @@ async def get_to_do_async( Get a to-do This operation is used to get the to-do with the given Id. + + Swagger operation ID: `GetToDoV3`. + + Args: + folder_id: To-do list. + id: To-do task. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -816,7 +1101,7 @@ async def get_to_do_async( f"/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -830,6 +1115,7 @@ async def get_to_do_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -837,7 +1123,7 @@ async def get_to_do_async( return json.loads(response.text) - async def get_to_do_list_async( + async def get_to_do_list( self, folder_id: str, *, @@ -850,13 +1136,28 @@ async def get_to_do_list_async( Get a to-do list This operation is used to get a specific to-do list. + + Swagger operation ID: `GetToDoListV2`. + + Args: + folder_id: To-do list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/lists/{quote(str(folder_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -870,6 +1171,7 @@ async def get_to_do_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -877,20 +1179,40 @@ async def get_to_do_list_async( return json.loads(response.text) - async def list_to_dos_by_folder_async( + def list_to_dos_by_folder( self, folder_id: str, - top: Optional[int] = None, *, + top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List to-dos by folder This operation is used to retrieve all to-dos from a specific list. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListToDosByFolderV2`. + + Args: + folder_id: To-do list. + top: Total number of entries to retrieve (default = 10, maximum = + 999). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -904,31 +1226,52 @@ async def list_to_dos_by_folder_async( query_params.append(f"$top={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def update_to_do_async( + async def update_to_do( self, - input: UpdateToDo, + input: UpdateToDo | Mapping[str, Any], folder_id: str, id: str, *, @@ -941,6 +1284,24 @@ async def update_to_do_async( Update to-do This operation is used to update a specific to-do. + + Swagger operation ID: `UpdateToDoV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + folder_id: To-do list. + id: To-do task. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -950,7 +1311,7 @@ async def update_to_do_async( f"/{quote(str(id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -964,6 +1325,7 @@ async def update_to_do_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/trello.py b/src/azure/connectors/trello.py index e75242a0..e489c7ba 100644 --- a/src/azure/connectors/trello.py +++ b/src/azure/connectors/trello.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List as TypingList, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List as TypingList, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,44 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "TrelloClient", + "Badges", + "Board", + "BoardLabel", + "BoardWithChecklists", + "Card", + "CardInAction", + "CardWithChecklists", + "CheckItemState", + "Checkitem", + "Checklist", + "ClientSubscription", + "Comment", + "CommentPost", + "CreateBoard", + "CreateCard", + "CreateList", + "CreateListResponse", + "Label", + "List", + "Member", + "Membership", + "ObjectEntity", + "Perfs", + "SubscriptionPayload", + "SubscriptionResponse", + "Team", + "TeamPreferences", + "UpdateBoard", + "UpdateCard", + "Webhook", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,88 +66,104 @@ class Card: Response for List the cards in a board """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique id of the card.""" - check_item_states: Optional[TypingList[CheckItemState]] = field( + check_item_states: Optional[TypingList[CheckItemState | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "checkItemStates"}, ) """The check item states in the card.""" - closed: Optional[bool] = None + closed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the card is closed. """ - date_last_activity: Optional[str] = field( + date_last_activity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dateLastActivity"}, ) """The datetime of last activity on the card.""" - desc: Optional[str] = None + desc: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the card.""" - id_board: Optional[str] = field( + id_board: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idBoard"}, ) """The unique Id of the board which the card belongs to.""" - id_list: Optional[str] = field( + id_list: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idList"}, ) """The unique Id of the list which the card belongs to.""" - id_members_voted: Optional[TypingList[str]] = field( + id_members_voted: Optional[TypingList[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idMembersVoted"}, ) """The unique Ids of the voting members.""" - id_short: Optional[int] = field( + id_short: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idShort"}, ) """The short Id of the card.""" - id_attachment_cover: Optional[str] = field( + id_attachment_cover: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idAttachmentCover"}, ) """The unique Id of the attachment cover.""" - manual_cover_attachment: Optional[bool] = field( + manual_cover_attachment: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "manualCoverAttachment"}, ) """ A boolean value (true, false) determining whether or not the card has a manual cover attachment. """ - id_labels: Optional[TypingList[str]] = field( + id_labels: Optional[TypingList[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idLabels"}, ) """A list of label Ids on the card.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the card.""" - pos: Optional[float] = None + pos: Optional[float] = dataclass_field(default=None, kw_only=True) """The position of the card.""" - short_link: Optional[str] = field( + short_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortLink"}, ) """A short link to the card.""" - badges: Optional[Badges] = None - due: Optional[str] = None + badges: Optional[Badges | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + due: Optional[str] = dataclass_field(default=None, kw_only=True) """The due date of the card.""" - short_url: Optional[str] = field( + short_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortUrl"}, ) """The short url link to the card.""" - subscribed: Optional[bool] = None + subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the card is subscribed to. """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The full url to the card.""" - checklists: Optional[TypingList[Checklist]] = None + checklists: Optional[ + TypingList[Checklist | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The set of board checklists.""" @@ -120,88 +173,104 @@ class CardWithChecklists: Response for Get a card by id """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique id of the card.""" - check_item_states: Optional[TypingList[CheckItemState]] = field( + check_item_states: Optional[TypingList[CheckItemState | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "checkItemStates"}, ) """The check item states in the card.""" - closed: Optional[bool] = None + closed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the card is closed. """ - date_last_activity: Optional[str] = field( + date_last_activity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dateLastActivity"}, ) """The datetime of last activity on the card.""" - desc: Optional[str] = None + desc: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the card.""" - id_board: Optional[str] = field( + id_board: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idBoard"}, ) """The unique Id of the board which the card belongs to.""" - id_list: Optional[str] = field( + id_list: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idList"}, ) """The unique Id of the list which the card belongs to.""" - id_members_voted: Optional[TypingList[str]] = field( + id_members_voted: Optional[TypingList[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idMembersVoted"}, ) """The unique Ids of the voting members.""" - id_short: Optional[int] = field( + id_short: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idShort"}, ) """The short Id of the card.""" - id_attachment_cover: Optional[str] = field( + id_attachment_cover: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idAttachmentCover"}, ) """The unique Id of the attachment cover.""" - manual_cover_attachment: Optional[bool] = field( + manual_cover_attachment: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "manualCoverAttachment"}, ) """ A boolean value (true, false) determining whether or not the card has a manual cover attachment. """ - id_labels: Optional[TypingList[str]] = field( + id_labels: Optional[TypingList[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idLabels"}, ) """A list of label Ids on the card.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the card.""" - pos: Optional[float] = None + pos: Optional[float] = dataclass_field(default=None, kw_only=True) """The position of the card.""" - short_link: Optional[str] = field( + short_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortLink"}, ) """A short link to the card.""" - badges: Optional[Badges] = None - due: Optional[str] = None + badges: Optional[Badges | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + due: Optional[str] = dataclass_field(default=None, kw_only=True) """The due date of the card.""" - short_url: Optional[str] = field( + short_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortUrl"}, ) """The short url link to the card.""" - subscribed: Optional[bool] = None + subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the card is subscribed to. """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The full url to the card.""" - checklists: Optional[TypingList[Checklist]] = None + checklists: Optional[ + TypingList[Checklist | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The set of card checklists.""" @@ -211,7 +280,7 @@ class ObjectEntity: Response for Delete a card """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -224,73 +293,85 @@ class Board: Response for List boards """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique Id of the board.""" - closed: Optional[bool] = None + closed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the board is closed. """ - date_last_activity: Optional[str] = field( + date_last_activity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dateLastActivity"}, ) """Date of the last activity on the board.""" - date_last_view: Optional[str] = field( + date_last_view: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dateLastView"}, ) """Date of the last time the board is viewed.""" - desc: Optional[str] = None + desc: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the board.""" - id_organization: Optional[str] = field( + id_organization: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idOrganization"}, ) """The id of the organization.""" - invitations: Optional[TypingList[str]] = None + invitations: Optional[TypingList[str]] = dataclass_field(default=None, kw_only=True) """The list of invitations on the board.""" - invited: Optional[bool] = None + invited: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the account is invited to the board. """ - label_names: Optional[Label] = field( + label_names: Optional[Label | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "labelNames"}, ) - memberships: Optional[TypingList[Membership]] = None + memberships: Optional[ + TypingList[Membership | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The set of board memberships.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the board.""" - pinned: Optional[bool] = None + pinned: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the board is pinned. """ - power_ups: Optional[TypingList[str]] = field( + power_ups: Optional[TypingList[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "powerUps"}, ) """The set of power ups on the board.""" - perfs: Optional[Perfs] = None - short_link: Optional[str] = field( + perfs: Optional[Perfs | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + short_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortLink"}, ) """The short link of the board.""" - short_url: Optional[str] = field( + short_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortUrl"}, ) """The short url to the board.""" - starred: Optional[bool] = None + starred: Optional[bool] = dataclass_field(default=None, kw_only=True) """A value determining whether or not the board is starred.""" - subscribed: Optional[bool] = None + subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A value determining whether or not the account is subscribed to the board. """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The full url of the board.""" @@ -300,75 +381,92 @@ class BoardWithChecklists: Response for Get a board by Id """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique Id of the board.""" - closed: Optional[bool] = None + closed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the board is closed. """ - date_last_activity: Optional[str] = field( + date_last_activity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dateLastActivity"}, ) """Date of the last activity on the board.""" - date_last_view: Optional[str] = field( + date_last_view: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dateLastView"}, ) """Date of the last time the board is viewed.""" - desc: Optional[str] = None + desc: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the board.""" - id_organization: Optional[str] = field( + id_organization: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idOrganization"}, ) """The id of the organization.""" - invitations: Optional[TypingList[str]] = None + invitations: Optional[TypingList[str]] = dataclass_field(default=None, kw_only=True) """The list of invitations on the board.""" - invited: Optional[bool] = None + invited: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the account is invited to the board. """ - label_names: Optional[Label] = field( + label_names: Optional[Label | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "labelNames"}, ) - memberships: Optional[TypingList[Membership]] = None + memberships: Optional[ + TypingList[Membership | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The set of board memberships.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the board.""" - pinned: Optional[bool] = None + pinned: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the board is pinned. """ - power_ups: Optional[TypingList[str]] = field( + power_ups: Optional[TypingList[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "powerUps"}, ) """The set of power ups on the board.""" - perfs: Optional[Perfs] = None - short_link: Optional[str] = field( + perfs: Optional[Perfs | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + short_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortLink"}, ) """The short link of the board.""" - short_url: Optional[str] = field( + short_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortUrl"}, ) """The short url to the board.""" - starred: Optional[bool] = None + starred: Optional[bool] = dataclass_field(default=None, kw_only=True) """A value determining whether or not the board is starred.""" - subscribed: Optional[bool] = None + subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A value determining whether or not the account is subscribed to the board. """ - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The full url of the board.""" - checklists: Optional[TypingList[Checklist]] = None + checklists: Optional[ + TypingList[Checklist | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The set of board checklists.""" @@ -378,30 +476,36 @@ class List: Response for List the card lists in a board """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique Id of the list.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the list.""" - closed: Optional[bool] = None + closed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the list is closed. """ - id_board: Optional[str] = field( + id_board: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idBoard"}, ) """The unique Id of the board which the list belongs to.""" - pos: Optional[float] = None + pos: Optional[float] = dataclass_field(default=None, kw_only=True) """The position of the list.""" - subscribed: Optional[bool] = None + subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not to the account is subscribed to the list. """ - cards: Optional[TypingList[Card]] = None + cards: Optional[ + TypingList[Card | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The cards inside the list.""" - board: Optional[Board] = None + board: Optional[Board | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -410,16 +514,13 @@ class CreateListResponse: Response for Update a list """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique Id of the list.""" - name: Optional[str] = None + name: str """The name of the list.""" - id_board: Optional[str] = field( - default=None, - metadata={"wire_name": "idBoard"}, - ) + id_board: str = dataclass_field(metadata={"wire_name": "idBoard"}) """The unique Id of the board the list belongs to.""" - pos: Optional[float] = None + pos: Optional[float] = dataclass_field(default=None, kw_only=True) """The position of the list.""" @@ -429,33 +530,47 @@ class Team: Response for List teams you are a member of """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the team.""" - desc: Optional[str] = None + desc: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the team.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """The display name of the team.""" - id_boards: Optional[TypingList[str]] = field( + id_boards: Optional[TypingList[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idBoards"}, ) """The boards assigned to this team.""" - billable_member_count: Optional[int] = field( + billable_member_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "billableMemberCount"}, ) """The number of members in this team.""" - memberships: Optional[TypingList[Membership]] = None + memberships: Optional[ + TypingList[Membership | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The memberships for this team.""" - web_site: Optional[str] = field( + web_site: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "WebSite"}, ) """The team website.""" - prefs: Optional[TeamPreferences] = None + prefs: Optional[ + TeamPreferences | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -464,16 +579,17 @@ class Member: Response for List members of a team """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique Id of the member.""" - full_name: Optional[str] = field( + full_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fullName"}, ) """The full name of the member.""" - username: Optional[str] = None + username: Optional[str] = dataclass_field(default=None, kw_only=True) """The username of the member.""" - initials: Optional[str] = None + initials: Optional[str] = dataclass_field(default=None, kw_only=True) """The initials of the member.""" @@ -483,11 +599,11 @@ class BoardLabel: Response for List labels of a board """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The Label Id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The Label name.""" - color: Optional[str] = None + color: Optional[str] = dataclass_field(default=None, kw_only=True) """The Label color.""" @@ -497,13 +613,14 @@ class Comment: Response for List comments for a card """ - member_creator: Optional[Member] = field( + member_creator: Optional[Member | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "memberCreator"}, ) - text: Optional[str] = None + text: Optional[str] = dataclass_field(default=None, kw_only=True) """The text of the comment.""" - date: Optional[str] = None + date: Optional[str] = dataclass_field(default=None, kw_only=True) """The datetime the comment was left.""" @@ -513,21 +630,23 @@ class CardInAction: Response for When a new card is added to a board """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique id of the card.""" - id_short: Optional[int] = field( + id_short: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idShort"}, ) """The short Id of the card.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the card.""" - short_link: Optional[str] = field( + short_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shortLink"}, ) """A short link to the card.""" - due: Optional[str] = None + due: Optional[str] = dataclass_field(default=None, kw_only=True) """The due date of the card.""" @@ -537,12 +656,13 @@ class CheckItemState: Definition: CheckItemState """ - id_check_item: Optional[str] = field( + id_check_item: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idCheckItem"}, ) """ID of the check item.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """State of the check item.""" @@ -552,55 +672,71 @@ class Badges: Definition: Badges """ - votes: Optional[int] = field(default=None, metadata={"wire_name": "Votes"}) + votes: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Votes"}, + ) """The number of votes on the card badges.""" - viewing_member_voted: Optional[bool] = field( + viewing_member_voted: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ViewingMemberVoted"}, ) """ A boolean value (true, false) determining whether or not viewing members voted on the badge. """ - subscribed: Optional[bool] = field( + subscribed: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Subscribed"}, ) """ A boolean value (true, false) determining whether or not the account is subscribed to the card badges. """ - fogbugz: Optional[str] = field( + fogbugz: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Fogbugz"}, ) """The fogbugz of the badges.""" - check_items: Optional[int] = field( + check_items: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckItems"}, ) """The number of check items in the badge.""" - check_items_checked: Optional[int] = field( + check_items_checked: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CheckItemsChecked"}, ) """The number of checked check items in the badge.""" - comments: Optional[int] = field( + comments: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Comments"}, ) """The comments on the badge.""" - attachments: Optional[int] = field( + attachments: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Attachments"}, ) """The attachments on the badge.""" - description: Optional[bool] = field( + description: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Description"}, ) """The description of the badge.""" - due: Optional[str] = field(default=None, metadata={"wire_name": "Due"}) + due: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Due"}, + ) """The due date of the badge.""" @@ -610,44 +746,48 @@ class UpdateCard: Definition: UpdateCard """ - name: Optional[str] = None + name: str """The updated name of the new card.""" - desc: Optional[str] = None + desc: Optional[str] = dataclass_field(default=None, kw_only=True) """The updated description of the new card.""" - closed: Optional[bool] = None + closed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the card is closed. """ - id_members_array: Optional[TypingList[str]] = field( + id_members_array: Optional[TypingList[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idMembersArray"}, ) """An array of member Ids to attach to the card.""" - id_attachment_cover: Optional[str] = field( + id_attachment_cover: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idAttachmentCover"}, ) """The id of the attachment to attach to the card.""" - id_board: Optional[str] = field( + id_board: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idBoard"}, ) """The id of the board to attach the card to.""" - id_list: Optional[str] = field( + id_list: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idList"}, ) """The id of the list to attach the card to.""" - pos: Optional[str] = None + pos: Optional[str] = dataclass_field(default=None, kw_only=True) """ The position of the card on the page. Specify top, bottom, or a positive number. Note this is used in relation to existing card locations so the resulting location may not match the exact value provided. """ - due: Optional[str] = None + due: Optional[str] = dataclass_field(default=None, kw_only=True) """The due date of the card.""" - subscribed: Optional[bool] = None + subscribed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not to subscribe to the card. @@ -660,55 +800,58 @@ class CreateCard: Definition: CreateCard """ - id_list: Optional[str] = field( - default=None, - metadata={"wire_name": "idList"}, - ) + id_list: str = dataclass_field(metadata={"wire_name": "idList"}) """The id of the list that the card should be added to.""" - name: Optional[str] = None + name: str """The name of the new card.""" - desc: Optional[str] = None + desc: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the new card.""" - pos: Optional[str] = None + pos: Optional[str] = dataclass_field(default=None, kw_only=True) """ The position of the card. Specify top, bottom, or a positive number. Note this is used in relation to existing card locations so the resulting location may not match the exact value provided. """ - id_members_array: Optional[TypingList[str]] = field( + id_members_array: Optional[TypingList[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idMembersArray"}, ) """An array of member Ids to attach to the card.""" - id_labels_array: Optional[TypingList[str]] = field( + id_labels_array: Optional[TypingList[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idLabelsArray"}, ) """An array of label Ids to attach to the card.""" - url_source: Optional[str] = field( + url_source: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlSource"}, ) """ Source url of the card. Has to be a URL starting with http:// or https:// or null. """ - file_source: Optional[str] = field( + file_source: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fileSource"}, ) """Source file of the card.""" - id_card_source: Optional[str] = field( + id_card_source: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idCardSource"}, ) """The Id of the card to copy into a new card.""" - keep_from_source: Optional[str] = field( + keep_from_source: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "keepFromSource"}, ) """Properties of the card to copy over from the source.""" - due: Optional[str] = None + due: Optional[str] = dataclass_field(default=None, kw_only=True) """The due date of the card.""" @@ -718,25 +861,25 @@ class Label: Definition: Label """ - green: Optional[str] = None + green: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the green label.""" - yellow: Optional[str] = None + yellow: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the yellow label.""" - orange: Optional[str] = None + orange: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the orange label.""" - red: Optional[str] = None + red: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the red label.""" - purple: Optional[str] = None + purple: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the purple label.""" - blue: Optional[str] = None + blue: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the blue label.""" - sky: Optional[str] = None + sky: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the sky blue label.""" - lime: Optional[str] = None + lime: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the lime green label.""" - pink: Optional[str] = None + pink: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the pink label.""" - black: Optional[str] = None + black: Optional[str] = dataclass_field(default=None, kw_only=True) """The value of the black label.""" @@ -746,19 +889,21 @@ class Membership: Definition: Membership """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique Id of the membership.""" - id_member: Optional[str] = field( + id_member: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idMember"}, ) """The unique Id of the member.""" - member_type: Optional[str] = field( + member_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "memberType"}, ) """The type of member.""" - unconfirmed: Optional[bool] = None + unconfirmed: Optional[bool] = dataclass_field(default=None, kw_only=True) """ A boolean value (true, false) determining whether or not the membership is unconfirmed. @@ -771,94 +916,107 @@ class Perfs: Definition: Perfs """ - permission_level: Optional[str] = field( + permission_level: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "permissionLevel"}, ) """The permission level of the object.""" - voting: Optional[str] = None + voting: Optional[str] = dataclass_field(default=None, kw_only=True) """Who can vote on the object.""" - comments: Optional[str] = None + comments: Optional[str] = dataclass_field(default=None, kw_only=True) """Who can comment on the object.""" - invitations: Optional[str] = None + invitations: Optional[str] = dataclass_field(default=None, kw_only=True) """Who can invite people to the object.""" - self_join: Optional[bool] = field( + self_join: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selfJoin"}, ) """ A boolean value (true, false) determining whether or not the object can self join. """ - card_covers: Optional[bool] = field( + card_covers: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "cardCovers"}, ) """ A boolean value (true, false) determining whether or not the object has access to card covers. """ - calendar_feed_enabled: Optional[bool] = field( + calendar_feed_enabled: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "calendarFeedEnabled"}, ) """ A boolean value (true, false) determining whether or not the calendar feed enabled. """ - background: Optional[str] = None + background: Optional[str] = dataclass_field(default=None, kw_only=True) """The background of the object.""" - background_color: Optional[str] = field( + background_color: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "backgroundColor"}, ) """The background color of the object, in hex notation.""" - background_image: Optional[str] = field( + background_image: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "backgroundImage"}, ) """The background image of the object.""" - background_image_scaled: Optional[str] = field( + background_image_scaled: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "backgroundImageScaled"}, ) """The scaled version of the background image.""" - background_tile: Optional[bool] = field( + background_tile: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "backgroundTile"}, ) """The background tile of the object.""" - background_brightness: Optional[str] = field( + background_brightness: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "backgroundBrightness"}, ) """The brightness of the object background.""" - can_be_public: Optional[bool] = field( + can_be_public: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "canBePublic"}, ) """ A boolean value (true, false) determining whether or not the object can be public. """ - can_be_org: Optional[bool] = field( + can_be_org: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "canBeOrg"}, ) """ A boolean value (true, false) determining whether or not the object can be part of the organization """ - can_be_private: Optional[bool] = field( + can_be_private: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "canBePrivate"}, ) """ A boolean value (true, false) determining whether or not the object can be private. """ - can_invite: Optional[bool] = field( + can_invite: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "canInvite"}, ) """ @@ -873,52 +1031,57 @@ class UpdateBoard: Definition: UpdateBoard """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the board.""" - default_lists: Optional[str] = field( + default_lists: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "defaultLists"}, ) """ A string (true, false) determining whether or not to create default lists. """ - desc: Optional[str] = None + desc: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the board.""" - id_organization: Optional[str] = field( + id_organization: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idOrganization"}, ) """The id of the team.""" - prefs_permission_level: Optional[str] = field( + prefs_permission_level: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "prefs_permissionLevel"}, ) """The permission level of the board.""" - prefs_comments: Optional[str] = None + prefs_comments: Optional[str] = dataclass_field(default=None, kw_only=True) """ The comment preferences on the board. Valid options are 'disabled', 'members', 'observers', 'org' or 'public'. """ - prefs_invitations: Optional[str] = None + prefs_invitations: Optional[str] = dataclass_field(default=None, kw_only=True) """ The invitation preferences of the board. Valid options are 'admins' or 'members'. """ - prefs_card_covers: Optional[str] = field( + prefs_card_covers: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "prefs_cardCovers"}, ) """A string (true, false) determining whether or not to use card covers.""" - prefs_background: Optional[str] = None + prefs_background: Optional[str] = dataclass_field(default=None, kw_only=True) """The background color of the board.""" - prefs_voting: Optional[str] = None + prefs_voting: Optional[str] = dataclass_field(default=None, kw_only=True) """The voting power-up preferences of the board.""" - prefs_card_aging: Optional[str] = field( + prefs_card_aging: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "prefs_cardAging"}, ) """The card aging power-up preferences of the board.""" - enable_calendar: Optional[str] = None + enable_calendar: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string (true, false) determining whether or not to enable calendar power-up @@ -931,8 +1094,9 @@ class TeamPreferences: Definition: TeamPreferences """ - permission_level: Optional[str] = field( + permission_level: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "permissionLevel"}, ) """The permission level of the team.""" @@ -944,29 +1108,33 @@ class Webhook: Definition: Webhook """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique Id of the webhook.""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Brief Description of the webhook""" - id_model: Optional[str] = field( + id_model: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idModel"}, ) """ID of the model to be monitored (i.e. card,board, etc.)""" - callback_u_r_l: Optional[str] = field( + callback_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "callbackURL"}, ) """The callbackURL to receive webhook notifications""" - active: Optional[bool] = None + active: Optional[bool] = dataclass_field(default=None, kw_only=True) """Determines whether the webhook is active and sending POST requests.""" - consecutive_failures: Optional[float] = field( + consecutive_failures: Optional[float] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "consecutiveFailures"}, ) """The number of consecutive Failures in posting webhook notifications.""" - first_consecutive_fail_date: Optional[str] = field( + first_consecutive_fail_date: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstConsecutiveFailDate"}, ) """The date of First Consecutive Failure.""" @@ -978,7 +1146,7 @@ class CommentPost: Definition: CommentPost """ - text: Optional[str] = None + text: Optional[str] = dataclass_field(default=None, kw_only=True) """The text of the comment.""" @@ -988,49 +1156,54 @@ class CreateBoard: Definition: CreateBoard """ - name: Optional[str] = None + name: str """The name of the board.""" - default_lists: Optional[str] = field( + default_lists: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "defaultLists"}, ) """ A string (true, false) determining whether or not to create default lists. """ - desc: Optional[str] = None + desc: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the board.""" - id_organization: Optional[str] = field( + id_organization: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idOrganization"}, ) """The id of the team.""" - prefs_permission_level: Optional[str] = field( + prefs_permission_level: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "prefs_permissionLevel"}, ) """ The permission level of the board. Valid options are 'org', 'private', or 'public'. """ - prefs_comments: Optional[str] = None + prefs_comments: Optional[str] = dataclass_field(default=None, kw_only=True) """The comment preferences of the board.""" - prefs_invitations: Optional[str] = None + prefs_invitations: Optional[str] = dataclass_field(default=None, kw_only=True) """The invitation preferences of the board.""" - prefs_card_covers: Optional[str] = field( + prefs_card_covers: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "prefs_cardCovers"}, ) """A string (true, false) determining whether or not to use card covers.""" - prefs_background: Optional[str] = None + prefs_background: Optional[str] = dataclass_field(default=None, kw_only=True) """The background color of the board.""" - prefs_voting: Optional[str] = None + prefs_voting: Optional[str] = dataclass_field(default=None, kw_only=True) """The voting power-up preferences of the board.""" - prefs_card_aging: Optional[str] = field( + prefs_card_aging: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "prefs_cardAging"}, ) """The card aging power-up preferences of the board.""" - enable_calendar: Optional[str] = None + enable_calendar: Optional[str] = dataclass_field(default=None, kw_only=True) """ A string (true, false) determining whether or not to enable calendar power-up. @@ -1043,17 +1216,15 @@ class CreateList: Definition: CreateList """ - name: Optional[str] = None + name: str """The name of the list.""" - id_board: Optional[str] = field( - default=None, - metadata={"wire_name": "idBoard"}, - ) + id_board: str = dataclass_field(metadata={"wire_name": "idBoard"}) """The unique Id of the board to create the list in.""" - pos: Optional[str] = None + pos: Optional[str] = dataclass_field(default=None, kw_only=True) """The position of the list. Specify top, bottom, or a positive number.""" - id_list_source: Optional[str] = field( + id_list_source: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idListSource"}, ) """The id of the list to copy into the new list.""" @@ -1065,24 +1236,27 @@ class Checklist: Definition: Checklist """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique Id of the checklist.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of the checklist.""" - pos: Optional[int] = None + pos: Optional[int] = dataclass_field(default=None, kw_only=True) """The position of the checklist.""" - id_board: Optional[str] = field( + id_board: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idBoard"}, ) """The unique Id of the board.""" - id_card: Optional[str] = field( + id_card: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idCard"}, ) """The unique Id of the card.""" - check_items: Optional[TypingList[Checkitem]] = field( + check_items: Optional[TypingList[Checkitem | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "checkItems"}, ) """The list of the checklist items""" @@ -1094,28 +1268,31 @@ class Checkitem: Definition: Checkitem """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique Id of the checkitem.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """The name of them checkitem.""" - name_data: Optional[Dict[str, Any]] = field( + name_data: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nameData"}, ) """The nameData of them checkitem.""" - pos: Optional[float] = None + pos: Optional[float] = dataclass_field(default=None, kw_only=True) """The position of the checkitem.""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The state of the checkitem.""" - due: Optional[str] = None + due: Optional[str] = dataclass_field(default=None, kw_only=True) """The due date of the checkitem.""" - id_member: Optional[str] = field( + id_member: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idMember"}, ) """The unique Id of the member.""" - id_checklist: Optional[str] = field( + id_checklist: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "idChecklist"}, ) """The unique Id of the checklist.""" @@ -1127,8 +1304,7 @@ class ClientSubscription: Definition: ClientSubscription """ - notification_u_r_l: Optional[str] = field( - default=None, + notification_u_r_l: str = dataclass_field( metadata={"wire_name": "NotificationURL"}, ) """ @@ -1143,17 +1319,19 @@ class SubscriptionResponse: Definition: SubscriptionResponse """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Id of the subscription""" - notification_u_r_l: Optional[str] = field( + notification_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "NotificationURL"}, ) """Notification Url""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """Resource of the subscription request""" - notification_type: Optional[str] = field( + notification_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationType"}, ) """Notification Type""" @@ -1165,7 +1343,7 @@ class SubscriptionPayload: Definition: SubscriptionPayload """ - action: Optional[Dict[str, Any]] = None + action: Dict[str, Any] """webhook action""" @@ -1180,7 +1358,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1197,8 +1375,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1219,7 +1397,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1234,9 +1412,87 @@ def __init__( def connector_name(self) -> str: return "trello" - async def list_cards_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_cards( self, board_id: str, + *, actions: Optional[str] = None, attachments: Optional[bool] = None, attachment_fields: Optional[str] = None, @@ -1250,16 +1506,55 @@ async def list_cards_async( before: Optional[str] = None, filter: Optional[str] = None, fields: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List the cards in a board List the cards matching the query parameters in a specific board. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListCards`. + + Args: + board_id: The unique id of the board. + actions: The list the actions to return. Specify 'all' or a comma + separated list of valid values. + attachments: A boolean value (true, false) determining whether or + not to show attachments. + attachment_fields: List the attachment fields to return. Specify + 'all' or a comma separated list of valid values. + stickers: A boolean value (true, false) determining whether or not + to show stickers. + members: A boolean value (true, false) determining whether or not + to show members. + memeber_fields: List the member fields to return. Specify 'all' or + a comma separated list of valid values. + check_item_states: A boolean value (true, false) determining + whether or not to return the card states. + checklists: Specify the checklists to return. + limit: The max number of results to return, between 1 and 1000. + since: Fetch all cards after this date. + before: Fetch all cards before this date. + filter: An option on how to filter the response. The allowed values + are 'all', 'closed', 'none', 'open' or 'visible'. + fields: List the card fields to return. Specify 'all' or a comma + separated list of valid values. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1333,29 +1628,50 @@ async def list_cards_async( query_params.append(f"fields={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_cards_simple_async( + def list_cards_simple( self, board_id: str, *, @@ -1363,42 +1679,82 @@ async def list_cards_simple_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ A simple version of the list cards A simple version of the list cards API method used by dynamic values. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListCardsSimple`. + + Args: + board_id: Board Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/simple/boards/{quote(str(board_id), safe='')}/cards" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_card_async( + async def get_card( self, card_id: str, board_id: str, + *, actions: Optional[str] = None, actions_entities: Optional[bool] = None, actions_display: Optional[bool] = None, @@ -1422,7 +1778,6 @@ async def get_card_async( stickers: Optional[bool] = None, sticker_fields: Optional[str] = None, fields: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1432,6 +1787,70 @@ async def get_card_async( Get a card by id Get a specific card by its unique id. + + Swagger operation ID: `GetCard`. + + Args: + card_id: The id of the card to fetch. + board_id: The id of the board to fetch cards in. + actions: List the actions to return. Specify 'all' or a comma + separated list of valid values. + actions_entities: A boolean value (true, false) determining whether + or not to return action entities. + actions_display: A boolean value (true, false) determining whether + or not to return action displays. + actions_limit: Max number of actions to return. + action_fields: List of action fields to return for each action. + Specify 'all' or a comma separated list of valid values. + action_member_creator_fields: List of action member creator fields + to return. Specify 'all' or a comma separated list of valid + values. + attachments: A boolean value (true, false) determining whether or + not to return attachments. + attachment_fields: List of attachment fields to return for each + attachment. Specify 'all' or a comma separated list of valid + values. + members: A boolean value (true, false) determining whether or not + to return members. + member_fields: List of member fields to return for each member. + Specify 'all' or a comma separated list of valid values. + members_voted: A boolean value (true, false) determining whether or + not to return voted members. + member_voted_fields: List of voted member fields to return for each + voted member. Specify 'all' or a comma separated list of valid + values. + check_item_states: A boolean value (true, false) determining + whether or not to return card states. + check_item_state_fields: List of state fields to return for each of + the card item state. Specify 'all' or a comma separated list of + valid values. + checklists: Specify the checklists to return for each card. + checklist_fields: List of checklist fields to return for each + checklist. Specify 'all' or a comma separated list of valid + values. + board: A boolean value (true, false) determining whether or not to + return the board which the card belongs to. + board_fields: List the board fields to return. Specify 'all' or a + comma separated list of valid values. + list: A boolean value (true, false) determining whether or not to + return the list which the card belongs to. + list_fields: List the list fields to return. Specify 'all' or a + comma separated list of valid values. + stickers: A boolean value (true, false) determining whether or not + to return the stickers. + sticker_fields: List the sticker fields to return for each sticker. + Specify 'all' or a comma separated list of valid values. + fields: List the card fields to return. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1560,7 +1979,7 @@ async def get_card_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1574,6 +1993,7 @@ async def get_card_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1581,7 +2001,7 @@ async def get_card_async( return json.loads(response.text) - async def delete_card_async( + async def delete_card( self, card_id: str, board_id: str, @@ -1595,6 +2015,22 @@ async def delete_card_async( Delete a card Delete an existing card from the account. + + Swagger operation ID: `DeleteCard`. + + Args: + card_id: The id of the card to delete. + board_id: The id of the board to fetch cards from. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1608,7 +2044,7 @@ async def delete_card_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -1622,6 +2058,7 @@ async def delete_card_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1629,8 +2066,9 @@ async def delete_card_async( return json.loads(response.text) - async def list_boards_async( + def list_boards( self, + *, filter: Optional[str] = None, fields: Optional[str] = None, actions: Optional[str] = None, @@ -1643,16 +2081,52 @@ async def list_boards_async( organization: Optional[bool] = None, organization_fields: Optional[str] = None, lists: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List boards List the boards matching the specified query parameters. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListBoards`. + + Args: + filter: List filters to apply to board results. Specify 'all' or a + comma separated list of valid values. + fields: List the board fields to return. Specify 'all' or a comma + separated list of valid values. + actions: List the action fields to return. Specify 'all' or a comma + separated list of valid values. + actions_entities: A boolean value (true, false) determining whether + or not to return action entities. + actions_limit: The max number of actions to return. + actions_format: Specify the format of the actions to return. The + valid options are 'count', 'list', 'minimal'. + actions_since: Return actions after the specified date. + action_fields: List the fields of the action to return. Specify + 'all' or a comma separated list of valid values. + memberships: Specify membership information to return. + organization: A boolean value (true, false) determining whether or + not to return organization information. + organization_fields: List the organization fields to return. + Specify 'all' or a comma separated list of valid values. + lists: Specify whether to return lists which belong to the board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/member/me/boards" query_params = [] @@ -1718,68 +2192,128 @@ async def list_boards_async( query_params.append(f"lists={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def list_boards_simple_async( + def list_boards_simple( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ A simple version of the list boards A simple version of the list boards API call with no parameters to be used by dynamic values. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListBoardsSimple`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/simple/member/me/boards" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def get_board_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_board( self, board_id: str, + *, actions: Optional[str] = None, action_entities: Optional[bool] = None, actions_display: Optional[bool] = None, @@ -1817,7 +2351,6 @@ async def get_board_async( organization_memberships: Optional[str] = None, my_perfs: Optional[bool] = None, fields: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1827,6 +2360,93 @@ async def get_board_async( Get a board by Id Get a specific board by its unique identifier. + + Swagger operation ID: `GetBoard`. + + Args: + board_id: The unique Id of the board to get. + actions: List the actions to return. Specify 'all' or a comma + separated list of valid values. + action_entities: A boolean value (true, false) determining whether + or not to return action entities. + actions_display: A boolean value (true, false) determining whether + or not to return actions display. + actions_format: Specify the format of the actions to return. Valid + options are 'count', 'list', 'minimal'. + actions_since: Only return the actions after this date. + actions_limit: Max number of actions to return. + action_fields: List the fields to return with each field. Specify + 'all' or a comma separated list of valid values. + action_member: A boolean value (true, false) determining whether or + not to return action members. + action_member_fields: List the member fields to return with each + action member. Specify 'all' or a comma separated list of valid + values. + action_member_creator: A boolean value (true, false) determining + whether or not to return action member creator. + action_member_creator_fields: List the action member creator fields + to return. Specify 'all' or a comma separated list of valid + values. + cards: Specify the cards to return. Valid options are 'all', + 'closed', 'none', 'open', or 'visible'. + card_fields: List the fields to return for each card. Specify 'all' + or a comma separated list of valid values. + card_attachments: A boolean value (true, false) determining whether + or not to return attachments on cards. + card_attachment_fields: List the attachment fields to return for + each attachment. Specify 'all' or a comma separated list of + valid values. + card_checklists: Specify the checklists to return for each card. + card_stickers: A boolean value (true, false) determining whether or + not to return card stickers. + board_stars: Specify the board stars to return. + labels: Specify the labels to return. + label_fields: List the label fields to return for each label. + Specify 'all' or a comma separated list of valid values. + labels_limit: Max number of labels to return. + lists: Specify the lists to return. + list_fields: List the list fields to return for each list. Specify + 'all' or a comma separated list of valid values. + memberships: List the memberships to return. Specify 'all' or a + comma separated list of valid values. + memberships_member: A boolean value (true, false) determining + whether or not to return membership members. + memberships_member_fields: List the member fields to return for + each membership member. Specify 'all' or a comma separated list + of valid values. + members: List the members to return. Specify 'all' or a comma + separated list of valid values. + member_fields: List the member fields to return for each member. + Specify 'all' or a comma separated list of valid values. + members_invited: Specify the invited members to return. + members_invited_fields: List the fields to return for each. Specify + 'all' or a comma separated list of valid values. + checklists: Specify the checklists to return. + checklist_fields: List the checklist fields to return for each + checklist. Specify 'all' or a comma separated list of valid + values. + organization: A boolean value (true, false) determining whether or + not to return the organization information. + organization_fields: List the organization fields to return for + each organization. Specify 'all' or a comma separated list of + valid values. + organization_memberships: List the organization memberships to + return. Specify 'all' or a comma separated list of valid + values. + my_perfs: A boolean value (true, false) determining whether or not + to return my perfs. + fields: List the fields to return. Specify 'all' or a comma + separated list of valid values. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2021,7 +2641,7 @@ async def get_board_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2035,6 +2655,7 @@ async def get_board_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2042,9 +2663,9 @@ async def get_board_async( return json.loads(response.text) - async def update_board_async( + async def update_board( self, - input: UpdateBoard, + input: UpdateBoard | Mapping[str, Any], board_id: str, *, timeout: Optional[float] = None, @@ -2056,13 +2677,30 @@ async def update_board_async( Update a board Update an existing board. + + Swagger operation ID: `UpdateBoard`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + board_id: The unique identifier of the board to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/boards/{quote(str(board_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2076,6 +2714,7 @@ async def update_board_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2083,23 +2722,48 @@ async def update_board_async( return json.loads(response.text) - async def list_lists_async( + def list_lists( self, board_id: str, + *, cards: Optional[str] = None, card_fields: Optional[str] = None, filter: Optional[str] = None, fields: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List the card lists in a board List the card lists and the cards within the list in a specific board. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListLists`. + + Args: + board_id: The unique id of the board to fetch lists. + cards: Specify the cards to return. + card_fields: List the card fields to return from. Specify 'all' or + a comma separated list of valid values. + filter: Specify the filter property for lists. Valid options are + 'all, 'closed', 'none', or 'open'. + fields: List the fields to return. Specify 'all' or a comma + separated list of valid values. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2128,29 +2792,50 @@ async def list_lists_async( query_params.append(f"fields={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def list_lists_simple_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_lists_simple( self, board_id: str, *, @@ -2158,48 +2843,87 @@ async def list_lists_simple_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ A simple version of list lists A simple version of list lists to be used by dynamic values. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListListsSimple`. + + Args: + board_id: Unique Id of the board to fetch lists. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/simple/boards/{quote(str(board_id), safe='')}/lists" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def get_list_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_list( self, list_id: str, board_id: str, + *, cards: Optional[str] = None, card_fields: Optional[str] = None, board: Optional[bool] = None, board_fields: Optional[str] = None, fields: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2210,6 +2934,31 @@ async def get_list_async( Get an existing list and the cards in the list by the unique identifier of the list. + + Swagger operation ID: `GetList`. + + Args: + list_id: The unique Id of the list to fetch. + board_id: The unique Id of the board to fetch the lists from. + cards: Specify the cards to return. + card_fields: List the card fields to return for each card. Specify + 'all' or a comma separated list of valid values. + board: A boolean value (true, false) determining whether or not to + return board information. + board_fields: List the board fields to return. Specify 'all' or a + comma separated list of valid values. + fields: List the list fields to return. Specify 'all' or a comma + separated list of valid values. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2248,7 +2997,7 @@ async def get_list_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2262,6 +3011,7 @@ async def get_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2269,16 +3019,16 @@ async def get_list_async( return json.loads(response.text) - async def update_list_async( + async def update_list( self, list_id: str, board_id: str, + *, name: Optional[str] = None, closed: Optional[str] = None, id_board: Optional[str] = None, pos: Optional[str] = None, subscribed: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2288,6 +3038,29 @@ async def update_list_async( Update a list Update an existing list. + + Swagger operation ID: `UpdateList`. + + Args: + list_id: The unique id of the list to update. + board_id: The unique id of the board the list is on. + name: The new list name. + closed: A string (true, false) determining whether or not to close + the list. + id_board: The unique id of the board to move the list to. + pos: The list position (top, bottom, or number). + subscribed: A boolean value (true, false) determining whether or + not to subscribe to the list. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2326,7 +3099,7 @@ async def update_list_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2340,6 +3113,7 @@ async def update_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2347,10 +3121,10 @@ async def update_list_async( return json.loads(response.text) - async def get_user_profile_async( + async def get_user_profile( self, - fields: Optional[str] = None, *, + fields: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -2360,6 +3134,22 @@ async def get_user_profile_async( Get your User Profile info Get information about your User Profile + + Swagger operation ID: `GetUserProfile`. + + Args: + fields: List the fields to return. Specify 'all' or a comma + separated list of valid values. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/members/me" query_params = [] @@ -2371,7 +3161,7 @@ async def get_user_profile_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2385,6 +3175,7 @@ async def get_user_profile_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2392,45 +3183,83 @@ async def get_user_profile_async( return json.loads(response.text) - async def list_teams_async( + def list_teams( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List teams you are a member of The list of teams or organizations the account is a member of. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListTeams`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/members/me/organizations" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def list_team_members_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_team_members( self, team_id: str, *, @@ -2438,39 +3267,78 @@ async def list_team_members_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List members of a team List the members in a specific team. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListTeamMembers`. + + Args: + team_id: The unique Id of the team. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/organizations/{quote(str(team_id), safe='')}/members" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def list_board_members_async( + return AsyncItemPaged(get_next, extract_data) + + def list_board_members( self, board_id: str, *, @@ -2478,39 +3346,78 @@ async def list_board_members_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List members of a board List the members of a specific board. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListBoardMembers`. + + Args: + board_id: The unique Id of the board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/boards/{quote(str(board_id), safe='')}/members" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def list_board_labels_async( + return AsyncItemPaged(get_next, extract_data) + + def list_board_labels( self, board_id: str, *, @@ -2518,11 +3425,29 @@ async def list_board_labels_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List labels of a board List the labels of a specific board. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListBoardLabels`. + + Args: + board_id: The unique Id of the board. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2532,29 +3457,50 @@ async def list_board_labels_async( query_params.append("limit=" + quote("1000", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_team_for_board_async( + async def get_team_for_board( self, board_id: str, *, @@ -2567,13 +3513,28 @@ async def get_team_for_board_async( Get the team for a board Get the team details for a specific board. + + Swagger operation ID: `GetTeamForBoard`. + + Args: + board_id: The unique Id of the board to fetch team. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/boards/{quote(str(board_id), safe='')}/organization" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2587,6 +3548,7 @@ async def get_team_for_board_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2594,7 +3556,7 @@ async def get_team_for_board_async( return json.loads(response.text) - async def list_card_members_async( + def list_card_members( self, card_id: str, board_id: str, @@ -2603,11 +3565,30 @@ async def list_card_members_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List members for a card List the members for a specific card. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListCardMembers`. + + Args: + card_id: The unique id of the card. + board_id: The unique id of the board to look for cards on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2620,29 +3601,50 @@ async def list_card_members_async( query_params.append(f"board_id={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def list_card_comments_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_card_comments( self, card_id: str, board_id: str, @@ -2651,11 +3653,30 @@ async def list_card_comments_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List comments for a card List the comments for a specific card. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListCardComments`. + + Args: + card_id: The unique id of the card. + board_id: The unique id of the board to look for comments on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2668,31 +3689,52 @@ async def list_card_comments_async( query_params.append(f"board_id={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def add_comment_to_card_async( + return AsyncItemPaged(get_next, extract_data) + + async def add_comment_to_card( self, - input: CommentPost, + input: CommentPost | Mapping[str, Any], card_id: str, board_id: str, *, @@ -2705,6 +3747,24 @@ async def add_comment_to_card_async( Add a comment to a card Add a comment to a specific card. + + Swagger operation ID: `AddCommentToCard`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + card_id: The unique id of the card. + board_id: The unique id of the board to add a comment to. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2718,7 +3778,7 @@ async def add_comment_to_card_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2732,6 +3792,7 @@ async def add_comment_to_card_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2739,7 +3800,7 @@ async def add_comment_to_card_async( return json.loads(response.text) - async def add_member_to_card_async( + async def add_member_to_card( self, card_id: str, board_id: str, @@ -2754,6 +3815,23 @@ async def add_member_to_card_async( Add member to a card Add a member to a specific card. + + Swagger operation ID: `AddMemberToCard`. + + Args: + card_id: The unique identifier of the card to add a member to. + board_id: The unique id of the board the card is on. + member_id: The member id or username to add to the card. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2771,7 +3849,7 @@ async def add_member_to_card_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -2785,6 +3863,7 @@ async def add_member_to_card_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2792,9 +3871,9 @@ async def add_member_to_card_async( return json.loads(response.text) - async def create_board_async( + async def create_board( self, - input: CreateBoard, + input: CreateBoard | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -2805,10 +3884,26 @@ async def create_board_async( Create a board Create a new board with the specified fields. + + Swagger operation ID: `CreateBoard`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/boards" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2822,6 +3917,7 @@ async def create_board_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2829,9 +3925,9 @@ async def create_board_async( return json.loads(response.text) - async def create_list_async( + async def create_list( self, - input: CreateList, + input: CreateList | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -2842,10 +3938,26 @@ async def create_list_async( Create a list Create a new list. + + Swagger operation ID: `CreateList`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/lists" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2859,6 +3971,7 @@ async def create_list_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2866,7 +3979,7 @@ async def create_list_async( return json.loads(response.text) - async def close_board_async( + async def close_board( self, board_id: str, *, @@ -2879,13 +3992,28 @@ async def close_board_async( Close a board Set a specific board to closed. + + Swagger operation ID: `CloseBoard`. + + Args: + board_id: The unique id of the board to close. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/boards/{quote(str(board_id), safe='')}/closed" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -2899,6 +4027,7 @@ async def close_board_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2906,9 +4035,9 @@ async def close_board_async( return json.loads(response.text) - async def create_card_async( + async def create_card( self, - input: CreateCard, + input: CreateCard | Mapping[str, Any], board_id: str, *, timeout: Optional[float] = None, @@ -2920,6 +4049,23 @@ async def create_card_async( Create a card Creates a new card with the parameters provided. + + Swagger operation ID: `CreateCard_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + board_id: The id of the board to create the card in. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/cards" query_params = [] @@ -2930,7 +4076,7 @@ async def create_card_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2944,6 +4090,7 @@ async def create_card_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2951,9 +4098,9 @@ async def create_card_async( return json.loads(response.text) - async def update_card_async( + async def update_card( self, - input: UpdateCard, + input: UpdateCard | Mapping[str, Any], card_id: str, board_id: str, *, @@ -2966,6 +4113,24 @@ async def update_card_async( Update a card Update an existing card with new parameters. + + Swagger operation ID: `UpdateCard_V2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + card_id: The id of the card to update. + board_id: The id of the board to fetch cards from. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2979,7 +4144,7 @@ async def update_card_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -2993,6 +4158,7 @@ async def update_card_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/twitter.py b/src/azure/connectors/twitter.py index c0cf9106..af1a243c 100644 --- a/src/azure/connectors/twitter.py +++ b/src/azure/connectors/twitter.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,22 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "TwitterClient", + "OriginalTweetModel", + "OriginalTweetUserDetailsModel", + "OriginalTweetUserMentionsModel", + "TriggerBatchResponseTweetModel", + "TweetModel", + "TweetResponseModel", + "UserDetailsModel", + "UserMentionsModel", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,69 +44,72 @@ class TweetModel: Response for Get user timeline """ - tweet_text: Optional[str] = field( - default=None, - metadata={"wire_name": "TweetText"}, - ) + tweet_text: str = dataclass_field(metadata={"wire_name": "TweetText"}) """Text content of the tweet""" - tweet_id: Optional[str] = field( + tweet_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TweetId"}, ) """Id of the tweet""" - created_at: Optional[str] = field( + created_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedAt"}, ) """Time at which the tweet was posted""" - created_at_iso: Optional[str] = field( + created_at_iso: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedAtIso"}, ) """Time at which the tweet was posted""" - retweet_count: Optional[int] = field( - default=None, + retweet_count: int = dataclass_field( metadata={"wire_name": "RetweetCount"}, ) """Total number of re-tweets for the tweet""" - tweeted_by: Optional[str] = field( - default=None, - metadata={"wire_name": "TweetedBy"}, - ) + tweeted_by: str = dataclass_field(metadata={"wire_name": "TweetedBy"}) """Name of the user who has posted the tweet""" - media_urls: Optional[List[str]] = field( + media_urls: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaUrls"}, ) """Url of the media posted along with the tweet""" - tweet_language_code: Optional[str] = field( + tweet_language_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TweetLanguageCode"}, ) """Language code of the tweet""" - tweet_in_reply_to_user_id: Optional[str] = field( + tweet_in_reply_to_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TweetInReplyToUserId"}, ) """ User Id of the author of the tweet that the current tweet is a reply to """ - favorited: Optional[bool] = field( + favorited: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Favorited"}, ) """Indicates whether the tweet is marked as favorited or not""" - user_mentions: Optional[List[UserMentionsModel]] = field( + user_mentions: Optional[List[UserMentionsModel | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserMentions"}, ) """List of users mentioned in the tweet""" - original_tweet: Optional[OriginalTweetModel] = field( + original_tweet: Optional[OriginalTweetModel | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "OriginalTweet"}, ) - user_details: Optional[UserDetailsModel] = field( + user_details: Optional[UserDetailsModel | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserDetails"}, ) @@ -102,50 +120,47 @@ class UserDetailsModel: Response for Get followers """ - full_name: Optional[str] = field( - default=None, - metadata={"wire_name": "FullName"}, - ) + full_name: str = dataclass_field(metadata={"wire_name": "FullName"}) """Name of the user""" - location: Optional[str] = field( - default=None, - metadata={"wire_name": "Location"}, - ) + location: str = dataclass_field(metadata={"wire_name": "Location"}) """Location of the user""" - id: Optional[int] = field(default=None, metadata={"wire_name": "Id"}) - """X id (handle) of the user""" - user_name: Optional[str] = field( + id: Optional[int] = dataclass_field( default=None, - metadata={"wire_name": "UserName"}, + kw_only=True, + metadata={"wire_name": "Id"}, ) + """X id (handle) of the user""" + user_name: str = dataclass_field(metadata={"wire_name": "UserName"}) """Screen name of the user""" - followers_count: Optional[int] = field( + followers_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FollowersCount"}, ) """Number of followers""" - description: Optional[str] = field( - default=None, - metadata={"wire_name": "Description"}, - ) + description: str = dataclass_field(metadata={"wire_name": "Description"}) """User description""" - statuses_count: Optional[int] = field( + statuses_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StatusesCount"}, ) """User status count""" - friends_count: Optional[int] = field( + friends_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FriendsCount"}, ) """Number of friends""" - favourites_count: Optional[int] = field( + favourites_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FavouritesCount"}, ) """Number of tweets that the user has favorited""" - profile_image_url: Optional[str] = field( + profile_image_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ProfileImageUrl"}, ) """Url of the profile image""" @@ -157,10 +172,7 @@ class TweetResponseModel: Response for Post a tweet """ - tweet_id: Optional[str] = field( - default=None, - metadata={"wire_name": "TweetId"}, - ) + tweet_id: str = dataclass_field(metadata={"wire_name": "TweetId"}) """ID of the tweet posted""" @@ -170,7 +182,12 @@ class TriggerBatchResponseTweetModel: Response for When a new tweet is posted """ - value: Optional[List[TweetModel]] = None + value: Optional[ + List[TweetModel | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """A list of the response objects""" @@ -180,15 +197,17 @@ class UserMentionsModel: Definition: UserMentionsModel """ - id: Optional[int] = field(default=None, metadata={"wire_name": "Id"}) + id: int = dataclass_field(metadata={"wire_name": "Id"}) """X id (handle) of the user""" - full_name: Optional[str] = field( + full_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FullName"}, ) """Full name of the user""" - user_name: Optional[str] = field( + user_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserName"}, ) """Screen name of the user""" @@ -200,66 +219,70 @@ class OriginalTweetModel: Definition: OriginalTweetModel """ - tweet_text: Optional[str] = field( - default=None, - metadata={"wire_name": "TweetText"}, - ) + tweet_text: str = dataclass_field(metadata={"wire_name": "TweetText"}) """Text content of the original retrieved tweet""" - tweet_id: Optional[str] = field( + tweet_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TweetId"}, ) """Id of the original tweet""" - created_at: Optional[str] = field( + created_at: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedAt"}, ) """Time at which original tweet was posted""" - created_at_iso: Optional[str] = field( + created_at_iso: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "CreatedAtIso"}, ) """Time at which original tweet was posted""" - retweet_count: Optional[int] = field( - default=None, + retweet_count: int = dataclass_field( metadata={"wire_name": "RetweetCount"}, ) """Total number of re-tweets for this original tweet""" - tweeted_by: Optional[str] = field( - default=None, - metadata={"wire_name": "TweetedBy"}, - ) + tweeted_by: str = dataclass_field(metadata={"wire_name": "TweetedBy"}) """User name of the person who posted the original tweet""" - media_urls: Optional[List[str]] = field( + media_urls: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaUrls"}, ) """Url of the media posted along with the original tweet""" - tweet_language_code: Optional[str] = field( + tweet_language_code: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TweetLanguageCode"}, ) """Language code for the original tweet""" - tweet_in_reply_to_user_id: Optional[str] = field( + tweet_in_reply_to_user_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "TweetInReplyToUserId"}, ) """ User Id of the author of the tweet that the current original tweet is a reply to """ - favorited: Optional[bool] = field( + favorited: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Favorited"}, ) """Indicates whether the original tweet is marked as favorited""" - user_mentions: Optional[List[OriginalTweetUserMentionsModel]] = field( + user_mentions: Optional[ + List[OriginalTweetUserMentionsModel | Mapping[str, Any]] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserMentions"}, ) """The list of user mentioned in the tweet""" - user_details: Optional[OriginalTweetUserDetailsModel] = field( + user_details: Optional[OriginalTweetUserDetailsModel | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserDetails"}, ) @@ -270,15 +293,17 @@ class OriginalTweetUserMentionsModel: Definition: OriginalTweetUserMentionsModel """ - id: Optional[int] = field(default=None, metadata={"wire_name": "Id"}) + id: int = dataclass_field(metadata={"wire_name": "Id"}) """X id (handle) of the user""" - full_name: Optional[str] = field( + full_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FullName"}, ) """Full name of the user""" - user_name: Optional[str] = field( + user_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "UserName"}, ) """Screen name of the user""" @@ -290,50 +315,47 @@ class OriginalTweetUserDetailsModel: Definition: OriginalTweetUserDetailsModel """ - full_name: Optional[str] = field( - default=None, - metadata={"wire_name": "FullName"}, - ) + full_name: str = dataclass_field(metadata={"wire_name": "FullName"}) """Name of the user""" - location: Optional[str] = field( - default=None, - metadata={"wire_name": "Location"}, - ) + location: str = dataclass_field(metadata={"wire_name": "Location"}) """Location of the user""" - id: Optional[int] = field(default=None, metadata={"wire_name": "Id"}) - """X id (handle) of the user""" - user_name: Optional[str] = field( + id: Optional[int] = dataclass_field( default=None, - metadata={"wire_name": "UserName"}, + kw_only=True, + metadata={"wire_name": "Id"}, ) + """X id (handle) of the user""" + user_name: str = dataclass_field(metadata={"wire_name": "UserName"}) """Screen name of the user""" - followers_count: Optional[int] = field( + followers_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FollowersCount"}, ) """Number of followers""" - description: Optional[str] = field( - default=None, - metadata={"wire_name": "Description"}, - ) + description: str = dataclass_field(metadata={"wire_name": "Description"}) """User description""" - statuses_count: Optional[int] = field( + statuses_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "StatusesCount"}, ) """User status count""" - friends_count: Optional[int] = field( + friends_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FriendsCount"}, ) """Number of friends""" - favourites_count: Optional[int] = field( + favourites_count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FavouritesCount"}, ) """Number of tweets that the user has favorited""" - profile_image_url: Optional[str] = field( + profile_image_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ProfileImageUrl"}, ) """Url of the profile image""" @@ -350,7 +372,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -367,8 +389,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -389,7 +411,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -404,21 +426,117 @@ def __init__( def connector_name(self) -> str: return "twitter" - async def user_timeline_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_user_timeline( self, user_name: str, - max_results: Optional[int] = None, *, + max_results: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get user timeline This operation gets a list of the most recent tweets posted by a given user. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `UserTimeline`. + + Args: + user_name: X handle for the user. + max_results: Maximum number of tweets to return. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/usertimeline" query_params = [] @@ -433,42 +551,81 @@ async def user_timeline_async( query_params.append(f"maxResults={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def home_timeline_async( + def list_home_timeline( self, - max_results: Optional[int] = None, *, + max_results: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get home timeline This operation gets the most recent tweets and re-tweets posted by me and my followers. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `HomeTimeline`. + + Args: + max_results: Maximum number of tweets to return. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/hometimeline" query_params = [] @@ -479,44 +636,86 @@ async def home_timeline_async( query_params.append(f"maxResults={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def search_tweet_async( + def list_search_tweet( self, search_query: str, + *, max_results: Optional[int] = None, since_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Search tweets This operation gets a list of relevant tweets matching the search query. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SearchTweet`. + + Args: + search_query: Search term like \"happy hour\", #haiku, + from:@username, love OR hate. + max_results: Maximum number of tweets to return. + since_id: Return tweets after the specified tweet ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/searchtweets" query_params = [] @@ -536,42 +735,82 @@ async def search_tweet_async( query_params.append(f"sinceId={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def followers_async( + def list_followers( self, user_name: str, - max_results: Optional[int] = None, *, + max_results: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get followers This operation gets the list of users that follow a given user. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Followers`. + + Args: + user_name: X handle for the user. + max_results: Maximum number of users to return. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/followers" query_params = [] @@ -586,41 +825,80 @@ async def followers_async( query_params.append(f"maxResults={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def my_followers_async( + return AsyncItemPaged(get_next, extract_data) + + def list_my_followers( self, - max_results: Optional[int] = None, *, + max_results: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get my followers This operation gets the list of users who are following me. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `MyFollowers`. + + Args: + max_results: Maximum number of users to get. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/myfollowers" query_params = [] @@ -631,42 +909,82 @@ async def my_followers_async( query_params.append(f"maxResults={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def following_async( + return AsyncItemPaged(get_next, extract_data) + + def list_following( self, user_name: str, - max_results: Optional[int] = None, *, + max_results: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get following The operation gets the list of people the given user follows. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Following`. + + Args: + user_name: X handle for the user. + max_results: Maximum number of users to return. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/friends" query_params = [] @@ -681,41 +999,80 @@ async def following_async( query_params.append(f"maxResults={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() - async def my_following_async( + return AsyncItemPaged(get_next, extract_data) + + def list_my_following( self, - max_results: Optional[int] = None, *, + max_results: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get my following This operation gets the list of users that I am following. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `MyFollowing`. + + Args: + max_results: Maximum number of users to return. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/myfriends" query_params = [] @@ -726,29 +1083,50 @@ async def my_following_async( query_params.append(f"maxResults={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def user_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def user( self, user_name: str, *, @@ -762,6 +1140,21 @@ async def user_async( This operation gets the profile details for a given user, such as user name, description, followers count, and more. + + Swagger operation ID: `User`. + + Args: + user_name: X handle for the user. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/user" query_params = [] @@ -772,7 +1165,7 @@ async def user_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -786,6 +1179,7 @@ async def user_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -793,11 +1187,11 @@ async def user_async( return json.loads(response.text) - async def tweet_async( + async def tweet( self, input: bytes, - tweet_text: Optional[str] = None, *, + tweet_text: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -807,6 +1201,22 @@ async def tweet_async( Post a tweet This operation posts a new tweet. + + Swagger operation ID: `Tweet`. + + Args: + input: The binary request body. + tweet_text: Text to be posted. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/posttweet" query_params = [] @@ -818,7 +1228,7 @@ async def tweet_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -835,6 +1245,7 @@ async def tweet_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -842,11 +1253,11 @@ async def tweet_async( return json.loads(response.text) - async def retweet_async( + async def retweet( self, tweet_id: str, - trim_user: Optional[bool] = None, *, + trim_user: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -856,6 +1267,22 @@ async def retweet_async( Retweet This operation retweets a tweet. + + Swagger operation ID: `Retweet`. + + Args: + tweet_id: Tweet to be retweeted. + trim_user: Boolean to indicate whether to trim user information. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/retweet" query_params = [] @@ -871,7 +1298,7 @@ async def retweet_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -885,6 +1312,7 @@ async def retweet_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/typeform.py b/src/azure/connectors/typeform.py index 205d74b5..820c751f 100644 --- a/src/azure/connectors/typeform.py +++ b/src/azure/connectors/typeform.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,22 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "TypeformClient", + "Item", + "ItemNew", + "ListFormsResponse", + "ListFormsResponseOld", + "NewResponseWebhookInput", + "ResponseList", + "WebhookCreationResponse", + "WebhookPayload", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,9 +44,9 @@ class NewResponseWebhookInput: When a response is submitted """ - url: Optional[str] = None + url: str """Webhook URL.""" - enabled: Optional[bool] = None + enabled: bool """ Yes if you want to send responses to the webhook immediately. Otherwise, no. @@ -44,25 +59,25 @@ class WebhookCreationResponse: Response for When a response is submitted """ - id: Optional[str] = None + id: str """Unique ID of the webhook""" - form_id: Optional[str] = None + form_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique ID of the typeform""" - tag: Optional[str] = None + tag: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique name you want to use for the webhook""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """Webhook URL""" - enabled: Optional[bool] = None + enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) """ True if you want to send responses to the webhook immediately. Otherwise, false. """ - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """ Date and time when webhook was created. In ISO 8601 format, UTC time, to the second, with T as a delimiter between the date and time. """ - updated_at: Optional[str] = None + updated_at: Optional[str] = dataclass_field(default=None, kw_only=True) """ Date of last update to webhook. In ISO 8601 format, UTC time, to the second, with T as a delimeter between the date and time. @@ -75,11 +90,11 @@ class ListFormsResponse: Response for List forms """ - total_items: Optional[int] = None + total_items: Optional[int] = dataclass_field(default=None, kw_only=True) """Total number of forms.""" - page_count: Optional[int] = None + page_count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of pages of results.""" - items: Optional[List[Dict[str, Any]]] = None + items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Forms in response.""" @@ -92,7 +107,12 @@ class ResponseList: Definition: ResponseList """ - responses: Optional[List[Item]] = None + responses: Optional[ + List[Item | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -101,8 +121,9 @@ class Item: Definition: Item """ - item_internal_id: Optional[str] = field( + item_internal_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ItemInternalId"}, ) @@ -113,8 +134,9 @@ class ItemNew: Definition: Item-New """ - item_internal_id: Optional[str] = field( + item_internal_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ItemInternalId"}, ) @@ -125,11 +147,11 @@ class WebhookPayload: Definition: WebhookPayload """ - event_id: Optional[str] = None + event_id: str """Unique ID for the webhook. Automatically assigned by Typeform.""" - event_type: Optional[str] = None + event_type: str """Reason the webhook is being sent.""" - form_response: Optional[Dict[str, Any]] = None + form_response: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """ Object that contains information about the typeform and account associated with the webhook. @@ -147,7 +169,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -164,8 +186,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -186,7 +208,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -201,23 +223,122 @@ def __init__( def connector_name(self) -> str: return "typeform" - async def list_forms_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + def list_forms( self, + *, search: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, workspace_id: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List forms Retrieves a list of JSON descriptions for all forms in your Typeform account (public and private). + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListForms_V2`. + + Args: + search: Returns items that contain the specified string. + page: The page of results to retrieve. Default is the first page. + page_size: Number of results to retrieve per page. Default is 10. + Maximum is 200. + workspace_id: Retrieve typeforms for the specified workspace. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/forms" query_params = [] @@ -243,29 +364,50 @@ async def list_forms_async( query_params.append(f"workspace_id={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def get_schema_async( + async def get_schema( self, form_id: str, *, @@ -278,13 +420,28 @@ async def get_schema_async( Get schema Get schema + + Swagger operation ID: `GetSchema_V3`. + + Args: + form_id: Form. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v3/forms/{quote(str(form_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -298,6 +455,7 @@ async def get_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/universalprint.py b/src/azure/connectors/universalprint.py index df2b0feb..7b3f853a 100644 --- a/src/azure/connectors/universalprint.py +++ b/src/azure/connectors/universalprint.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,14 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "UniversalprintClient", + "ListRecentSharesResponse", +] + # Type Definitions @@ -29,7 +36,7 @@ class ListRecentSharesResponse: Response for List recently used shares """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """The list of printer shares""" @@ -44,7 +51,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -61,8 +68,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -83,7 +90,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -98,11 +105,89 @@ def __init__( def connector_name(self) -> str: return "universalprint" - async def print_file_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def print_file( self, input: bytes, printer: str, file_name: str, + *, configuration_copies: Optional[int] = None, configuration_orientation: Optional[str] = None, configuration_color_mode: Optional[str] = None, @@ -113,7 +198,6 @@ async def print_file_async( configuration_quality: Optional[str] = None, configuration_media_type: Optional[str] = None, configuration_finishings: Optional[List[str]] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -123,6 +207,38 @@ async def print_file_async( Print PDF Prints the given pdf. + + Swagger operation ID: `PrintFile`. + + Args: + input: The binary request body. + printer: The name of the printer. + file_name: The name of file. + configuration_copies: The number of copies that should be printed. + configuration_orientation: The direction in which document is + displayed. + configuration_color_mode: The color configuration to print the job. + configuration_media_size: The page size for the paper or other + print media. + configuration_duplex_mode: The setting to print one-sided jobs or + double-sided jobs. + configuration_pages_per_sheet: The number of input Pages to impose + upon a single Impression. + configuration_dpi: The resolution to use when printing the job. + configuration_quality: The print quality to process a print job. + configuration_media_type: The type of media to use. + configuration_finishings: The finishing processes to apply to the + printed document. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/print/shares" query_params = [] @@ -198,7 +314,7 @@ async def print_file_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, @@ -215,42 +331,81 @@ async def print_file_async( request_url, response.status, response.text, + response=response, ) - async def list_recent_shares_async( + def list_recent_shares( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List recently used shares List recently used printer shares. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListRecentShares`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/beta/me/print/recentPrinterShares" ) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) + + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - return json.loads(response.text) + return AsyncItemPaged(get_next, extract_data) diff --git a/src/azure/connectors/waywedo.py b/src/azure/connectors/waywedo.py index ede024fc..7360e2cf 100644 --- a/src/azure/connectors/waywedo.py +++ b/src/azure/connectors/waywedo.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,37 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "WaywedoClient", + "ChecklistComment", + "ChecklistCreateWebHookInput", + "ChecklistInstance", + "ChecklistInstancesInput", + "ChecklistStep", + "ChecklistStepCompletedWebHookInput", + "ChecklistStepsCompleteInput", + "ChecklistStepsCompleteResponse", + "CollaboratorsAddInput", + "CollaboratorsAddResponse", + "CommentAddInput", + "CompletedStep", + "FinishChecklistWebHookInput", + "GenerateAcceptancePDFWebHookInput", + "GetAllChecklistInstancesResponse", + "InviteSupervisorWebHookInput", + "NewCommentWebHookInput", + "Procedure", + "ProcedureAcceptance", + "User", + "UsersInput", + "UsersPostResponse", + "WebhookRegistered", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,24 +59,19 @@ class CommentAddInput: Add a comment to a checklist instance step """ - instance_id: Optional[str] = field( - default=None, - metadata={"wire_name": "instanceId"}, - ) + instance_id: str = dataclass_field(metadata={"wire_name": "instanceId"}) """Select the checklist instance""" - step_id: Optional[str] = field( - default=None, - metadata={"wire_name": "stepId"}, - ) + step_id: str = dataclass_field(metadata={"wire_name": "stepId"}) """Select the step of the checklist instance""" - user_id: Optional[int] = field( + user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userId"}, ) """Select the user creating the comment""" - message: Optional[str] = None + message: str """Specify the comment to add""" - bot: Optional[str] = None + bot: str """The name of the bot creating the comment""" @@ -56,46 +81,57 @@ class ChecklistComment: Response for Add a comment to a checklist instance step """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the comment.""" - type_: Optional[int] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type of comment; either 1 (standard) or 2 (attachment).""" - procedure_id: Optional[int] = field( + procedure_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "procedureId"}, ) """The unique ID of the procedure.""" - procedure_title: Optional[str] = field( + procedure_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "procedureTitle"}, ) """The title of the procedure.""" - instance_id: Optional[str] = field( + instance_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "instanceId"}, ) """The unique ID of the checklist instance.""" - step_id: Optional[str] = field( + step_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "stepId"}, ) """The unique ID of the checklist step.""" - instance_title: Optional[str] = field( + instance_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "instanceTitle"}, ) """The title of the checklist instance.""" - comment: Optional[str] = None + comment: Optional[str] = dataclass_field(default=None, kw_only=True) """The comment text added to the step.""" - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time the comment was created.""" - created_by: Optional[str] = field( + created_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) """The email address of the user who created the comment.""" - image_url: Optional[str] = field( + image_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "imageUrl"}, ) """The URL to the attached file. Valid for 5 minutes.""" @@ -107,24 +143,23 @@ class ChecklistInstancesInput: Create Checklist Instance """ - procedure_id: Optional[int] = field( - default=None, - metadata={"wire_name": "procedureId"}, - ) + procedure_id: int = dataclass_field(metadata={"wire_name": "procedureId"}) """Select a checklist master""" - title: Optional[str] = None + title: str """The title of the checklist instance""" - user_id: Optional[int] = field( + user_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userId"}, ) """Select the user to add as a collaborator""" - company_role_id: Optional[int] = field( + company_role_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "companyRoleId"}, ) """Select the company role to add as a collaborator.""" - bot: Optional[str] = None + bot: str """The name of the bot creating the instance""" @@ -134,33 +169,37 @@ class ChecklistInstance: Response for Create Checklist Instance """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the checklist instance.""" - procedure_id: Optional[int] = field( + procedure_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "procedureId"}, ) """The unique ID of the procedure.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the checklist instance.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The URL to the checklist instance.""" - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time the checklist instance was started.""" - created_by: Optional[str] = field( + created_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) """The email address of the user who started the checklist instance.""" - finished: Optional[str] = None + finished: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time the checklist instance was finished.""" - earliest_due: Optional[str] = field( + earliest_due: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "earliestDue"}, ) """The earliest date and time the checklist instance could be due.""" - latest_due: Optional[str] = field( + latest_due: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "latestDue"}, ) """The latest date and time the checklist instance could be due.""" @@ -172,11 +211,11 @@ class ChecklistStep: Response for Find Checklist Step """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the instance step.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the instance step.""" - ordinal: Optional[int] = None + ordinal: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of the instance step.""" @@ -186,12 +225,9 @@ class ChecklistStepsCompleteInput: Complete a Checklist Step """ - user_id: Optional[int] = field( - default=None, - metadata={"wire_name": "userId"}, - ) + user_id: int = dataclass_field(metadata={"wire_name": "userId"}) """Select the user completing the step""" - bot: Optional[str] = None + bot: str """The name of the bot that completed the checklist step""" @@ -201,7 +237,7 @@ class ChecklistStepsCompleteResponse: Response for Complete a Checklist Step """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -214,17 +250,18 @@ class CollaboratorsAddInput: Add Collaborators to a Checklist Instance """ - checklist_instance_id: Optional[str] = field( - default=None, + checklist_instance_id: str = dataclass_field( metadata={"wire_name": "checklistInstanceId"}, ) """Select the checklist instance""" - user_ids: Optional[List[int]] = field( + user_ids: Optional[List[int]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "userIds"}, ) - company_role_ids: Optional[List[int]] = field( + company_role_ids: Optional[List[int]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "companyRoleIds"}, ) @@ -235,7 +272,7 @@ class CollaboratorsAddResponse: Response for Add Collaborators to a Checklist Instance """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -248,24 +285,29 @@ class Procedure: Response for Find Checklist """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique ID of the procedure.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the procedure.""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The publishing status of the procedure.""" - summary: Optional[str] = None + summary: Optional[str] = dataclass_field(default=None, kw_only=True) """The summary of the procedure.""" - created_by: Optional[str] = field( + created_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) """The email of the user that created the procedure.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """The URL of the procedure.""" - restricted: Optional[bool] = None + restricted: Optional[bool] = dataclass_field(default=None, kw_only=True) """Whether the procedure is restricted or not.""" - type_: Optional[int] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The type of procedure; 1 (standard) or 2 (checklist)""" @@ -275,19 +317,21 @@ class User: Response for Find User """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique ID of the user.""" - first_name: Optional[str] = field( + first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstName"}, ) """The first name of the user.""" - last_name: Optional[str] = field( + last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastName"}, ) """The last name of the user.""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address of the user.""" @@ -297,31 +341,22 @@ class UsersInput: Add a New User """ - first_name: Optional[str] = field( - default=None, - metadata={"wire_name": "firstName"}, - ) + first_name: str = dataclass_field(metadata={"wire_name": "firstName"}) """The first name of the user.""" - last_name: Optional[str] = field( - default=None, - metadata={"wire_name": "lastName"}, - ) + last_name: str = dataclass_field(metadata={"wire_name": "lastName"}) """The last name of the user.""" - email: Optional[str] = None + email: str """The email address of the user.""" - security_role: Optional[int] = field( - default=None, + security_role: int = dataclass_field( metadata={"wire_name": "securityRole"}, ) """Select a security role.""" - company_roles: Optional[List[int]] = field( + company_roles: Optional[List[int]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "companyRoles"}, ) - time_zone_id: Optional[str] = field( - default=None, - metadata={"wire_name": "timeZoneId"}, - ) + time_zone_id: str = dataclass_field(metadata={"wire_name": "timeZoneId"}) """Select the user's timezone.""" @@ -331,7 +366,7 @@ class UsersPostResponse: Response for Add a New User """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -344,10 +379,7 @@ class ChecklistCreateWebHookInput: When a checklist instance is started """ - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """The URL to call when action occurs.""" @@ -357,14 +389,15 @@ class WebhookRegistered: Response for When a checklist instance is started """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique ID of the Webhook registration.""" - callbackurl: Optional[str] = None + callbackurl: Optional[str] = dataclass_field(default=None, kw_only=True) """The URL to call when action occurs.""" - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time the webhook was registered.""" - web_hook_event: Optional[str] = field( + web_hook_event: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "webHookEvent"}, ) """The name of the webhook event.""" @@ -376,10 +409,7 @@ class NewCommentWebHookInput: When a comment is added to a checklist """ - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """The URL to call when action occurs.""" @@ -389,10 +419,7 @@ class FinishChecklistWebHookInput: When a checklist is finished """ - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """The URL to call when action occurs.""" @@ -402,10 +429,7 @@ class InviteSupervisorWebHookInput: When a supervisor is invited """ - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """The URL to call when action occurs.""" @@ -415,10 +439,7 @@ class GenerateAcceptancePDFWebHookInput: When a procedure is accepted """ - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """The URL to call when action occurs.""" @@ -428,10 +449,7 @@ class ChecklistStepCompletedWebHookInput: When a checklist step is completed """ - callback_url: Optional[str] = field( - default=None, - metadata={"wire_name": "callbackUrl"}, - ) + callback_url: str = dataclass_field(metadata={"wire_name": "callbackUrl"}) """The URL to call when action occurs.""" @@ -441,10 +459,16 @@ class GetAllChecklistInstancesResponse: Response for Get All Checklist Instances """ - results: Optional[List[ChecklistInstance]] = None + results: Optional[ + List[ChecklistInstance | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The list of checklist instances.""" - total: Optional[int] = field( + total: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "_total"}, ) """The total number of checklist instances.""" @@ -456,30 +480,34 @@ class CompletedStep: Definition: CompletedStep """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The unique ID of the checklist step completion.""" - instance_id: Optional[str] = field( + instance_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "instanceId"}, ) """The unique ID of the checklist instance.""" - procedure_id: Optional[int] = field( + procedure_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "procedureId"}, ) """The unique ID of the procedure.""" - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time the checklist step was completed.""" - created_by: Optional[str] = field( + created_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) """The email address of the user that completed the checklist step.""" - due: Optional[str] = None + due: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time the checklist step was due.""" - step: Optional[ChecklistStep] = None - decision_choices: Optional[List[str]] = field( + step: Optional[ChecklistStep | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + decision_choices: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "decisionChoices"}, ) """The list of choices made if the step is a decision point.""" @@ -491,27 +519,31 @@ class ProcedureAcceptance: Definition: ProcedureAcceptance """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """The unique ID of the procedure acceptance""" - accepted: Optional[str] = None + accepted: Optional[str] = dataclass_field(default=None, kw_only=True) """The date and time the procedure was accepted.""" - created_by: Optional[str] = field( + created_by: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdBy"}, ) """The email address of the user that accepted the procedure.""" - file_name: Optional[str] = field( + file_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fileName"}, ) """The file name of the generated PDF.""" - attachment_url: Optional[str] = field( + attachment_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "attachmentUrl"}, ) """The URL to the generated PDF. Valid for 5 minutes.""" - procedure_title: Optional[str] = field( + procedure_title: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "procedureTitle"}, ) """The title of the accepted procedure.""" @@ -528,7 +560,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -545,8 +577,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -567,7 +599,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -582,9 +614,86 @@ def __init__( def connector_name(self) -> str: return "waywedo" - async def comment_add_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def comment_add( self, - input: CommentAddInput, + input: CommentAddInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -595,12 +704,28 @@ async def comment_add_async( Add a comment to a checklist instance step Adds a new comment to an Activated Checklist Instance step. + + Swagger operation ID: `Comment_Add`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v1/ChecklistInstanceComments" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -614,6 +739,7 @@ async def comment_add_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -621,9 +747,9 @@ async def comment_add_async( return json.loads(response.text) - async def checklist_instances_async( + async def checklist_instances( self, - input: ChecklistInstancesInput, + input: ChecklistInstancesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -634,10 +760,26 @@ async def checklist_instances_async( Create Checklist Instance Creates a new activated checklist instance. + + Swagger operation ID: `ChecklistInstances_Post`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/ChecklistInstances" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -651,6 +793,7 @@ async def checklist_instances_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -658,7 +801,7 @@ async def checklist_instances_async( return json.loads(response.text) - async def checklist_instances_get_async( + async def checklist_instances_get( self, instance_id: str, *, @@ -671,13 +814,28 @@ async def checklist_instances_get_async( Get A Checklist Instance Retrieve a specific checklist instance by ID + + Swagger operation ID: `ChecklistInstances_Get`. + + Args: + instance_id: The ID of the checklist instance. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1/ChecklistInstances/{quote(str(instance_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -691,6 +849,7 @@ async def checklist_instances_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -698,7 +857,7 @@ async def checklist_instances_get_async( return json.loads(response.text) - async def checklist_instances_activity_async( + def list_checklist_instances_activity( self, instance_id: str, *, @@ -706,11 +865,29 @@ async def checklist_instances_activity_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Checklist Instance Activity Retrieve all activity for a checklist instance + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ChecklistInstances_Activity`. + + Args: + instance_id: Select the checklist instance. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -719,42 +896,82 @@ async def checklist_instances_activity_async( f"/{quote(str(instance_id), safe='')}" f"/Activity" ) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def find_steps_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_find_steps( self, instance_id: str, - query: Optional[str] = None, *, + query: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Find Checklist Step Find a step of a checklist instance + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Find_Steps`. + + Args: + instance_id: Select the checklist instance. + query: Search for a step title. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -768,29 +985,50 @@ async def find_steps_async( query_params.append(f"query={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) - async def checklist_steps_get_async( + async def checklist_steps_get( self, instance_id: str, step_id: str, @@ -804,6 +1042,22 @@ async def checklist_steps_get_async( Get A Checklist Step Retrieve a specific checklist step by ID + + Swagger operation ID: `ChecklistSteps_Get`. + + Args: + instance_id: The ID of the checklist instance. + step_id: The ID of the checklist step. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -814,7 +1068,7 @@ async def checklist_steps_get_async( f"/{quote(str(step_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -828,6 +1082,7 @@ async def checklist_steps_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -835,9 +1090,9 @@ async def checklist_steps_get_async( return json.loads(response.text) - async def checklist_steps_complete_async( + async def checklist_steps_complete( self, - input: ChecklistStepsCompleteInput, + input: ChecklistStepsCompleteInput | Mapping[str, Any], instance_id: str, step_id: str, *, @@ -850,6 +1105,24 @@ async def checklist_steps_complete_async( Complete a Checklist Step Mark a specific step in a checklist instance as complete. + + Swagger operation ID: `ChecklistSteps_Complete`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + instance_id: Select the checklist instance. + step_id: Select the checklist step. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -861,7 +1134,7 @@ async def checklist_steps_complete_async( f"/Complete" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -875,6 +1148,7 @@ async def checklist_steps_complete_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -882,9 +1156,9 @@ async def checklist_steps_complete_async( return json.loads(response.text) - async def collaborators_add_async( + async def collaborators_add( self, - input: CollaboratorsAddInput, + input: CollaboratorsAddInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -895,10 +1169,26 @@ async def collaborators_add_async( Add Collaborators to a Checklist Instance Adds one or more collaborators to a checklist instance. + + Swagger operation ID: `Collaborators_Add`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/Collaborators" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -912,6 +1202,7 @@ async def collaborators_add_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -919,19 +1210,37 @@ async def collaborators_add_async( return json.loads(response.text) - async def find_checklist_async( + def list_find_checklist( self, - query: Optional[str] = None, *, + query: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Find Checklist Search for a checklist by title + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Find_Checklist`. + + Args: + query: The title of the checklist. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/Procedures" query_params = [] @@ -943,29 +1252,50 @@ async def find_checklist_async( query_params.append(f"query={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def procedures_get_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def procedures_get( self, procedure_id: int, *, @@ -978,13 +1308,28 @@ async def procedures_get_async( Get A Checklist Or Procedure Retrieve a specific checklist or procedure by ID + + Swagger operation ID: `Procedures_Get`. + + Args: + procedure_id: The ID of the checklist or procedure. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1/Procedures/{quote(str(procedure_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -998,6 +1343,7 @@ async def procedures_get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1005,20 +1351,39 @@ async def procedures_get_async( return json.loads(response.text) - async def find_checklist_instances_async( + def list_find_checklist_instances( self, procedure_id: int, - query: Optional[str] = None, *, + query: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Find Checklist Instance Search for a checklist instance by title. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Find_Checklist_Instances`. + + Args: + procedure_id: Select a checklist. + query: The title of the checklist instance. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1035,41 +1400,80 @@ async def find_checklist_instances_async( query_params.append(f"query={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def find_user_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_find_user( self, - query: Optional[str] = None, *, + query: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Find User Search for a user by name or email. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `Find_User`. + + Args: + query: The name or email address of the user. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/Users" query_params = [] @@ -1080,31 +1484,52 @@ async def find_user_async( query_params.append(f"query={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def users_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def users( self, - input: UsersInput, + input: UsersInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1115,10 +1540,26 @@ async def users_async( Add a New User Creates and invites a new user. + + Swagger operation ID: `Users_Post`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/Users" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1132,6 +1573,7 @@ async def users_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1139,21 +1581,41 @@ async def users_async( return json.loads(response.text) - async def get_all_checklist_instances_async( + def list_all_checklist_instances( self, + *, limit: Optional[int] = None, offset: Optional[int] = None, status: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get All Checklist Instances Retrieve a list of all activated checklist instances. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetAll_ChecklistInstances`. + + Args: + limit: Maximum number of results to fetch. + offset: The number of records skipped. + status: The status of instances returned. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/ChecklistInstances" query_params = [] @@ -1174,27 +1636,48 @@ async def get_all_checklist_instances_async( query_params.append(f"status={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("results", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/wdatp.py b/src/azure/connectors/wdatp.py index 1e14bdb5..270525fe 100644 --- a/src/azure/connectors/wdatp.py +++ b/src/azure/connectors/wdatp.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,54 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "WdatpClient", + "AdvancedHuntingInput", + "AdvancedHuntingResponse", + "AdvancedHuntingSchemaInput", + "AdvancedHuntingSchemaResponse", + "Alert", + "CancelSingleMachineActionInput", + "CollectInvestigationPackageInput", + "CreateAlertByReferenceInput", + "DomainStats", + "FileStats", + "GetAlertsResponse", + "GetInvestigationPackageUriResponse", + "GetInvestigationsResponse", + "GetLiveResponseDownloadLinkResponse", + "GetMachineActionsResponse", + "GetMachinesResponse", + "GetRemediationActivitiesResponse", + "GetRemediationActivityMachineListResponse", + "InitiateInvestigationInput", + "InitiateInvestigationResponse", + "Investigation", + "IpStats", + "IsolateMachineInput", + "LiveResponseCommand", + "LiveResponseCommandStatus", + "Machine", + "MachineAction", + "MachineTagInput", + "OnNewRemediationActivityResponse", + "PatchAlertInput", + "RemediationActivity", + "RestrictAppExecutionInput", + "RunAntivirusScanInput", + "RunLiveResponseInput", + "StartInvestigationInput", + "UnisolateMachineInput", + "UnrestrictAppExecutionInput", + "WebHookNotification", + "WebHookSubscriptionRequest", + "WebHookSubscriptionTableEntity", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +76,7 @@ class AdvancedHuntingInput: Advanced Hunting (Deprecated) """ - query: Optional[str] = field(default=None, metadata={"wire_name": "Query"}) + query: str = dataclass_field(metadata={"wire_name": "Query"}) """The query to run""" @@ -39,13 +86,15 @@ class AdvancedHuntingResponse: Response for Advanced Hunting (Deprecated) """ - stats: Optional[Dict[str, Any]] = field( + stats: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Stats"}, ) """Stats""" - results: Optional[List[Dict[str, Any]]] = field( + results: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "Results"}, ) @@ -56,31 +105,21 @@ class CreateAlertByReferenceInput: Alerts - Create alert """ - machine_id: Optional[str] = field( - default=None, - metadata={"wire_name": "machineId"}, - ) + machine_id: str = dataclass_field(metadata={"wire_name": "machineId"}) """ID of the machine on which the event was identified""" - report_id: Optional[str] = field( - default=None, - metadata={"wire_name": "reportId"}, - ) + report_id: str = dataclass_field(metadata={"wire_name": "reportId"}) """Report Id of the event""" - event_time: Optional[str] = field( - default=None, - metadata={"wire_name": "eventTime"}, - ) + event_time: str = dataclass_field(metadata={"wire_name": "eventTime"}) """Time of the event as string, e.g. 2018-08-03T16:45:21.7115183Z""" - severity: Optional[str] = None + severity: str """Severity of the alert.""" - category: Optional[str] = None + category: str """Category of the alert""" - title: Optional[str] = None + title: str """Title of the Alert""" - description: Optional[str] = None + description: str """Description of the Alert""" - recommended_action: Optional[str] = field( - default=None, + recommended_action: str = dataclass_field( metadata={"wire_name": "recommendedAction"}, ) """Recommended action for the Alert""" @@ -92,69 +131,79 @@ class Alert: Response for Alerts - Create alert """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Alert identifier""" - incident_id: Optional[int] = field( + incident_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "incidentId"}, ) """The ID of the incident""" - investigation_id: Optional[int] = field( + investigation_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "investigationId"}, ) """The Id of the investigation""" - severity: Optional[str] = None + severity: Optional[str] = dataclass_field(default=None, kw_only=True) """Alert severity""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the alert""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Alert description""" - alert_creation_time: Optional[str] = field( + alert_creation_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "alertCreationTime"}, ) """The time at which the alert was created""" - category: Optional[str] = None + category: Optional[str] = dataclass_field(default=None, kw_only=True) """Alert category""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Alert title""" - threat_family_name: Optional[str] = field( + threat_family_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "threatFamilyName"}, ) """Threat family name""" - detection_source: Optional[str] = field( + detection_source: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "detectionSource"}, ) """Detection source""" - classification: Optional[str] = None + classification: Optional[str] = dataclass_field(default=None, kw_only=True) """Alert classification""" - determination: Optional[str] = None + determination: Optional[str] = dataclass_field(default=None, kw_only=True) """Alert determination""" - assigned_to: Optional[str] = field( + assigned_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedTo"}, ) """Person to whom the alert was assigned""" - resolved_time: Optional[str] = field( + resolved_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "resolvedTime"}, ) """The time at which the alert was resolved""" - last_event_time: Optional[str] = field( + last_event_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastEventTime"}, ) """The time of the last event related to the alert""" - first_event_time: Optional[str] = field( + first_event_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstEventTime"}, ) """The time of the first event related to the alert""" - machine_id: Optional[str] = field( + machine_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "machineId"}, ) """The identifier of the machine related to the alert""" @@ -166,15 +215,22 @@ class GetAlertsResponse: Response for Alerts - Get list of alerts """ - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.count"}, ) """The number of available alerts by this query""" - value: Optional[List[Alert]] = None + value: Optional[ + List[Alert | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The alerts returned""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """ @@ -189,19 +245,20 @@ class PatchAlertInput: Alerts - Update alert """ - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """Status of the alert. One of 'New', 'InProgress' and 'Resolved'""" - assigned_to: Optional[str] = field( + assigned_to: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "assignedTo"}, ) """Person to assign the alert to""" - classification: Optional[str] = None + classification: Optional[str] = dataclass_field(default=None, kw_only=True) """ Classification of the alert. One of 'Unknown', 'FalsePositive', 'TruePositive' """ - determination: Optional[str] = None + determination: Optional[str] = dataclass_field(default=None, kw_only=True) """ The determination of the alert. One of 'NotAvailable', 'Apt', 'Malware', 'SecurityPersonnel', 'SecurityTesting', 'UnwantedSoftware', 'Other' @@ -214,10 +271,7 @@ class InitiateInvestigationInput: Actions - Initiate investigation on a machine (to be deprecated) """ - comment: Optional[str] = field( - default=None, - metadata={"wire_name": "Comment"}, - ) + comment: str = dataclass_field(metadata={"wire_name": "Comment"}) """A comment to associate to the investigation""" @@ -227,7 +281,7 @@ class InitiateInvestigationResponse: Response for Actions - Initiate investigation on a machine (to be deprecated) """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the investigation""" @@ -237,10 +291,7 @@ class StartInvestigationInput: Actions - Start automated investigation on a machine """ - comment: Optional[str] = field( - default=None, - metadata={"wire_name": "Comment"}, - ) + comment: str = dataclass_field(metadata={"wire_name": "Comment"}) """A comment to associate to the investigation""" @@ -250,32 +301,37 @@ class Investigation: Response for Actions - Start automated investigation on a machine """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the investigation""" - state: Optional[str] = None + state: Optional[str] = dataclass_field(default=None, kw_only=True) """The state of the investigation (e.g. 'Benign', 'Running', etc..)""" - status_details: Optional[str] = field( + status_details: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusDetails"}, ) """Details on the status""" - computer_dns_name: Optional[str] = field( + computer_dns_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "computerDnsName"}, ) """The computer name""" - machine_id: Optional[str] = field( + machine_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "machineId"}, ) """The machine ID""" - start_time: Optional[str] = field( + start_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startTime"}, ) """The UTC time at which investigation was started""" - end_time: Optional[str] = field( + end_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endTime"}, ) """The UTC time at which investigation was completed""" @@ -287,42 +343,56 @@ class MachineAction: Response for Actions - Get single machine action """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The ID of the machine action""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """ The type of the action (e.g. 'Isolate', 'CollectInvestigationPackage', ...) """ - requestor: Optional[str] = None + requestor: Optional[str] = dataclass_field(default=None, kw_only=True) """The person that requested the machine action""" - requestor_comment: Optional[str] = field( + requestor_comment: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requestorComment"}, ) """The comment associated to the machine action""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status of the machine action (e.g., 'InProgress')""" - machine_id: Optional[str] = field( + machine_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "machineId"}, ) """The ID of the machine on which the action has been performed""" - creation_date_time_utc: Optional[str] = field( + creation_date_time_utc: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creationDateTimeUtc"}, ) """The UTC time at which the action has been requested""" - last_update_date_time_utc: Optional[str] = field( + last_update_date_time_utc: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastUpdateDateTimeUtc"}, ) """The last UTC time at which the action has been updated""" - related_file_info: Optional[Dict[str, Any]] = field( + related_file_info: Optional[Dict[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "relatedFileInfo"}, ) """relatedFileInfo""" - commands: Optional[List[LiveResponseCommandStatus]] = None + commands: Optional[ + List[LiveResponseCommandStatus | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Live response machine action commands""" @@ -332,10 +402,7 @@ class CancelSingleMachineActionInput: Actions - Cancel a single machine action """ - comment: Optional[str] = field( - default=None, - metadata={"wire_name": "Comment"}, - ) + comment: str = dataclass_field(metadata={"wire_name": "Comment"}) """A comment to associate to the machine action cancellation""" @@ -345,7 +412,7 @@ class GetLiveResponseDownloadLinkResponse: Response for Actions - Get live response command result download URI """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """The live response command download URI""" @@ -355,15 +422,22 @@ class GetMachineActionsResponse: Response for Actions - Get list of machine actions """ - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.count"}, ) """The number of available machine actions by this query""" - value: Optional[List[MachineAction]] = None + value: Optional[ + List[MachineAction | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The machine actions returned""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """ @@ -378,40 +452,47 @@ class FileStats: Response for Files - Get the statistics for the given file """ - sha1: Optional[str] = None + sha1: Optional[str] = dataclass_field(default=None, kw_only=True) """The sha1 of the file""" - globally_prevalence: Optional[int] = field( + globally_prevalence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "globallyPrevalence"}, ) """The file global prevalence.""" - global_first_observed: Optional[str] = field( + global_first_observed: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "globalFirstObserved"}, ) """The first time the file was observed globally.""" - global_last_observed: Optional[str] = field( + global_last_observed: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "globalLastObserved"}, ) """The Last time the file was observed.""" - organization_prevalence: Optional[int] = field( + organization_prevalence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "organizationPrevalence"}, ) """The file prevalence across organization""" - org_first_seen: Optional[str] = field( + org_first_seen: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "orgFirstSeen"}, ) """The first time the file was observed in the organization.""" - org_last_seen: Optional[str] = field( + org_last_seen: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "orgLastSeen"}, ) """The last time the file was observed in the organization.""" - top_file_names: Optional[List[str]] = field( + top_file_names: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "topFileNames"}, ) """The file names that this file has been presented.""" @@ -423,20 +504,23 @@ class DomainStats: Response for Domains - Get the statistics for the given domain name """ - host: Optional[str] = None + host: Optional[str] = dataclass_field(default=None, kw_only=True) """The domain host.""" - organization_prevalence: Optional[int] = field( + organization_prevalence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "organizationPrevalence"}, ) """The domain prevalence across organization""" - org_first_seen: Optional[str] = field( + org_first_seen: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "orgFirstSeen"}, ) """The first time the domain was observed in the organization.""" - org_last_seen: Optional[str] = field( + org_last_seen: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "orgLastSeen"}, ) """The last time the domain was observed in the organization.""" @@ -448,23 +532,27 @@ class IpStats: Response for Ips - Get the statistics for the given ip address """ - ip_address: Optional[str] = field( + ip_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ipAddress"}, ) """The ip address""" - organization_prevalence: Optional[int] = field( + organization_prevalence: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "organizationPrevalence"}, ) """The ip address prevalence across organization""" - org_first_seen: Optional[str] = field( + org_first_seen: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "orgFirstSeen"}, ) """The first time the ip address was observed in the organization.""" - org_last_seen: Optional[str] = field( + org_last_seen: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "orgLastSeen"}, ) """The last time the ip address was observed in the organization.""" @@ -476,15 +564,22 @@ class GetInvestigationsResponse: Response for Actions - Get list of investigation """ - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.count"}, ) """The number of available investigations by this query""" - value: Optional[List[Investigation]] = None + value: Optional[ + List[Investigation | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The investigations returned""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """ @@ -499,10 +594,7 @@ class CollectInvestigationPackageInput: Actions - Collect investigation package """ - comment: Optional[str] = field( - default=None, - metadata={"wire_name": "Comment"}, - ) + comment: str = dataclass_field(metadata={"wire_name": "Comment"}) """A comment to associate to the collection""" @@ -512,7 +604,7 @@ class GetInvestigationPackageUriResponse: Response for Actions - Get investigation package download URI """ - value: Optional[str] = None + value: Optional[str] = dataclass_field(default=None, kw_only=True) """The investigation package SAS URI""" @@ -522,13 +614,9 @@ class IsolateMachineInput: Actions - Isolate machine """ - comment: Optional[str] = field( - default=None, - metadata={"wire_name": "Comment"}, - ) + comment: str = dataclass_field(metadata={"wire_name": "Comment"}) """A comment to associate to the isolation""" - isolation_type: Optional[str] = field( - default=None, + isolation_type: str = dataclass_field( metadata={"wire_name": "IsolationType"}, ) """ @@ -544,10 +632,7 @@ class UnisolateMachineInput: Actions - Unisolate machine """ - comment: Optional[str] = field( - default=None, - metadata={"wire_name": "Comment"}, - ) + comment: str = dataclass_field(metadata={"wire_name": "Comment"}) """A comment to associate to the unisolation""" @@ -557,10 +642,7 @@ class RestrictAppExecutionInput: Actions - Restrict app execution """ - comment: Optional[str] = field( - default=None, - metadata={"wire_name": "Comment"}, - ) + comment: str = dataclass_field(metadata={"wire_name": "Comment"}) """A comment to associate to the restriction""" @@ -570,10 +652,7 @@ class UnrestrictAppExecutionInput: Actions - Remove app execution restriction """ - comment: Optional[str] = field( - default=None, - metadata={"wire_name": "Comment"}, - ) + comment: str = dataclass_field(metadata={"wire_name": "Comment"}) """A comment to associate to the restriction removal""" @@ -583,15 +662,9 @@ class RunAntivirusScanInput: Actions - Run antivirus scan """ - comment: Optional[str] = field( - default=None, - metadata={"wire_name": "Comment"}, - ) + comment: str = dataclass_field(metadata={"wire_name": "Comment"}) """A comment to associate to the scan request""" - scan_type: Optional[str] = field( - default=None, - metadata={"wire_name": "ScanType"}, - ) + scan_type: str = dataclass_field(metadata={"wire_name": "ScanType"}) """Type of scan to perform. Allowed values are 'Quick' or 'Full'""" @@ -601,13 +674,9 @@ class RunLiveResponseInput: Actions - Run live response """ - comment: Optional[str] = field( - default=None, - metadata={"wire_name": "Comment"}, - ) + comment: str = dataclass_field(metadata={"wire_name": "Comment"}) """A comment to associate to the isolation""" - commands: Optional[List[LiveResponseCommand]] = field( - default=None, + commands: List[LiveResponseCommand | Mapping[str, Any]] = dataclass_field( metadata={"wire_name": "Commands"}, ) """The live response commands to execute""" @@ -619,15 +688,22 @@ class GetRemediationActivitiesResponse: Response for Remediation tasks - Get list of remediation activities (Preview) """ - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.count"}, ) """The number of remediation activities by this query""" - value: Optional[List[RemediationActivity]] = None + value: Optional[ + List[RemediationActivity | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The remediation activities returned""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """ @@ -642,124 +718,149 @@ class RemediationActivity: Response for RemediationActivities - Get single remediation activity (Preview) """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The remediation activity identifier""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the remediation activit""" - created_on: Optional[str] = field( + created_on: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "createdOn"}, ) """The time when the remediation activity was created""" - status_last_modified_on: Optional[str] = field( + status_last_modified_on: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "statusLastModifiedOn"}, ) """The time when the status was last modified""" - requester_id: Optional[str] = field( + requester_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requesterId"}, ) """The remediation activity creator id""" - requester_email: Optional[str] = field( + requester_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requesterEmail"}, ) """The remediation activity creator email address""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """the remediation activity status""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """The description of the remediation activity""" - related_component: Optional[str] = field( + related_component: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "relatedComponent"}, ) """The remediation activity related component""" - target_devices: Optional[int] = field( + target_devices: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetDevices"}, ) """The number of the remediation activity target machines""" - rbac_group_names: Optional[List[str]] = field( + rbac_group_names: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "rbacGroupNames"}, ) """The rbac group names associated to the remediation activity""" - fixed_devices: Optional[int] = field( + fixed_devices: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "fixedDevices"}, ) """The number of the remediation activity fixed machines""" - requester_notes: Optional[str] = field( + requester_notes: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requesterNotes"}, ) """The remediation activity creator notes""" - due_on: Optional[str] = field( + due_on: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dueOn"}, ) """The due time for the remediation activity""" - category: Optional[str] = None + category: Optional[str] = dataclass_field(default=None, kw_only=True) """the remediation activity category""" - productivity_impact_remediation_type: Optional[str] = field( + productivity_impact_remediation_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "productivityImpactRemediationType"}, ) """the remediation Productivity impact type""" - priority: Optional[str] = None + priority: Optional[str] = dataclass_field(default=None, kw_only=True) """The remediation activity priority""" - completion_method: Optional[str] = field( + completion_method: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completionMethod"}, ) """The remediation activity completion method""" - completer_id: Optional[str] = field( + completer_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completerId"}, ) """The remediation activity completer object id""" - completer_email: Optional[str] = field( + completer_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "completerEmail"}, ) """The remediation activity completer email address""" - scid: Optional[str] = None + scid: Optional[str] = dataclass_field(default=None, kw_only=True) """The remediation activity security configuration id""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """The remediation activity type""" - product_id: Optional[str] = field( + product_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "productId"}, ) """Product Id""" - vendor_id: Optional[str] = field( + vendor_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "vendorId"}, ) """Vendor id""" - name_id: Optional[str] = field( + name_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nameId"}, ) """Name id""" - recommended_version: Optional[str] = field( + recommended_version: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recommendedVersion"}, ) """Recommended version""" - recommended_vendor: Optional[str] = field( + recommended_vendor: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recommendedVendor"}, ) """Recommended vendor""" - recommended_program: Optional[str] = field( + recommended_program: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "recommendedProgram"}, ) """Recommended program""" - recommendation_reference: Optional[str] = field( + recommendation_reference: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "RecommendationReference"}, ) """Recommendation reference""" @@ -771,15 +872,22 @@ class GetRemediationActivityMachineListResponse: Response for Remediation activities - Get list of related machines (Preview) """ - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.count"}, ) """The number of available machines by this query""" - value: Optional[List[Machine]] = None + value: Optional[ + List[Machine | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The machines returned""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """ @@ -794,15 +902,22 @@ class GetMachinesResponse: Response for Machines - Get list of machines """ - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.count"}, ) """The number of available machines by this query""" - value: Optional[List[Machine]] = None + value: Optional[ + List[Machine | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The machines returned""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """ @@ -817,90 +932,107 @@ class Machine: Response for Machines - Get single machine """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """The machine identifier""" - computer_dns_name: Optional[str] = field( + computer_dns_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "computerDnsName"}, ) """The computer name""" - first_seen: Optional[str] = field( + first_seen: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstSeen"}, ) """The time of the first event received by the machine""" - last_seen: Optional[str] = field( + last_seen: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastSeen"}, ) """The time of the last event received by the machine""" - os_platform: Optional[str] = field( + os_platform: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "osPlatform"}, ) """The OS platform of the machine""" - os_version: Optional[str] = field( + os_version: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "osVersion"}, ) """The OS version of the machine""" - system_product_name: Optional[str] = field( + system_product_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "systemProductName"}, ) """systemProductName""" - last_ip_address: Optional[str] = field( + last_ip_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastIpAddress"}, ) """The last IP address of the machine""" - last_external_ip_address: Optional[str] = field( + last_external_ip_address: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastExternalIpAddress"}, ) """The last external IP address of the machine""" - agent_version: Optional[str] = field( + agent_version: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "agentVersion"}, ) """The agent version""" - os_build: Optional[int] = field( + os_build: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "osBuild"}, ) """The OS build of the machine""" - health_status: Optional[str] = field( + health_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "healthStatus"}, ) """The health status of the machine""" - is_aad_joined: Optional[bool] = field( + is_aad_joined: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isAadJoined"}, ) """A flag indicating whether the machine is joined to Microsoft Entra ID""" - machine_tags: Optional[List[str]] = field( + machine_tags: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "machineTags"}, ) """The tags associated to the machine""" - rbac_group_id: Optional[int] = field( + rbac_group_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "rbacGroupId"}, ) """The ID of the RBAC group to which the machine belongs""" - rbac_group_name: Optional[str] = field( + rbac_group_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "rbacGroupName"}, ) """The name of the RBAC group to which the machine belongs""" - risk_score: Optional[str] = field( + risk_score: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "riskScore"}, ) """A score indicating how much the machine is at risk""" - aad_device_id: Optional[str] = field( + aad_device_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "aadDeviceId"}, ) """aadDeviceId""" @@ -912,12 +1044,9 @@ class MachineTagInput: Machines - Tag machine """ - value: Optional[str] = field(default=None, metadata={"wire_name": "Value"}) + value: str = dataclass_field(metadata={"wire_name": "Value"}) """The tag to add or remove""" - action: Optional[str] = field( - default=None, - metadata={"wire_name": "Action"}, - ) + action: str = dataclass_field(metadata={"wire_name": "Action"}) """ The action to perform. Value should be one of 'Add' (to add a tag) or 'Remove' (to remove a tag) @@ -930,14 +1059,16 @@ class WebHookSubscriptionTableEntity: Response for Triggers - Trigger when new WDATP alert occurs """ - id: Optional[str] = None - notification_url: Optional[str] = field( + id: Optional[str] = dataclass_field(default=None, kw_only=True) + notification_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notificationUrl"}, ) """Gets or sets the web hook subscription notification URL.""" - client_state: Optional[str] = field( + client_state: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "clientState"}, ) @@ -948,15 +1079,22 @@ class OnNewRemediationActivityResponse: Response for Triggers when a new remediation activity is created (Preview) """ - count: Optional[int] = field( + count: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.count"}, ) """The number of remediation activities by this query""" - value: Optional[List[RemediationActivity]] = None + value: Optional[ + List[RemediationActivity | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The remediation activities returned""" - next_link: Optional[str] = field( + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """ @@ -971,7 +1109,7 @@ class AdvancedHuntingSchemaInput: Advanced Hunting Schema """ - query: Optional[str] = field(default=None, metadata={"wire_name": "Query"}) + query: str = dataclass_field(metadata={"wire_name": "Query"}) """The query to run""" @@ -981,7 +1119,7 @@ class AdvancedHuntingSchemaResponse: Response for Advanced Hunting Schema """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -994,29 +1132,37 @@ class LiveResponseCommandStatus: Definition: LiveResponseCommandStatus """ - index: Optional[int] = None + index: Optional[int] = dataclass_field(default=None, kw_only=True) """The index of the command""" - start_time: Optional[str] = field( + start_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "startTime"}, ) """The command execution start time UTC""" - end_time: Optional[str] = field( + end_time: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "endTime"}, ) """The command execution end time UTC""" - command_status: Optional[str] = field( + command_status: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "commandStatus"}, ) """The status of the command execution (e.g., 'Completed')""" - errors: Optional[List[str]] = None + errors: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """ List of command execution errors. In case no errors reported this will be an empty list. """ - command: Optional[LiveResponseCommand] = None + command: Optional[ + LiveResponseCommand | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) """The live response command""" @@ -1026,9 +1172,9 @@ class LiveResponseCommand: Definition: LiveResponseCommand """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: str = dataclass_field(metadata={"wire_name": "type"}) """The type of the command""" - params: Optional[List[Dict[str, Any]]] = None + params: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of command parameters.""" @@ -1038,28 +1184,20 @@ class WebHookSubscriptionRequest: Definition: WebHookSubscriptionRequest """ - client_state: Optional[str] = field( - default=None, - metadata={"wire_name": "clientState"}, - ) + client_state: str = dataclass_field(metadata={"wire_name": "clientState"}) """Gets or sets the client state.""" - change_type: Optional[str] = field( - default=None, - metadata={"wire_name": "changeType"}, - ) + change_type: str = dataclass_field(metadata={"wire_name": "changeType"}) """ Indicates the type of change in the subscribed resource that will raise a notification. """ - resource: Optional[str] = None + resource: str """Specifies the resource that will be monitored for changes.""" - expiration_date_time: Optional[str] = field( - default=None, + expiration_date_time: str = dataclass_field( metadata={"wire_name": "expirationDateTime"}, ) """Specifies the date and time when the webhook subscription expires.""" - notification_url: Optional[str] = field( - default=None, + notification_url: str = dataclass_field( metadata={"wire_name": "notificationUrl"}, ) """Gets or sets the web hook callback URL.""" @@ -1071,9 +1209,10 @@ class WebHookNotification: Definition: WebHookNotification """ - id: Optional[str] = None - machine_id: Optional[str] = field( + id: Optional[str] = dataclass_field(default=None, kw_only=True) + machine_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "machineId"}, ) @@ -1089,7 +1228,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -1106,8 +1245,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -1128,7 +1267,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -1144,15 +1283,49 @@ def connector_name(self) -> str: return "wdatp" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -1169,7 +1342,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -1182,9 +1359,9 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def advanced_hunting_async( + async def advanced_hunting( self, - input: AdvancedHuntingInput, + input: AdvancedHuntingInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1199,10 +1376,26 @@ async def advanced_hunting_async( and will be retired on February 1, 2027. Migrate to the Microsoft Graph Security API. For migration guidance, see: https://learn.microsoft.com/en-us/graph/api/resources/security-api-overview?view=graph-rest-1.0#powerplatformflow-migrationpowerapps-power-automate-logic-apps + + Swagger operation ID: `AdvancedHunting`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/advancedqueries/run" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1216,6 +1409,7 @@ async def advanced_hunting_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1223,9 +1417,9 @@ async def advanced_hunting_async( return json.loads(response.text) - async def create_alert_by_reference_async( + async def create_alert_by_reference( self, - input: CreateAlertByReferenceInput, + input: CreateAlertByReferenceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1236,12 +1430,28 @@ async def create_alert_by_reference_async( Alerts - Create alert Create Alert based on specific Event + + Swagger operation ID: `CreateAlertByReference`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/api/alerts/createAlertByReference" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1255,6 +1465,7 @@ async def create_alert_by_reference_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1262,8 +1473,9 @@ async def create_alert_by_reference_async( return json.loads(response.text) - async def get_alerts_async( + def list_alerts( self, + *, expand: Optional[str] = None, filter: Optional[str] = None, select: Optional[str] = None, @@ -1271,19 +1483,41 @@ async def get_alerts_async( top: Optional[int] = None, skip: Optional[int] = None, count: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Alerts - Get list of alerts Retrieve from Windows Defender ATP the most recent alerts - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetAlerts`. + + Args: + expand: Expands related entities inline. + filter: Filters the results, using OData syntax. + select: Selects which properties to include in the response, + defaults to all. + orderby: Sorts the results. + top: Returns only the first n results. + skip: Skips the first n results. + count: Includes a count of the matching results in the response. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/alerts" query_params = [] @@ -1324,11 +1558,18 @@ async def get_alerts_async( query_params.append(f"$count={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1341,23 +1582,32 @@ async def get_alerts_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_single_alert_async( + async def get_single_alert( self, alert_id: str, *, @@ -1370,13 +1620,28 @@ async def get_single_alert_async( Alerts - Get single alert Retrieve from Windows Defender ATP a specific alert + + Swagger operation ID: `GetSingleAlert`. + + Args: + alert_id: The identifier of the alert to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/alerts/{quote(str(alert_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1390,6 +1655,7 @@ async def get_single_alert_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1397,9 +1663,9 @@ async def get_single_alert_async( return json.loads(response.text) - async def patch_alert_async( + async def patch_alert( self, - input: PatchAlertInput, + input: PatchAlertInput | Mapping[str, Any], alert_id: str, *, timeout: Optional[float] = None, @@ -1411,13 +1677,30 @@ async def patch_alert_async( Alerts - Update alert Update a Windows Defender ATP alert + + Swagger operation ID: `PatchAlert`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + alert_id: The identifier of the alert to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/alerts/{quote(str(alert_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -1431,6 +1714,7 @@ async def patch_alert_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1438,9 +1722,9 @@ async def patch_alert_async( return json.loads(response.text) - async def initiate_investigation_async( + async def initiate_investigation( self, - input: InitiateInvestigationInput, + input: InitiateInvestigationInput | Mapping[str, Any], machine_id: str, *, timeout: Optional[float] = None, @@ -1452,6 +1736,23 @@ async def initiate_investigation_async( Actions - Initiate investigation on a machine (to be deprecated) Initiate investigation on a machine + + Swagger operation ID: `InitiateInvestigation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + machine_id: The ID of the machine to investigate. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1461,7 +1762,7 @@ async def initiate_investigation_async( f"/initiateInvestigation" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1475,6 +1776,7 @@ async def initiate_investigation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1482,9 +1784,9 @@ async def initiate_investigation_async( return json.loads(response.text) - async def start_investigation_async( + async def start_investigation( self, - input: StartInvestigationInput, + input: StartInvestigationInput | Mapping[str, Any], machine_id: str, *, timeout: Optional[float] = None, @@ -1496,6 +1798,23 @@ async def start_investigation_async( Actions - Start automated investigation on a machine Start automated investigation on a machine + + Swagger operation ID: `StartInvestigation`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + machine_id: The ID of the machine to investigate. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1505,7 +1824,7 @@ async def start_investigation_async( f"/startInvestigation" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1519,6 +1838,7 @@ async def start_investigation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1526,7 +1846,7 @@ async def start_investigation_async( return json.loads(response.text) - async def get_single_machine_action_async( + async def get_single_machine_action( self, machine_action_id: str, *, @@ -1539,13 +1859,29 @@ async def get_single_machine_action_async( Actions - Get single machine action Retrieve from Windows Defender ATP a specific machine action + + Swagger operation ID: `GetSingleMachineAction`. + + Args: + machine_action_id: The identifier of the machine action to + retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/machineactions/{quote(str(machine_action_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1559,6 +1895,7 @@ async def get_single_machine_action_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1566,9 +1903,9 @@ async def get_single_machine_action_async( return json.loads(response.text) - async def cancel_single_machine_action_async( + async def cancel_single_machine_action( self, - input: CancelSingleMachineActionInput, + input: CancelSingleMachineActionInput | Mapping[str, Any], machine_action_id: str, *, timeout: Optional[float] = None, @@ -1580,6 +1917,23 @@ async def cancel_single_machine_action_async( Actions - Cancel a single machine action Cancel a specific machine action + + Swagger operation ID: `CancelSingleMachineAction`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + machine_action_id: The identifier of the machine action to cancel. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1589,7 +1943,7 @@ async def cancel_single_machine_action_async( f"/cancel" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1603,6 +1957,7 @@ async def cancel_single_machine_action_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1610,7 +1965,7 @@ async def cancel_single_machine_action_async( return json.loads(response.text) - async def get_live_response_download_link_async( + async def get_live_response_download_link( self, machine_action_id: str, command_index: int, @@ -1624,6 +1979,23 @@ async def get_live_response_download_link_async( Actions - Get live response command result download URI Get result download URI for a completed live response command + + Swagger operation ID: `GetLiveResponseDownloadLink`. + + Args: + machine_action_id: The identifier of the machine action. + command_index: The index of the live response command to get the + results download URI for. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1635,7 +2007,7 @@ async def get_live_response_download_link_async( f")" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1649,6 +2021,7 @@ async def get_live_response_download_link_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1656,27 +2029,49 @@ async def get_live_response_download_link_async( return json.loads(response.text) - async def get_machine_actions_async( + def list_machine_actions( self, + *, filter: Optional[str] = None, select: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, count: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Actions - Get list of machine actions Retrieve from Windows Defender ATP the most recent machine actions - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetMachineActions`. + + Args: + filter: Filters the results, using OData syntax. + select: Selects which properties to include in the response, + defaults to all. + orderby: Sorts the results. + top: Returns only the first n results. + skip: Skips the first n results. + count: Includes a count of the matching results in the response. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/machineactions" query_params = [] @@ -1712,11 +2107,18 @@ async def get_machine_actions_async( query_params.append(f"$count={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -1729,27 +2131,36 @@ async def get_machine_actions_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_file_stats_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_file_stats( self, file_id: str, - look_back_hours: Optional[int] = None, *, + look_back_hours: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1760,6 +2171,23 @@ async def get_file_stats_async( Retrieve from Windows Defender ATP statistics for the given file to a given file by identifier Sha1, or Sha256 + + Swagger operation ID: `GetFileStats`. + + Args: + file_id: The file identifier - Sha1, or Sha256. + look_back_hours: The look back period in hours to look by, the + default is 24 hours. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1774,7 +2202,7 @@ async def get_file_stats_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1788,6 +2216,7 @@ async def get_file_stats_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1795,11 +2224,11 @@ async def get_file_stats_async( return json.loads(response.text) - async def get_domain_stats_async( + async def get_domain_stats( self, domain_name: str, - look_back_hours: Optional[int] = None, *, + look_back_hours: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1810,6 +2239,23 @@ async def get_domain_stats_async( Retrieve from Windows Defender ATP statistics related to a given domain name + + Swagger operation ID: `GetDomainStats`. + + Args: + domain_name: The domain name. + look_back_hours: The look back period in hours to look by, the + default is 24 hours. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1824,7 +2270,7 @@ async def get_domain_stats_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1838,6 +2284,7 @@ async def get_domain_stats_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1845,11 +2292,11 @@ async def get_domain_stats_async( return json.loads(response.text) - async def get_ip_stats_async( + async def get_ip_stats( self, ip_address: str, - look_back_hours: Optional[int] = None, *, + look_back_hours: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -1860,6 +2307,23 @@ async def get_ip_stats_async( Retrieve from Windows Defender ATP statistics related to a given ip address - given in ipv4 or ipv6 format. + + Swagger operation ID: `GetIpStats`. + + Args: + ip_address: The ip address. + look_back_hours: The look back period in hours to look by, the + default is 24 hours. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -1874,7 +2338,7 @@ async def get_ip_stats_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1888,6 +2352,7 @@ async def get_ip_stats_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1895,7 +2360,7 @@ async def get_ip_stats_async( return json.loads(response.text) - async def get_single_investigation_async( + async def get_single_investigation( self, investigation_id: str, *, @@ -1908,13 +2373,28 @@ async def get_single_investigation_async( Actions - Get single investigation Retrieve from Microsoft Defender ATP a specific investigation + + Swagger operation ID: `GetSingleInvestigation`. + + Args: + investigation_id: The identifier of the investigation to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/investigations/{quote(str(investigation_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1928,6 +2408,7 @@ async def get_single_investigation_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1935,27 +2416,49 @@ async def get_single_investigation_async( return json.loads(response.text) - async def get_investigations_async( + def list_investigations( self, + *, filter: Optional[str] = None, select: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, count: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Actions - Get list of investigation Retrieve from Microsoft Defender ATP the most recent investigations - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetInvestigations`. + + Args: + filter: Filters the results, using OData syntax. + select: Selects which properties to include in the response, + defaults to all. + orderby: Sorts the results. + top: Returns only the first n results. + skip: Skips the first n results. + count: Includes a count of the matching results in the response. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/investigations" query_params = [] @@ -1991,11 +2494,18 @@ async def get_investigations_async( query_params.append(f"$count={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2008,25 +2518,34 @@ async def get_investigations_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def collect_investigation_package_async( + async def collect_investigation_package( self, - input: CollectInvestigationPackageInput, + input: CollectInvestigationPackageInput | Mapping[str, Any], machine_id: str, *, timeout: Optional[float] = None, @@ -2038,6 +2557,24 @@ async def collect_investigation_package_async( Actions - Collect investigation package Collect investigation package from a machine + + Swagger operation ID: `CollectInvestigationPackage`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + machine_id: The ID of the machine to collect the investigation + from. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2047,7 +2584,7 @@ async def collect_investigation_package_async( f"/collectInvestigationPackage" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2061,6 +2598,7 @@ async def collect_investigation_package_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2068,7 +2606,7 @@ async def collect_investigation_package_async( return json.loads(response.text) - async def get_investigation_package_uri_async( + async def get_investigation_package_uri( self, machine_action_id: str, *, @@ -2081,6 +2619,21 @@ async def get_investigation_package_uri_async( Actions - Get investigation package download URI Get a URI that allows downloading of an investigation package + + Swagger operation ID: `GetInvestigationPackageUri`. + + Args: + machine_action_id: The ID of the investigation package collection. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2090,7 +2643,7 @@ async def get_investigation_package_uri_async( f"/getPackageUri" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2104,6 +2657,7 @@ async def get_investigation_package_uri_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2111,9 +2665,9 @@ async def get_investigation_package_uri_async( return json.loads(response.text) - async def isolate_machine_async( + async def isolate_machine( self, - input: IsolateMachineInput, + input: IsolateMachineInput | Mapping[str, Any], machine_id: str, *, timeout: Optional[float] = None, @@ -2125,13 +2679,30 @@ async def isolate_machine_async( Actions - Isolate machine Isolate a machine from network + + Swagger operation ID: `IsolateMachine`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + machine_id: The ID of the machine to isolate. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/machines/{quote(str(machine_id), safe='')}/isolate" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2145,6 +2716,7 @@ async def isolate_machine_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2152,9 +2724,9 @@ async def isolate_machine_async( return json.loads(response.text) - async def unisolate_machine_async( + async def unisolate_machine( self, - input: UnisolateMachineInput, + input: UnisolateMachineInput | Mapping[str, Any], machine_id: str, *, timeout: Optional[float] = None, @@ -2166,13 +2738,30 @@ async def unisolate_machine_async( Actions - Unisolate machine Unisolate a machine from network + + Swagger operation ID: `UnisolateMachine`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + machine_id: The ID of the machine to unisolate. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/machines/{quote(str(machine_id), safe='')}/unisolate" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2186,6 +2775,7 @@ async def unisolate_machine_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2193,9 +2783,9 @@ async def unisolate_machine_async( return json.loads(response.text) - async def restrict_app_execution_async( + async def restrict_app_execution( self, - input: RestrictAppExecutionInput, + input: RestrictAppExecutionInput | Mapping[str, Any], machine_id: str, *, timeout: Optional[float] = None, @@ -2208,6 +2798,23 @@ async def restrict_app_execution_async( Restrict execution of all applications on the machine except a predefined set + + Swagger operation ID: `RestrictAppExecution`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + machine_id: The ID of the machine to restrict. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2217,7 +2824,7 @@ async def restrict_app_execution_async( f"/restrictCodeExecution" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2231,6 +2838,7 @@ async def restrict_app_execution_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2238,9 +2846,9 @@ async def restrict_app_execution_async( return json.loads(response.text) - async def unrestrict_app_execution_async( + async def unrestrict_app_execution( self, - input: UnrestrictAppExecutionInput, + input: UnrestrictAppExecutionInput | Mapping[str, Any], machine_id: str, *, timeout: Optional[float] = None, @@ -2252,6 +2860,23 @@ async def unrestrict_app_execution_async( Actions - Remove app execution restriction Enable execution of any application on the machine + + Swagger operation ID: `UnrestrictAppExecution`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + machine_id: The ID of the machine to unrestrict. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2261,7 +2886,7 @@ async def unrestrict_app_execution_async( f"/unrestrictCodeExecution" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2275,6 +2900,7 @@ async def unrestrict_app_execution_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2282,9 +2908,9 @@ async def unrestrict_app_execution_async( return json.loads(response.text) - async def run_antivirus_scan_async( + async def run_antivirus_scan( self, - input: RunAntivirusScanInput, + input: RunAntivirusScanInput | Mapping[str, Any], machine_id: str, *, timeout: Optional[float] = None, @@ -2296,13 +2922,30 @@ async def run_antivirus_scan_async( Actions - Run antivirus scan Initiate Windows Defender Antivirus scan on a machine + + Swagger operation ID: `RunAntivirusScan`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + machine_id: The ID of the machine to scan. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/machines/{quote(str(machine_id), safe='')}/runAntiVirusScan" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2316,6 +2959,7 @@ async def run_antivirus_scan_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2323,9 +2967,9 @@ async def run_antivirus_scan_async( return json.loads(response.text) - async def run_live_response_async( + async def run_live_response( self, - input: RunLiveResponseInput, + input: RunLiveResponseInput | Mapping[str, Any], machine_id: str, *, timeout: Optional[float] = None, @@ -2337,13 +2981,30 @@ async def run_live_response_async( Actions - Run live response Run live response api commands for a single machine + + Swagger operation ID: `RunLiveResponse`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + machine_id: The ID of the machine to run live response session on. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/machines/{quote(str(machine_id), safe='')}/runliveresponse" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2357,6 +3018,7 @@ async def run_live_response_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2364,27 +3026,49 @@ async def run_live_response_async( return json.loads(response.text) - async def get_remediation_activities_async( + def list_remediation_activities( self, + *, filter: Optional[str] = None, select: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, count: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Remediation tasks - Get list of remediation activities (Preview) Retrieve from Windows Defender ATP the remediation activities - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetRemediationActivities`. + + Args: + filter: Filters the results, using OData syntax. + select: Selects which properties to include in the response, + defaults to all. + orderby: Sorts the results. + top: Returns only the first n results. + skip: Skips the first n results. + count: Includes a count of the matching results in the response. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/remediationtasks" query_params = [] @@ -2420,11 +3104,18 @@ async def get_remediation_activities_async( query_params.append(f"$count={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2437,23 +3128,32 @@ async def get_remediation_activities_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_single_remediation_activity_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_single_remediation_activity( self, remediation_id: str, *, @@ -2466,13 +3166,29 @@ async def get_single_remediation_activity_async( RemediationActivities - Get single remediation activity (Preview) Retrieve from Windows Defender ATP a specific remediation activity + + Swagger operation ID: `GetSingleRemediationActivity`. + + Args: + remediation_id: The identifier of the remediation activity to + retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/remediationtasks/{quote(str(remediation_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2486,6 +3202,7 @@ async def get_single_remediation_activity_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2493,7 +3210,7 @@ async def get_single_remediation_activity_async( return json.loads(response.text) - async def get_remediation_activity_machine_list_async( + def list_get_remediation_activity_machine( self, remediation_id: str, *, @@ -2501,15 +3218,32 @@ async def get_remediation_activity_machine_list_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Remediation activities - Get list of related machines (Preview) Retrieve from Windows Defender ATP the related machines to a specific remediation activity - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetRemediationActivityMachineList`. + + Args: + remediation_id: The identifier of the remediation activity to + retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -2518,11 +3252,18 @@ async def get_remediation_activity_machine_list_async( f"/{quote(str(remediation_id), safe='')}" f"/machinereferences" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2535,43 +3276,74 @@ async def get_remediation_activity_machine_list_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_machines_async( + return AsyncItemPaged(get_next, extract_data) + + def list_machines( self, + *, filter: Optional[str] = None, select: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, count: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Machines - Get list of machines Retrieve from Windows Defender ATP the most recent machines - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetMachines`. + + Args: + filter: Filters the results, using OData syntax. + select: Selects which properties to include in the response, + defaults to all. + orderby: Sorts the results. + top: Returns only the first n results. + skip: Skips the first n results. + count: Includes a count of the matching results in the response. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/machines" query_params = [] @@ -2607,11 +3379,18 @@ async def get_machines_async( query_params.append(f"$count={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -2624,23 +3403,32 @@ async def get_machines_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_single_machine_async( + async def get_single_machine( self, machine_id: str, *, @@ -2653,13 +3441,28 @@ async def get_single_machine_async( Machines - Get single machine Retrieve from Windows Defender ATP a specific machine + + Swagger operation ID: `GetSingleMachine`. + + Args: + machine_id: The identifier of the machine to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/machines/{quote(str(machine_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -2673,6 +3476,7 @@ async def get_single_machine_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2680,9 +3484,9 @@ async def get_single_machine_async( return json.loads(response.text) - async def machine_tag_async( + async def machine_tag( self, - input: MachineTagInput, + input: MachineTagInput | Mapping[str, Any], machine_id: str, *, timeout: Optional[float] = None, @@ -2694,13 +3498,31 @@ async def machine_tag_async( Machines - Tag machine Add or remove a tag to/from a machine + + Swagger operation ID: `MachineTag`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + machine_id: The ID of the machine to which the tag should be added + or removed. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/api/machines/{quote(str(machine_id), safe='')}/tags" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2714,6 +3536,7 @@ async def machine_tag_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -2721,9 +3544,9 @@ async def machine_tag_async( return json.loads(response.text) - async def advanced_hunting_schema_async( + async def advanced_hunting_schema( self, - input: AdvancedHuntingSchemaInput, + input: AdvancedHuntingSchemaInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -2734,12 +3557,28 @@ async def advanced_hunting_schema_async( Advanced Hunting Schema Gets the schema for a Windows Defender ATP custom query + + Swagger operation ID: `AdvancedHuntingSchema`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/api/advancedqueries/schema" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -2753,6 +3592,7 @@ async def advanced_hunting_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/webex.py b/src/azure/connectors/webex.py index d212fa9e..486cec80 100644 --- a/src/azure/connectors/webex.py +++ b/src/azure/connectors/webex.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,42 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "WebexClient", + "CreateSpaceInput", + "CreateSpaceMemberInput", + "CreateSpaceMemberResponse", + "CreateSpaceResponse", + "CreateTeamMemberInput", + "CreateTeamMemberResponse", + "GetMessageDetailsResponse", + "GetMessagesResponse", + "GetMyOwnDetailsResponse", + "GetPeopleResponse", + "GetSpaceDetailResponse", + "GetSpacesResponse", + "MembershipsCreatedInput", + "MembershipsCreatedResponse", + "MembershipsDeletedInput", + "MembershipsDeletedResponse", + "MembershipsUpdatedInput", + "MembershipsUpdatedResponse", + "MessagesCreatedInput", + "MessagesCreatedResponse", + "MessagesDeletedInput", + "MessagesDeletedResponse", + "SendMessageInput", + "SendMessageResponse", + "SpaceCreatedInput", + "SpaceCreatedResponse", + "SpaceUpdatedInput", + "SpaceUpdatedResponse", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,25 +64,21 @@ class CreateSpaceMemberInput: Add Member to Space """ - is_moderator: Optional[bool] = field( - default=None, - metadata={"wire_name": "isModerator"}, - ) + is_moderator: bool = dataclass_field(metadata={"wire_name": "isModerator"}) """Is moderator?""" - person_email: Optional[str] = field( + person_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personEmail"}, ) """Email address""" - person_id: Optional[str] = field( + person_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personId"}, ) """Person ID of the new member""" - room_id: Optional[str] = field( - default=None, - metadata={"wire_name": "roomId"}, - ) + room_id: str = dataclass_field(metadata={"wire_name": "roomId"}) """Select a space""" @@ -57,42 +88,49 @@ class CreateSpaceMemberResponse: Response for Add Member to Space """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - is_moderator: Optional[bool] = field( + is_moderator: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isModerator"}, ) """isModerator""" - is_monitor: Optional[bool] = field( + is_monitor: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isMonitor"}, ) """isMonitor""" - person_display_name: Optional[str] = field( + person_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personDisplayName"}, ) """personDisplayName""" - person_email: Optional[str] = field( + person_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personEmail"}, ) """personEmail""" - person_id: Optional[str] = field( + person_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personId"}, ) """personId""" - person_org_id: Optional[str] = field( + person_org_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personOrgId"}, ) """personOrgId""" - room_id: Optional[str] = field( + room_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "roomId"}, ) """roomId""" @@ -104,7 +142,7 @@ class GetMessagesResponse: Response for Get Messages """ - items: Optional[List[Dict[str, Any]]] = None + items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """items""" @@ -114,26 +152,29 @@ class SendMessageInput: Send a Message """ - files: Optional[List[str]] = None + files: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """files""" - markdown: Optional[str] = None + markdown: Optional[str] = dataclass_field(default=None, kw_only=True) """Message, in markdown format""" - room_id: Optional[str] = field( + room_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "roomId"}, ) """Select a recipient space""" - text: Optional[str] = None + text: Optional[str] = dataclass_field(default=None, kw_only=True) """ Message Text, in plain text, used for clients that do not support markdown """ - to_person_email: Optional[str] = field( + to_person_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "toPersonEmail"}, ) """The email address of the recipient when sending a private 1:1 message""" - to_person_id: Optional[str] = field( + to_person_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "toPersonId"}, ) """The ID of the recipient when sending a 1:1 message""" @@ -145,34 +186,39 @@ class SendMessageResponse: Response for Send a Message """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - person_email: Optional[str] = field( + person_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personEmail"}, ) """personEmail""" - person_id: Optional[str] = field( + person_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personId"}, ) """personId""" - room_id: Optional[str] = field( + room_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "roomId"}, ) """roomId""" - room_type: Optional[str] = field( + room_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "roomType"}, ) """roomType""" - text: Optional[str] = None + text: Optional[str] = dataclass_field(default=None, kw_only=True) """text""" - to_person_email: Optional[str] = field( + to_person_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "toPersonEmail"}, ) """toPersonEmail""" @@ -184,53 +230,61 @@ class GetMessageDetailsResponse: Response for Get Message Details """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - files: Optional[List[str]] = None + files: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """files""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - markdown: Optional[str] = None + markdown: Optional[str] = dataclass_field(default=None, kw_only=True) """markdown""" - mentioned_groups: Optional[List[str]] = field( + mentioned_groups: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mentionedGroups"}, ) """mentionedGroups""" - mentioned_people: Optional[List[str]] = field( + mentioned_people: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "mentionedPeople"}, ) """mentionedPeople""" - person_email: Optional[str] = field( + person_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personEmail"}, ) """personEmail""" - person_id: Optional[str] = field( + person_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personId"}, ) """personId""" - room_id: Optional[str] = field( + room_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "roomId"}, ) """roomId""" - room_type: Optional[str] = field( + room_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "roomType"}, ) """roomType""" - text: Optional[str] = None + text: Optional[str] = dataclass_field(default=None, kw_only=True) """text""" - to_person_email: Optional[str] = field( + to_person_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "toPersonEmail"}, ) """toPersonEmail""" - to_person_id: Optional[str] = field( + to_person_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "toPersonId"}, ) """toPersonId""" @@ -242,10 +296,11 @@ class GetPeopleResponse: Response for Get People """ - items: Optional[List[Dict[str, Any]]] = None + items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """items""" - not_found_ids: Optional[List[str]] = field( + not_found_ids: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "notFoundIds"}, ) """notFoundIds""" @@ -257,52 +312,63 @@ class GetMyOwnDetailsResponse: Response for Get My Own Details """ - avatar: Optional[str] = None + avatar: Optional[str] = dataclass_field(default=None, kw_only=True) """avatar""" - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) """displayName""" - emails: Optional[List[str]] = None + emails: Optional[List[str]] = dataclass_field(default=None, kw_only=True) """emails""" - first_name: Optional[str] = field( + first_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "firstName"}, ) """firstName""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - last_activity: Optional[str] = field( + last_activity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastActivity"}, ) """lastActivity""" - last_name: Optional[str] = field( + last_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastName"}, ) """lastName""" - nick_name: Optional[str] = field( + nick_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nickName"}, ) """nickName""" - org_id: Optional[str] = field( + org_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "orgId"}, ) """orgId""" - phone_numbers: Optional[List[Dict[str, Any]]] = field( + phone_numbers: Optional[List[Dict[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "phoneNumbers"}, ) """phoneNumbers""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """type""" @@ -312,7 +378,7 @@ class GetSpacesResponse: Response for Get Spaces List """ - items: Optional[List[Dict[str, Any]]] = None + items: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """items""" @@ -322,12 +388,13 @@ class CreateSpaceInput: Create Space """ - team_id: Optional[str] = field( + team_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamId"}, ) """Optionally select a team""" - title: Optional[str] = None + title: str """Space Title""" @@ -337,28 +404,35 @@ class CreateSpaceResponse: Response for Create Space """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - creator_id: Optional[str] = field( + creator_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creatorId"}, ) """creatorId""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - is_locked: Optional[bool] = field( + is_locked: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isLocked"}, ) """isLocked""" - last_activity: Optional[str] = field( + last_activity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastActivity"}, ) """lastActivity""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """title""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """type""" @@ -368,28 +442,35 @@ class GetSpaceDetailResponse: Response for Get Space Details """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - creator_id: Optional[str] = field( + creator_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "creatorId"}, ) """creatorId""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - is_locked: Optional[bool] = field( + is_locked: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isLocked"}, ) """isLocked""" - last_activity: Optional[str] = field( + last_activity: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "lastActivity"}, ) """lastActivity""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """title""" - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """type""" @@ -399,25 +480,21 @@ class CreateTeamMemberInput: Add Member to Team """ - is_moderator: Optional[bool] = field( - default=None, - metadata={"wire_name": "isModerator"}, - ) + is_moderator: bool = dataclass_field(metadata={"wire_name": "isModerator"}) """Is Moderator?""" - person_email: Optional[str] = field( + person_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personEmail"}, ) """Email address""" - person_id: Optional[str] = field( + person_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personId"}, ) """Person ID of the new member""" - team_id: Optional[str] = field( - default=None, - metadata={"wire_name": "teamId"}, - ) + team_id: str = dataclass_field(metadata={"wire_name": "teamId"}) """Select a team""" @@ -427,37 +504,43 @@ class CreateTeamMemberResponse: Response for Add Member to Team """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - is_moderator: Optional[bool] = field( + is_moderator: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isModerator"}, ) """isModerator""" - person_display_name: Optional[str] = field( + person_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personDisplayName"}, ) """personDisplayName""" - person_email: Optional[str] = field( + person_email: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personEmail"}, ) """personEmail""" - person_id: Optional[str] = field( + person_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personId"}, ) """personId""" - person_org_id: Optional[str] = field( + person_org_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "personOrgId"}, ) """personOrgId""" - team_id: Optional[str] = field( + team_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "teamId"}, ) """teamId""" @@ -469,16 +552,13 @@ class MembershipsUpdatedInput: When a membership is updated """ - event: Optional[str] = None + event: str """event""" - name: Optional[str] = None + name: str """name""" - resource: Optional[str] = None + resource: str """resource""" - target_url: Optional[str] = field( - default=None, - metadata={"wire_name": "targetUrl"}, - ) + target_url: str = dataclass_field(metadata={"wire_name": "targetUrl"}) """targetUrl""" @@ -488,26 +568,27 @@ class MembershipsUpdatedResponse: Response for When a membership is updated """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - target_url: Optional[str] = field( + target_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetUrl"}, ) """targetUrl""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """resource""" - event: Optional[str] = None + event: Optional[str] = dataclass_field(default=None, kw_only=True) """event""" - filter: Optional[str] = None + filter: Optional[str] = dataclass_field(default=None, kw_only=True) """filter""" - secret: Optional[str] = None + secret: Optional[str] = dataclass_field(default=None, kw_only=True) """secret""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" @@ -517,16 +598,13 @@ class MembershipsDeletedInput: When a membership is deleted """ - event: Optional[str] = None + event: str """event""" - name: Optional[str] = None + name: str """name""" - resource: Optional[str] = None + resource: str """resource""" - target_url: Optional[str] = field( - default=None, - metadata={"wire_name": "targetUrl"}, - ) + target_url: str = dataclass_field(metadata={"wire_name": "targetUrl"}) """targetUrl""" @@ -536,26 +614,27 @@ class MembershipsDeletedResponse: Response for When a membership is deleted """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - target_url: Optional[str] = field( + target_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetUrl"}, ) """targetUrl""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """resource""" - event: Optional[str] = None + event: Optional[str] = dataclass_field(default=None, kw_only=True) """event""" - filter: Optional[str] = None + filter: Optional[str] = dataclass_field(default=None, kw_only=True) """filter""" - secret: Optional[str] = None + secret: Optional[str] = dataclass_field(default=None, kw_only=True) """secret""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" @@ -565,16 +644,13 @@ class MembershipsCreatedInput: When a membership is created """ - event: Optional[str] = None + event: str """event""" - name: Optional[str] = None + name: str """name""" - resource: Optional[str] = None + resource: str """resource""" - target_url: Optional[str] = field( - default=None, - metadata={"wire_name": "targetUrl"}, - ) + target_url: str = dataclass_field(metadata={"wire_name": "targetUrl"}) """targetUrl""" @@ -584,26 +660,27 @@ class MembershipsCreatedResponse: Response for When a membership is created """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - target_url: Optional[str] = field( + target_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetUrl"}, ) """targetUrl""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """resource""" - event: Optional[str] = None + event: Optional[str] = dataclass_field(default=None, kw_only=True) """event""" - filter: Optional[str] = None + filter: Optional[str] = dataclass_field(default=None, kw_only=True) """filter""" - secret: Optional[str] = None + secret: Optional[str] = dataclass_field(default=None, kw_only=True) """secret""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" @@ -613,16 +690,13 @@ class MessagesCreatedInput: When a message is created """ - event: Optional[str] = None + event: str """event""" - name: Optional[str] = None + name: str """name""" - resource: Optional[str] = None + resource: str """resource""" - target_url: Optional[str] = field( - default=None, - metadata={"wire_name": "targetUrl"}, - ) + target_url: str = dataclass_field(metadata={"wire_name": "targetUrl"}) """targetUrl""" @@ -632,26 +706,27 @@ class MessagesCreatedResponse: Response for When a message is created """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - target_url: Optional[str] = field( + target_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetUrl"}, ) """targetUrl""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """resource""" - event: Optional[str] = None + event: Optional[str] = dataclass_field(default=None, kw_only=True) """event""" - filter: Optional[str] = None + filter: Optional[str] = dataclass_field(default=None, kw_only=True) """filter""" - secret: Optional[str] = None + secret: Optional[str] = dataclass_field(default=None, kw_only=True) """secret""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" @@ -661,16 +736,13 @@ class MessagesDeletedInput: When a message is deleted """ - event: Optional[str] = None + event: str """event""" - name: Optional[str] = None + name: str """name""" - resource: Optional[str] = None + resource: str """resource""" - target_url: Optional[str] = field( - default=None, - metadata={"wire_name": "targetUrl"}, - ) + target_url: str = dataclass_field(metadata={"wire_name": "targetUrl"}) """targetUrl""" @@ -680,26 +752,27 @@ class MessagesDeletedResponse: Response for When a message is deleted """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - target_url: Optional[str] = field( + target_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetUrl"}, ) """targetUrl""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """resource""" - event: Optional[str] = None + event: Optional[str] = dataclass_field(default=None, kw_only=True) """event""" - filter: Optional[str] = None + filter: Optional[str] = dataclass_field(default=None, kw_only=True) """filter""" - secret: Optional[str] = None + secret: Optional[str] = dataclass_field(default=None, kw_only=True) """secret""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" @@ -709,16 +782,13 @@ class SpaceCreatedInput: When a space is created """ - event: Optional[str] = None + event: str """event""" - name: Optional[str] = None + name: str """name""" - resource: Optional[str] = None + resource: str """resource""" - target_url: Optional[str] = field( - default=None, - metadata={"wire_name": "targetUrl"}, - ) + target_url: str = dataclass_field(metadata={"wire_name": "targetUrl"}) """targetUrl""" @@ -728,26 +798,27 @@ class SpaceCreatedResponse: Response for When a space is created """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - target_url: Optional[str] = field( + target_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetUrl"}, ) """targetUrl""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """resource""" - event: Optional[str] = None + event: Optional[str] = dataclass_field(default=None, kw_only=True) """event""" - filter: Optional[str] = None + filter: Optional[str] = dataclass_field(default=None, kw_only=True) """filter""" - secret: Optional[str] = None + secret: Optional[str] = dataclass_field(default=None, kw_only=True) """secret""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" @@ -757,16 +828,13 @@ class SpaceUpdatedInput: When a space is updated """ - event: Optional[str] = None + event: str """event""" - name: Optional[str] = None + name: str """name""" - resource: Optional[str] = None + resource: str """resource""" - target_url: Optional[str] = field( - default=None, - metadata={"wire_name": "targetUrl"}, - ) + target_url: str = dataclass_field(metadata={"wire_name": "targetUrl"}) """targetUrl""" @@ -776,26 +844,27 @@ class SpaceUpdatedResponse: Response for When a space is updated """ - created: Optional[str] = None + created: Optional[str] = dataclass_field(default=None, kw_only=True) """created""" - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """id""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """name""" - target_url: Optional[str] = field( + target_url: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "targetUrl"}, ) """targetUrl""" - resource: Optional[str] = None + resource: Optional[str] = dataclass_field(default=None, kw_only=True) """resource""" - event: Optional[str] = None + event: Optional[str] = dataclass_field(default=None, kw_only=True) """event""" - filter: Optional[str] = None + filter: Optional[str] = dataclass_field(default=None, kw_only=True) """filter""" - secret: Optional[str] = None + secret: Optional[str] = dataclass_field(default=None, kw_only=True) """secret""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" @@ -810,7 +879,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -827,8 +896,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -849,7 +918,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -864,9 +933,86 @@ def __init__( def connector_name(self) -> str: return "webex" - async def create_space_member_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def create_space_member( self, - input: CreateSpaceMemberInput, + input: CreateSpaceMemberInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -877,10 +1023,26 @@ async def create_space_member_async( Add Member to Space Add a member to an existing space + + Swagger operation ID: `CreateSpaceMember`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/memberships" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -894,6 +1056,7 @@ async def create_space_member_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -901,23 +1064,47 @@ async def create_space_member_async( return json.loads(response.text) - async def get_messages_async( + def list_messages( self, room_id: str, + *, mentioned_people: Optional[str] = None, before_message: Optional[str] = None, before: Optional[str] = None, max: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Messages Get a list of recent messages for a space + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetMessages`. + + Args: + room_id: List messages in a space for a given space ID. + mentioned_people: List messages where the caller is mentioned by + specifying \"me\" or the caller personId. + before_message: List messages sent before a message, by ID. + before: List messages sent before a date and time, in ISO8601 + format. + max: Limit the maximum number of messages in the response. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/messages" query_params = [] @@ -947,31 +1134,52 @@ async def get_messages_async( query_params.append(f"max={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() - async def send_message_async( + return AsyncItemPaged(get_next, extract_data) + + async def send_message( self, - input: SendMessageInput, + input: SendMessageInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -982,10 +1190,26 @@ async def send_message_async( Send a Message Send a message to webex + + Swagger operation ID: `SendMessage`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/messages" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -999,6 +1223,7 @@ async def send_message_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1006,7 +1231,7 @@ async def send_message_async( return json.loads(response.text) - async def get_message_details_async( + async def get_message_details( self, message_id: str, *, @@ -1019,13 +1244,28 @@ async def get_message_details_async( Get Message Details Shows details for a message, by message ID. + + Swagger operation ID: `GetMessageDetails`. + + Args: + message_id: The message ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1/messages/{quote(str(message_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1039,6 +1279,7 @@ async def get_message_details_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1046,20 +1287,40 @@ async def get_message_details_async( return json.loads(response.text) - async def get_people_async( + def list_people( self, + *, id: Optional[str] = None, email: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get People Lookup details and presence information for people in your organization + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetPeople`. + + Args: + id: List people by ID. Accepts up to 85 person IDs separated by + commas. + email: List people with this email address. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/people" query_params = [] @@ -1075,29 +1336,50 @@ async def get_people_async( query_params.append(f"email={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item + + return None, items() - async def get_my_own_details_async( + return AsyncItemPaged(get_next, extract_data) + + async def get_my_own_details( self, *, timeout: Optional[float] = None, @@ -1109,10 +1391,24 @@ async def get_my_own_details_async( Get My Own Details Lookup your own details + + Swagger operation ID: `GetMyOwnDetails`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/people/me" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1126,6 +1422,7 @@ async def get_my_own_details_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1133,21 +1430,43 @@ async def get_my_own_details_async( return json.loads(response.text) - async def get_spaces_async( + def list_spaces( self, + *, max: Optional[int] = None, type_: Optional[str] = None, sort_by: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get Spaces List This action retrieves a list of spaces + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetSpaces`. + + Args: + max: Maximum number of spaces to return. + type_: (group) only include group spaces, (direct) only include 1 + to 1 spaces, returns all if not specified. + sort_by: (id) the space id, (lastactivity) the last activity + timestamp, (created) space creation date. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/rooms" query_params = [] @@ -1168,31 +1487,52 @@ async def get_spaces_async( query_params.append(f"sortBy={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("items", []): + yield item - async def create_space_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def create_space( self, - input: CreateSpaceInput, + input: CreateSpaceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1203,10 +1543,26 @@ async def create_space_async( Create Space Create space or team space + + Swagger operation ID: `CreateSpace`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/rooms" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1220,6 +1576,7 @@ async def create_space_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1227,7 +1584,7 @@ async def create_space_async( return json.loads(response.text) - async def get_space_detail_async( + async def get_space_detail( self, room_id: str, *, @@ -1240,13 +1597,28 @@ async def get_space_detail_async( Get Space Details Return details of a given space + + Swagger operation ID: `GetSpaceDetail`. + + Args: + room_id: Select a space. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v1/rooms/{quote(str(room_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -1260,6 +1632,7 @@ async def get_space_detail_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -1267,9 +1640,9 @@ async def get_space_detail_async( return json.loads(response.text) - async def create_team_member_async( + async def create_team_member( self, - input: CreateTeamMemberInput, + input: CreateTeamMemberInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -1280,10 +1653,26 @@ async def create_team_member_async( Add Member to Team Add a member to a team + + Swagger operation ID: `CreateTeamMember`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1/team/memberships" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -1297,6 +1686,7 @@ async def create_team_member_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/wordonlinebusiness.py b/src/azure/connectors/wordonlinebusiness.py index 74c4ab05..47622104 100644 --- a/src/azure/connectors/wordonlinebusiness.py +++ b/src/azure/connectors/wordonlinebusiness.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,21 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "WordonlinebusinessClient", + "BlobMetadata", + "ContentBody", + "CreateFileItemInput", + "GetDrivesResponse", + "GetFileSchemaResponse", + "GetFiles", + "GetSourcesResponse", + "SensitivityLabelMetadata", +] + # Type Definitions @@ -29,7 +43,7 @@ class CreateFileItemInput: Populate a Microsoft Word template """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -42,7 +56,7 @@ class GetSourcesResponse: Response for Get sources """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -51,7 +65,7 @@ class GetDrivesResponse: Response for Get drives """ - value: Optional[List[Dict[str, Any]]] = None + value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -60,7 +74,7 @@ class GetFileSchemaResponse: Response for Fetches the schema of the selected file """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -79,32 +93,48 @@ class BlobMetadata: Definition: BlobMetadata """ - id: Optional[str] = field(default=None, metadata={"wire_name": "Id"}) + id: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Id"}, + ) """The unique identifier of the file or folder.""" - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) """The name of the file or folder.""" - display_name: Optional[str] = field( + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) """The display name of the file or folder.""" - path: Optional[str] = field(default=None, metadata={"wire_name": "Path"}) + path: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Path"}, + ) """The path of the file or folder.""" - media_type: Optional[str] = field( + media_type: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "MediaType"}, ) """The media type of the file or folder.""" - is_folder: Optional[bool] = field( + is_folder: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "IsFolder"}, ) """ A boolean value (true, false) to indicate whether or not the blob is a folder. """ - file_locator: Optional[str] = field( + file_locator: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "FileLocator"}, ) """The file locator of the file or folder.""" @@ -116,7 +146,7 @@ class ContentBody: Definition: ContentBody """ - content: Optional[str] = None + content: str """Content of the word document""" @@ -131,7 +161,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -148,8 +178,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -170,7 +200,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -185,9 +215,86 @@ def __init__( def connector_name(self) -> str: return "wordonlinebusiness" - async def create_file_item_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def create_file_item( self, - input: CreateFileItemInput, + input: CreateFileItemInput | Mapping[str, Any], source: str, drive: str, file: str, @@ -202,6 +309,28 @@ async def create_file_item_async( Reads a Microsoft Word template to then fill the template fields with selected dynamic values to generate a Word Document. + + Swagger operation ID: `CreateFileItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (colons are required). + drive: Select a document library from the drop-down. + file: Select a Word file through File Browse. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/templates/getFile" query_params = [] @@ -220,7 +349,7 @@ async def create_file_item_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -234,15 +363,16 @@ async def create_file_item_async( request_url, response.status, response.text, + response=response, ) return response.content - async def create_word_file_with_content_async( + async def create_word_file_with_content( self, - input: ContentBody, - file_name: Optional[str] = None, + input: ContentBody | Mapping[str, Any], *, + file_name: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -253,6 +383,23 @@ async def create_word_file_with_content_async( Creates a Microsoft Word file with the given content in the root directory (use only from Copilot Studio) + + Swagger operation ID: `CreateWordFileWithContent`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + file_name: Name of the file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -267,7 +414,7 @@ async def create_word_file_with_content_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -281,6 +428,7 @@ async def create_word_file_with_content_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -288,14 +436,14 @@ async def create_word_file_with_content_async( return json.loads(response.text) - async def get_file_pdf_async( + async def get_file_pdf( self, source: str, drive: str, file: str, + *, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -305,6 +453,30 @@ async def get_file_pdf_async( Convert Word Document to PDF Gets a PDF version of the selected file + + Swagger operation ID: `GetFilePDF`. + + Args: + source: Select from the drop-down or specify one of the following: + - \"me\" - \"SharePoint Site URL\" - \"users/someone's UPN\" - + \"groups/group Id\" - \"sites/SharePoint Site URL:/teams/team + name:\" (colons are required). + drive: Select a document library from the drop-down. + file: Select a Word file through File Browse. + extract_sensitivity_label: Select if you want to extract + Sensitivity label ( false, true). + fetch_sensitivity_label_metadata: A boolean whether to fetch + sensitivity label Metadata for associated LabelId. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/api/templates/convertFile" @@ -336,7 +508,7 @@ async def get_file_pdf_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -350,62 +522,118 @@ async def get_file_pdf_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_sources_async( + def list_sources( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get sources Get a list of sources. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetSources`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/codeless/v1.0/sources" query_params = [] query_params.append("$top=" + quote("", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() - async def get_drives_async( + return AsyncItemPaged(get_next, extract_data) + + def list_drives( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get drives Get a list of drives. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetDrives`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/codeless/v1.0/drives" query_params = [] @@ -413,29 +641,50 @@ async def get_drives_async( query_params.append("$select=" + quote("", safe='')) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def get_file_schema_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_file_schema( self, source: str, drive: str, @@ -450,6 +699,23 @@ async def get_file_schema_async( Fetches the schema of the selected file Fetches the schema of the selected file. + + Swagger operation ID: `GetFileSchema`. + + Args: + source: source. + drive: drive. + file: file. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/api/templates/schema" query_params = [] @@ -468,7 +734,7 @@ async def get_file_schema_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -482,6 +748,7 @@ async def get_file_schema_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/wordpress.py b/src/azure/connectors/wordpress.py index bd5b0fb8..31a4f078 100644 --- a/src/azure/connectors/wordpress.py +++ b/src/azure/connectors/wordpress.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,27 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "WordpressClient", + "CreatePostModel", + "Error", + "ListPostsResponse", + "PostModel", + "PostResponse", + "PostsModel", + "Site", + "SiteInsightsModel", + "SiteList", + "SiteModel", + "SiteStatsChartModel", + "SiteStatsModel", + "TopPostModel", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +49,12 @@ class ListPostsResponse: Response for When a post is created """ - posts: Optional[List[PostResponse]] = None + posts: Optional[ + List[PostResponse | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Posts""" @@ -39,29 +64,30 @@ class SiteStatsModel: Response for Get site statistics """ - visitors_today: Optional[int] = None - visitors_yesterday: Optional[int] = None - visitors: Optional[int] = None - views_today: Optional[int] = None - views_yesterday: Optional[int] = None - views_best_day: Optional[str] = None - views_best_day_total: Optional[int] = None - views: Optional[int] = None - comments: Optional[int] = None - posts: Optional[int] = None - followers_blog: Optional[int] = None - followers_comments: Optional[int] = None - comments_per_month: Optional[int] = None - comments_most_active_recent_day: Optional[str] = None - comments_most_active_time: Optional[str] = None - comments_spam: Optional[int] = None - categories: Optional[int] = None - tags: Optional[int] = None - shares: Optional[int] = None - shares_twitter: Optional[int] = None - shares_facebook: Optional[int] = None - shares_press_this: Optional[int] = field( + visitors_today: Optional[int] = dataclass_field(default=None, kw_only=True) + visitors_yesterday: Optional[int] = dataclass_field(default=None, kw_only=True) + visitors: Optional[int] = dataclass_field(default=None, kw_only=True) + views_today: Optional[int] = dataclass_field(default=None, kw_only=True) + views_yesterday: Optional[int] = dataclass_field(default=None, kw_only=True) + views_best_day: Optional[str] = dataclass_field(default=None, kw_only=True) + views_best_day_total: Optional[int] = dataclass_field(default=None, kw_only=True) + views: Optional[int] = dataclass_field(default=None, kw_only=True) + comments: Optional[int] = dataclass_field(default=None, kw_only=True) + posts: Optional[int] = dataclass_field(default=None, kw_only=True) + followers_blog: Optional[int] = dataclass_field(default=None, kw_only=True) + followers_comments: Optional[int] = dataclass_field(default=None, kw_only=True) + comments_per_month: Optional[int] = dataclass_field(default=None, kw_only=True) + comments_most_active_recent_day: Optional[str] = dataclass_field(default=None, kw_only=True) + comments_most_active_time: Optional[str] = dataclass_field(default=None, kw_only=True) + comments_spam: Optional[int] = dataclass_field(default=None, kw_only=True) + categories: Optional[int] = dataclass_field(default=None, kw_only=True) + tags: Optional[int] = dataclass_field(default=None, kw_only=True) + shares: Optional[int] = dataclass_field(default=None, kw_only=True) + shares_twitter: Optional[int] = dataclass_field(default=None, kw_only=True) + shares_facebook: Optional[int] = dataclass_field(default=None, kw_only=True) + shares_press_this: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "shares_press-this"}, ) @@ -72,42 +98,57 @@ class PostModel: Response for Get post """ - id: Optional[int] = field(default=None, metadata={"wire_name": "ID"}) - site_id: Optional[int] = field( + id: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID"}, + ) + site_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "site_ID"}, ) - date: Optional[str] = None - modified: Optional[str] = None - title: Optional[str] = None - u_r_l: Optional[str] = field(default=None, metadata={"wire_name": "URL"}) - short_u_r_l: Optional[str] = field( + date: Optional[str] = dataclass_field(default=None, kw_only=True) + modified: Optional[str] = dataclass_field(default=None, kw_only=True) + title: Optional[str] = dataclass_field(default=None, kw_only=True) + u_r_l: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "URL"}, + ) + short_u_r_l: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "short_URL"}, ) - content: Optional[str] = None - excerpt: Optional[str] = None - slug: Optional[str] = None - guid: Optional[str] = None - status: Optional[str] = None - sticky: Optional[bool] = None - password: Optional[str] = None - parent: Optional[Any] = None - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) - likes_enabled: Optional[bool] = None - sharing_enabled: Optional[bool] = None - like_count: Optional[int] = None - i_like: Optional[bool] = None - is_reblogged: Optional[bool] = None - is_following: Optional[bool] = None - global_id: Optional[str] = field( + content: Optional[str] = dataclass_field(default=None, kw_only=True) + excerpt: Optional[str] = dataclass_field(default=None, kw_only=True) + slug: Optional[str] = dataclass_field(default=None, kw_only=True) + guid: Optional[str] = dataclass_field(default=None, kw_only=True) + status: Optional[str] = dataclass_field(default=None, kw_only=True) + sticky: Optional[bool] = dataclass_field(default=None, kw_only=True) + password: Optional[str] = dataclass_field(default=None, kw_only=True) + parent: Optional[Any] = dataclass_field(default=None, kw_only=True) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) + likes_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) + sharing_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True) + like_count: Optional[int] = dataclass_field(default=None, kw_only=True) + i_like: Optional[bool] = dataclass_field(default=None, kw_only=True) + is_reblogged: Optional[bool] = dataclass_field(default=None, kw_only=True) + is_following: Optional[bool] = dataclass_field(default=None, kw_only=True) + global_id: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "global_ID"}, ) - featured_image: Optional[str] = None - post_thumbnail: Optional[Dict[str, Any]] = None - format: Optional[str] = None - geo: Optional[bool] = None + featured_image: Optional[str] = dataclass_field(default=None, kw_only=True) + post_thumbnail: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) + format: Optional[str] = dataclass_field(default=None, kw_only=True) + geo: Optional[bool] = dataclass_field(default=None, kw_only=True) @dataclass @@ -116,7 +157,12 @@ class SiteList: Response for List sites """ - sites: Optional[List[Site]] = None + sites: Optional[ + List[Site | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """List of sites""" @@ -126,33 +172,41 @@ class Site: Definition: Site """ - id: Optional[int] = field(default=None, metadata={"wire_name": "ID"}) + id: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID"}, + ) """Site ID""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Site Name""" - description: Optional[str] = None + description: Optional[str] = dataclass_field(default=None, kw_only=True) """Site Description""" - u_r_l: Optional[str] = field(default=None, metadata={"wire_name": "URL"}) + u_r_l: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "URL"}, + ) """Site URL""" - is_multisite: Optional[bool] = None + is_multisite: Optional[bool] = dataclass_field(default=None, kw_only=True) """ Whether the site is a Multisite site or not. Always true for WP.com sites. """ - post_count: Optional[int] = None + post_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of posts the site has""" - subscribers_count: Optional[int] = None + subscribers_count: Optional[int] = dataclass_field(default=None, kw_only=True) """The number of subscribers the site has""" - lang: Optional[str] = None + lang: Optional[str] = dataclass_field(default=None, kw_only=True) """Language""" - visible: Optional[bool] = None + visible: Optional[bool] = dataclass_field(default=None, kw_only=True) """Site visibility""" - is_private: Optional[bool] = None + is_private: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is site private""" - single_user_site: Optional[bool] = None + single_user_site: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is single user site""" - is_vip: Optional[bool] = None + is_vip: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is VIP""" - is_following: Optional[bool] = None + is_following: Optional[bool] = dataclass_field(default=None, kw_only=True) """Is Following""" @@ -168,10 +222,10 @@ class SiteInsightsModel: Definition: SiteInsightsModel """ - highest_hour: Optional[int] = None - highest_hour_percent: Optional[float] = None - highest_day_of_week: Optional[int] = None - highest_day_percent: Optional[float] = None + highest_hour: Optional[int] = dataclass_field(default=None, kw_only=True) + highest_hour_percent: Optional[float] = dataclass_field(default=None, kw_only=True) + highest_day_of_week: Optional[int] = dataclass_field(default=None, kw_only=True) + highest_day_percent: Optional[float] = dataclass_field(default=None, kw_only=True) TopPostModel = List[Dict[str, Any]] @@ -183,20 +237,33 @@ class PostResponse: Definition: PostResponse """ - id: Optional[int] = field(default=None, metadata={"wire_name": "ID"}) - comment_count: Optional[int] = None - site_id: Optional[int] = field( + id: Optional[int] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "ID"}, + ) + comment_count: Optional[int] = dataclass_field(default=None, kw_only=True) + site_id: Optional[int] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "site_ID"}, ) - date: Optional[str] = None - modified: Optional[str] = None - title: Optional[str] = None - u_r_l: Optional[str] = field(default=None, metadata={"wire_name": "URL"}) - slug: Optional[str] = None - guid: Optional[str] = None - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) - like_count: Optional[int] = None + date: Optional[str] = dataclass_field(default=None, kw_only=True) + modified: Optional[str] = dataclass_field(default=None, kw_only=True) + title: Optional[str] = dataclass_field(default=None, kw_only=True) + u_r_l: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "URL"}, + ) + slug: Optional[str] = dataclass_field(default=None, kw_only=True) + guid: Optional[str] = dataclass_field(default=None, kw_only=True) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) + like_count: Optional[int] = dataclass_field(default=None, kw_only=True) PostsModel = List[Dict[str, Any]] @@ -208,13 +275,13 @@ class CreatePostModel: Definition: CreatePostModel """ - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """The title of the post""" - content: Optional[str] = None + content: Optional[str] = dataclass_field(default=None, kw_only=True) """The content of the post""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """The status of the post""" - tags: Optional[str] = None + tags: Optional[str] = dataclass_field(default=None, kw_only=True) """The tags for post""" @@ -224,9 +291,9 @@ class Error: Definition: Error """ - code: Optional[int] = None - message: Optional[str] = None - fields: Optional[str] = None + code: Optional[int] = dataclass_field(default=None, kw_only=True) + message: Optional[str] = dataclass_field(default=None, kw_only=True) + fields: Optional[str] = dataclass_field(default=None, kw_only=True) # Client Class @@ -240,7 +307,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -257,8 +324,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -279,7 +346,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -294,7 +361,84 @@ def __init__( def connector_name(self) -> str: return "wordpress" - async def site_stats_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def site_stats( self, site_id: str, *, @@ -307,6 +451,21 @@ async def site_stats_async( Get site statistics Get statistics for a specified site + + Swagger operation ID: `SiteStats`. + + Args: + site_id: The site's id or domain. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -317,7 +476,7 @@ async def site_stats_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -331,6 +490,7 @@ async def site_stats_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -338,7 +498,7 @@ async def site_stats_async( return json.loads(response.text) - async def get_async( + async def get( self, site_id: str, post_id: str, @@ -352,6 +512,22 @@ async def get_async( Get post Get post + + Swagger operation ID: `GetPost`. + + Args: + site_id: The site's id or domain. + post_id: The post Id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -361,7 +537,7 @@ async def get_async( f"/{quote(str(post_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -375,6 +551,7 @@ async def get_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -382,9 +559,9 @@ async def get_async( return json.loads(response.text) - async def create_async( + async def create( self, - input: CreatePostModel, + input: CreatePostModel | Mapping[str, Any], site_id: str, *, timeout: Optional[float] = None, @@ -396,13 +573,30 @@ async def create_async( Create post Create post + + Swagger operation ID: `CreatePost`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + site_id: The site's id or domain. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/sites/{quote(str(site_id), safe='')}/posts/new" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -416,6 +610,7 @@ async def create_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -423,18 +618,35 @@ async def create_async( return json.loads(response.text) - async def list_sites_async( + def list_sites( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ List sites List sites + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `ListSites`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/me/sites" query_params = [] @@ -447,27 +659,48 @@ async def list_sites_async( ) if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("sites", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/src/azure/connectors/yammer.py b/src/azure/connectors/yammer.py index 36b48359..3bded427 100644 --- a/src/azure/connectors/yammer.py +++ b/src/azure/connectors/yammer.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,24 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "YammerClient", + "LikedBy", + "Message", + "MessageBody", + "MessageList", + "Network", + "PageableMessageList", + "PostOperationRequest", + "Topic", + "User", + "YammerEntity", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,11 +46,11 @@ class Network: Response for Get my networks """ - id: Optional[str] = None + id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique identifier of the network.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Summary of the network.""" - permalink: Optional[str] = None + permalink: Optional[str] = dataclass_field(default=None, kw_only=True) """Web link to the network page.""" @@ -43,11 +60,15 @@ class YammerEntity: Response for Get groups """ - type_: Optional[str] = field(default=None, metadata={"wire_name": "type"}) + type_: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "type"}, + ) """Details of the Viva Engage entity.""" - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique identifier of the group.""" - full_name: Optional[str] = None + full_name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the Viva Engage entity.""" @@ -57,25 +78,25 @@ class User: Response for Get user details """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Username.""" - job_title: Optional[str] = None + job_title: Optional[str] = dataclass_field(default=None, kw_only=True) """User job title.""" - location: Optional[str] = None + location: Optional[str] = dataclass_field(default=None, kw_only=True) """User location.""" - full_name: Optional[str] = None + full_name: Optional[str] = dataclass_field(default=None, kw_only=True) """User full name.""" - first_name: Optional[str] = None + first_name: Optional[str] = dataclass_field(default=None, kw_only=True) """User first name.""" - last_name: Optional[str] = None + last_name: Optional[str] = dataclass_field(default=None, kw_only=True) """User last name.""" - web_url: Optional[str] = None + web_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User profile url.""" - email: Optional[str] = None + email: Optional[str] = dataclass_field(default=None, kw_only=True) """User email.""" - birth_date: Optional[str] = None + birth_date: Optional[str] = dataclass_field(default=None, kw_only=True) """User birth date.""" - mugshot_url: Optional[str] = None + mugshot_url: Optional[str] = dataclass_field(default=None, kw_only=True) """User photo url.""" @@ -85,9 +106,15 @@ class PageableMessageList: Response for Get all messages """ - value: Optional[List[Message]] = None - next_link: Optional[str] = field( + value: Optional[ + List[Message | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nextLink"}, ) """The URL to retrieve the next page.""" @@ -99,7 +126,12 @@ class MessageList: Response for When there is a new message in my followed feed """ - messages: Optional[List[Message]] = None + messages: Optional[ + List[Message | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """messages""" @@ -109,45 +141,45 @@ class Message: Definition: Message """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """ID associated with the post.""" - content_excerpt: Optional[str] = None + content_excerpt: Optional[str] = dataclass_field(default=None, kw_only=True) """Text Content of the post.""" - sender_id: Optional[int] = None + sender_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique ID of user who posted the message.""" - replied_to_id: Optional[int] = None + replied_to_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ID of the message to which this message is a reply.""" - created_at: Optional[str] = None + created_at: Optional[str] = dataclass_field(default=None, kw_only=True) """Time at which the message was created.""" - network_id: Optional[int] = None + network_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Id of the network message is associated with.""" - message_type: Optional[str] = None + message_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the message type.""" - sender_type: Optional[str] = None + sender_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Description of the type of sender.""" - url: Optional[str] = None + url: Optional[str] = dataclass_field(default=None, kw_only=True) """API url of the post.""" - web_url: Optional[str] = None + web_url: Optional[str] = dataclass_field(default=None, kw_only=True) """Web url of the post.""" - group_id: Optional[int] = None + group_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique ID of group who posted the message.""" - body: Optional[MessageBody] = None - thread_id: Optional[int] = None + body: Optional[MessageBody | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + thread_id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique ID of thread.""" - direct_message: Optional[bool] = None + direct_message: Optional[bool] = dataclass_field(default=None, kw_only=True) """Flag to specify if the post is a a direct message.""" - client_type: Optional[str] = None + client_type: Optional[str] = dataclass_field(default=None, kw_only=True) """Type of the client.""" - client_url: Optional[str] = None + client_url: Optional[str] = dataclass_field(default=None, kw_only=True) """Web link of the client.""" - language: Optional[str] = None + language: Optional[str] = dataclass_field(default=None, kw_only=True) """Language used in the message.""" - notified_user_ids: Optional[List[int]] = None + notified_user_ids: Optional[List[int]] = dataclass_field(default=None, kw_only=True) """Details of users notified.""" - privacy: Optional[str] = None + privacy: Optional[str] = dataclass_field(default=None, kw_only=True) """Details of the privacy associated with the message.""" - liked_by: Optional[LikedBy] = None - system_message: Optional[bool] = None + liked_by: Optional[LikedBy | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + system_message: Optional[bool] = dataclass_field(default=None, kw_only=True) """Flag to specify if the post is a system generated message or not.""" @@ -157,9 +189,9 @@ class Topic: Definition: Topic """ - id: Optional[int] = None + id: Optional[int] = dataclass_field(default=None, kw_only=True) """Unique identifier of the topic.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name of the topic.""" @@ -169,20 +201,20 @@ class PostOperationRequest: Definition: PostOperationRequest """ - group_id: Optional[int] = None + group_id: int """The group to post a message to (0 = All Company/Network).""" - body: Optional[str] = None + body: str """Your message to be posted into your network.""" - replied_to_id: Optional[int] = None + replied_to_id: Optional[int] = dataclass_field(default=None, kw_only=True) """The message ID this message is in reply to.""" - direct_to_id: Optional[int] = None + direct_to_id: Optional[int] = dataclass_field(default=None, kw_only=True) """ If set, a private message will be sent directly to the user with the indicated ID. """ - broadcast: Optional[bool] = None + broadcast: Optional[bool] = dataclass_field(default=None, kw_only=True) """Post message as an announcement to all users in a group.""" - title: Optional[str] = None + title: Optional[str] = dataclass_field(default=None, kw_only=True) """Title of the message to be posted.""" @@ -192,11 +224,11 @@ class MessageBody: Definition: MessageBody """ - parsed: Optional[str] = None + parsed: Optional[str] = dataclass_field(default=None, kw_only=True) """Parsed text format.""" - plain: Optional[str] = None + plain: Optional[str] = dataclass_field(default=None, kw_only=True) """Plain text format.""" - rich: Optional[str] = None + rich: Optional[str] = dataclass_field(default=None, kw_only=True) """Rich text format.""" @@ -206,9 +238,9 @@ class LikedBy: Definition: LikedBy """ - count: Optional[int] = None + count: Optional[int] = dataclass_field(default=None, kw_only=True) """Number of distinct likes.""" - names: Optional[List[Dict[str, Any]]] = None + names: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """List of people who liked the post.""" @@ -223,7 +255,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -240,8 +272,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -262,7 +294,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -278,15 +310,49 @@ def connector_name(self) -> str: return "yammer" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -303,7 +369,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -316,57 +386,115 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def get_networks_async( + def list_networks( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get my networks Gets all the networks that the user belongs to. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetNetworks`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/networks.json" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def get_groups_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_groups( self, + *, network_id: Optional[str] = None, mine: Optional[int] = None, show_all_company_group: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get groups Gets all groups. If mine = 1, get only groups to which the user belongs + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetGroups`. + + Args: + network_id: Network ID. + mine: Used for getting groups which user is part of. + show_all_company_group: Used for showing All Company Group. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/groups.json" query_params = [] @@ -387,29 +515,50 @@ async def get_groups_async( query_params.append(f"showAllCompanyGroup={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else [] + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page: + yield item - async def get_user_details_by_id_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_user_details_by_id( self, user_id: int, *, @@ -422,13 +571,28 @@ async def get_user_details_by_id_async( Get user details This operation returns user profile details. + + Swagger operation ID: `GetUserDetailsById`. + + Args: + user_id: Unique identifier of the user. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/users/{quote(str(user_id), safe='')}.json" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -442,6 +606,7 @@ async def get_user_details_by_id_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -449,7 +614,7 @@ async def get_user_details_by_id_async( return json.loads(response.text) - async def like_message_async( + async def like_message( self, message_id: str, *, @@ -462,6 +627,21 @@ async def like_message_async( Like message This operation is used to like the specified message. + + Swagger operation ID: `LikeMessage`. + + Args: + message_id: Unique id of the message. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/messages/liked_by/current.json" @@ -474,7 +654,7 @@ async def like_message_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -488,21 +668,22 @@ async def like_message_async( request_url, response.status, response.text, + response=response, ) - async def get_all_messages_async( + def list_all_messages( self, + *, network_id: Optional[str] = None, older_than: Optional[int] = None, newer_than: Optional[int] = None, threaded: Optional[str] = None, limit: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get all messages @@ -510,8 +691,43 @@ async def get_all_messages_async( Engage network. Corresponds to \"All\" conversations in the Viva Engage web interface. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetAllMessagesV3`. + + Args: + network_id: Network ID. + older_than: Returns messages older than the message ID specified as + a numeric string. This is useful for paginating messages. For + example, if you're currently viewing 20 messages and the oldest + is number 2912, you could append \"?older_than=2912″ to your + request to get the 20 messages prior to those you're seeing. + newer_than: Returns messages newer than the message ID specified as + a numeric string. This should be used when polling for new + messages. If you're looking at messages, and the most recent + message returned is 3516, you can make a request with the + parameter \"?newer_than=3516″ to ensure that you do not get + duplicate copies of messages already on your page. + threaded: Threaded=true will only return the thread starter (first + message) for each thread. This parameter is intended for apps + which need to display message threads collapsed. + threaded=extended will return the thread starter messages and + the two most recent messages all ordered by activity, as they + are viewed in the default view on the Viva Engage web + interface. + limit: Return only the specified number of messages. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v3/messages.json" query_params = [] @@ -542,11 +758,18 @@ async def get_all_messages_async( query_params.append(f"limit={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -559,35 +782,44 @@ async def get_all_messages_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def get_messages_following_async( + return AsyncItemPaged(get_next, extract_data) + + def list_messages_following( self, + *, network_id: Optional[str] = None, older_than: Optional[int] = None, newer_than: Optional[int] = None, threaded: Optional[str] = None, limit: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get the messages from my Following feed @@ -595,8 +827,43 @@ async def get_messages_following_async( conversations involving people, groups and topics that the user is following. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetMessagesFollowingV3`. + + Args: + network_id: Unique identifier of the network. + older_than: Returns messages older than the message ID specified as + a numeric string. This is useful for paginating messages. For + example, if you're currently viewing 20 messages and the oldest + is number 2912, you could append \"?older_than=2912″ to your + request to get the 20 messages prior to those you're seeing. + newer_than: Returns messages newer than the message ID specified as + a numeric string. This should be used when polling for new + messages. If you're looking at messages, and the most recent + message returned is 3516, you can make a request with the + parameter \"?newer_than=3516″ to ensure that you do not get + duplicate copies of messages already on your page. + threaded: Threaded=true will only return the thread starter (first + message) for each thread. This parameter is intended for apps + which need to display message threads collapsed. + threaded=extended will return the thread starter messages and + the two most recent messages all ordered by activity, as they + are viewed in the default view on the Viva Engage web + interface. + limit: Return only the specified number of messages. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/v3/messages/following.json" @@ -629,11 +896,18 @@ async def get_messages_following_async( query_params.append(f"limit={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -646,43 +920,87 @@ async def get_messages_following_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_messages_in_group_async( + def list_messages_in_group( self, group_id: int, + *, network_id: Optional[str] = None, older_than: Optional[int] = None, newer_than: Optional[int] = None, threaded: Optional[str] = None, limit: Optional[int] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get messages in a group This operation returns the messages posted in a group. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetMessagesInGroupV3`. + + Args: + group_id: Unique identifier of the group. + network_id: Unique identifier of the network. + older_than: Returns messages in threads where the thread's latest + message is older than the specified message ID. Any thread with + a most recent message ID that is newer than or equal to the + specified ID will not have any of its messages returned by this + query. + newer_than: Returns messages in threads where the thread's latest + message is newer than the specified message ID. Any thread with + a most recent message ID that is older than or equal to the + specified ID will not have any of its messages returned by this + query. + threaded: Threaded=true will only return the thread starter (first + message) for each thread. This parameter is intended for apps + which need to display message threads collapsed. + threaded=extended will return the thread starter messages and + the two most recent messages all ordered by activity, as they + are viewed in the default view on the Viva Engage web + interface. + limit: Return only the specified number of messages. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -716,11 +1034,18 @@ async def get_messages_in_group_async( query_params.append(f"limit={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -733,23 +1058,32 @@ async def get_messages_in_group_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return continuation_token, items() - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return AsyncItemPaged(get_next, extract_data) - async def get_messages_in_thread_async( + def list_messages_in_thread( self, thread_id: int, *, @@ -757,24 +1091,47 @@ async def get_messages_in_thread_async( headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get messages in a thread This operation returns the messages posted in a thread. - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetMessagesInThreadV3`. + + Args: + thread_id: Unique identifier of the thread. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/v3/messages/in_thread/{quote(str(thread_id), safe='')}.json" ) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -787,27 +1144,36 @@ async def get_messages_in_thread_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + return continuation_token, items() - async def post_message_async( + return AsyncItemPaged(get_next, extract_data) + + async def post_message( self, - input: PostOperationRequest, - network_id: Optional[str] = None, + input: PostOperationRequest | Mapping[str, Any], *, + network_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -819,6 +1185,23 @@ async def post_message_async( This operation is used to post a Message to a Group or All Company Feed. If group ID is provided, message will be posted to the specified group else it will be posted in All Company Feed. + + Swagger operation ID: `PostMessageV2`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + network_id: Unique id of the network. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v2/messages.json" query_params = [] @@ -830,7 +1213,7 @@ async def post_message_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -844,6 +1227,7 @@ async def post_message_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/zendesk.py b/src/azure/connectors/zendesk.py index 23d33eaf..d9bf00c7 100644 --- a/src/azure/connectors/zendesk.py +++ b/src/azure/connectors/zendesk.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, AsyncIterator, Dict, List, Any, Mapping -from urllib.parse import quote, urlsplit +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,31 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "ZendeskClient", + "BlobDataSetsMetadata", + "DataSet", + "DataSetsList", + "DataSetsMetadata", + "GetCurrentUserInfoResponse", + "Item", + "ItemsList", + "ObjectEntity", + "SearchResult", + "Table", + "TableCapabilitiesMetadata", + "TableFilterRestrictionsMetadata", + "TableMetadata", + "TableSelectRestrictionsMetadata", + "TableSortRestrictionsMetadata", + "TablesList", + "TabularDataSetsMetadata", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +53,12 @@ class TablesList: Response for Get tables """ - value: Optional[List[Table]] = None + value: Optional[ + List[Table | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -38,9 +67,15 @@ class ItemsList: Response for Get items """ - value: Optional[List[Item]] = None - next_link: Optional[str] = field( + value: Optional[ + List[Item | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) + next_link: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "@odata.nextLink"}, ) """The URL to retrieve the next page.""" @@ -52,8 +87,9 @@ class Item: Response for Create Item """ - dynamic_properties: Optional[Dict[str, ObjectEntity]] = field( + dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "dynamicProperties"}, ) @@ -64,7 +100,7 @@ class SearchResult: Response for Search Articles """ - results: Optional[List[Dict[str, Any]]] = None + results: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) @dataclass @@ -73,19 +109,22 @@ class TableMetadata: Response for Get item metadata """ - name: Optional[str] = None - title: Optional[str] = None - x_ms_permission: Optional[str] = field( + name: Optional[str] = dataclass_field(default=None, kw_only=True) + title: Optional[str] = dataclass_field(default=None, kw_only=True) + x_ms_permission: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-permission"}, ) - x_ms_capabilities: Optional[TableCapabilitiesMetadata] = field( + x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "x-ms-capabilities"}, ) - schema: Optional[ObjectEntity] = None - referenced_entities: Optional[ObjectEntity] = field( + schema: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field(default=None, kw_only=True) + referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "referencedEntities"}, ) @@ -96,8 +135,18 @@ class DataSetsMetadata: Definition: DataSetsMetadata """ - tabular: Optional[TabularDataSetsMetadata] = None - blob: Optional[BlobDataSetsMetadata] = None + tabular: Optional[ + TabularDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) + blob: Optional[ + BlobDataSetsMetadata | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -106,21 +155,25 @@ class TabularDataSetsMetadata: Definition: TabularDataSetsMetadata """ - source: Optional[str] = None - display_name: Optional[str] = field( + source: Optional[str] = dataclass_field(default=None, kw_only=True) + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) - table_display_name: Optional[str] = field( + table_display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tableDisplayName"}, ) - table_plural_name: Optional[str] = field( + table_plural_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "tablePluralName"}, ) @@ -131,13 +184,15 @@ class BlobDataSetsMetadata: Definition: BlobDataSetsMetadata """ - source: Optional[str] = None - display_name: Optional[str] = field( + source: Optional[str] = dataclass_field(default=None, kw_only=True) + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "displayName"}, ) - url_encoding: Optional[str] = field( + url_encoding: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "urlEncoding"}, ) @@ -148,25 +203,36 @@ class TableCapabilitiesMetadata: Definition: TableCapabilitiesMetadata """ - sort_restrictions: Optional[TableSortRestrictionsMetadata] = field( + sort_restrictions: Optional[ + TableSortRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "sortRestrictions"}, ) - filter_restrictions: Optional[TableFilterRestrictionsMetadata] = field( + filter_restrictions: Optional[ + TableFilterRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterRestrictions"}, ) - select_restrictions: Optional[TableSelectRestrictionsMetadata] = field( + select_restrictions: Optional[ + TableSelectRestrictionsMetadata | Mapping[str, Any] + ] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "selectRestrictions"}, ) - is_only_server_pagable: Optional[bool] = field( + is_only_server_pagable: Optional[bool] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "isOnlyServerPagable"}, ) """Server paging restrictions""" - filter_function_support: Optional[List[str]] = field( + filter_function_support: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "filterFunctionSupport"}, ) @@ -177,7 +243,7 @@ class ObjectEntity: Definition: Object """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -190,15 +256,17 @@ class TableSortRestrictionsMetadata: Definition: TableSortRestrictionsMetadata """ - sortable: Optional[bool] = None + sortable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has sortable columns""" - unsortable_properties: Optional[List[str]] = field( + unsortable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "unsortableProperties"}, ) """List of unsortable properties""" - ascending_only_properties: Optional[List[str]] = field( + ascending_only_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "ascendingOnlyProperties"}, ) """List of properties which support ascending order only""" @@ -210,15 +278,17 @@ class TableFilterRestrictionsMetadata: Definition: TableFilterRestrictionsMetadata """ - filterable: Optional[bool] = None + filterable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has filterable columns""" - non_filterable_properties: Optional[List[str]] = field( + non_filterable_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "nonFilterableProperties"}, ) """List of non filterable properties""" - required_properties: Optional[List[str]] = field( + required_properties: Optional[List[str]] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "requiredProperties"}, ) """List of required properties""" @@ -230,7 +300,7 @@ class TableSelectRestrictionsMetadata: Definition: TableSelectRestrictionsMetadata """ - selectable: Optional[bool] = None + selectable: Optional[bool] = dataclass_field(default=None, kw_only=True) """Indicates whether this table has selectable columns""" @@ -240,7 +310,12 @@ class DataSetsList: Definition: DataSetsList """ - value: Optional[List[DataSet]] = None + value: Optional[ + List[DataSet | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) @dataclass @@ -249,9 +324,14 @@ class DataSet: Definition: DataSet """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) - display_name: Optional[str] = field( + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) @@ -262,9 +342,14 @@ class Table: Definition: Table """ - name: Optional[str] = field(default=None, metadata={"wire_name": "Name"}) - display_name: Optional[str] = field( + name: Optional[str] = dataclass_field( + default=None, + kw_only=True, + metadata={"wire_name": "Name"}, + ) + display_name: Optional[str] = dataclass_field( default=None, + kw_only=True, metadata={"wire_name": "DisplayName"}, ) @@ -275,7 +360,7 @@ class GetCurrentUserInfoResponse: Definition: GetCurrentUserInfoResponse """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -293,7 +378,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -310,8 +395,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -332,7 +417,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -348,15 +433,49 @@ def connector_name(self) -> str: return "zendesk" def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: - parsed_next_link = urlsplit(next_link) - if not parsed_next_link.scheme or not parsed_next_link.netloc: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: if next_link.startswith("/"): return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") if next_link.startswith("?"): - return f"{current_request_url.partition('?')[0]}{next_link}" - return f"{self._connection_runtime_url}/{next_link}" + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) - parsed_connection = urlsplit(self._connection_runtime_url) next_link_hostname = parsed_next_link.hostname connection_hostname = parsed_connection.hostname if next_link_hostname is None or connection_hostname is None: @@ -373,7 +492,11 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s parsed_next_link.scheme == parsed_connection.scheme and next_link_port == connection_port ): - return next_link + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() raise ValueError( "Pagination URL origin " @@ -386,63 +509,124 @@ def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> s suffix += f"?{parsed_next_link.query}" return f"{self._connection_runtime_url}{suffix}" - async def get_tables_async( + def list_tables( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get tables Retrieves Zendesk tables from a site + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTables`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/datasets/default/tables" + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url - async def get_items_async( + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + def list_items( self, table: str, + *, filter: Optional[str] = None, orderby: Optional[str] = None, skip: Optional[int] = None, top: Optional[int] = None, select: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> AsyncIterator[dict[str, Any]]: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get items Retrieves Zendesk items of a certain Zendesk type (example: 'Ticket') - Yields items from every response page and automatically follows the - connector continuation URL. + Returns an Azure Core async pager that follows the connector + continuation URL. + + Swagger operation ID: `GetItems`. + + Args: + table: Zendesk item type (example: 'Ticket'). + filter: An ODATA filter query to restrict the entries returned + (e.g. stringColumn eq 'string' OR numberColumn lt 123). + orderby: An ODATA orderBy query for specifying the order of + entries. + skip: Number of entries to skip (default = 0). + top: Maximum number of entries to retrieve (default = 512). + select: Specific fields to retrieve from entries (default = all). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -480,11 +664,18 @@ async def get_items_async( query_params.append(f"$select={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url request_body = None - while True: - response = await self.http_client.send_async( - "GET", request_url, body=request_body, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, timeout=timeout, headers=headers, client_request_id=client_request_id, @@ -497,25 +688,34 @@ async def get_items_async( request_url, response.status, response.text, + response=response, ) - if not response.text: - return - - page = json.loads(response.text) - for item in page.get("value", []): - yield item + return response, request_url + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} next_link = page.get("@odata.nextLink") - if not next_link: - return + continuation_token = ( + self._resolve_pagination_url(next_link, request_url) + if next_link + else None + ) - request_url = self._resolve_pagination_url(next_link, request_url) - request_body = None + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("value", []): + yield item - async def post_item_async( + return continuation_token, items() + + return AsyncItemPaged(get_next, extract_data) + + async def post_item( self, - input: Item, + input: Item | Mapping[str, Any], table: str, *, timeout: Optional[float] = None, @@ -527,6 +727,23 @@ async def post_item_async( Create Item Creates a Zendesk item + + Swagger operation ID: `PostItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + table: Zendesk item type (example: 'Ticket'). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -537,7 +754,7 @@ async def post_item_async( f"/items" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -551,6 +768,7 @@ async def post_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -558,7 +776,7 @@ async def post_item_async( return json.loads(response.text) - async def get_item_async( + async def get_item( self, table: str, id: str, @@ -572,6 +790,22 @@ async def get_item_async( Get item Retrieves a Zendesk item + + Swagger operation ID: `GetItem`. + + Args: + table: Zendesk item type (example: 'Ticket'). + id: Unique identifier of the item to retrieve. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -583,7 +817,7 @@ async def get_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -597,6 +831,7 @@ async def get_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -604,7 +839,7 @@ async def get_item_async( return json.loads(response.text) - async def delete_item_async( + async def delete_item( self, table: str, id: str, @@ -618,6 +853,22 @@ async def delete_item_async( Delete item Deletes a Zendesk item + + Swagger operation ID: `DeleteItem`. + + Args: + table: Zendesk item type (example: 'Ticket'). + id: Unique identifier of the item to delete. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -629,7 +880,7 @@ async def delete_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "DELETE", request_url, body=None, timeout=timeout, headers=headers, @@ -643,11 +894,12 @@ async def delete_item_async( request_url, response.status, response.text, + response=response, ) - async def patch_item_async( + async def patch_item( self, - input: Item, + input: Item | Mapping[str, Any], table: str, id: str, *, @@ -660,6 +912,24 @@ async def patch_item_async( Update item Updates an existing Zendesk item + + Swagger operation ID: `PatchItem`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + table: Zendesk item type (example: 'Ticket'). + id: Unique identifier of the item to update. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -671,7 +941,7 @@ async def patch_item_async( f"/{quote(quote(str(id), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PATCH", request_url, body=input, timeout=timeout, headers=headers, @@ -685,6 +955,7 @@ async def patch_item_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -692,26 +963,50 @@ async def patch_item_async( return json.loads(response.text) - async def search_articles_async( + def list_search_articles( self, query: str, + *, locale: Optional[str] = None, brand_id: Optional[int] = None, category: Optional[int] = None, section: Optional[int] = None, label_names: Optional[str] = None, multibrand: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Search Articles Returns a default number of 25 articles per page, up to a maximum of 1000 results. + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `SearchArticles`. + + Args: + query: Article to search for. + locale: The locale the item is displayed in. + brand_id: Search for articles in the specified brand. + category: Limit the search to this category id. + section: Limit the search to this section id. + label_names: A comma-separated list of label names. + multibrand: Enable search across all brands if true. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -754,29 +1049,50 @@ async def search_articles_async( query_params.append(f"multibrand={quote(value, safe='')}") if query_params: request_url += '?' + '&'.join(query_params) + initial_request_url = request_url + request_body = None - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) - - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, ) - if not response.text: - return None + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - return json.loads(response.text) + return response, request_url + + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} + + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("results", []): + yield item - async def get_table_async( + return None, items() + + return AsyncItemPaged(get_next, extract_data) + + async def get_table( self, table: str, *, @@ -789,6 +1105,21 @@ async def get_table_async( Get item metadata Retrieves item metadata for Zendesk object type + + Swagger operation ID: `GetTable`. + + Args: + table: Zendesk item type (example: 'Ticket'). + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -799,7 +1130,7 @@ async def get_table_async( f"/{quote(quote(str(table), safe=''), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -813,6 +1144,7 @@ async def get_table_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/zeptomail.py b/src/azure/connectors/zeptomail.py index 937d0693..0052e2f1 100644 --- a/src/azure/connectors/zeptomail.py +++ b/src/azure/connectors/zeptomail.py @@ -5,7 +5,7 @@ from __future__ import annotations -from dataclasses import dataclass, field +from dataclasses import dataclass, field as dataclass_field from typing import Optional, Dict, List, Any, Mapping from urllib.parse import quote import json @@ -20,6 +20,20 @@ ConnectorResponseHook, ) +__all__ = [ + "ZeptomailClient", + "EmailAddress", + "EmailAddressItems", + "FromAddress", + "GetMailAgentResponse", + "GetProcessedEmailsResponse", + "ProcessedMailStatsResponse", + "ReplyToAddress", + "SendMailInput", + "SendTemplateMailInput", + "SuccessMessage", +] + # Type Definitions @@ -29,9 +43,9 @@ class GetMailAgentResponse: Response for Get all Mail Agent """ - data: Optional[List[Dict[str, Any]]] = None + data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """data""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """message""" @@ -41,9 +55,9 @@ class GetProcessedEmailsResponse: Response for Get processed email details """ - data: Optional[Dict[str, Any]] = None + data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """data""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """message""" @@ -53,32 +67,46 @@ class SendMailInput: Send mail """ - mailagent_key: Optional[str] = None + mailagent_key: str """Choose Mail Agent or enter the Mail Agent key.""" - bounce_address: Optional[str] = None + bounce_address: Optional[str] = dataclass_field(default=None, kw_only=True) """The email address to which bounced emails will be sent.""" - from_: Optional[FromAddress] = field( - default=None, + from_: FromAddress | Mapping[str, Any] = dataclass_field( metadata={"wire_name": "from"}, ) - to: Optional[List[EmailAddressItems]] = None + to: List[EmailAddressItems | Mapping[str, Any]] """Recipient email address.""" - cc: Optional[List[EmailAddressItems]] = None + cc: Optional[ + List[EmailAddressItems | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Email addresses of cc'd recipients.""" - bcc: Optional[List[EmailAddressItems]] = None + bcc: Optional[ + List[EmailAddressItems | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Email addresses of bcc'd recipients.""" - mailtype: Optional[str] = None + mailtype: Optional[str] = dataclass_field(default=None, kw_only=True) """Format of the mail to be sent""" - subject: Optional[str] = None + subject: str """Subject line of your email""" - htmlbody: Optional[str] = None + htmlbody: Optional[str] = dataclass_field(default=None, kw_only=True) """This is the body content for your email.""" - reply_to: Optional[List[ReplyToAddress]] = None + reply_to: Optional[ + List[ReplyToAddress | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """ The email address to which the recipient's email responses will be addressed. """ - attachments: Optional[List[Dict[str, Any]]] = None + attachments: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """Attachments""" @@ -88,11 +116,11 @@ class SuccessMessage: Response for Send mail """ - data: Optional[List[Dict[str, Any]]] = None + data: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) """data""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """The status of the request made.""" - request_id: Optional[str] = None + request_id: Optional[str] = dataclass_field(default=None, kw_only=True) """Unique reference ID of the request.""" @@ -102,28 +130,52 @@ class SendTemplateMailInput: Send template mail """ - mailagent_key: Optional[str] = None + mailagent_key: str """Choose Mail Agent or enter the Mail Agent key.""" - bounce_address: Optional[str] = None + bounce_address: Optional[str] = dataclass_field(default=None, kw_only=True) """the email address to which bounced emails will be sent.""" - mail_template_key: Optional[str] = None + mail_template_key: str """Choose the Mail template""" - from_: Optional[FromAddress] = field( - default=None, + from_: FromAddress | Mapping[str, Any] = dataclass_field( metadata={"wire_name": "from"}, ) - to: Optional[List[EmailAddressItems]] = None + to: Optional[ + List[EmailAddressItems | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Recipient email address.""" - cc: Optional[List[EmailAddressItems]] = None + cc: Optional[ + List[EmailAddressItems | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Email addresses of cc'd recipients.""" - bcc: Optional[List[EmailAddressItems]] = None + bcc: Optional[ + List[EmailAddressItems | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Email addresses of bcc'd recipients.""" - merge_key_detail: Optional[List[Dict[str, Any]]] = None + merge_key_detail: Optional[ + List[Dict[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """ You can use merge tags to replace the placeholders with multiple values for different recipients. """ - reply_to: Optional[List[ReplyToAddress]] = None + reply_to: Optional[ + List[ReplyToAddress | Mapping[str, Any]] + ] = dataclass_field( + default=None, + kw_only=True, + ) """Reply To""" @@ -133,11 +185,11 @@ class ProcessedMailStatsResponse: Response for Processed emails analytics """ - hb: Optional[Dict[str, Any]] = None + hb: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Emails that have hard bounced""" - sb: Optional[Dict[str, Any]] = None + sb: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """sb""" - sent: Optional[Dict[str, Any]] = None + sent: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Emails that have been sent""" @@ -147,11 +199,10 @@ class FromAddress: Definition: FromAddress """ - from_detail: Optional[Dict[str, Any]] = field( - default=None, + from_detail: Dict[str, Any] = dataclass_field( metadata={"wire_name": "from-detail"}, ) - name: Optional[str] = None + name: str """Sender's user name""" @@ -161,9 +212,9 @@ class EmailAddress: Definition: EmailAddress """ - address: Optional[str] = None + address: str """Recipient's email address.""" - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Recipient's name.""" @@ -173,12 +224,12 @@ class ReplyToAddress: Definition: ReplyToAddress """ - address: Optional[str] = None + address: Optional[str] = dataclass_field(default=None, kw_only=True) """ A valid email address containing a domain that is verified in your Mail Agent. """ - name: Optional[str] = None + name: Optional[str] = dataclass_field(default=None, kw_only=True) """Name for the reply-to.""" @@ -188,7 +239,12 @@ class EmailAddressItems: Definition: EmailAddressItems """ - email_address: Optional[EmailAddress] = None + email_address: Optional[ + EmailAddress | Mapping[str, Any] + ] = dataclass_field( + default=None, + kw_only=True, + ) # Client Class @@ -202,7 +258,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -219,8 +275,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -241,7 +297,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -256,7 +312,7 @@ def __init__( def connector_name(self) -> str: return "zeptomail" - async def get_mail_agent_async( + async def get_mail_agent( self, *, timeout: Optional[float] = None, @@ -275,10 +331,24 @@ async def get_mail_agent_async( created.\\n- status: Status of the Mail Agent.\\n\\nExample 1: To retrieve details of all Mail Agents in the ZeptoMail account. Sample prompt 1: Get me details of all the Mail Agents in the account. + + Swagger operation ID: `GetMailAgent`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/portal/v1.0/mailagents" - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -292,6 +362,7 @@ async def get_mail_agent_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -299,9 +370,10 @@ async def get_mail_agent_async( return json.loads(response.text) - async def get_processed_emails_async( + async def get_processed_emails( self, mailagent_key: str, + *, subject: Optional[str] = None, from_: Optional[str] = None, to: Optional[str] = None, @@ -310,7 +382,6 @@ async def get_processed_emails_async( request_id: Optional[str] = None, is_hb: Optional[bool] = None, is_sb: Optional[bool] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -324,6 +395,31 @@ async def get_processed_emails_async( Subject, From Address, Sent time and Request ID for emails sent for the time range. The mailagent_key parameter should match the Mail Agent key of the Mail Agent as listed in our system. + + Swagger operation ID: `Get_Processed_Emails`. + + Args: + mailagent_key: Choose Mail Agent or enter the Mail Agent key. + subject: Enter subject of the email. + from_: Enter sender address of the email. + to: Enter recipient address of the email. + date_from: Enter from date for search in the format + yyyy-MM-ddTHH:mm:sszzz. + date_to: Enter to date for search in the format + yyyy-MM-ddTHH:mm:sszzz. + request_id: Enter Request ID of the email. + is_hb: Include hardbounces in results. + is_sb: Include softbounces in results. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/email" query_params = [] @@ -374,7 +470,7 @@ async def get_processed_emails_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -388,6 +484,7 @@ async def get_processed_emails_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -395,9 +492,9 @@ async def get_processed_emails_async( return json.loads(response.text) - async def send_mail_async( + async def send_mail( self, - input: SendMailInput, + input: SendMailInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -408,10 +505,26 @@ async def send_mail_async( Send mail To send an email to the desired recipient. + + Swagger operation ID: `SendMail`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/email" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -425,6 +538,7 @@ async def send_mail_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -432,9 +546,9 @@ async def send_mail_async( return json.loads(response.text) - async def send_template_mail_async( + async def send_template_mail( self, - input: SendTemplateMailInput, + input: SendTemplateMailInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, @@ -445,10 +559,26 @@ async def send_template_mail_async( Send template mail Sending a single email using Templates. + + Swagger operation ID: `SendTemplateMail`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/email/template" - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -462,6 +592,7 @@ async def send_template_mail_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -469,12 +600,12 @@ async def send_template_mail_async( return json.loads(response.text) - async def processed_mail_stats_async( + async def processed_mail_stats( self, mailagent: str, + *, from_time: Optional[str] = None, to_time: Optional[str] = None, - *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, @@ -488,6 +619,25 @@ async def processed_mail_stats_async( count of Hardbounce, Softbounce and Sent statistics over a period of time and each day . The mailagent parameter should match the Mail Agent name as listed in our system. + + Swagger operation ID: `Processed_Mail_Stats`. + + Args: + mailagent: Choose or enter Mail agent name. + from_time: Enter statics from date in the format + yyyy-MM-ddTHH:mm:sszzz. + to_time: Enter statics to date in the format + yyyy-MM-ddTHH:mm:sszzz. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/v1.0/stats/email" query_params = [] @@ -508,7 +658,7 @@ async def processed_mail_stats_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -522,6 +672,7 @@ async def processed_mail_stats_async( request_url, response.status, response.text, + response=response, ) if not response.text: diff --git a/src/azure/connectors/zohosign.py b/src/azure/connectors/zohosign.py index 9106ab3a..7beafb66 100644 --- a/src/azure/connectors/zohosign.py +++ b/src/azure/connectors/zohosign.py @@ -5,11 +5,12 @@ from __future__ import annotations -from dataclasses import dataclass, field -from typing import Optional, Dict, List, Any, Mapping -from urllib.parse import quote +from dataclasses import dataclass, field as dataclass_field +from typing import Optional, AsyncIterator, Dict, List, Any, Mapping +from urllib.parse import quote, SplitResult, urljoin, urlsplit import json +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.transport import AsyncHttpTransport @@ -18,8 +19,23 @@ ConnectorClientBase, ConnectorException, ConnectorResponseHook, + ConnectorResponseSnapshot, ) +__all__ = [ + "ZohosignClient", + "GetDocumentResponse", + "GetFormDataResponse", + "GetTemplatesResponse", + "InvokeAPIInput", + "InvokeAPIResponse", + "SendSignRequestResponse", + "UpdateDocumentInput", + "UpdateDocumentResponse", + "ZohoSignTriggersInput", + "TRIGGER_OPERATIONS", +] + # Type Definitions @@ -29,7 +45,7 @@ class InvokeAPIInput: Invoke API """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -42,7 +58,7 @@ class InvokeAPIResponse: Response for Invoke API """ - additional_properties: Dict[str, Any] = field(default_factory=dict) + additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True) """ Dynamic properties determined at runtime (similar to .NET [JsonExtensionData]) @@ -55,13 +71,13 @@ class ZohoSignTriggersInput: Zoho Sign Triggers """ - webhook_url: Optional[str] = None + webhook_url: str """Webhook url""" - webhook_actions: Optional[str] = None + webhook_actions: str """Webhook actions""" - purpose: Optional[str] = None + purpose: str """Purpose""" - appname: Optional[str] = None + appname: str """appname""" @@ -71,11 +87,11 @@ class GetFormDataResponse: Response for Get data of completed request """ - code: Optional[int] = None + code: Optional[int] = dataclass_field(default=None, kw_only=True) """code""" - document_form_data: Optional[Dict[str, Any]] = None + document_form_data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """Document form data""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" @@ -85,13 +101,13 @@ class GetDocumentResponse: Response for Get a document """ - code: Optional[int] = None + code: Optional[int] = dataclass_field(default=None, kw_only=True) """code""" - requests: Optional[Dict[str, Any]] = None + requests: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True) """requests""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """message""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" @@ -101,7 +117,7 @@ class UpdateDocumentInput: Update the properties of a created request """ - requests: Optional[Dict[str, Any]] = None + requests: Dict[str, Any] """requests""" @@ -111,11 +127,11 @@ class UpdateDocumentResponse: Response for Update the properties of a created request """ - code: Optional[int] = None + code: Optional[int] = dataclass_field(default=None, kw_only=True) """code""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """message""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" @@ -125,11 +141,11 @@ class SendSignRequestResponse: Response for SendSignRequest """ - code: Optional[int] = None + code: Optional[int] = dataclass_field(default=None, kw_only=True) """code""" - message: Optional[str] = None + message: Optional[str] = dataclass_field(default=None, kw_only=True) """message""" - status: Optional[str] = None + status: Optional[str] = dataclass_field(default=None, kw_only=True) """status""" @@ -139,7 +155,7 @@ class GetTemplatesResponse: Response for Get list of templates """ - templates: Optional[List[Dict[str, Any]]] = None + templates: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True) # Client Class @@ -153,7 +169,7 @@ def __init__( credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, - timeout_seconds: float = 30.0, + timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, @@ -170,8 +186,8 @@ def __init__( URL from Azure Portal. credential: Caller-owned Azure Core credential. max_retry_attempts: The maximum number of request attempts. - timeout_seconds: The total network timeout for each request, - including retries, response loading, and body reads. + timeout: The network timeout in seconds for each request. + The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. use_exponential_backoff: Whether retries use exponential backoff. initial_retry_delay_seconds: The initial retry delay in seconds. @@ -192,7 +208,7 @@ def __init__( super().__init__( credential, max_retry_attempts=max_retry_attempts, - timeout_seconds=timeout_seconds, + timeout=timeout, use_exponential_backoff=use_exponential_backoff, initial_retry_delay_seconds=initial_retry_delay_seconds, maximum_retry_delay_seconds=maximum_retry_delay_seconds, @@ -207,9 +223,86 @@ def __init__( def connector_name(self) -> str: return "zohosign" - async def invoke_api_async( + def _resolve_pagination_url(self, next_link: str, current_request_url: str) -> str: + def split_url(value: str) -> SplitResult: + if "\\" in value or any( + ord(character) <= 32 or ord(character) == 127 + for character in value + ): + raise ValueError("Pagination URLs contain unsafe characters.") + parsed = urlsplit(value) + if parsed.scheme or parsed.netloc or value.startswith("//"): + if not parsed.hostname: + raise ValueError("Pagination URLs must include a hostname.") + if ( + parsed.scheme not in ("http", "https") + or "@" in parsed.netloc + or "%" in parsed.netloc + ): + raise ValueError("Pagination URLs have an unsafe authority.") + authority = parsed.hostname + if ":" in authority: + authority = f"[{authority}]" + if parsed.port is not None: + authority += f":{parsed.port}" + if parsed.netloc.casefold() != authority.casefold(): + raise ValueError("Pagination URLs have an unsafe authority.") + return parsed + + parsed_connection = split_url(self._connection_runtime_url) + parsed_next_link = split_url(next_link) + if parsed_connection.hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if not parsed_next_link.scheme and not parsed_next_link.netloc: + if next_link.startswith("/"): + return f"{self._connection_runtime_url}{next_link}" + if split_url(current_request_url).hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + if next_link.startswith("?"): + return self._resolve_pagination_url( + f"{current_request_url.partition('?')[0]}{next_link}", + current_request_url, + ) + return self._resolve_pagination_url( + urljoin(current_request_url, next_link), current_request_url + ) + + next_link_hostname = parsed_next_link.hostname + connection_hostname = parsed_connection.hostname + if next_link_hostname is None or connection_hostname is None: + raise ValueError("Pagination URLs must include a hostname.") + + next_link_port = parsed_next_link.port + if next_link_port is None: + next_link_port = 443 if parsed_next_link.scheme == "https" else 80 + connection_port = parsed_connection.port + if connection_port is None: + connection_port = 443 if parsed_connection.scheme == "https" else 80 + if next_link_hostname.lower() == connection_hostname.lower(): + if ( + parsed_next_link.scheme == parsed_connection.scheme + and next_link_port == connection_port + ): + return parsed_connection._replace( + path=parsed_next_link.path, + query=parsed_next_link.query, + fragment=parsed_next_link.fragment, + ).geturl() + + raise ValueError( + "Pagination URL origin " + f"'{parsed_next_link.scheme}://{next_link_hostname}:{next_link_port}' " + "must use the connection runtime scheme and port." + ) + + suffix = parsed_next_link.path + if parsed_next_link.query: + suffix += f"?{parsed_next_link.query}" + return f"{self._connection_runtime_url}{suffix}" + + async def invoke_api( self, - input: InvokeAPIInput, + input: InvokeAPIInput | Mapping[str, Any], url: str, method: str, *, @@ -222,6 +315,24 @@ async def invoke_api_async( Invoke API Invoke API + + Swagger operation ID: `InvokeAPI`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + url: Provide url path. + method: Select API Method to be used. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}/{quote(str(url), safe='')}" @@ -234,7 +345,7 @@ async def invoke_api_async( if query_params: request_url += '?' + '&'.join(query_params) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=input, timeout=timeout, headers=headers, @@ -248,6 +359,7 @@ async def invoke_api_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -255,7 +367,7 @@ async def invoke_api_async( return json.loads(response.text) - async def download_completion_certificate_async( + async def download_completion_certificate( self, request_id: int, *, @@ -268,6 +380,21 @@ async def download_completion_certificate_async( Download Completion Certificate Downloads the completion certificate of a specific envelope + + Swagger operation ID: `download-completion-certificate`. + + Args: + request_id: Request ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -276,7 +403,7 @@ async def download_completion_certificate_async( f"/completioncertificate" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -290,11 +417,12 @@ async def download_completion_certificate_async( request_url, response.status, response.text, + response=response, ) return response.content - async def download_document_async( + async def download_document( self, request_id: int, *, @@ -307,13 +435,28 @@ async def download_document_async( Download Document Downloads a specific envelope + + Swagger operation ID: `download-document`. + + Args: + request_id: Request ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/requests/{quote(str(request_id), safe='')}/pdf" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -327,11 +470,12 @@ async def download_document_async( request_url, response.status, response.text, + response=response, ) return response.content - async def download_file_async( + async def download_file( self, request_id: int, document_id: int, @@ -345,6 +489,22 @@ async def download_file_async( Download File Downloads a specific document or file + + Swagger operation ID: `download-file`. + + Args: + request_id: Request ID. + document_id: Document ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + bytes: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" @@ -355,7 +515,7 @@ async def download_file_async( f"/pdf" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -369,11 +529,12 @@ async def download_file_async( request_url, response.status, response.text, + response=response, ) return response.content - async def get_form_data_async( + async def get_form_data( self, request_id: int, *, @@ -386,13 +547,28 @@ async def get_form_data_async( Get data of completed request Shows the details of a signed envelope + + Swagger operation ID: `get-form-data`. + + Args: + request_id: Request id. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/requests/{quote(str(request_id), safe='')}/fielddata" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -406,6 +582,7 @@ async def get_form_data_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -413,7 +590,7 @@ async def get_form_data_async( return json.loads(response.text) - async def recall_document_async( + async def recall_document( self, request_id: int, *, @@ -426,13 +603,28 @@ async def recall_document_async( Recall a particular document Recall a particular document + + Swagger operation ID: `recall-document`. + + Args: + request_id: Request ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/requests/{quote(str(request_id), safe='')}/recall" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -446,9 +638,10 @@ async def recall_document_async( request_url, response.status, response.text, + response=response, ) - async def remind_document_recipients_async( + async def remind_document_recipients( self, request_id: int, *, @@ -461,13 +654,28 @@ async def remind_document_recipients_async( Reminder for recipients Send a reminder to recipients of a particular document. + + Swagger operation ID: `remind-document-recipients`. + + Args: + request_id: Request ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/requests/{quote(str(request_id), safe='')}/remind" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -481,9 +689,10 @@ async def remind_document_recipients_async( request_url, response.status, response.text, + response=response, ) - async def delete_document_async( + async def delete_document( self, request_id: int, *, @@ -496,13 +705,28 @@ async def delete_document_async( Delete Document Delete a particular document + + Swagger operation ID: `delete-document`. + + Args: + request_id: Request ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/requests/{quote(str(request_id), safe='')}/delete" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=None, timeout=timeout, headers=headers, @@ -516,9 +740,10 @@ async def delete_document_async( request_url, response.status, response.text, + response=response, ) - async def get_document_async( + async def get_document( self, request_id: int, *, @@ -531,13 +756,28 @@ async def get_document_async( Get a document Shows the details of a specific envelope + + Swagger operation ID: `get-document`. + + Args: + request_id: Request ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/requests/{quote(str(request_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -551,6 +791,7 @@ async def get_document_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -558,9 +799,9 @@ async def get_document_async( return json.loads(response.text) - async def update_document_async( + async def update_document( self, - input: UpdateDocumentInput, + input: UpdateDocumentInput | Mapping[str, Any], request_id: str, *, timeout: Optional[float] = None, @@ -572,13 +813,30 @@ async def update_document_async( Update the properties of a created request Update the properties of a created request + + Swagger operation ID: `UpdateDocument`. + + Args: + input: The request body. Mapping keys use serialized Swagger wire + names. + request_id: Request ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/requests/{quote(str(request_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "PUT", request_url, body=input, timeout=timeout, headers=headers, @@ -592,6 +850,7 @@ async def update_document_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -599,7 +858,7 @@ async def update_document_async( return json.loads(response.text) - async def send_sign_request_async( + async def send_sign_request( self, request_id: str, *, @@ -612,13 +871,28 @@ async def send_sign_request_async( SendSignRequest Send the uploaded document out for signature + + Swagger operation ID: `SendSignRequest`. + + Args: + request_id: Request ID. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + dict[str, Any] | None: The connector operation result. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/requests/{quote(str(request_id), safe='')}/submit" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "POST", request_url, body=None, timeout=timeout, headers=headers, @@ -632,6 +906,7 @@ async def send_sign_request_async( request_url, response.status, response.text, + response=response, ) if not response.text: @@ -639,7 +914,7 @@ async def send_sign_request_async( return json.loads(response.text) - async def get_template_details_async( + async def get_template_details( self, template_id: str, *, @@ -652,13 +927,28 @@ async def get_template_details_async( Get particular template details Shows the details of a specific document template + + Swagger operation ID: `get-template-details`. + + Args: + template_id: List of Templates. + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + None: The operation completes without a response body. + + Raises: + ConnectorException: If the connector request fails. """ request_url = ( f"{self._connection_runtime_url}" f"/templates/{quote(str(template_id), safe='')}" ) - response = await self.http_client.send_async( + response = await self.http_client.send( "GET", request_url, body=None, timeout=timeout, headers=headers, @@ -672,43 +962,82 @@ async def get_template_details_async( request_url, response.status, response.text, + response=response, ) - async def get_templates_async( + def list_templates( self, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None, - ) -> dict[str, Any] | None: + ) -> AsyncItemPaged[dict[str, Any]]: """ Get list of templates Shows a list of all the document templates created + + Returns a single-page Azure Core async collection. + + Swagger operation ID: `GetTemplates`. + + Args: + timeout: The request timeout in seconds. + headers: Additional HTTP request headers. + client_request_id: A caller-provided request identifier. + response_hook: A callback invoked with the connector response. + + Returns: + AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector + results. Consume it with `async for`. + + Raises: + ConnectorException: If the connector request fails. """ request_url = f"{self._connection_runtime_url}/templates" + initial_request_url = request_url + request_body = None + + async def get_next( + continuation_token: Optional[str], + ) -> tuple[ConnectorResponseSnapshot, str]: + request_url = initial_request_url + if continuation_token is not None: + request_url = self._resolve_pagination_url(continuation_token, initial_request_url) + body = request_body if continuation_token is None else None + response = await self.http_client.send( + "GET", request_url, body=body, + timeout=timeout, + headers=headers, + client_request_id=client_request_id, + response_hook=response_hook, + ) - response = await self.http_client.send_async( - "GET", request_url, body=None, - timeout=timeout, - headers=headers, - client_request_id=client_request_id, - response_hook=response_hook, - ) + if not (200 <= response.status < 300): + raise ConnectorException( + "GET", + request_url, + response.status, + response.text, + response=response, + ) - if not (200 <= response.status < 300): - raise ConnectorException( - "GET", - request_url, - response.status, - response.text, - ) + return response, request_url - if not response.text: - return None + async def extract_data( + page_response: tuple[ConnectorResponseSnapshot, str], + ) -> tuple[Optional[str], AsyncIterator[dict[str, Any]]]: + response, request_url = page_response + page = json.loads(response.text) if response.text else {} - return json.loads(response.text) + async def items() -> AsyncIterator[dict[str, Any]]: + for item in page.get("templates", []): + yield item + + return None, items() + + return AsyncItemPaged(get_next, extract_data) # Trigger Operations diff --git a/tests/generated_connector_test_utils.py b/tests/generated_connector_test_utils.py index 0bbbf032..d2878b2d 100644 --- a/tests/generated_connector_test_utils.py +++ b/tests/generated_connector_test_utils.py @@ -5,13 +5,20 @@ from __future__ import annotations import dataclasses +import importlib import inspect +import re +from collections.abc import Mapping +from enum import Enum from types import ModuleType -from typing import Any, get_args, get_origin, get_type_hints +from typing import Any, Literal, get_args, get_origin, get_type_hints from unittest.mock import AsyncMock, patch import pytest +from azure.core.async_paging import AsyncItemPaged from azure.core.credentials import AzureKeyCredential +from azure.core.paging import ItemPaged +from azure.core.polling import AsyncLROPoller, LROPoller from azure.connectors.sdk import ConnectorException from azure.connectors.sdk.serialization import ( @@ -29,25 +36,82 @@ } +def _get_generated_type_hints(method: Any, module: ModuleType) -> dict[str, Any]: + """Resolve annotations from shared root models and the client module.""" + method_module = importlib.import_module(method.__module__) + return get_type_hints( + method, + globalns={**vars(module), **vars(method_module)}, + ) + + def get_generated_operations(client_type: type[Any]) -> set[str]: - """Return generated async operation names without their async suffix.""" + """Return public operations declared by a generated client.""" return { - name.removesuffix("_async") - for name in dir(client_type) - if name.endswith("_async") - and ( - inspect.iscoroutinefunction(getattr(client_type, name)) - or inspect.isasyncgenfunction(getattr(client_type, name)) - ) + name + for name, member in vars(client_type).items() + if not name.startswith("_") + and name != "close" + and callable(member) } +def generated_pager_response_text(method: Any) -> str: + """Build a one-item response matching a generated pager's wire shape.""" + method_source = inspect.getsource(method) + if "for item in page:" in method_source: + return '[{"ok": true}]' + + collection_match = re.search( + r'for item in page\.get\("([^"]+)", \[\]\):', + method_source, + ) + assert collection_match is not None, method.__qualname__ + return f'{{"{collection_match.group(1)}": [{{"ok": true}}]}}' + + +def resolve_sync_generated_result(result: Any) -> Any: + """Resolve a generated result, consuming a synchronous pager or poller.""" + if isinstance(result, ItemPaged): + return list(result) + if isinstance(result, LROPoller): + return result.result() + + return result + + async def resolve_generated_result(result: Any) -> Any: - """Resolve a generated coroutine or collect a generated async iterator.""" - if inspect.isasyncgen(result): + """Resolve an asynchronous generated result, consuming a pager or poller.""" + if isinstance(result, AsyncItemPaged): return [item async for item in result] + if isinstance(result, AsyncLROPoller): + return await result.result() + + awaited_result = await result + if isinstance(awaited_result, AsyncLROPoller): + return await awaited_result.result() + + return awaited_result + - return await result +def invoke_sync_generated_operation( + client: Any, + operation: str, + module: ModuleType, + include_optional_parameters: bool = False, + request_controls: dict[str, Any] | None = None, +) -> Any: + """Invoke a synchronous generated operation with representative arguments.""" + method = getattr(client, operation) + type_hints = _get_generated_type_hints(method, module) + arguments = { + parameter.name: _representative_value(type_hints[parameter.name]) + for parameter in inspect.signature(method).parameters.values() + if parameter.name not in _REQUEST_CONTROL_PARAMETER_NAMES + and (include_optional_parameters or parameter.default is inspect.Parameter.empty) + } + arguments.update(request_controls or {}) + return resolve_sync_generated_result(method(**arguments)) async def invoke_generated_operation( @@ -57,9 +121,9 @@ async def invoke_generated_operation( include_optional_parameters: bool = False, request_controls: dict[str, Any] | None = None, ) -> Any: - """Invoke a generated operation with representative arguments.""" - method = getattr(client, f"{operation}_async") - type_hints = get_type_hints(method, globalns=vars(module)) + """Invoke an asynchronous generated operation with representative arguments.""" + method = getattr(client, operation) + type_hints = _get_generated_type_hints(method, module) arguments = { parameter.name: _representative_value(type_hints[parameter.name]) for parameter in inspect.signature(method).parameters.values() @@ -70,6 +134,39 @@ async def invoke_generated_operation( return await resolve_generated_result(method(**arguments)) +def model_instance( + model_type: type[Any], + *args: Any, + **kwargs: Any, +) -> Any: + """Construct a model while filling required fields omitted by a focused test.""" + type_hints = get_type_hints(model_type) + model_fields = [ + model_field + for model_field in dataclasses.fields(model_type) + if model_field.init + ] + positional_field_names = [ + model_field.name + for model_field in model_fields + if not model_field.kw_only + ] + provided_field_names = set(positional_field_names[:len(args)]) | set(kwargs) + + for model_field in model_fields: + if ( + model_field.name not in provided_field_names + and model_field.default is dataclasses.MISSING + and model_field.default_factory is dataclasses.MISSING + ): + kwargs[model_field.name] = _representative_value( + type_hints[model_field.name], + active_model_types=frozenset({model_type}), + ) + + return model_type(*args, **kwargs) + + class GeneratedConnectorContractTests: """Shared contract tests for a generated connector client.""" @@ -98,7 +195,7 @@ def test_init_with_invalid_url_raises_error(self, connection_runtime_url: str | @pytest.mark.asyncio async def test_context_manager(self, mock_credential: Any) -> None: - """Test async context manager cleanup.""" + """Test asynchronous context manager cleanup.""" with patch.object(self.client_type, "close", new_callable=AsyncMock) as mock_close: async with self.client_type( "https://example.azure.com/connections/test", @@ -106,7 +203,7 @@ async def test_context_manager(self, mock_credential: Any) -> None: ) as client: assert isinstance(client, self.client_type) - mock_close.assert_called_once() + mock_close.assert_awaited_once() def test_all_generated_operations_are_covered(self) -> None: """Test the expected generated operation surface.""" @@ -125,7 +222,7 @@ def test_generated_models_serialize_wire_names(self) -> None: assert model_types for model_type in model_types: - instance = model_type() + instance = model_instance(model_type) expected = {} wire_names = [] @@ -156,15 +253,26 @@ async def test_generated_operation_success_contracts(self, mock_credential: Any) "https://example.azure.com/connections/test", credential=mock_credential, ) - generated_method = getattr(client, f"{operation}_async") - is_pageable = inspect.isasyncgenfunction(generated_method) + generated_method = getattr(client, operation) + return_type = _get_generated_type_hints( + generated_method, + self.connector_module, + )["return"] + is_pageable = get_origin(return_type) is AsyncItemPaged + result_type = ( + get_args(return_type)[0] + if get_origin(return_type) is AsyncLROPoller + else return_type + ) response_text = ( - '{"value": [{"ok": true}]}' if is_pageable else '{"ok": true}' + generated_pager_response_text(generated_method) + if is_pageable + else '{"ok": true}' ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text=response_text), ) as mock_send: @@ -183,17 +291,13 @@ async def test_generated_operation_success_contracts(self, mock_credential: Any) body = mock_send.call_args.kwargs["body"] assert (body is not None) is expects_body, operation if expects_body: - assert to_wire(body), operation + assert to_wire(body) is not None, operation - return_type = get_type_hints( - getattr(client, f"{operation}_async"), - globalns=vars(self.connector_module), - )["return"] - if return_type is type(None): + if result_type is type(None): assert result is None, operation elif is_pageable: assert result == [{"ok": True}], operation - elif return_type is bytes: + elif result_type is bytes: assert result == b'{"ok": true}', operation else: assert result == {"ok": True}, operation @@ -209,7 +313,7 @@ async def test_non_success_responses_raise_exception(self, mock_credential: Any) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=400, text="bad request"), ): @@ -217,7 +321,10 @@ async def test_non_success_responses_raise_exception(self, mock_credential: Any) await invoke_generated_operation(client, operation, self.connector_module) -def _representative_value(annotation: Any) -> Any: +def _representative_value( + annotation: Any, + active_model_types: frozenset[type[Any]] = frozenset(), +) -> Any: """Create a representative value for a required generated parameter.""" if annotation is str: return "value" @@ -237,34 +344,89 @@ def _representative_value(annotation: Any) -> Any: origin = get_origin(annotation) if origin is list: item_types = get_args(annotation) - return [_representative_value(item_types[0])] if item_types else ["value"] + if not item_types: + return ["value"] + + if item_types[0] in active_model_types: + return [] + + return [ + _representative_value( + item_types[0], + active_model_types=active_model_types, + ) + ] if origin is dict: return {"key": "value"} + if origin is Mapping: + return {"key": "value"} + + if origin is Literal: + return get_args(annotation)[0] + non_null_types = [ item_type for item_type in get_args(annotation) if item_type is not type(None) ] if len(non_null_types) == 1: - return _representative_value(non_null_types[0]) + return _representative_value( + non_null_types[0], + active_model_types=active_model_types, + ) + + mapping_types = [ + item_type + for item_type in non_null_types + if get_origin(item_type) is Mapping + ] + if mapping_types: + return _representative_value( + mapping_types[0], + active_model_types=active_model_types, + ) + + for item_type in non_null_types: + try: + return _representative_value( + item_type, + active_model_types=active_model_types, + ) + except AssertionError: + continue if annotation is Any: return "value" - if inspect.isclass(annotation) and dataclasses.is_dataclass(annotation): - instance = annotation() - model_fields = dataclasses.fields(instance) - if model_fields: - model_field = model_fields[0] - value = ( - {"key": "value"} - if model_field.name == ADDITIONAL_PROPERTIES_FIELD - else "value" - ) - setattr(instance, model_field.name, value) + if inspect.isclass(annotation) and issubclass(annotation, Enum): + return next(iter(annotation)) - return instance + if inspect.isclass(annotation) and dataclasses.is_dataclass(annotation): + return _representative_model( + annotation, + active_model_types=active_model_types, + ) raise AssertionError(f"Unsupported generated parameter type '{annotation}'.") + + +def _representative_model( + model_type: type[Any], + active_model_types: frozenset[type[Any]], +) -> Any: + """Construct a generated model with values for every required field.""" + type_hints = get_type_hints(model_type) + nested_model_types = active_model_types | {model_type} + arguments = { + model_field.name: _representative_value( + type_hints[model_field.name], + active_model_types=nested_model_types, + ) + for model_field in dataclasses.fields(model_type) + if model_field.init + and model_field.default is dataclasses.MISSING + and model_field.default_factory is dataclasses.MISSING + } + return model_type(**arguments) diff --git a/tests/test_api_docs.py b/tests/test_api_docs.py index beab6784..2cb65037 100644 --- a/tests/test_api_docs.py +++ b/tests/test_api_docs.py @@ -118,6 +118,36 @@ def test_validate_api_docs_reports_missing_page(documentation_tree: Path) -> Non ] +def test_validate_api_docs_reports_missing_core_page( + documentation_tree: Path, +) -> None: + """Report a missing async runtime API page at its root location.""" + ( + documentation_tree + / "api" + / "core" + / "core" + / "index.html" + ).unlink() + + assert validate_api_docs.validate_api_docs(documentation_tree) == [ + "Missing core API pages: core", + ] + + +@pytest.mark.parametrize("section", ["core-aio", "connectors-aio"]) +def test_validate_api_docs_rejects_obsolete_dual_mode_pages( + documentation_tree: Path, + section: str, +) -> None: + """Reject stale duplicate namespace pages rather than treating them as async API.""" + _write_api_page(documentation_tree, section, "obsolete") + + assert validate_api_docs.validate_api_docs(documentation_tree) == [ + f"Obsolete dual-mode API section: '{section}'. Build a clean site.", + ] + + @pytest.mark.parametrize("page_content", ["", ""]) def test_validate_api_docs_rejects_page_without_api_content( documentation_tree: Path, diff --git a/tests/test_arm.py b/tests/test_arm.py index 5dfdb933..1d052527 100644 --- a/tests/test_arm.py +++ b/tests/test_arm.py @@ -6,8 +6,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.arm import ArmClient from azure.connectors.arm import ( - ArmClient, LocationListResult, Location, Subscription, @@ -97,7 +97,7 @@ def test_init_with_custom_settings(self, mock_credential): client = ArmClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -181,11 +181,11 @@ async def test_success_with_subscriptions(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(arm_client.subscriptions_list_async()) + result = await resolve_generated_result(arm_client.list_subscriptions()) mock_send.assert_called_once_with( "GET", @@ -211,11 +211,11 @@ async def test_success_uses_generated_api_version(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(arm_client.subscriptions_list_async()) + result = await resolve_generated_result(arm_client.list_subscriptions()) mock_send.assert_called_once_with( "GET", @@ -237,11 +237,11 @@ async def test_success_with_empty_subscriptions(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(arm_client.subscriptions_list_async()) + result = await resolve_generated_result(arm_client.list_subscriptions()) mock_send.assert_called_once() assert result is not None @@ -254,11 +254,11 @@ async def test_success_with_empty_response_body(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(arm_client.subscriptions_list_async()) + result = await resolve_generated_result(arm_client.list_subscriptions()) mock_send.assert_called_once() assert result == [] @@ -295,12 +295,12 @@ async def test_success_with_pagination(self, arm_client): with patch.object( arm_client._http_client, - "send_async", + "send", new_callable=AsyncMock, side_effect=responses, ) as mock_send: result = await resolve_generated_result( - arm_client.subscriptions_list_async() + arm_client.list_subscriptions() ) assert result == [first_subscription, second_subscription] @@ -317,12 +317,12 @@ async def test_error_unauthorized(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(arm_client.subscriptions_list_async()) + await resolve_generated_result(arm_client.list_subscriptions()) assert exc_info.value.status_code == 401 @@ -336,12 +336,12 @@ async def test_error_forbidden(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(arm_client.subscriptions_list_async()) + await resolve_generated_result(arm_client.list_subscriptions()) assert exc_info.value.status_code == 403 @@ -355,12 +355,12 @@ async def test_error_not_found(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(arm_client.subscriptions_list_async()) + await resolve_generated_result(arm_client.list_subscriptions()) assert exc_info.value.status_code == 404 @@ -374,12 +374,12 @@ async def test_error_server_error(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(arm_client.subscriptions_list_async()) + await resolve_generated_result(arm_client.list_subscriptions()) assert exc_info.value.status_code == 500 @@ -794,11 +794,11 @@ async def test_success_with_resource_groups(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(arm_client.resource_groups_list_async( + result = await resolve_generated_result(arm_client.list_resource_groups( subscription_id="sub-1" )) @@ -826,12 +826,12 @@ async def test_error_not_found(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(arm_client.resource_groups_list_async( + await resolve_generated_result(arm_client.list_resource_groups( subscription_id="sub-1" )) @@ -855,11 +855,11 @@ async def test_success(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await arm_client.resource_groups_get_async( + result = await arm_client.resource_groups_get( subscription_id="sub-1", resource_group_name="rg-1" ) @@ -880,11 +880,11 @@ async def test_success_returns_none(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await arm_client.resource_groups_delete_async( + result = await arm_client.resource_groups_delete( subscription_id="sub-1", resource_group_name="rg-1" ) @@ -908,11 +908,11 @@ async def test_success_202_accepted(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await arm_client.resource_groups_delete_async( + result = await arm_client.resource_groups_delete( subscription_id="sub-1", resource_group_name="rg-1" ) @@ -920,26 +920,26 @@ async def test_success_202_accepted(self, arm_client): assert result is None @pytest.mark.asyncio - async def test_error_not_found(self, arm_client): - """Test 404 Not Found raises ConnectorException.""" + async def test_server_error_raises_exception(self, arm_client): + """Test a server error raises ConnectorException.""" mock_response = MockResponse( - status=404, - text='{"error": {"code": "NotFound", "message": "Resource group not found"}}' + status=500, + text='{"error": {"code": "ServerError", "message": "Request failed"}}' ) with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await arm_client.resource_groups_delete_async( + await arm_client.resource_groups_delete( subscription_id="sub-1", resource_group_name="rg-1" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestDeploymentsGetAsync: @@ -963,11 +963,11 @@ async def test_success(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await arm_client.deployments_get_async( + result = await arm_client.deployments_get( subscription_id="sub-1", resource_group_name="rg-1", deployment_name="deploy-1" @@ -988,11 +988,11 @@ async def test_success_returns_none(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await arm_client.deployments_delete_async( + result = await arm_client.deployments_delete( subscription_id="sub-1", resource_group_name="rg-1", deployment_name="deploy-1" @@ -1011,11 +1011,11 @@ async def test_success_returns_none(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await arm_client.deployments_cancel_async( + result = await arm_client.deployments_cancel( subscription_id="sub-1", resource_group_name="rg-1", deployment_name="deploy-1" @@ -1058,11 +1058,11 @@ async def test_success_with_providers(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(arm_client.providers_list_async( + result = await resolve_generated_result(arm_client.list_providers( subscription_id="sub-1" )) @@ -1085,11 +1085,11 @@ async def test_success(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await arm_client.providers_register_async( + result = await arm_client.providers_register( subscription_id="sub-1", resource_provider_namespace="Microsoft.Compute" ) @@ -1123,12 +1123,14 @@ async def test_success_with_locations(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await arm_client.subscriptions_list_locations_async( - subscription_id="sub-1" + result = await resolve_generated_result( + arm_client.list_subscriptions_list_locations( + subscription_id="sub-1" + ) ) mock_send.assert_called_once_with( @@ -1141,8 +1143,7 @@ async def test_success_with_locations(self, arm_client): client_request_id=None, response_hook=None, ) - assert result is not None - assert len(result["value"]) == 2 + assert result == mock_response_data["value"] class TestSubscriptionsGetAsync: @@ -1161,11 +1162,11 @@ async def test_success(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await arm_client.subscriptions_get_async( + result = await arm_client.subscriptions_get( subscription_id="sub-1" ) @@ -1193,11 +1194,11 @@ async def test_success_returns_none(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await arm_client.tags_delete_value_async( + result = await arm_client.tags_delete_value( subscription_id="sub-1", tag_name="environment", tag_value="deprecated" @@ -1216,11 +1217,11 @@ async def test_success_returns_none(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await arm_client.tags_delete_async( + result = await arm_client.tags_delete( subscription_id="sub-1", tag_name="obsolete-tag" ) @@ -1238,11 +1239,11 @@ async def test_success_returns_none(self, arm_client): with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await arm_client.resources_delete_by_id_async( + result = await arm_client.resources_delete_by_id( x_ms_api_version=RESOURCE_API_VERSION, subscription_id="sub-1", resource_group_name="rg-1", @@ -1253,21 +1254,21 @@ async def test_success_returns_none(self, arm_client): assert result is None @pytest.mark.asyncio - async def test_error_not_found(self, arm_client): - """Test 404 Not Found raises ConnectorException.""" + async def test_server_error_raises_exception(self, arm_client): + """Test a server error raises ConnectorException.""" mock_response = MockResponse( - status=404, - text='{"error": {"code": "NotFound", "message": "Resource not found"}}' + status=500, + text='{"error": {"code": "ServerError", "message": "Request failed"}}' ) with patch.object( arm_client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await arm_client.resources_delete_by_id_async( + await arm_client.resources_delete_by_id( x_ms_api_version=RESOURCE_API_VERSION, subscription_id="sub-1", resource_group_name="rg-1", @@ -1275,4 +1276,4 @@ async def test_error_not_found(self, arm_client): short_resource_id="virtualMachines/vm-1" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 diff --git a/tests/test_async_sample_pager_consumption.py b/tests/test_async_sample_pager_consumption.py new file mode 100644 index 00000000..c1490a71 --- /dev/null +++ b/tests/test_async_sample_pager_consumption.py @@ -0,0 +1,351 @@ +# ------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# ------------------------------------------------------------ + +"""Execute asynchronous sample consumers against real, multi-page AsyncItemPaged values.""" + +from __future__ import annotations + +import ast +import importlib.util +import inspect +import re +from functools import lru_cache +from pathlib import Path +from typing import Any +from unittest.mock import AsyncMock, MagicMock + +import pytest +from azure.core.async_paging import AsyncItemPaged + +ROOT = Path(__file__).resolve().parent.parent +SAMPLES = ROOT / "samples" / "sample_connector_usage" + + +def top_level_imports(tree: ast.Module) -> list[ast.ImportFrom]: + """Find imports under module-level guards without entering local scopes.""" + imports = [] + pending = list(tree.body) + while pending: + node = pending.pop() + if isinstance(node, ast.ImportFrom): + imports.append(node) + continue + if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef, ast.ClassDef)): + continue + pending.extend(ast.iter_child_nodes(node)) + return imports + + +@lru_cache(maxsize=None) +def pageable_methods(sample_path: Path) -> dict[str, set[str]]: + """Resolve imported async clients' pageable methods from generated annotations.""" + clients = {} + tree = ast.parse(sample_path.read_text(encoding="utf-8-sig")) + for node in top_level_imports(tree): + if not node.module: + continue + if not node.module.startswith("azure.connectors."): + continue + if node.module.startswith("azure.connectors.sdk"): + continue + source_path = ROOT / "src" / Path(*node.module.split(".")).with_suffix(".py") + source = ast.parse(source_path.read_text(encoding="utf-8-sig")) + for alias in node.names: + for declaration in source.body: + if not isinstance(declaration, ast.ClassDef): + continue + if declaration.name != alias.name: + continue + clients[alias.asname or alias.name] = { + method.name + for method in declaration.body + if isinstance(method, (ast.FunctionDef, ast.AsyncFunctionDef)) + and method.returns is not None + and "AsyncItemPaged" in ast.unparse(method.returns) + } + return clients + + +def sample_cases() -> list[tuple[Path, str, str, tuple[str, ...]]]: + """Discover all actual sample functions calling generated pageable operations.""" + cases = [] + for sample_path in sorted(SAMPLES.glob("sample_connector_usage_*.py")): + tree = ast.parse(sample_path.read_text(encoding="utf-8-sig")) + for client_name, operations in pageable_methods(sample_path).items(): + for function in tree.body: + if not isinstance(function, ast.AsyncFunctionDef): + continue + called_operations = { + node.func.attr + for node in ast.walk(function) + if isinstance(node, ast.Call) + and isinstance(node.func, ast.Attribute) + and node.func.attr in operations + } + if called_operations: + if sample_path.stem == "sample_connector_usage_azureblob": + for operation in sorted(called_operations): + cases.append(( + sample_path, client_name, function.name, (operation,), + )) + else: + cases.append(( + sample_path, client_name, function.name, + tuple(sorted(called_operations)), + )) + return cases + + +CASES = sample_cases() + + +def test_sharepoint_pageable_call_sites_are_discovered() -> None: + """Prove imports under SharePoint's top-level try block remain in the sweep.""" + discovered = { + (sample_path.stem, function_name, operation) + for sample_path, _, function_name, operations in CASES + for operation in operations + } + assert ( + "sample_connector_usage_sharepoint", + "example_1_get_lists", + "list_tables", + ) in discovered + assert ( + "sample_connector_usage_sharepoint", + "example_6_file_operations", + "list_root_folder", + ) in discovered + assert ( + "sample_connector_usage_sharepoint", + "example_6_file_operations", + "list_folder", + ) in discovered + + +def load_sample(sample_path: Path) -> Any: + """Load the actual worktree sample independently of other tests' module caches.""" + specification = importlib.util.spec_from_file_location( + f"async_pager_review_{sample_path.stem}", sample_path, + ) + assert specification is not None and specification.loader is not None + module = importlib.util.module_from_spec(specification) + specification.loader.exec_module(module) + return module + + +def configure_sample( + module: Any, sample_path: Path, monkeypatch: pytest.MonkeyPatch, +) -> MagicMock: + """Supply async context managers and local configuration without live I/O.""" + tree = ast.parse(sample_path.read_text(encoding="utf-8-sig")) + for node in ast.walk(tree): + if not isinstance(node, ast.Call) or not isinstance(node.func, ast.Attribute): + continue + if node.func.attr not in {"get", "getenv"} or not node.args: + continue + if ast.unparse(node.func.value) not in {"os", "os.environ"}: + continue + if isinstance(node.args[0], ast.Constant): + monkeypatch.setenv(node.args[0].value, "sample-value") + for name, value in vars(module).copy().items(): + if name.isupper() and isinstance(value, str): + monkeypatch.setattr(module, name, "sample-value") + credential = MagicMock() + credential.__aenter__.return_value = credential + monkeypatch.setattr(module, "DefaultAzureCredential", MagicMock(return_value=credential)) + client = MagicMock() + client.__aenter__.return_value = client + return client + + +def sample_item(tree: ast.Module, index: int) -> dict[str, Any]: + """Provide recognizable values for the actual sample display fields.""" + marker = f"pager-review-item-{index}" + item = { + node.args[0].value: marker + for node in ast.walk(tree) + if isinstance(node, ast.Call) + and isinstance(node.func, ast.Attribute) + and node.func.attr == "get" + and node.args + and isinstance(node.args[0], ast.Constant) + and isinstance(node.args[0].value, str) + } + item.update({ + "id": marker, "name": marker, "Name": marker, "contentData": marker, + "fields": {"summary": marker}, "EmailAddresses": [{"Address": marker}], + "lockToken": marker, "subscriptionPolicies": {"quotaId": marker}, + }) + return item + + +def create_pager(items: list[Any], visits: list[str | None]) -> AsyncItemPaged[Any]: + """Include empty initial and intermediate pages before final-page termination.""" + pages = { + None: ("first-items", []), + "first-items": ("empty-middle", items[:1]), + "empty-middle": ("last-items", []), + "last-items": (None, items[1:]), + } + + async def get_next(continuation: str | None) -> tuple[str | None, list[Any]]: + """Record every lazy page request, including requests after empty pages.""" + visits.append(continuation) + return pages[continuation] + + async def extract_data(page: tuple[str | None, list[Any]]) -> tuple[str | None, list[Any]]: + """Expose the continuation and flattened item sequence to Azure Core.""" + return page + + return AsyncItemPaged(get_next, extract_data) + + +@pytest.mark.parametrize("item_count", [0, 2]) +@pytest.mark.parametrize( + "sample_path,client_name,function_name,operations", CASES, + ids=[f"{case[0].stem}-{case[2]}-{'-'.join(case[3])}" for case in CASES], +) +@pytest.mark.asyncio +async def test_async_sample_consumes_pages_and_reports_items( + sample_path: Path, + client_name: str, + function_name: str, + operations: tuple[str, ...], + item_count: int, + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + """Exercise real sample functions, including populated results after empty pages.""" + module = load_sample(sample_path) + client = configure_sample(module, sample_path, monkeypatch) + if sample_path.stem == "sample_connector_usage_azureblob": + monkeypatch.setenv( + "TEST_FOLDER_ID", "" if operations == ("list_root_folder",) else "sample-value", + ) + tree = ast.parse(sample_path.read_text(encoding="utf-8-sig")) + generated_client = getattr(module, client_name) + all_operations = pageable_methods(sample_path)[client_name] + page_visits: list[list[str | None]] = [] + + def pager_for_operation(operation: str) -> AsyncItemPaged[Any]: + """Create a fresh real pager for each invocation, not an awaitable mock.""" + visits: list[str | None] = [] + page_visits.append(visits) + items = [ + f"pager-review-item-{index}" + if operation == "list_file_tags" else sample_item(tree, index) + for index in range(item_count) + ] + return create_pager(items, visits) + + for name, member in inspect.getmembers(generated_client, inspect.isfunction): + if name.startswith("_"): + continue + if name in all_operations: + getattr(client, name).side_effect = ( + lambda *args, operation=name, **kwargs: pager_for_operation(operation) + ) + elif inspect.iscoroutinefunction(member): + setattr(client, name, AsyncMock(return_value={})) + monkeypatch.setattr(module, client_name, MagicMock(return_value=client)) + function = getattr(module, function_name) + arguments = { + name: "sample-value" + for name, parameter in inspect.signature(function).parameters.items() + if parameter.default is inspect.Parameter.empty + } + + await function(**arguments) + + output = capsys.readouterr().out + assert "error" not in output.casefold(), output + assert "AsyncItemPaged object" not in output, output + for operation in operations: + assert getattr(client, operation).called, operation + assert page_visits, output + assert all( + visits == [None, "first-items", "empty-middle", "last-items"] + for visits in page_visits + ), page_visits + body = "\n".join( + line for line in output.splitlines() if not line.startswith("===") + ) + if item_count: + assert ( + "pager-review-item-0" in body + or re.search(r"\b2\b", body) + or body.count("[REDACTED]") == 2 + ), output + if sample_path.stem in { + "sample_connector_usage_office365", "sample_connector_usage_office365users", + }: + assert "pager-review-item-1" in body, output + else: + assert "pager-review-item-" not in body + assert re.search(r"\b0\b|\bno\b|empty|\[\]", body, re.IGNORECASE), output + if sample_path.stem == "sample_connector_usage_rss": + assert f"Retrieved {item_count} item(s)" in body + assert f"Polling query returned {item_count} item(s)." in body + + +def test_all_async_pageable_call_sites_are_explicitly_consumed() -> None: + """Sweep every sample using generated return types, not operation-name guesses.""" + paths = sorted(SAMPLES.glob("sample_connector_usage_*.py")) + assert len(paths) == 99 + pageable_sample_count = 0 + call_count = 0 + for sample_path in paths: + tree = ast.parse(sample_path.read_text(encoding="utf-8-sig")) + clients = pageable_methods(sample_path) + operations = set().union(*clients.values()) if clients else set() + parents = { + child: node for node in ast.walk(tree) for child in ast.iter_child_nodes(node) + } + calls = [ + node for node in ast.walk(tree) + if isinstance(node, ast.Call) + and isinstance(node.func, ast.Attribute) + and node.func.attr in operations + ] + pageable_sample_count += bool(calls) + call_count += len(calls) + for call in calls: + parent = parents[call] + assert ( + isinstance(parent, ast.comprehension) + and parent.is_async + and parent.iter is call + ) or ( + isinstance(parent, ast.AsyncFor) and parent.iter is call + ), (sample_path.name, call.lineno, ast.unparse(call)) + assert pageable_sample_count == 75 + assert call_count == 152 + + +@pytest.mark.parametrize("response", [None, {}, {"value": [{"id": "created"}]}]) +@pytest.mark.asyncio +async def test_excel_mutation_responses_remain_eager_envelopes( + response: dict[str, Any] | None, + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + """Keep nullable mutation responses awaited and intact, not flattened as pagers.""" + sample_path = SAMPLES / "sample_connector_usage_excelonline.py" + module = load_sample(sample_path) + client = configure_sample(module, sample_path, monkeypatch) + client.list_all_worksheets.side_effect = lambda **kwargs: create_pager([], []) + client.list_tables.side_effect = lambda **kwargs: create_pager([], []) + client.create_worksheet = AsyncMock(return_value=response) + client.add_row = AsyncMock(return_value=response) + monkeypatch.setattr(module, "ExcelonlineClient", MagicMock(return_value=client)) + + await module.main() + + output = capsys.readouterr().out + assert f"created worksheet {response}" in output + assert f"added row {response}" in output + assert "error" not in output.casefold() + client.create_worksheet.assert_awaited_once() + client.add_row.assert_awaited_once() diff --git a/tests/test_azuread.py b/tests/test_azuread.py index b7299fca..b1444e28 100644 --- a/tests/test_azuread.py +++ b/tests/test_azuread.py @@ -6,8 +6,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.azuread import AzureadClient from azure.connectors.azuread import ( - AzureadClient, CreateOffice365GroupInput, CreateSecurityGroupInput, CreateUserRequest, @@ -26,7 +26,7 @@ ConnectorException, ) from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import model_instance, resolve_generated_result class TestAzureadClientInitialization: @@ -62,7 +62,7 @@ def test_init_with_custom_settings(self, mock_credential): client = AzureadClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -141,11 +141,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_office365_group_async(input=group_input) + result = await client.create_office365_group(input=group_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -163,15 +163,18 @@ async def test_empty_response_returns_none(self, mock_credential): ) mock_response = MockResponse(status=201, text="") - group_input = CreateOffice365GroupInput(display_name="Test Group") + group_input = model_instance( + CreateOffice365GroupInput, + display_name="Test Group", + ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.create_office365_group_async(input=group_input) + result = await client.create_office365_group(input=group_input) assert result is None @pytest.mark.asyncio @@ -183,16 +186,16 @@ async def test_error_response_raises_exception(self, mock_credential): ) mock_response = MockResponse(status=400, text='{"error": "Invalid group configuration"}') - group_input = CreateOffice365GroupInput(display_name="") + group_input = model_instance(CreateOffice365GroupInput, display_name="") with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_office365_group_async(input=group_input) + await client.create_office365_group(input=group_input) assert exc_info.value.status_code == 400 @@ -222,11 +225,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_security_group_async(input=group_input) + result = await client.create_security_group(input=group_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -244,16 +247,19 @@ async def test_error_response_raises_exception(self, mock_credential): ) mock_response = MockResponse(status=403, text='{"error": "Insufficient permissions"}') - group_input = CreateSecurityGroupInput(display_name="Test Security Group") + group_input = model_instance( + CreateSecurityGroupInput, + display_name="Test Security Group", + ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_security_group_async(input=group_input) + await client.create_security_group(input=group_input) assert exc_info.value.status_code == 403 @@ -266,15 +272,18 @@ async def test_empty_response_returns_none(self, mock_credential): ) mock_response = MockResponse(status=201, text="") - group_input = CreateSecurityGroupInput(display_name="Empty Response Group") + group_input = model_instance( + CreateSecurityGroupInput, + display_name="Empty Response Group", + ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.create_security_group_async(input=group_input) + result = await client.create_security_group(input=group_input) assert result is None @@ -308,11 +317,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_user_async(input=user_input) + result = await client.create_user(input=user_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -334,6 +343,7 @@ async def test_with_all_optional_fields(self, mock_credential): account_enabled=True, display_name="Jane Smith", mail_nickname="janesmith", + password_profile={"password": "SecurePass123!"}, user_principal_name="jane.smith@contoso.com", given_name="Jane", surname="Smith", @@ -347,11 +357,11 @@ async def test_with_all_optional_fields(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.create_user_async(input=user_input) + result = await client.create_user(input=user_input) assert result["id"] == "user-full" @pytest.mark.asyncio @@ -363,19 +373,20 @@ async def test_error_response_raises_exception(self, mock_credential): ) mock_response = MockResponse(status=409, text='{"error": "User already exists"}') - user_input = CreateUserRequest( + user_input = model_instance( + CreateUserRequest, display_name="Existing User", user_principal_name="existing@contoso.com" ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_user_async(input=user_input) + await client.create_user(input=user_input) assert exc_info.value.status_code == 409 @@ -388,15 +399,18 @@ async def test_empty_response_returns_none(self, mock_credential): ) mock_response = MockResponse(status=201, text="") - user_input = CreateUserRequest(display_name="Empty Response User") + user_input = model_instance( + CreateUserRequest, + display_name="Empty Response User", + ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.create_user_async(input=user_input) + result = await client.create_user(input=user_input) assert result is None @@ -415,11 +429,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.remove_member_from_group_async( + await client.remove_member_from_group( group_id="group-abc123", member_id="user-xyz789" ) @@ -441,11 +455,11 @@ async def test_with_different_ids(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.remove_member_from_group_async( + await client.remove_member_from_group( group_id="5e6cf5c7-b511-4842-6aae-3f6b8ae5e95b", member_id="8a9bf2d1-c322-5933-7bbf-4g7c9bf6f06c" ) @@ -462,21 +476,21 @@ async def test_error_response_raises_exception(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(status=404, text='{"error": "Member not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.remove_member_from_group_async( + await client.remove_member_from_group( group_id="group-abc123", member_id="nonexistent-user" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestCreateGroup: @@ -505,11 +519,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_group_async(input=group_input) + result = await client.create_group(input=group_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -528,16 +542,16 @@ async def test_error_response_raises_exception(self, mock_credential): ) mock_response = MockResponse(status=400, text='{"error": "Invalid request"}') - group_input = CreateGroupInput(display_name="") + group_input = model_instance(CreateGroupInput, display_name="") with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_group_async(input=group_input) + await client.create_group(input=group_input) assert exc_info.value.status_code == 400 @@ -550,15 +564,18 @@ async def test_empty_response_returns_none(self, mock_credential): ) mock_response = MockResponse(status=201, text="") - group_input = CreateGroupInput(display_name="Empty Response Group") + group_input = model_instance( + CreateGroupInput, + display_name="Empty Response Group", + ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.create_group_async(input=group_input) + result = await client.create_group(input=group_input) assert result is None @@ -603,6 +620,7 @@ def test_create_user_request_creation(self): account_enabled=True, display_name="Test User", mail_nickname="testuser", + password_profile={"password": "SecurePass123!"}, user_principal_name="test@contoso.com", given_name="Test", surname="User", @@ -720,11 +738,11 @@ async def test_special_characters_in_group_id(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.remove_member_from_group_async( + await client.remove_member_from_group( group_id="5e6cf5c7-b511-4842-6aae-3f6b8ae5e95b", member_id="8a9bf2d1-c322-5933-7bbf-4g7c9bf6f06c" ) @@ -744,15 +762,15 @@ async def test_multiple_consecutive_calls(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - group_input = CreateGroupInput(display_name="Group 1") - await client.create_group_async(input=group_input) + group_input = model_instance(CreateGroupInput, display_name="Group 1") + await client.create_group(input=group_input) - group_input2 = CreateGroupInput(display_name="Group 2") - await client.create_group_async(input=group_input2) + group_input2 = model_instance(CreateGroupInput, display_name="Group 2") + await client.create_group(input=group_input2) assert mock_send.call_count == 2 @@ -775,11 +793,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_group_async(id="group-123") + result = await client.get_group(id="group-123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -800,11 +818,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_group_async(id="group-123") + result = await client.get_group(id="group-123") assert result is None @pytest.mark.asyncio @@ -819,12 +837,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_group_async(id="nonexistent-group") + await client.get_group(id="nonexistent-group") assert exc_info.value.status_code == 404 @@ -850,11 +868,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_user_async(id="user-456") + result = await client.get_user(id="user-456") mock_send.assert_called_once() call_args = mock_send.call_args @@ -875,11 +893,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_user_async(id="user-456") + result = await client.get_user(id="user-456") assert result is None @pytest.mark.asyncio @@ -894,12 +912,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_user_async(id="nonexistent-user") + await client.get_user(id="nonexistent-user") assert exc_info.value.status_code == 404 @@ -923,11 +941,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.update_user_async(input=user_input, id="user-123") + await client.update_user(input=user_input, id="user-123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -961,11 +979,11 @@ async def test_with_all_fields(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - await client.update_user_async(input=user_input, id="user-123") + await client.update_user(input=user_input, id="user-123") @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -980,12 +998,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.update_user_async(input=user_input, id="user-123") + await client.update_user(input=user_input, id="user-123") assert exc_info.value.status_code == 400 @@ -1005,11 +1023,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.refresh_tokens_async(id="user-123") + await client.refresh_tokens(id="user-123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -1028,12 +1046,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.refresh_tokens_async(id="nonexistent-user") + await client.refresh_tokens(id="nonexistent-user") assert exc_info.value.status_code == 404 @@ -1059,11 +1077,11 @@ async def test_success_with_members(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.get_group_members_async(id="group-123")) + result = await resolve_generated_result(client.list_group_members(id="group-123")) mock_send.assert_called_once() call_args = mock_send.call_args @@ -1096,12 +1114,12 @@ async def test_with_top_parameter(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, side_effect=responses, ) as mock_send: result = await resolve_generated_result( - client.get_group_members_async(id="group-123", top="10") + client.list_group_members(id="group-123", top="10") ) assert "$top=10" in mock_send.call_args_list[0].args[1] @@ -1121,11 +1139,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await resolve_generated_result(client.get_group_members_async(id="group-123")) + result = await resolve_generated_result(client.list_group_members(id="group-123")) assert result == [] @pytest.mark.asyncio @@ -1140,13 +1158,13 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: await resolve_generated_result( - client.get_group_members_async(id="nonexistent-group") + client.list_group_members(id="nonexistent-group") ) assert exc_info.value.status_code == 404 @@ -1168,11 +1186,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.add_user_to_group_async(input=user_ref, id="group-123") + await client.add_user_to_group(input=user_ref, id="group-123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -1192,12 +1210,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.add_user_to_group_async(input=user_ref, id="group-123") + await client.add_user_to_group(input=user_ref, id="group-123") assert exc_info.value.status_code == 400 @@ -1218,11 +1236,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.assign_manager_async(input=manager_ref, id="user-123") + await client.assign_manager(input=manager_ref, id="user-123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -1242,12 +1260,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.assign_manager_async(input=manager_ref, id="nonexistent-user") + await client.assign_manager(input=manager_ref, id="nonexistent-user") assert exc_info.value.status_code == 404 @@ -1271,17 +1289,19 @@ async def test_success_user_is_member(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.check_member_groups_async(input=check_input, id="user-123") + result = await resolve_generated_result( + client.check_member_groups(input=check_input, id="user-123") + ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "POST" assert "/v2/v1.0/users/user-123/checkMemberGroups" in call_args[0][1] - assert "group-123" in result["value"] + assert result == {"value": ["group-123"]} @pytest.mark.asyncio async def test_success_user_is_not_member(self, mock_credential): @@ -1296,16 +1316,18 @@ async def test_success_user_is_not_member(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.check_member_groups_async(input=check_input, id="user-123") - assert result["value"] == [] + result = await resolve_generated_result( + client.check_member_groups(input=check_input, id="user-123") + ) + assert result == {"value": []} @pytest.mark.asyncio - async def test_empty_response_returns_none(self, mock_credential): - """Test that empty response returns None.""" + async def test_empty_response_returns_empty_page(self, mock_credential): + """Test that an empty response returns an empty page.""" client = AzureadClient( "https://example.azure.com/connections/test", credential=mock_credential @@ -1316,11 +1338,13 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.check_member_groups_async(input=check_input, id="user-123") + result = await resolve_generated_result( + client.check_member_groups(input=check_input, id="user-123") + ) assert result is None @pytest.mark.asyncio @@ -1336,12 +1360,17 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.check_member_groups_async(input=check_input, id="nonexistent-user") + await resolve_generated_result( + client.check_member_groups( + input=check_input, + id="nonexistent-user", + ) + ) assert exc_info.value.status_code == 404 @@ -1365,17 +1394,19 @@ async def test_success_with_groups(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_member_groups_async(input=member_input, id="user-123") + result = await resolve_generated_result( + client.list_member_groups(input=member_input, id="user-123") + ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "POST" assert "/v2/v1.0/users/user-123/getMemberGroups" in call_args[0][1] - assert len(result["value"]) == 3 + assert result == ["group-1", "group-2", "group-3"] @pytest.mark.asyncio async def test_with_security_enabled_only(self, mock_credential): @@ -1390,32 +1421,36 @@ async def test_with_security_enabled_only(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_member_groups_async(input=member_input, id="user-123") - assert len(result["value"]) == 1 + result = await resolve_generated_result( + client.list_member_groups(input=member_input, id="user-123") + ) + assert result == ["sec-group-1"] @pytest.mark.asyncio - async def test_empty_response_returns_none(self, mock_credential): - """Test that empty response returns None.""" + async def test_empty_response_returns_empty_page(self, mock_credential): + """Test that an empty response returns an empty page.""" client = AzureadClient( "https://example.azure.com/connections/test", credential=mock_credential ) mock_response = MockResponse(status=200, text="") - member_input = GetMemberGroupsRequest() + member_input = model_instance(GetMemberGroupsRequest) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_member_groups_async(input=member_input, id="user-123") - assert result is None + result = await resolve_generated_result( + client.list_member_groups(input=member_input, id="user-123") + ) + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -1426,16 +1461,18 @@ async def test_error_response_raises_exception(self, mock_credential): ) mock_response = MockResponse(status=403, text='{"error": "Insufficient permissions"}') - member_input = GetMemberGroupsRequest() + member_input = model_instance(GetMemberGroupsRequest) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_member_groups_async(input=member_input, id="user-123") + await resolve_generated_result( + client.list_member_groups(input=member_input, id="user-123") + ) assert exc_info.value.status_code == 403 @@ -1502,7 +1539,7 @@ async def test_group_members_continuation_yields_later_members( ) as client: with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, side_effect=[ MockResponse(status=200, text=json.dumps({ @@ -1516,7 +1553,7 @@ async def test_group_members_continuation_yields_later_members( ], ) as transport: members = [ - member async for member in client.get_group_members_async( + member async for member in client.list_group_members( id="group-123" ) ] @@ -1553,12 +1590,12 @@ async def test_group_members_empty_response_yields_no_items(mock_credential): ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text=""), ): members = [ - member async for member in client.get_group_members_async( + member async for member in client.list_group_members( id="group-123" ) ] diff --git a/tests/test_azureautomation.py b/tests/test_azureautomation.py index 99a4c81e..2f67aa67 100644 --- a/tests/test_azureautomation.py +++ b/tests/test_azureautomation.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.azureautomation import AzureautomationClient from azure.connectors.azureautomation import ( - AzureautomationClient, CreateJobInput, CreateJobResponse, AutomationAccountResponse, @@ -65,7 +65,7 @@ def test_init_with_custom_settings(self, mock_credential): client = AzureautomationClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -271,11 +271,11 @@ async def test_success_returns_content(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_job_output_async( + result = await client.get_job_output( subscription_id="sub123", resource_group_name="rg-test", automation_account="myAutomation", @@ -306,12 +306,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_job_output_async( + await client.get_job_output( subscription_id="sub123", resource_group_name="rg-test", automation_account="myAutomation", @@ -328,8 +328,8 @@ async def test_method_exists(self, mock_credential): credential=mock_credential ) - assert hasattr(client, 'get_job_output_async') - assert callable(client.get_job_output_async) + assert hasattr(client, 'get_job_output') + assert callable(client.get_job_output) class TestGetStatusOfJobAsync: @@ -350,11 +350,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_status_of_job_async( + result = await client.get_status_of_job( subscription_id="sub123", resource_group_name="rg-test", automation_account="myAutomation", @@ -383,11 +383,11 @@ async def test_success_with_empty_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_status_of_job_async( + result = await client.get_status_of_job( subscription_id="sub123", resource_group_name="rg-test", automation_account="myAutomation", @@ -411,12 +411,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_status_of_job_async( + await client.get_status_of_job( subscription_id="sub123", resource_group_name="rg-test", automation_account="myAutomation", @@ -433,8 +433,8 @@ async def test_method_exists(self, mock_credential): credential=mock_credential ) - assert hasattr(client, 'get_status_of_job_async') - assert callable(client.get_status_of_job_async) + assert hasattr(client, 'get_status_of_job') + assert callable(client.get_status_of_job) class TestCreateJobAsync: @@ -458,11 +458,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_job_async( + result = await client.create_job( input=CreateJobInput(), subscription_id="sub123", resource_group_name="rg-test", @@ -496,11 +496,11 @@ async def test_success_with_wait_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_job_async( + result = await client.create_job( input=CreateJobInput(), subscription_id="sub123", resource_group_name="rg-test", @@ -526,11 +526,11 @@ async def test_success_with_empty_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.create_job_async( + result = await client.create_job( input=CreateJobInput(), subscription_id="sub123", resource_group_name="rg-test", @@ -554,12 +554,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_job_async( + await client.create_job( input=CreateJobInput(), subscription_id="sub123", resource_group_name="rg-test", @@ -576,8 +576,8 @@ async def test_method_exists(self, mock_credential): credential=mock_credential ) - assert hasattr(client, 'create_job_async') - assert callable(client.create_job_async) + assert hasattr(client, 'create_job') + assert callable(client.create_job) @pytest.mark.asyncio async def test_wait_parameter_is_optional(self, mock_credential): @@ -594,12 +594,12 @@ async def test_wait_parameter_is_optional(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: # Call without wait parameter - await client.create_job_async( + await client.create_job( input=CreateJobInput(), subscription_id="sub123", resource_group_name="rg-test", @@ -611,7 +611,7 @@ async def test_wait_parameter_is_optional(self, mock_credential): mock_send.reset_mock() # Call with wait parameter - await client.create_job_async( + await client.create_job( input=CreateJobInput(), subscription_id="sub123", resource_group_name="rg-test", diff --git a/tests/test_azureblob.py b/tests/test_azureblob.py index dc7fbd47..9ed67b7d 100644 --- a/tests/test_azureblob.py +++ b/tests/test_azureblob.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.azureblob import AzureblobClient from azure.connectors.azureblob import ( - AzureblobClient, SharedAccessSignatureBlobPolicy, ) from azure.connectors.sdk import ( @@ -49,7 +49,7 @@ def test_init_with_custom_settings(self, mock_credential): client = AzureblobClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -120,11 +120,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.copy_file_async( + result = await client.copy_file( dataset="mycontainer", source="/source/file.txt", destination="/dest/file.txt" @@ -150,11 +150,11 @@ async def test_with_overwrite_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.copy_file_async( + await client.copy_file( dataset="mycontainer", source="/source/file.txt", destination="/dest/file.txt", @@ -176,11 +176,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.copy_file_async( + result = await client.copy_file( dataset="mycontainer", source="/source/file.txt", destination="/dest/file.txt" @@ -199,12 +199,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.copy_file_async( + await client.copy_file( dataset="mycontainer", source="/source/file.txt", destination="/dest/file.txt" @@ -229,11 +229,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.create_block_blob_async( + await client.create_block_blob( input=blob_input, storage_account_name="mystorageaccount", folder_path="/uploads", @@ -267,11 +267,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_file_async( + result = await client.create_file( input=file_input, dataset="mycontainer", folder_path="/uploads", @@ -296,12 +296,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_file_async( + await client.create_file( input=b"file content", dataset="mycontainer", folder_path="/uploads", @@ -330,11 +330,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_share_link_by_path_async( + result = await client.create_share_link_by_path( input=policy_input, storage_account_name="mystorageaccount", path="/container/file.txt" @@ -358,12 +358,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_share_link_by_path_async( + await client.create_share_link_by_path( input=SharedAccessSignatureBlobPolicy(), storage_account_name="mystorageaccount", path="/container/file.txt" @@ -387,11 +387,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_file_async( + await client.delete_file( dataset="mycontainer", id="blob123" ) @@ -415,26 +415,28 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"extractedFiles": ["file1.txt", "file2.txt"]}' + text='["file1.txt", "file2.txt"]' ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.extract_folder_async( - dataset="mycontainer", - source="/archive.zip", - destination="/extracted" + result = await resolve_generated_result( + client.extract_folder( + dataset="mycontainer", + source="/archive.zip", + destination="/extracted" + ) ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "POST" assert "extractFolderV2" in call_args[0][1] - assert "extractedFiles" in result + assert result == ["file1.txt", "file2.txt"] @pytest.mark.asyncio async def test_with_overwrite_parameter(self, mock_credential): @@ -448,15 +450,17 @@ async def test_with_overwrite_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.extract_folder_async( - dataset="mycontainer", - source="/archive.zip", - destination="/extracted", - overwrite="true" + await resolve_generated_result( + client.extract_folder( + dataset="mycontainer", + source="/archive.zip", + destination="/extracted", + overwrite="true" + ) ) call_args = mock_send.call_args @@ -474,15 +478,17 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.extract_folder_async( - dataset="mycontainer", - source="/archive.zip", - destination="/extracted" + await resolve_generated_result( + client.extract_folder( + dataset="mycontainer", + source="/archive.zip", + destination="/extracted" + ) ) assert exc_info.value.status_code == 400 @@ -501,29 +507,31 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"policies": [{"id": "policy1", "permissions": "rwd"}]}' + text='[{"id": "policy1", "permissions": "rwd"}]' ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_access_policies_async( - storage_account_name="mystorageaccount", - path="/container/file.txt" + result = await resolve_generated_result( + client.list_access_policies( + storage_account_name="mystorageaccount", + path="/container/file.txt" + ) ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/policies" in call_args[0][1] - assert "policies" in result + assert result == [{"id": "policy1", "permissions": "rwd"}] @pytest.mark.asyncio - async def test_empty_response_returns_none(self, mock_credential): - """Test that empty response returns None.""" + async def test_empty_response_returns_empty_page(self, mock_credential): + """Test that an empty response returns an empty page.""" client = AzureblobClient( "https://example.azure.com/connections/test", credential=mock_credential @@ -533,15 +541,17 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_access_policies_async( - storage_account_name="mystorageaccount", - path="/container/file.txt" + result = await resolve_generated_result( + client.list_access_policies( + storage_account_name="mystorageaccount", + path="/container/file.txt" + ) ) - assert result is None + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -555,14 +565,16 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_access_policies_async( - storage_account_name="mystorageaccount", - path="/container/file.txt" + await resolve_generated_result( + client.list_access_policies( + storage_account_name="mystorageaccount", + path="/container/file.txt" + ) ) assert exc_info.value.status_code == 404 @@ -585,11 +597,11 @@ async def test_success_returns_binary_content(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_file_content_async( + result = await client.get_file_content( dataset="mycontainer", id="blob123" ) @@ -613,11 +625,11 @@ async def test_with_infer_content_type_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_file_content_async( + await client.get_file_content( dataset="mycontainer", id="blob123", infer_content_type="true" @@ -638,12 +650,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_file_content_async( + await client.get_file_content( dataset="mycontainer", id="nonexistent" ) @@ -668,11 +680,11 @@ async def test_success_returns_binary_content(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_file_content_by_path_async( + result = await client.get_file_content_by_path( dataset="mycontainer", path="/folder/file.txt" ) @@ -695,12 +707,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_file_content_by_path_async( + await client.get_file_content_by_path( dataset="mycontainer", path="/nonexistent/path.txt" ) @@ -726,11 +738,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_file_metadata_async( + result = await client.get_file_metadata( dataset="mycontainer", id="blob123" ) @@ -754,11 +766,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_file_metadata_async( + result = await client.get_file_metadata( dataset="mycontainer", id="blob123" ) @@ -776,12 +788,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_file_metadata_async( + await client.get_file_metadata( dataset="mycontainer", id="nonexistent" ) @@ -807,11 +819,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_file_metadata_by_path_async( + result = await client.get_file_metadata_by_path( dataset="mycontainer", path="/folder/file.txt" ) @@ -834,11 +846,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_file_metadata_by_path_async( + result = await client.get_file_metadata_by_path( dataset="mycontainer", path="/folder/file.txt" ) @@ -856,12 +868,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_file_metadata_by_path_async( + await client.get_file_metadata_by_path( dataset="mycontainer", path="/nonexistent/path.txt" ) @@ -887,11 +899,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.list_folder_async( + result = await resolve_generated_result(client.list_folder( dataset="mycontainer", id="folder123" )) @@ -903,8 +915,8 @@ async def test_success_with_json_response(self, mock_credential): assert len(result) == 2 @pytest.mark.asyncio - async def test_with_pagination_parameters(self, mock_credential): - """Test GET request with pagination parameters.""" + async def test_with_optional_parameters(self, mock_credential): + """Test GET request with public optional parameters.""" client = AzureblobClient( "https://example.azure.com/connections/test", credential=mock_credential @@ -914,19 +926,18 @@ async def test_with_pagination_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.list_folder_async( + await resolve_generated_result(client.list_folder( dataset="mycontainer", id="folder123", - next_page_marker="marker123", use_flat_listing="true" )) call_args = mock_send.call_args - assert "nextPageMarker=" in call_args[0][1] + assert "nextPageMarker=" not in call_args[0][1] assert "useFlatListing=true" in call_args[0][1] @pytest.mark.asyncio @@ -941,11 +952,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await resolve_generated_result(client.list_folder_async( + result = await resolve_generated_result(client.list_folder( dataset="mycontainer", id="folder123" )) @@ -963,12 +974,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.list_folder_async( + await resolve_generated_result(client.list_folder( dataset="mycontainer", id="nonexistent" )) @@ -994,12 +1005,12 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: result = await resolve_generated_result( - client.list_root_folder_async(dataset="mycontainer") + client.list_root_folder(dataset="mycontainer") ) mock_send.assert_called_once() @@ -1009,8 +1020,8 @@ async def test_success_with_json_response(self, mock_credential): assert len(result) == 2 @pytest.mark.asyncio - async def test_with_pagination_parameters(self, mock_credential): - """Test GET request with pagination parameters.""" + async def test_hides_continuation_parameter(self, mock_credential): + """Test that paging continuation is managed internally.""" client = AzureblobClient( "https://example.azure.com/connections/test", credential=mock_credential @@ -1020,17 +1031,16 @@ async def test_with_pagination_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.list_root_folder_async( - dataset="mycontainer", - next_page_marker="marker456" + await resolve_generated_result(client.list_root_folder( + dataset="mycontainer" )) call_args = mock_send.call_args - assert "nextPageMarker=marker456" in call_args[0][1] + assert "nextPageMarker=" not in call_args[0][1] @pytest.mark.asyncio async def test_empty_response_returns_none(self, mock_credential): @@ -1044,12 +1054,12 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): result = await resolve_generated_result( - client.list_root_folder_async(dataset="mycontainer") + client.list_root_folder(dataset="mycontainer") ) assert result == [] @@ -1065,12 +1075,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.list_root_folder_async(dataset="mycontainer")) + await resolve_generated_result(client.list_root_folder(dataset="mycontainer")) assert exc_info.value.status_code == 403 @@ -1090,11 +1100,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.set_blob_tier_by_path_async( + await client.set_blob_tier_by_path( storage_account_name="mystorageaccount", path="/container/file.txt", new_tier="Cool" @@ -1126,11 +1136,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.update_file_async( + result = await client.update_file( input=update_input, dataset="mycontainer", id="blob123" @@ -1154,11 +1164,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.update_file_async( + result = await client.update_file( input=b"updated content", dataset="mycontainer", id="blob123" @@ -1177,12 +1187,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.update_file_async( + await client.update_file( input=b"updated content", dataset="mycontainer", id="nonexistent" diff --git a/tests/test_azuredatafactory.py b/tests/test_azuredatafactory.py index 6cfaa253..c80adc04 100644 --- a/tests/test_azuredatafactory.py +++ b/tests/test_azuredatafactory.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.azuredatafactory import AzuredatafactoryClient from azure.connectors.azuredatafactory import ( - AzuredatafactoryClient, CreatePipelineRunResponse, PipelineRun, DataFactoryListResult, @@ -27,6 +27,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import model_instance class TestAzuredatafactoryClientInitialization: @@ -72,7 +73,7 @@ def test_init_with_custom_settings(self, mock_credential): client = AzuredatafactoryClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -151,14 +152,14 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = ParameterValueSpecification( additional_properties={"param1": "value1"} ) - result = await client.create_pipeline_run_async( + result = await client.create_pipeline_run( input=input_data, subscription_id="sub-123", resource_group_name="rg-test", @@ -189,12 +190,12 @@ async def test_success_with_reference_pipeline_run_id( with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = ParameterValueSpecification() - result = await client.create_pipeline_run_async( + result = await client.create_pipeline_run( input=input_data, subscription_id="sub-123", resource_group_name="rg-test", @@ -219,12 +220,12 @@ async def test_success_with_empty_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): input_data = ParameterValueSpecification() - result = await client.create_pipeline_run_async( + result = await client.create_pipeline_run( input=input_data, subscription_id="sub-123", resource_group_name="rg-test", @@ -249,14 +250,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): input_data = ParameterValueSpecification() with pytest.raises(ConnectorException) as exc_info: - await client.create_pipeline_run_async( + await client.create_pipeline_run( input=input_data, subscription_id="sub-123", resource_group_name="rg-test", @@ -274,8 +275,8 @@ async def test_method_exists(self, mock_credential): credential=mock_credential ) - assert hasattr(client, 'create_pipeline_run_async') - assert callable(client.create_pipeline_run_async) + assert hasattr(client, 'create_pipeline_run') + assert callable(client.create_pipeline_run) class TestCancelPipelineRunAsync: @@ -293,11 +294,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.cancel_pipeline_run_async( + await client.cancel_pipeline_run( subscription_id="sub-123", resource_group_name="rg-test", data_factory_name="adf-test", @@ -317,8 +318,8 @@ async def test_method_exists(self, mock_credential): credential=mock_credential ) - assert hasattr(client, 'cancel_pipeline_run_async') - assert callable(client.cancel_pipeline_run_async) + assert hasattr(client, 'cancel_pipeline_run') + assert callable(client.cancel_pipeline_run) class TestGetPipelineRunAsync: @@ -340,11 +341,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_pipeline_run_async( + result = await client.get_pipeline_run( subscription_id="sub-123", resource_group_name="rg-test", data_factory_name="adf-test", @@ -370,11 +371,11 @@ async def test_success_with_empty_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_pipeline_run_async( + result = await client.get_pipeline_run( subscription_id="sub-123", resource_group_name="rg-test", data_factory_name="adf-test", @@ -398,12 +399,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_pipeline_run_async( + await client.get_pipeline_run( subscription_id="sub-123", resource_group_name="rg-test", data_factory_name="adf-test", @@ -420,8 +421,8 @@ async def test_method_exists(self, mock_credential): credential=mock_credential ) - assert hasattr(client, 'get_pipeline_run_async') - assert callable(client.get_pipeline_run_async) + assert hasattr(client, 'get_pipeline_run') + assert callable(client.get_pipeline_run) class TestDataClasses: @@ -576,7 +577,7 @@ def test_resource_group(self): def test_resource_group_list_result(self): """Test ResourceGroupListResult dataclass creation.""" - rg = ResourceGroup(name="rg1") + rg = model_instance(ResourceGroup, name="rg1") result = ResourceGroupListResult( value=[rg], next_link=None diff --git a/tests/test_azuredigitaltwins.py b/tests/test_azuredigitaltwins.py index e2a37334..fcfb47f6 100644 --- a/tests/test_azuredigitaltwins.py +++ b/tests/test_azuredigitaltwins.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.azuredigitaltwins import AzuredigitaltwinsClient from azure.connectors.azuredigitaltwins import ( - AzuredigitaltwinsClient, AddTwinInput, AddRelationshipInput, ListModelsResponse, @@ -115,7 +115,7 @@ def test_init_with_custom_settings(self, mock_credential): client = AzuredigitaltwinsClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -187,12 +187,14 @@ async def test_uses_current_signature_and_internal_api_version( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text="{}"), ) as mock_send: - method = getattr(client, f"{operation}_async") - await method(input=input_value, **operation_args) + method = getattr(client, f"{operation}") + await resolve_generated_result( + method(input=input_value, **operation_args) + ) mock_send.assert_called_once_with( http_method, @@ -226,13 +228,15 @@ async def test_error_response_raises_exception( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=400, text="Invalid update"), ): - method = getattr(client, f"{operation}_async") + method = getattr(client, f"{operation}") with pytest.raises(ConnectorException) as exc_info: - await method(input=input_value, **operation_args) + await resolve_generated_result( + method(input=input_value, **operation_args) + ) assert exc_info.value.status_code == 400 @@ -269,11 +273,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.list_models_async()) + result = await resolve_generated_result(client.list_models()) mock_send.assert_called_once() call_args = mock_send.call_args @@ -293,11 +297,11 @@ async def test_with_optional_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.list_models_async( + await resolve_generated_result(client.list_models( dependencies_for="dtmi:example:Room;1", include_model_definition="true" )) @@ -318,12 +322,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.list_models_async()) + await resolve_generated_result(client.list_models()) assert exc_info.value.status_code == 401 @@ -346,11 +350,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_model_by_id_async( + result = await client.get_model_by_id( modelid="dtmi:example:Room;1" ) @@ -369,12 +373,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_model_by_id_async( + await client.get_model_by_id( modelid="nonexistent" ) @@ -396,11 +400,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_model_async( + await client.delete_model( modelid="dtmi:example:Room;1" ) @@ -427,11 +431,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_twin_by_id_async( + result = await client.get_twin_by_id( twinid="room1" ) @@ -450,12 +454,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_twin_by_id_async( + await client.get_twin_by_id( twinid="nonexistent" ) @@ -480,12 +484,12 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = AddTwinInput(value='{"$dtId": "room1"}') - result = await client.add_twin_async( + result = await client.add_twin( input=input_data, twinid="room1" ) @@ -511,11 +515,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_twin_async( + await client.delete_twin( twinid="room1" ) @@ -542,11 +546,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_component_async( + result = await client.get_component( twinid="room1", component_path="thermostat" ) @@ -575,11 +579,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_relationship_by_id_async( + result = await client.get_relationship_by_id( twinid="room1", relationship_id="rel1" ) @@ -606,12 +610,12 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = AddRelationshipInput(value='{"$targetId": "floor1"}') - result = await client.add_relationship_async( + result = await client.add_relationship( input=input_data, twinid="room1", relationship_id="rel1" @@ -638,11 +642,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_relationship_async( + await client.delete_relationship( twinid="room1", relationship_id="rel1" ) @@ -670,11 +674,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.list_relationships_async( + result = await resolve_generated_result(client.list_relationships( twinid="room1" )) @@ -700,11 +704,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.list_incoming_relationships_async( + result = await resolve_generated_result(client.list_incoming_relationships( twinid="room1" )) @@ -731,14 +735,14 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: query_input = QueryTwinsInput( query="SELECT * FROM digitaltwins WHERE $dtId = 'room1'" ) - result = await client.query_twins_async( + result = await client.query_twins( input=query_input ) @@ -760,14 +764,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): query_input = QueryTwinsInput(query="INVALID") with pytest.raises(ConnectorException) as exc_info: - await client.query_twins_async( + await client.query_twins( input=query_input ) @@ -789,12 +793,12 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: telemetry = SendTelemetryInput(value='{"temperature": 72}') - await client.send_telemetry_async( + await client.send_telemetry( input=telemetry, twinid="room1" ) @@ -818,12 +822,12 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: telemetry = SendComponentTelemetryInput(value='{"temperature": 72}') - await client.send_component_telemetry_async( + await client.send_component_telemetry( input=telemetry, twinid="room1", component_path="thermostat" diff --git a/tests/test_azureeventgrid.py b/tests/test_azureeventgrid.py index 241bc8b9..de49cc07 100644 --- a/tests/test_azureeventgrid.py +++ b/tests/test_azureeventgrid.py @@ -6,8 +6,8 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.azureeventgrid import AzureeventgridClient from azure.connectors.azureeventgrid import ( - AzureeventgridClient, EventRequest, EventSchema, EventTypesResponse, @@ -21,21 +21,17 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import model_instance, resolve_generated_result async def _invoke_operation(client: AzureeventgridClient, operation: str): """Invoke an Event Grid operation by name for shared error-handling tests.""" - if operation == "subscriptions_list": - return await client.subscriptions_list_async() - if operation == "topic_types_list": - return await client.topic_types_list_async() - - raise ValueError(f"Unsupported operation '{operation}'.") + return await resolve_generated_result(getattr(client, operation)()) ALL_OPERATIONS = [ - "subscriptions_list", - "topic_types_list", + "list_subscriptions", + "list_topic_types", ] @@ -72,7 +68,7 @@ def test_init_with_custom_settings(self, mock_credential): client = AzureeventgridClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -139,13 +135,13 @@ async def test_subscriptions_list_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.subscriptions_list_async() + result = await resolve_generated_result(client.list_subscriptions()) - assert result["value"][0]["subscriptionId"] == "sub-1" + assert result == [{"subscriptionId": "sub-1"}] assert mock_send.call_args[0][0] == "GET" assert "/subscriptions" in mock_send.call_args[0][1] assert "x-ms-api-version=2015-11-01" in mock_send.call_args[0][1] @@ -161,20 +157,20 @@ async def test_topic_types_list_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.topic_types_list_async() + result = await resolve_generated_result(client.list_topic_types()) - assert "value" in result + assert result == [] request_url = mock_send.call_args[0][1] assert "/providers/Microsoft.EventGrid/topicTypes" in request_url assert "x-ms-api-version=2017-09-15-preview" in request_url @pytest.mark.asyncio - async def test_topic_types_list_empty_body_returns_none(self, mock_credential): - """Test topic_types_list_async returns None when the body is empty.""" + async def test_topic_types_list_empty_body_returns_empty_page(self, mock_credential): + """Test topic_types_list_async returns an empty page for an empty body.""" client = AzureeventgridClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -183,13 +179,13 @@ async def test_topic_types_list_empty_body_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.topic_types_list_async() + result = await resolve_generated_result(client.list_topic_types()) - assert result is None + assert result == [] class TestAzureeventgridClientErrorHandling: @@ -211,7 +207,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -230,7 +226,7 @@ def test_dataclass_instances_initialize_expected_defaults(self): topic_types = TopicTypesResponse() event_types = EventTypesResponse() resource_names = ResourceNameResponse() - event_request = EventRequest() + event_request = model_instance(EventRequest) event_schema: EventSchema = [] subscription = Subscription() @@ -238,7 +234,7 @@ def test_dataclass_instances_initialize_expected_defaults(self): assert topic_types.value is None assert event_types.value is None assert resource_names.value is None - assert event_request.properties is None + assert event_request.properties == {"key": "value"} assert event_schema == [] assert subscription.subscription_id is None diff --git a/tests/test_azureiotcentral.py b/tests/test_azureiotcentral.py index e98fdafc..cfc6de5a 100644 --- a/tests/test_azureiotcentral.py +++ b/tests/test_azureiotcentral.py @@ -6,8 +6,8 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.azureiotcentral import AzureiotcentralClient from azure.connectors.azureiotcentral import ( - AzureiotcentralClient, Device, DeviceCloudProperties, DeviceCommand, @@ -24,7 +24,7 @@ ConnectorException, ) from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import model_instance, resolve_generated_result BASE_URL = "https://example.azure.com/connections/test" @@ -34,11 +34,11 @@ # keyword arguments required to invoke it. The "input" body argument is passed # as an empty dict since send_async is mocked in every test. OPERATION_ARGS = { - "device_groups_list": {"application": "app-1"}, + "list_device_groups": {"application": "app-1"}, "device_groups_get": {"device_group_id": "dg-1", "application": "app-1"}, "device_groups_set": {"input": {}, "device_group_id": "dg-1", "application": "app-1"}, "device_groups_remove": {"device_group_id": "dg-1", "application": "app-1"}, - "device_groups_get_devices": {"device_group_id": "dg-1", "application": "app-1"}, + "list_device_groups_get_devices": {"device_group_id": "dg-1", "application": "app-1"}, "devices_get_cloud_properties": {"device_id": "d-1", "application": "app-1"}, "devices_update_cloud_properties": {"input": {}, "device_id": "d-1", "application": "app-1"}, "devices_execute_component_command": { @@ -48,7 +48,7 @@ "command_name": "cmd-1", "application": "app-1", }, - "device_relationships_list": {"device_id": "d-1", "application": "app-1"}, + "list_device_relationships": {"device_id": "d-1", "application": "app-1"}, "device_relationships_get": { "device_id": "d-1", "relationship_id": "r-1", @@ -71,14 +71,14 @@ "relationship_id": "r-1", "application": "app-1", }, - "jobs_list": {"application": "app-1"}, + "list_jobs": {"application": "app-1"}, "jobs_get": {"job_id": "j-1", "application": "app-1"}, "jobs_set": {"input": {}, "job_id": "j-1", "application": "app-1"}, - "jobs_get_devices": {"job_id": "j-1", "application": "app-1"}, + "list_jobs_get_devices": {"job_id": "j-1", "application": "app-1"}, "jobs_stop": {"job_id": "j-1", "application": "app-1"}, "jobs_resume": {"job_id": "j-1", "application": "app-1"}, "jobs_rerun": {"job_id": "j-1", "rerun_id": "rr-1", "application": "app-1"}, - "organizations_list": {"application": "app-1"}, + "list_organizations": {"application": "app-1"}, "organizations_get": {"organization_id": "o-1", "application": "app-1"}, "organizations_set": { "input": {}, @@ -86,7 +86,7 @@ "application": "app-1", }, "organizations_remove": {"organization_id": "o-1", "application": "app-1"}, - "scheduled_jobs_list": {"application": "app-1"}, + "list_scheduled_jobs": {"application": "app-1"}, "scheduled_jobs_get": {"scheduled_job_id": "sj-1", "application": "app-1"}, "scheduled_jobs_set": { "input": {}, @@ -99,7 +99,7 @@ "application": "app-1", }, "scheduled_jobs_remove": {"scheduled_job_id": "sj-1", "application": "app-1"}, - "scheduled_jobs_list_jobs": {"scheduled_job_id": "sj-1", "application": "app-1"}, + "list_scheduled_jobs_list_jobs": {"scheduled_job_id": "sj-1", "application": "app-1"}, "devices_get": {"device_id": "d-1", "application": "app-1"}, "devices_get_command_response": { "device_id": "d-1", @@ -151,7 +151,7 @@ "telemetry_name": "t-1", "application": "app-1", }, - "devices_list": {"application": "app-1"}, + "list_devices": {"application": "app-1"}, "devices_remove": {"device_id": "d-1", "application": "app-1"}, "devices_run_command": { "input": {}, @@ -190,22 +190,22 @@ }, "devices_update_properties": {"input": {}, "device_id": "d-1", "application": "app-1"}, "device_templates_get": {"template_id": "tpl-1", "application": "app-1"}, - "device_templates_list": {"application": "app-1"}, - "device_templates_list_2": {"application": "app-1"}, + "list_device_templates": {"application": "app-1"}, + "list_device_templates_2": {"application": "app-1"}, "device_templates_remove": {"template_id": "tpl-1", "application": "app-1"}, "roles_get": {"role_id": "role-1", "application": "app-1"}, - "roles_list": {"application": "app-1"}, + "list_roles": {"application": "app-1"}, "users_create": {"input": {}, "user_id": "u-1", "application": "app-1"}, "users_get": {"user_id": "u-1", "application": "app-1"}, - "users_list": {"application": "app-1"}, + "list_users": {"application": "app-1"}, "users_remove": {"user_id": "u-1", "application": "app-1"}, "users_update": {"input": {}, "user_id": "u-1", "application": "app-1"}, - "applications_list": {}, - "workflow_get_components": {"application": "app-1", "template": "tpl-1"}, - "workflow_get_capabilities": {"application": "app-1", "template": "tpl-1"}, - "workflow_get_capabilities_v1": {"application": "app-1", "template": "tpl-1"}, - "workflow_get_components_v1": {"application": "app-1", "template": "tpl-1"}, - "workflow_get_modules": {"application": "app-1", "template": "tpl-1"}, + "list_applications": {}, + "list_workflow_get_components": {"application": "app-1", "template": "tpl-1"}, + "list_workflow_get_capabilities": {"application": "app-1", "template": "tpl-1"}, + "list_workflow_get_capabilities_v1": {"application": "app-1", "template": "tpl-1"}, + "list_workflow_get_components_v1": {"application": "app-1", "template": "tpl-1"}, + "list_workflow_get_modules": {"application": "app-1", "template": "tpl-1"}, "schema_device_cloud_properties": {"application": "app-1"}, "schema_device_command": {"application": "app-1"}, "schema_device_command_v1": {"application": "app-1"}, @@ -232,7 +232,7 @@ async def _invoke_operation(client: AzureiotcentralClient, operation: str): """Invoke an IoT Central operation by name for shared method tests.""" - method = getattr(client, f"{operation}_async") + method = getattr(client, f"{operation}") return await resolve_generated_result(method(**OPERATION_ARGS[operation])) @@ -271,7 +271,7 @@ def test_init_with_custom_settings(self, mock_credential): client = AzureiotcentralClient( BASE_URL, credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -329,11 +329,11 @@ async def test_devices_list_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await resolve_generated_result(client.devices_list_async(application="app-1")) + result = await resolve_generated_result(client.list_devices(application="app-1")) assert result[0]["id"] == "d-1" assert mock_send.call_args[0][0] == "GET" @@ -349,11 +349,11 @@ async def test_devices_get_targets_device_path(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.devices_get_async(device_id="d-1", application="app-1") + result = await client.devices_get(device_id="d-1", application="app-1") assert result["id"] == "d-1" assert "/devices/d-1" in mock_send.call_args[0][1] @@ -363,15 +363,15 @@ async def test_device_groups_set_sends_put_and_body(self, mock_credential): """Test device_groups_set_async issues a PUT and forwards the body.""" client = _make_client(mock_credential) mock_response = MockResponse(status=200, text='{"id":"dg-1"}') - body = DeviceGroup(display_name="group") + body = model_instance(DeviceGroup, display_name="group") with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.device_groups_set_async( + result = await client.device_groups_set( input=body, device_group_id="dg-1", application="app-1", @@ -394,11 +394,11 @@ async def test_execute_component_command_sends_post_and_body( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.devices_execute_component_command_async( + await client.devices_execute_component_command( input=body, device_id="d-1", component_name="component-1", @@ -417,15 +417,15 @@ async def test_device_relationships_update_sends_patch_and_body( """Test device_relationships_update_async forwards the PATCH body.""" client = _make_client(mock_credential) mock_response = MockResponse(status=200, text="{}") - body = DeviceRelationship() + body = model_instance(DeviceRelationship) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.device_relationships_update_async( + await client.device_relationships_update( input=body, device_id="d-1", relationship_id="relationship-1", @@ -443,11 +443,11 @@ async def test_device_groups_remove_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.device_groups_remove_async( + result = await client.device_groups_remove( device_group_id="dg-1", application="app-1", ) @@ -463,12 +463,12 @@ async def test_jobs_set_appends_optional_job_type(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.jobs_set_async( - input=Job(display_name="job"), + await client.jobs_set( + input=model_instance(Job, display_name="job"), job_id="j-1", application="app-1", job_type="cloudProperty", @@ -485,11 +485,11 @@ async def test_devices_get_command_response_encodes_query_value(self, mock_crede with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.devices_get_command_response_async( + await client.devices_get_command_response( device_id="d-1", command_name="cmd-1", application="app one", @@ -508,11 +508,11 @@ async def test_empty_body_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await resolve_generated_result(client.devices_list_async(application="app-1")) + result = await resolve_generated_result(client.list_devices(application="app-1")) assert result == [] @@ -525,7 +525,7 @@ async def test_all_operations_success(self, mock_credential, operation): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: @@ -551,7 +551,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -566,16 +566,16 @@ class TestAzureiotcentralTypeSerialization: def test_dataclass_instances_initialize_expected_defaults(self): """Test generated dataclasses initialize with expected default values.""" - device_group = DeviceGroup() - device = Device() - device_command = DeviceCommand() - cloud_properties = DeviceCloudProperties() - relationship = DeviceRelationship() - job = Job() - organization = Organization() - scheduled_job = ScheduledJob() - user = User() - trigger = WorkflowTrigger() + device_group = model_instance(DeviceGroup) + device = model_instance(Device) + device_command = model_instance(DeviceCommand) + cloud_properties = model_instance(DeviceCloudProperties) + relationship = model_instance(DeviceRelationship) + job = model_instance(Job) + organization = model_instance(Organization) + scheduled_job = model_instance(ScheduledJob) + user = model_instance(User) + trigger = model_instance(WorkflowTrigger) assert device_group.id is None assert device.id is None diff --git a/tests/test_azuremonitorlogs.py b/tests/test_azuremonitorlogs.py index 764791e3..0837b6ee 100644 --- a/tests/test_azuremonitorlogs.py +++ b/tests/test_azuremonitorlogs.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.azuremonitorlogs import AzuremonitorlogsClient from azure.connectors.azuremonitorlogs import ( - AzuremonitorlogsClient, QueryDataInput, QuerySchemaInput, VisualizeQueryInput, @@ -20,7 +20,7 @@ ConnectorException, ) from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import model_instance, resolve_generated_result class TestAzuremonitorlogsClientInitialization: @@ -66,7 +66,7 @@ def test_init_with_custom_settings(self, mock_credential): client = AzuremonitorlogsClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -189,11 +189,11 @@ async def test_success_returns_json(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await resolve_generated_result(client.list_subscriptions_async()) + result = await resolve_generated_result(client.list_subscriptions()) mock_send.assert_called_once_with( "GET", @@ -216,12 +216,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=500, text="Server error"), ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.list_subscriptions_async()) + await resolve_generated_result(client.list_subscriptions()) assert exc_info.value.status_code == 500 @@ -239,12 +239,12 @@ async def test_success_appends_query_params(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"value": []}'), ) as mock_send: await resolve_generated_result( - client.list_resource_groups_async(subscriptions="sub-id") + client.list_resource_groups(subscriptions="sub-id") ) call_args = mock_send.call_args @@ -273,11 +273,11 @@ async def test_success_appends_multiple_query_params( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"value": []}'), ) as mock_send: - await resolve_generated_result(client.list_resources_async( + await resolve_generated_result(client.list_resources( subscriptions="sub-id", resourcegroups="rg1", resourcetype="Microsoft.OperationalInsights/workspaces", @@ -301,18 +301,19 @@ async def test_success_sends_body_and_returns_json(self, mock_credential): credential=mock_credential, ) - request_body = QueryDataInput( + request_body = model_instance( + QueryDataInput, query="Heartbeat | take 1", timerangetype="SetInQuery", ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"value": [{"Computer": "vm1"}]}'), ) as mock_send: - result = await client.query_data_async( + result = await client.query_data( input=request_body, subscriptions="sub-id", resourcegroups="rg1", @@ -334,12 +335,12 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text=""), ): - result = await client.query_data_async( - input=QueryDataInput(), + result = await client.query_data( + input=model_instance(QueryDataInput), subscriptions="sub-id", resourcegroups="rg1", resourcetype="type", @@ -365,14 +366,14 @@ async def test_success_returns_dynamic_schema_payload( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse( status=200, text='{"type": "object", "properties": {"Computer": {"type": "string"}}}' ), ): - result = await client.query_schema_async( + result = await client.query_schema( input=QuerySchemaInput(), subscriptions="sub-id", resourcegroups="rg1", @@ -395,18 +396,19 @@ async def test_success_with_vis_type(self, mock_credential): credential=mock_credential, ) - body = VisualizeQueryInput( + body = model_instance( + VisualizeQueryInput, query="Heartbeat | summarize count() by bin(TimeGenerated, 1h)", timerangetype="SetInQuery", ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"body": "ok"}'), ) as mock_send: - result = await client.visualize_query_async( + result = await client.visualize_query( input=body, subscriptions="sub-id", resourcegroups="rg1", @@ -430,7 +432,7 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse( status=400, @@ -438,8 +440,8 @@ async def test_error_response_raises_exception(self, mock_credential): ), ): with pytest.raises(ConnectorException) as exc_info: - await client.visualize_query_async( - input=VisualizeQueryInput(), + await client.visualize_query( + input=model_instance(VisualizeQueryInput), subscriptions="sub-id", resourcegroups="rg1", resourcetype="type", @@ -463,14 +465,14 @@ async def test_success_returns_control_schema(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse( status=200, text='{"type": "Relative"}', ), ) as mock_send: - result = await client.get_time_range_selection_control_async( + result = await client.get_time_range_selection_control( timerangetype="Relative range", ) @@ -496,12 +498,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=400, text="Invalid time range"), ): with pytest.raises(ConnectorException) as exc_info: - await client.get_time_range_selection_control_async( + await client.get_time_range_selection_control( timerangetype="invalid", ) diff --git a/tests/test_azurequeues.py b/tests/test_azurequeues.py index fc8b614d..96b7f238 100644 --- a/tests/test_azurequeues.py +++ b/tests/test_azurequeues.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.azurequeues import AzurequeuesClient from azure.connectors.azurequeues import ( - AzurequeuesClient, Messages, QueueArray, PutMessageInput, @@ -22,6 +22,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestAzurequeuesClientInitialization: @@ -57,7 +58,7 @@ def test_init_with_custom_settings(self, mock_credential): client = AzurequeuesClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -125,11 +126,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_message_async( + await client.delete_message( storage_account_name="mystorageaccount", queue_name="myqueue", message_id="msg-123", @@ -152,7 +153,7 @@ async def test_popreceipt_is_required(self, mock_credential): ) with pytest.raises(TypeError): - await client.delete_message_async( + await client.delete_message( storage_account_name="mystorageaccount", queue_name="myqueue", message_id="msg-123" @@ -166,23 +167,23 @@ async def test_error_response_raises_exception(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(status=404, text='{"error": "Message not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_message_async( + await client.delete_message( storage_account_name="mystorageaccount", queue_name="myqueue", message_id="nonexistent", popreceipt="receipt-abc" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestGetMessages: @@ -203,11 +204,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_messages_async( + result = await client.get_messages( storage_account_name="mystorageaccount", queue_name="myqueue" ) @@ -230,11 +231,11 @@ async def test_with_query_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_messages_async( + await client.get_messages( storage_account_name="mystorageaccount", queue_name="myqueue", numofmessages="10", @@ -258,12 +259,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_messages_async( + await client.get_messages( storage_account_name="mystorageaccount", queue_name="nonexistent" ) @@ -284,24 +285,24 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"value": [{"name": "queue1"}, {"name": "queue2"}]}' + text='[{"name": "queue1"}, {"name": "queue2"}]' ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.list_queues_async( + result = await resolve_generated_result(client.list_queues( storage_account_name="mystorageaccount" - ) + )) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/storageAccounts/mystorageaccount/queues/list" in call_args[0][1] - assert len(result["value"]) == 2 + assert len(result) == 2 @pytest.mark.asyncio async def test_empty_response_returns_none(self, mock_credential): @@ -315,14 +316,14 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.list_queues_async( + result = await resolve_generated_result(client.list_queues( storage_account_name="mystorageaccount" - ) - assert result is None + )) + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -336,14 +337,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.list_queues_async( + await resolve_generated_result(client.list_queues( storage_account_name="nonexistent" - ) + )) assert exc_info.value.status_code == 404 @@ -375,11 +376,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.put_message_async( + await client.put_message( input=message_input, storage_account_name="mystorageaccount", queue_name="myqueue" @@ -407,12 +408,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.put_message_async( + await client.put_message( input=message_input, storage_account_name="mystorageaccount", queue_name="myqueue" @@ -439,11 +440,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.put_queue_async( + result = await client.put_queue( storage_account_name="mystorageaccount", queue_name="newqueue" ) @@ -467,12 +468,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.put_queue_async( + await client.put_queue( storage_account_name="mystorageaccount", queue_name="existingqueue" ) @@ -581,16 +582,16 @@ async def test_multiple_consecutive_calls(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(status=200, text='{"value": []}') + mock_response = MockResponse(status=200, text='[]') with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.list_queues_async(storage_account_name="account1") - await client.list_queues_async(storage_account_name="account2") + await resolve_generated_result(client.list_queues(storage_account_name="account1")) + await resolve_generated_result(client.list_queues(storage_account_name="account2")) assert mock_send.call_count == 2 @@ -606,11 +607,11 @@ async def test_special_characters_in_queue_name(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_messages_async( + await client.get_messages( storage_account_name="mystorageaccount", queue_name="my-queue-name" ) diff --git a/tests/test_azuretables.py b/tests/test_azuretables.py index cbec4796..66d1821a 100644 --- a/tests/test_azuretables.py +++ b/tests/test_azuretables.py @@ -6,8 +6,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.azuretables import AzuretablesClient from azure.connectors.azuretables import ( - AzuretablesClient, CreateEntityInput, InsertEntityResponse, CreateTableInput, @@ -63,7 +63,7 @@ def test_init_with_custom_settings(self, mock_credential): client = AzuretablesClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -137,11 +137,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_entity_async( + result = await client.create_entity( input=entity_input, storage_account_name="mystorageaccount", table_name="mytable" @@ -166,12 +166,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_entity_async( + await client.create_entity( input=entity_input, storage_account_name="mystorageaccount", table_name="mytable" @@ -199,11 +199,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_table_async( + result = await client.create_table( input=table_input, storage_account_name="mystorageaccount" ) @@ -227,12 +227,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_table_async( + await client.create_table( input=table_input, storage_account_name="mystorageaccount" ) @@ -255,11 +255,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_entity_async( + await client.delete_entity( storage_account_name="mystorageaccount", table_name="mytable", partition_key="pk1", @@ -279,23 +279,23 @@ async def test_error_response_raises_exception(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(status=404, text='{"error": "Entity not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_entity_async( + await client.delete_entity( storage_account_name="mystorageaccount", table_name="mytable", partition_key="nonexistent", row_key="nonexistent" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestDeleteTable: @@ -313,11 +313,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_table_async( + await client.delete_table( storage_account_name="mystorageaccount", table_name="mytable" ) @@ -335,21 +335,21 @@ async def test_error_response_raises_exception(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(status=404, text='{"error": "Table not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_table_async( + await client.delete_table( storage_account_name="mystorageaccount", table_name="nonexistent" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestGetEntities: @@ -373,11 +373,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.get_entities_async( + result = await resolve_generated_result(client.list_entities( storage_account_name="mystorageaccount", table_name="mytable" )) @@ -400,11 +400,11 @@ async def test_with_query_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.get_entities_async( + await resolve_generated_result(client.list_entities( storage_account_name="mystorageaccount", table_name="mytable", filter="PartitionKey eq 'pk1'", @@ -428,12 +428,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.get_entities_async( + await resolve_generated_result(client.list_entities( storage_account_name="mystorageaccount", table_name="nonexistent" )) @@ -459,11 +459,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_entity_async( + result = await client.get_entity( storage_account_name="mystorageaccount", table_name="mytable", partition_key="pk1", @@ -488,11 +488,11 @@ async def test_with_select_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_entity_async( + await client.get_entity( storage_account_name="mystorageaccount", table_name="mytable", partition_key="pk1", @@ -516,12 +516,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_entity_async( + await client.get_entity( storage_account_name="mystorageaccount", table_name="mytable", partition_key="nonexistent", @@ -549,11 +549,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_table_async( + result = await client.get_table( storage_account_name="mystorageaccount", table_name="mytable" ) @@ -576,12 +576,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_table_async( + await client.get_table( storage_account_name="mystorageaccount", table_name="nonexistent" ) @@ -590,7 +590,7 @@ async def test_error_response_raises_exception(self, mock_credential): class TestGetTables: - """Tests for get_tables_async method.""" + """Tests for list_tables method.""" @pytest.mark.asyncio async def test_success_with_json_response(self, mock_credential): @@ -607,19 +607,19 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_tables_async( - storage_account_name="mystorageaccount" + result = await resolve_generated_result( + client.list_tables(storage_account_name="mystorageaccount") ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/storageAccounts/mystorageaccount/tables" in call_args[0][1] - assert len(result["value"]) == 2 + assert len(result) == 2 @pytest.mark.asyncio async def test_empty_response_returns_none(self, mock_credential): @@ -633,14 +633,14 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_tables_async( - storage_account_name="mystorageaccount" + result = await resolve_generated_result( + client.list_tables(storage_account_name="mystorageaccount") ) - assert result is None + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -654,13 +654,13 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_tables_async( - storage_account_name="nonexistent" + await resolve_generated_result( + client.list_tables(storage_account_name="nonexistent") ) assert exc_info.value.status_code == 404 @@ -684,11 +684,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.insert_merge_entity_async( + await client.insert_merge_entity( input=entity_input, storage_account_name="mystorageaccount", table_name="mytable", @@ -714,12 +714,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.insert_merge_entity_async( + await client.insert_merge_entity( input=entity_input, storage_account_name="mystorageaccount", table_name="mytable", @@ -748,11 +748,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.insert_replace_entity_async( + await client.insert_replace_entity( input=entity_input, storage_account_name="mystorageaccount", table_name="mytable", @@ -778,12 +778,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.insert_replace_entity_async( + await client.insert_replace_entity( input=entity_input, storage_account_name="mystorageaccount", table_name="mytable", @@ -812,11 +812,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.merge_entity_async( + await client.merge_entity( input=entity_input, storage_account_name="mystorageaccount", table_name="mytable", @@ -842,12 +842,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.merge_entity_async( + await client.merge_entity( input=entity_input, storage_account_name="mystorageaccount", table_name="mytable", @@ -876,11 +876,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.replace_entity_async( + await client.replace_entity( input=entity_input, storage_account_name="mystorageaccount", table_name="mytable", @@ -906,12 +906,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.replace_entity_async( + await client.replace_entity( input=entity_input, storage_account_name="mystorageaccount", table_name="mytable", @@ -1087,12 +1087,16 @@ async def test_multiple_consecutive_calls(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_tables_async(storage_account_name="account1") - await client.get_tables_async(storage_account_name="account2") + await resolve_generated_result( + client.list_tables(storage_account_name="account1") + ) + await resolve_generated_result( + client.list_tables(storage_account_name="account2") + ) assert mock_send.call_count == 2 @@ -1108,11 +1112,11 @@ async def test_special_characters_in_keys(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_entity_async( + await client.get_entity( storage_account_name="mystorageaccount", table_name="mytable", partition_key="pk-1", @@ -1136,14 +1140,14 @@ async def test_success_returns_storage_accounts(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=MockResponse( status=200, text='{"value": [{"name": "account1"}]}' ) ) as mock_send: - result = await client.get_storage_accounts_async() + result = await resolve_generated_result(client.list_storage_accounts()) mock_send.assert_called_once_with( "GET", @@ -1154,7 +1158,7 @@ async def test_success_returns_storage_accounts(self, mock_credential): client_request_id=None, response_hook=None, ) - assert result["value"][0]["name"] == "account1" + assert result == [{"name": "account1"}] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -1166,12 +1170,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=MockResponse(status=500, text="Server error") ): with pytest.raises(ConnectorException) as exc_info: - await client.get_storage_accounts_async() + await resolve_generated_result(client.list_storage_accounts()) assert exc_info.value.status_code == 500 @@ -1195,7 +1199,7 @@ async def test_entities_continuation_yields_later_entities( ) as client: with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, side_effect=[ MockResponse(status=200, text=json.dumps({ @@ -1209,7 +1213,7 @@ async def test_entities_continuation_yields_later_entities( ], ) as transport: entities = [ - entity async for entity in client.get_entities_async( + entity async for entity in client.list_entities( storage_account_name="mystorageaccount", table_name="mytable", ) diff --git a/tests/test_azurevm.py b/tests/test_azurevm.py index f68e3ac8..f8aa66cc 100644 --- a/tests/test_azurevm.py +++ b/tests/test_azurevm.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.azurevm import AzurevmClient from azure.connectors.azurevm import ( - AzurevmClient, VirtualMachine, VirtualMachineProperties, VirtualMachineInScaleSet, @@ -70,7 +70,7 @@ def test_init_with_custom_settings(self, mock_credential): client = AzurevmClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -151,11 +151,11 @@ async def test_success_returns_vm_data(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.virtual_machine_get_async( + result = await client.virtual_machine_get( subscription_id="sub1", resource_group_name="rg1", virtual_machine_name="vm1" @@ -182,11 +182,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.virtual_machine_get_async( + result = await client.virtual_machine_get( subscription_id="sub1", resource_group_name="rg1", virtual_machine_name="vm1" @@ -209,12 +209,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.virtual_machine_get_async( + await client.virtual_machine_get( subscription_id="sub1", resource_group_name="rg1", virtual_machine_name="vm1" @@ -238,11 +238,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_start_async( + await client.virtual_machine_start( subscription_id="sub1", resource_group_name="rg1", virtual_machine_name="vm1" @@ -269,11 +269,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_deallocate_async( + await client.virtual_machine_deallocate( subscription_id="sub1", resource_group_name="rg1", virtual_machine_name="vm1" @@ -300,11 +300,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_poweroff_async( + await client.virtual_machine_poweroff( subscription_id="sub1", resource_group_name="rg1", virtual_machine_name="vm1" @@ -331,11 +331,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_reapply_async( + await client.virtual_machine_reapply( subscription_id="sub1", resource_group_name="rg1", virtual_machine_name="vm1" @@ -362,11 +362,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_redeploy_async( + await client.virtual_machine_redeploy( subscription_id="sub1", resource_group_name="rg1", virtual_machine_name="vm1" @@ -393,11 +393,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_restart_async( + await client.virtual_machine_restart( subscription_id="sub1", resource_group_name="rg1", virtual_machine_name="vm1" @@ -430,11 +430,11 @@ async def test_success_returns_vm_data(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.virtual_machine_in_scale_set_get_async( + result = await client.virtual_machine_in_scale_set_get( subscription_id="sub1", resource_group_name="rg1", virtual_machine_scale_set_name="vmss1", @@ -463,12 +463,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.virtual_machine_in_scale_set_get_async( + await client.virtual_machine_in_scale_set_get( subscription_id="sub1", resource_group_name="rg1", virtual_machine_scale_set_name="vmss1", @@ -493,11 +493,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_in_scale_set_deallocate_async( + await client.virtual_machine_in_scale_set_deallocate( subscription_id="sub1", resource_group_name="rg1", virtual_machine_scale_set_name="vmss1", @@ -525,11 +525,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_in_scale_set_power_off_async( + await client.virtual_machine_in_scale_set_power_off( subscription_id="sub1", resource_group_name="rg1", virtual_machine_scale_set_name="vmss1", @@ -557,11 +557,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_in_scale_set_redeploy_async( + await client.virtual_machine_in_scale_set_redeploy( subscription_id="sub1", resource_group_name="rg1", virtual_machine_scale_set_name="vmss1", @@ -589,11 +589,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_in_scale_set_reimage_async( + await client.virtual_machine_in_scale_set_reimage( subscription_id="sub1", resource_group_name="rg1", virtual_machine_scale_set_name="vmss1", @@ -621,11 +621,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_in_scale_set_restart_async( + await client.virtual_machine_in_scale_set_restart( subscription_id="sub1", resource_group_name="rg1", virtual_machine_scale_set_name="vmss1", @@ -653,11 +653,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.virtual_machine_in_scale_set_start_async( + await client.virtual_machine_in_scale_set_start( subscription_id="sub1", resource_group_name="rg1", virtual_machine_scale_set_name="vmss1", diff --git a/tests/test_box.py b/tests/test_box.py index 2fc8e4ac..4e1f31ff 100644 --- a/tests/test_box.py +++ b/tests/test_box.py @@ -6,50 +6,53 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.box import BoxClient from azure.connectors.box import ( BlobMetadata, BlobMetadataPage, - BoxClient, ) from azure.connectors.sdk import ( ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result async def _invoke_operation(client: BoxClient, operation: str): """Invoke a Box operation by name for shared parameterized tests.""" if operation == "get_file_metadata": - return await client.get_file_metadata_async(id="file123") + return await client.get_file_metadata(id="file123") if operation == "update_file": - return await client.update_file_async(input=b"updated content", id="file123") + return await client.update_file(input=b"updated content", id="file123") if operation == "delete_file": - return await client.delete_file_async(id="file123") + return await client.delete_file(id="file123") if operation == "get_file_metadata_by_path": - return await client.get_file_metadata_by_path_async(path="/Documents/file.txt") + return await client.get_file_metadata_by_path(path="/Documents/file.txt") if operation == "get_file_content_by_path": - return await client.get_file_content_by_path_async(path="/Documents/file.txt") + return await client.get_file_content_by_path(path="/Documents/file.txt") if operation == "get_file_content": - return await client.get_file_content_async(id="file123") + return await client.get_file_content(id="file123") if operation == "create_file": - return await client.create_file_async( + return await client.create_file( input=b"file content", folder_path="/Documents", name="created.txt", ) if operation == "copy_file": - return await client.copy_file_async( + return await client.copy_file( source="/Documents/source.txt", destination="/Documents/copy.txt", ) if operation == "list_folder": - return await client.list_folder_async(id="folder123") + return await resolve_generated_result(client.list_folder(id="folder123")) if operation == "list_root_folder": - return await client.list_root_folder_async() + return await resolve_generated_result(client.list_root_folder()) if operation == "extract_folder": - return await client.extract_folder_async( - source="/Documents/archive.zip", - destination="/Documents/extracted", + return await resolve_generated_result( + client.extract_folder( + source="/Documents/archive.zip", + destination="/Documents/extracted", + ) ) raise ValueError(f"Unsupported operation '{operation}'.") @@ -87,7 +90,7 @@ def test_init_with_custom_settings(self, mock_credential): client = BoxClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -154,11 +157,11 @@ async def test_get_file_metadata_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_file_metadata_async(id="file123") + result = await client.get_file_metadata(id="file123") assert result["name"] == "doc.txt" call_args = mock_send.call_args @@ -176,11 +179,11 @@ async def test_update_file_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.update_file_async(input=b"updated content", id="file123") + result = await client.update_file(input=b"updated content", id="file123") assert result["name"] == "updated.txt" call_args = mock_send.call_args @@ -198,11 +201,11 @@ async def test_delete_file_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_file_async(id="file123") + result = await client.delete_file(id="file123") assert result is None call_args = mock_send.call_args @@ -219,11 +222,11 @@ async def test_get_file_content_by_path_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_file_content_by_path_async(path="/Documents/file.txt") + result = await client.get_file_content_by_path(path="/Documents/file.txt") assert result == b"box file content" assert "path=%2FDocuments%2Ffile.txt" in mock_send.call_args[0][1] @@ -239,11 +242,11 @@ async def test_create_file_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_file_async( + result = await client.create_file( input=b"file content", folder_path="/Documents", name="created.txt", @@ -264,19 +267,18 @@ async def test_list_root_folder_success(self, mock_credential): ) mock_response = MockResponse( status=200, - text='{"value":[{"id":"1","name":"Docs"}]}' + text='[{"id":"1","name":"Docs"}]' ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.list_root_folder_async() + result = await resolve_generated_result(client.list_root_folder()) - assert len(result["value"]) == 1 - assert result["value"][0]["name"] == "Docs" + assert result == [{"id": "1", "name": "Docs"}] class TestBoxClientErrorHandling: @@ -313,7 +315,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_campfire.py b/tests/test_campfire.py index 5a123e96..d4a106f3 100644 --- a/tests/test_campfire.py +++ b/tests/test_campfire.py @@ -7,9 +7,9 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.campfire import CampfireClient from azure.connectors.campfire import ( Account, - CampfireClient, Room, TRIGGER_OPERATIONS, Upload, @@ -19,6 +19,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestCampfireClientInitialization: @@ -54,7 +55,7 @@ def test_init_with_custom_settings(self, mock_credential): client = CampfireClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -121,11 +122,11 @@ async def test_create_message_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_message_async( + result = await client.create_message( room_id="R1", account="acct1", message="hello" ) @@ -147,11 +148,11 @@ async def test_get_user_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_user_async(user_id="5", account="acct1") + result = await client.get_user(user_id="5", account="acct1") method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -170,17 +171,19 @@ async def test_list_accounts_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_accounts_async(parent_operation="op1") + result = await resolve_generated_result( + client.list_accounts(parent_operation="op1") + ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert "/authorization.json" in url assert "parentOperation=op1" in url - assert result == {"accounts": []} + assert result == [] @pytest.mark.asyncio async def test_list_rooms_success(self, mock_credential): @@ -193,21 +196,23 @@ async def test_list_rooms_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_rooms_async(account="acct1") + result = await resolve_generated_result( + client.list_rooms(account="acct1") + ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert "/rooms.json" in url assert "account=acct1" in url - assert result == {"rooms": []} + assert result == [] @pytest.mark.asyncio - async def test_empty_response_body_returns_none(self, mock_credential): - """Test a 2xx response with no body returns None.""" + async def test_empty_response_body_returns_empty_page(self, mock_credential): + """Test a 2xx response with no body returns an empty page.""" client = CampfireClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -216,13 +221,15 @@ async def test_empty_response_body_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.list_rooms_async(account="acct1") + result = await resolve_generated_result( + client.list_rooms(account="acct1") + ) - assert result is None + assert result == [] class TestCampfireClientErrorHandling: @@ -248,21 +255,23 @@ async def test_error_response_raises_exception(self, mock_credential, operation) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: if operation == "create_message": - await client.create_message_async( + await client.create_message( room_id="R1", account="acct1", message="hello" ) elif operation == "get_user": - await client.get_user_async(user_id="5", account="acct1") + await client.get_user(user_id="5", account="acct1") elif operation == "list_accounts": - await client.list_accounts_async() + await resolve_generated_result(client.list_accounts()) else: - await client.list_rooms_async(account="acct1") + await resolve_generated_result( + client.list_rooms(account="acct1") + ) assert exc_info.value.status_code == 500 diff --git a/tests/test_clicksendsms.py b/tests/test_clicksendsms.py index 1318c424..02d0870e 100644 --- a/tests/test_clicksendsms.py +++ b/tests/test_clicksendsms.py @@ -7,8 +7,8 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.clicksendsms import ClicksendsmsClient from azure.connectors.clicksendsms import ( - ClicksendsmsClient, CreateListContactInput, CreateListInput, DeleteListResponse, @@ -26,6 +26,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import model_instance class TestClicksendsmsClientInitialization: @@ -61,7 +62,7 @@ def test_init_with_custom_settings(self, mock_credential): client = ClicksendsmsClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -131,10 +132,10 @@ async def test_sms_send_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.sms_send_async(input=payload) + result = await client.sms_send(input=payload) assert mock_send.call_args[0][0] == "POST" assert "/sms/send" in mock_send.call_args[0][1] @@ -149,10 +150,10 @@ async def test_create_list_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_list_async(input=payload) + result = await client.create_list(input=payload) assert mock_send.call_args[0][0] == "POST" assert "/lists" in mock_send.call_args[0][1] @@ -166,10 +167,10 @@ async def test_get_contact_lists_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_contact_lists_async(page="2", limit="10") + result = await client.get_contact_lists(page="2", limit="10") url = mock_send.call_args[0][1] assert mock_send.call_args[0][0] == "GET" @@ -186,10 +187,10 @@ async def test_send_voice_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.send_voice_async(input=payload) + result = await client.send_voice(input=payload) assert mock_send.call_args[0][0] == "POST" assert "/voice/send" in mock_send.call_args[0][1] @@ -203,10 +204,10 @@ async def test_delete_list_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_list_async(list_id="123") + result = await client.delete_list(list_id="123") assert mock_send.call_args[0][0] == "DELETE" assert "/lists/123" in mock_send.call_args[0][1] @@ -216,14 +217,18 @@ async def test_delete_list_success(self, mock_credential): async def test_create_list_contact_success(self, mock_credential): """Test create_list_contact issues a POST to the list contacts route.""" client = self._make_client(mock_credential) - payload = CreateListContactInput(first_name="Ada", phone_number="+61411111111") + payload = model_instance( + CreateListContactInput, + first_name="Ada", + phone_number="+61411111111", + ) mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_list_contact_async(input=payload, list_id="123") + result = await client.create_list_contact(input=payload, list_id="123") assert mock_send.call_args[0][0] == "POST" assert "/lists/123/contacts" in mock_send.call_args[0][1] @@ -237,10 +242,10 @@ async def test_view_list_contacts_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.view_list_contacts_async(list_id="123") + result = await client.view_list_contacts(list_id="123") assert mock_send.call_args[0][0] == "GET" assert "/lists/123/contacts" in mock_send.call_args[0][1] @@ -253,10 +258,10 @@ async def test_delete_list_contact_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_list_contact_async(list_id="123", contact_id="456") + result = await client.delete_list_contact(list_id="123", contact_id="456") assert mock_send.call_args[0][0] == "DELETE" assert "/lists/123/contacts/456" in mock_send.call_args[0][1] @@ -270,10 +275,10 @@ async def test_send_mms_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.send_mms_async(input=payload) + result = await client.send_mms(input=payload) assert mock_send.call_args[0][0] == "POST" assert "/mms/send" in mock_send.call_args[0][1] @@ -288,10 +293,10 @@ async def test_send_fax_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.send_fax_async(input=payload) + result = await client.send_fax(input=payload) assert mock_send.call_args[0][0] == "POST" assert "/fax/send" in mock_send.call_args[0][1] @@ -306,10 +311,10 @@ async def test_upload_media_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.upload_media_async(input=payload, convert="mms") + result = await client.upload_media(input=payload, convert="mms") url = mock_send.call_args[0][1] assert mock_send.call_args[0][0] == "POST" @@ -325,10 +330,10 @@ async def test_search_contact_list_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.search_contact_list_async(q="friends") + result = await client.search_contact_list(q="friends") url = mock_send.call_args[0][1] assert mock_send.call_args[0][0] == "GET" @@ -340,14 +345,18 @@ async def test_search_contact_list_success(self, mock_credential): async def test_send_letter_success(self, mock_credential): """Test send_letter issues a POST to the letters route with the input body.""" client = self._make_client(mock_credential) - payload = SendLetterInput(file_url="url", recipients=[{"address_name": "Ada"}]) + payload = model_instance( + SendLetterInput, + file_url="url", + recipients=[{"address_name": "Ada"}], + ) mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.send_letter_async(input=payload) + result = await client.send_letter(input=payload) assert mock_send.call_args[0][0] == "POST" assert "/post/letters/send" in mock_send.call_args[0][1] @@ -362,10 +371,10 @@ async def test_send_postcard_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"data": {}}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.send_postcard_async(input=payload) + result = await client.send_postcard(input=payload) assert mock_send.call_args[0][0] == "POST" assert "/post/postcards/send" in mock_send.call_args[0][1] @@ -379,10 +388,10 @@ async def test_empty_response_body_returns_none(self, mock_credential): mock_response = MockResponse(status=200, text="") with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.view_list_contacts_async(list_id="123") + result = await client.view_list_contacts(list_id="123") assert result is None @@ -419,40 +428,44 @@ async def test_error_response_raises_exception(self, mock_credential, operation) mock_response = MockResponse(status=500, text='{"error":"server failure"}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: if operation == "sms_send": - await client.sms_send_async(input=SmsSendInput()) + await client.sms_send(input=model_instance(SmsSendInput)) elif operation == "create_list": - await client.create_list_async(input=CreateListInput()) + await client.create_list(input=model_instance(CreateListInput)) elif operation == "get_contact_lists": - await client.get_contact_lists_async() + await client.get_contact_lists() elif operation == "send_voice": - await client.send_voice_async(input=SendVoiceInput()) + await client.send_voice(input=model_instance(SendVoiceInput)) elif operation == "delete_list": - await client.delete_list_async(list_id="123") + await client.delete_list(list_id="123") elif operation == "create_list_contact": - await client.create_list_contact_async( - input=CreateListContactInput(), list_id="123" + await client.create_list_contact( + input=model_instance(CreateListContactInput), + list_id="123", ) elif operation == "view_list_contacts": - await client.view_list_contacts_async(list_id="123") + await client.view_list_contacts(list_id="123") elif operation == "delete_list_contact": - await client.delete_list_contact_async(list_id="123", contact_id="456") + await client.delete_list_contact(list_id="123", contact_id="456") elif operation == "send_mms": - await client.send_mms_async(input=SendMmsInput()) + await client.send_mms(input=model_instance(SendMmsInput)) elif operation == "send_fax": - await client.send_fax_async(input=SendFaxInput()) + await client.send_fax(input=model_instance(SendFaxInput)) elif operation == "upload_media": - await client.upload_media_async(input=UploadMediaInput(), convert="mms") + await client.upload_media( + input=model_instance(UploadMediaInput), + convert="mms", + ) elif operation == "search_contact_list": - await client.search_contact_list_async(q="friends") + await client.search_contact_list(q="friends") elif operation == "send_letter": - await client.send_letter_async(input=SendLetterInput()) + await client.send_letter(input=model_instance(SendLetterInput)) else: - await client.send_postcard_async(input=SendPostcardInput()) + await client.send_postcard(input=model_instance(SendPostcardInput)) assert exc_info.value.status_code == 500 @@ -488,6 +501,11 @@ def test_dataclass_defaults(self): assert SmsSendResponse().http_code is None assert SmsSendResponse().response_msg is None assert DeleteListResponse().response_msg is None - assert CreateListContactInput().first_name is None - assert CreateListContactInput().custom1 is None - assert CreateListContactInput().address_line1 is None + contact = CreateListContactInput( + first_name="Ada", + last_name="Lovelace", + phone_number="+61411111111", + ) + assert contact.first_name == "Ada" + assert contact.custom1 is None + assert contact.address_line1 is None diff --git a/tests/test_cloudmersiveconvert.py b/tests/test_cloudmersiveconvert.py index 88739168..cbbf300f 100644 --- a/tests/test_cloudmersiveconvert.py +++ b/tests/test_cloudmersiveconvert.py @@ -7,8 +7,8 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.cloudmersiveconvert import CloudmersiveconvertClient from azure.connectors.cloudmersiveconvert import ( - CloudmersiveconvertClient, GetDocxBodyRequest, GetDocxGetCommentsHierarchicalRequest, ) @@ -51,7 +51,7 @@ def test_init_with_custom_settings(self, mock_credential): client = CloudmersiveconvertClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -119,11 +119,11 @@ async def test_success_forwards_request_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.edit_document_docx_body_async(input=request) + result = await client.edit_document_docx_body(input=request) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -144,12 +144,12 @@ async def test_error_response_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.edit_document_docx_body_async(input=GetDocxBodyRequest()) + await client.edit_document_docx_body(input=GetDocxBodyRequest()) assert exc_info.value.status_code == 400 @@ -169,11 +169,11 @@ async def test_success_forwards_request_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.edit_document_docx_get_comments_hierarchical_async( + result = await client.edit_document_docx_get_comments_hierarchical( input=request ) @@ -195,12 +195,12 @@ async def test_server_error_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.edit_document_docx_get_comments_hierarchical_async( + await client.edit_document_docx_get_comments_hierarchical( input=GetDocxGetCommentsHierarchicalRequest() ) @@ -269,12 +269,12 @@ async def test_server_error_raises_connector_exception(self, mock_credential): def test_generated_operation_inventory_matches_contract(): """Test all 53 supported operations are represented without multipart APIs.""" assert len(ALL_OPERATIONS) == 53 - assert not hasattr(CloudmersiveconvertClient, "create_document_async") + assert not hasattr(CloudmersiveconvertClient, "create_document") async def _invoke_operation(client: CloudmersiveconvertClient, operation: str): """Invoke a Cloudmersive Convert operation by name for shared method tests.""" - method = getattr(client, f"{operation}_async") + method = getattr(client, f"{operation}") return await method(**OPERATION_ARGS[operation]) @@ -290,7 +290,7 @@ async def test_all_operations_success(self, mock_credential, operation): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: @@ -316,7 +316,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_code_quality.py b/tests/test_code_quality.py index a4125007..33be5d66 100644 --- a/tests/test_code_quality.py +++ b/tests/test_code_quality.py @@ -64,11 +64,11 @@ def test_flake8(self): raise AssertionError( f'flake8 validation failed:\n{output}') from None - def test_no_unchecked_send_async_calls(self): - """Verify all send_async calls capture their response. + def test_no_unchecked_send_calls(self): + """Verify all async send calls capture their response. - Generated connector code must not discard send_async responses. - This check catches the most egregious error: calling send_async + Generated connector code must not discard send responses. + This check catches the most egregious error: calling send without capturing the response at all (fire-and-forget). It does NOT validate that the captured response is checked with the correct status guard pattern — that requires manual review or regeneration. @@ -80,34 +80,122 @@ def test_no_unchecked_send_async_calls(self): violations: list[LintViolation] = [] - for filepath in connector_dir.glob('*.py'): + connector_paths = sorted(connector_dir.glob('*.py')) + for filepath in connector_paths: if filepath.name in skip_files: continue - violations.extend(self._find_unchecked_send_async(filepath)) + violations.extend(self._find_unchecked_send(filepath)) if violations: messages = [ f" {v.file}:{v.line}: {v.message}" - for v in sorted(violations, key=lambda x: (x.file, x.line)) + for v in sorted( + violations, + key=lambda violation: (violation.file, violation.line), + ) ] violation_text = "\n".join(messages) raise AssertionError( - f"Found {len(violations)} unchecked send_async call(s).\n" - f"All send_async calls must capture the response.\n" + f"Found {len(violations)} unchecked send call(s).\n" + f"All async send calls must capture the response.\n" f"Fix the generator (see GENERATION.md) and regenerate, " f"or regenerate with the latest generator.\n\n" f"{violation_text}" ) - def _find_unchecked_send_async( + def test_only_explicit_resource_deletes_accept_not_found(self): + """Verify only explicitly idempotent resource deletes accept HTTP 404.""" + connector_dir = ROOT_PATH / 'src' / 'azure' / 'connectors' + expected_operations = { + ('arm.py', 'deployments_delete'), + } + connector_paths = sorted(connector_dir.glob('*.py')) + actual_operations: set[tuple[str, str]] = set() + + for filepath in connector_paths: + if filepath.name.startswith('_'): + continue + + tree = ast.parse(filepath.read_text(encoding='utf-8')) + for function in ( + node for node in ast.walk(tree) + if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)) + ): + if not self._sends_request(function): + continue + + accepts_not_found = self._accepts_not_found(function) + if accepts_not_found: + relative_path = filepath.relative_to(connector_dir).as_posix() + actual_operations.add((relative_path, function.name)) + assert self._uses_http_method(function, 'DELETE'), ( + f'{relative_path}:{function.lineno}: ' + f'{function.name} accepts 404 without using HTTP DELETE' + ) + + assert actual_operations == expected_operations, ( + 'Generated HTTP 404 guards do not match the explicit idempotent ' + f'resource-delete policy: {sorted(actual_operations)}' + ) + + @staticmethod + def _sends_request(function: ast.AST) -> bool: + """Return whether a function sends an HTTP request.""" + return any( + isinstance(node, ast.Call) + and isinstance(node.func, ast.Attribute) + and node.func.attr == 'send' + for node in ast.walk(function) + ) + + @staticmethod + def _uses_http_method(function: ast.AST, method: str) -> bool: + """Return whether a function sends the specified HTTP method.""" + return any( + isinstance(node, ast.Call) + and isinstance(node.func, ast.Attribute) + and node.func.attr == 'send' + and node.args + and isinstance(node.args[0], ast.Constant) + and node.args[0].value == method + for node in ast.walk(function) + ) + + @staticmethod + def _accepts_not_found(function: ast.AST) -> bool: + """Return whether a function returns None for HTTP 404.""" + for node in ast.walk(function): + if not isinstance(node, ast.If) or not isinstance(node.test, ast.Compare): + continue + + comparison = node.test + if ( + len(comparison.ops) == 1 + and isinstance(comparison.ops[0], ast.Eq) + and len(comparison.comparators) == 1 + and isinstance(comparison.comparators[0], ast.Constant) + and comparison.comparators[0].value == 404 + and any( + isinstance(statement, ast.Return) + and isinstance(statement.value, ast.Constant) + and statement.value.value is None + for statement in node.body + ) + ): + return True + + return False + + def _find_unchecked_send( self, filepath: pathlib.Path ) -> list[LintViolation]: - """Find send_async calls whose result is not captured. + """Find async send calls whose result is not captured. Detects the pattern: - await self.http_client.send_async(...) # Result discarded! + self.http_client.send(...) # Result discarded! + await self.http_client.send(...) # Result discarded! This is a minimal check that catches discarded responses. It does NOT validate that captured responses are checked with the correct @@ -124,20 +212,27 @@ def _find_unchecked_send_async( for node in ast.walk(tree): # NOTE(victoriahall): ast.Expr means the value is discarded, not assigned. - if isinstance(node, ast.Expr) and isinstance(node.value, ast.Await): - await_expr = node.value.value - - if isinstance(await_expr, ast.Call): - func = await_expr.func - - if isinstance(func, ast.Attribute) and func.attr == 'send_async': - if isinstance(func.value, ast.Attribute): - attr_name = func.value.attr - if attr_name in ('http_client', '_http_client'): - violations.append(LintViolation( - file=filepath.name, - line=node.lineno, - message='Unchecked send_async call' - )) + if not isinstance(node, ast.Expr): + continue + + expression = node.value + if isinstance(expression, ast.Await): + expression = expression.value + + if not isinstance(expression, ast.Call): + continue + + function = expression.func + if not isinstance(function, ast.Attribute) or function.attr != 'send': + continue + + if isinstance(function.value, ast.Attribute): + attribute_name = function.value.attr + if attribute_name in ('http_client', '_http_client'): + violations.append(LintViolation( + file=filepath.relative_to(ROOT_PATH).as_posix(), + line=node.lineno, + message='Unchecked send call' + )) return violations diff --git a/tests/test_commondataservice.py b/tests/test_commondataservice.py index e717dc66..e9fb3998 100644 --- a/tests/test_commondataservice.py +++ b/tests/test_commondataservice.py @@ -5,10 +5,10 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.commondataservice import CommondataserviceClient from azure.connectors.commondataservice import ( TRIGGER_OPERATIONS, AssociateRecordsPatchItemInput, - CommondataserviceClient, ItemsList, PatchItemInput, PostItemInput, @@ -18,6 +18,7 @@ ) from azure.connectors.sdk.serialization import to_wire from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestCommondataserviceClientInitialization: @@ -53,7 +54,7 @@ def test_init_with_custom_settings(self, mock_credential): client = CommondataserviceClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -138,11 +139,11 @@ async def test_get_item_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"itemInternalId": "1"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.get_item_async(dataset="default", table="accounts", id="1") + result = await client.get_item(dataset="default", table="accounts", id="1") call_args = mock_send.call_args assert call_args[0][0] == "GET" @@ -153,17 +154,17 @@ async def test_get_item_success(self, mock_credential): async def test_get_item_error_response(self, mock_credential): """Test that error response raises ConnectorException.""" client = _make_client(mock_credential) - mock_response = MockResponse(status=404, text="Not found") + mock_response = MockResponse(status=500, text="Server error") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_item_async(dataset="default", table="accounts", id="99") + await client.get_item(dataset="default", table="accounts", id="99") - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestGetItems: @@ -176,12 +177,12 @@ async def test_get_items_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"value": []}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response result = [ - item async for item in client.get_items_async( + item async for item in client.list_items( dataset="default", table="accounts", ) @@ -212,12 +213,12 @@ async def test_get_items_follows_odata_next_link(self, mock_credential): ] with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.side_effect = responses result = [ - item async for item in client.get_items_async( + item async for item in client.list_items( dataset="default", table="accounts", ) @@ -227,6 +228,38 @@ async def test_get_items_follows_odata_next_link(self, mock_credential): assert mock_send.await_count == 2 assert mock_send.await_args_list[1].args[1] == next_link + @pytest.mark.asyncio + async def test_get_items_rebases_caller_continuation_to_runtime_origin( + self, + mock_credential, + ): + """Test caller continuation URLs cannot redirect authenticated requests.""" + client = _make_client(mock_credential) + continuation_token = "https://attacker.invalid/capture?secret=opaque" + mock_response = MockResponse( + status=200, + text='{"value": [{"sequence": 2}]}', + ) + + with patch.object( + client._http_client, "send", new_callable=AsyncMock + ) as mock_send: + mock_send.return_value = mock_response + + page_iterator = client.list_items( + dataset="default", + table="accounts", + ).by_page(continuation_token=continuation_token) + page = await anext(page_iterator) + result = [item async for item in page] + + assert result == [{"sequence": 2}] + mock_send.assert_awaited_once() + assert mock_send.await_args.args[1] == ( + "https://example.azure.com/connections/test" + "/capture?secret=opaque" + ) + @pytest.mark.asyncio async def test_get_items_resolves_query_only_next_link_against_current_url( self, @@ -247,12 +280,12 @@ async def test_get_items_resolves_query_only_next_link_against_current_url( ] with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.side_effect = responses result = [ - item async for item in client.get_items_async( + item async for item in client.list_items( dataset="default", table="accounts", filter="statecode eq 0", @@ -285,12 +318,12 @@ async def test_get_items_resolves_leading_slash_next_link_against_runtime( ] with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.side_effect = responses result = [ - item async for item in client.get_items_async( + item async for item in client.list_items( dataset="default", table="accounts", ) @@ -322,12 +355,12 @@ async def test_get_items_routes_bare_token_through_next_link_endpoint( ] with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.side_effect = responses result = [ - item async for item in client.get_items_async( + item async for item in client.list_items( dataset="default", table="accounts", ) @@ -443,11 +476,11 @@ async def test_get_items_with_query_params(self, mock_credential): mock_response = MockResponse(status=200, text='{"value": []}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = client.get_items_async( + result = client.list_items( dataset="default", table="contacts", apply="groupby((name))", @@ -472,13 +505,13 @@ async def test_get_items_error_response(self, mock_credential): mock_response = MockResponse(status=500, text="Server error") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: await anext( - client.get_items_async(dataset="default", table="accounts") + client.list_items(dataset="default", table="accounts") ) assert exc_info.value.status_code == 500 @@ -495,11 +528,11 @@ async def test_patch_item_success(self, mock_credential): body = PatchItemInput() with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.patch_item_async( + result = await client.patch_item( input=body, dataset="default", table="accounts", @@ -519,12 +552,12 @@ async def test_patch_item_error_response(self, mock_credential): mock_response = MockResponse(status=400, text="Bad request") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.patch_item_async( + await client.patch_item( input=PatchItemInput(), dataset="default", table="accounts", @@ -545,11 +578,11 @@ async def test_post_item_success(self, mock_credential): body = PostItemInput() with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.post_item_async( + result = await client.post_item( input=body, dataset="default", table="accounts", @@ -568,12 +601,12 @@ async def test_post_item_error_response(self, mock_credential): mock_response = MockResponse(status=400, text="Bad request") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.post_item_async( + await client.post_item( input=PostItemInput(), dataset="default", table="accounts", @@ -592,11 +625,11 @@ async def test_get_data_sets_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"value": []}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.get_data_sets_async() + await resolve_generated_result(client.list_data_sets()) call_args = mock_send.call_args assert call_args[0][0] == "GET" @@ -609,12 +642,12 @@ async def test_get_data_sets_error_response(self, mock_credential): mock_response = MockResponse(status=500, text="Server error") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_data_sets_async() + await resolve_generated_result(client.list_data_sets()) assert exc_info.value.status_code == 500 @@ -629,11 +662,11 @@ async def test_get_metadata_for_patch_item_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"name": "accounts"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.get_metadata_for_patch_item_async(dataset="default", table="accounts") + await client.get_metadata_for_patch_item(dataset="default", table="accounts") call_args = mock_send.call_args assert call_args[0][0] == "GET" @@ -646,17 +679,17 @@ async def test_get_metadata_for_patch_item_success(self, mock_credential): async def test_get_metadata_for_patch_item_error_response(self, mock_credential): """Test that error response raises ConnectorException.""" client = _make_client(mock_credential) - mock_response = MockResponse(status=404, text="Not found") + mock_response = MockResponse(status=500, text="Server error") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_metadata_for_patch_item_async(dataset="default", table="accounts") + await client.get_metadata_for_patch_item(dataset="default", table="accounts") - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestGetMetadataForPostItem: @@ -669,11 +702,11 @@ async def test_get_metadata_for_post_item_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"name": "accounts"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.get_metadata_for_post_item_async(dataset="default", table="accounts") + await client.get_metadata_for_post_item(dataset="default", table="accounts") call_args = mock_send.call_args assert call_args[0][0] == "GET" @@ -686,17 +719,17 @@ async def test_get_metadata_for_post_item_success(self, mock_credential): async def test_get_metadata_for_post_item_error_response(self, mock_credential): """Test that error response raises ConnectorException.""" client = _make_client(mock_credential) - mock_response = MockResponse(status=404, text="Not found") + mock_response = MockResponse(status=500, text="Server error") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_metadata_for_post_item_async(dataset="default", table="accounts") + await client.get_metadata_for_post_item(dataset="default", table="accounts") - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestGetTable: @@ -709,11 +742,11 @@ async def test_get_table_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"name": "accounts"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.get_table_async(dataset="default", table="accounts") + result = await client.get_table(dataset="default", table="accounts") call_args = mock_send.call_args assert call_args[0][0] == "GET" @@ -727,12 +760,12 @@ async def test_get_table_error_response(self, mock_credential): mock_response = MockResponse(status=404, text="Not found") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_table_async(dataset="default", table="accounts") + await client.get_table(dataset="default", table="accounts") assert exc_info.value.status_code == 404 @@ -750,17 +783,19 @@ async def test_get_tables_success(self, mock_credential): ) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.get_tables_async(dataset="default") + result = await resolve_generated_result( + client.list_tables(dataset="default") + ) call_args = mock_send.call_args assert call_args[0][0] == "GET" assert call_args[0][1].endswith("/v2/datasets/default/tables") assert call_args.kwargs["body"] is None - assert result == {"value": [{"Name": "accounts"}]} + assert result == [{"Name": "accounts"}] @pytest.mark.asyncio async def test_get_tables_error_response(self, mock_credential): @@ -769,12 +804,14 @@ async def test_get_tables_error_response(self, mock_credential): mock_response = MockResponse(status=500, text="Server error") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_tables_async(dataset="default") + await resolve_generated_result( + client.list_tables(dataset="default") + ) assert exc_info.value.status_code == 500 @@ -789,11 +826,11 @@ async def test_get_data_sets_metadata_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"tabular": {}}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.get_data_sets_metadata_async() + result = await client.get_data_sets_metadata() call_args = mock_send.call_args assert call_args[0][0] == "GET" @@ -807,12 +844,12 @@ async def test_get_data_sets_metadata_error_response(self, mock_credential): mock_response = MockResponse(status=500, text="Server error") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_data_sets_metadata_async() + await client.get_data_sets_metadata() assert exc_info.value.status_code == 500 @@ -830,11 +867,11 @@ async def test_get_next_page_success(self, mock_credential): ) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.get_next_page_async(next_link="token123") + result = await client.get_next_page(next_link="token123") call_args = mock_send.call_args assert call_args[0][0] == "GET" @@ -854,11 +891,11 @@ async def test_get_next_page_empty_body_returns_none(self, mock_credential): mock_response = MockResponse(status=200, text="") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.get_next_page_async(next_link="token123") + result = await client.get_next_page(next_link="token123") assert result is None @@ -869,12 +906,12 @@ async def test_get_next_page_error_response(self, mock_credential): mock_response = MockResponse(status=404, text="Not found") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_next_page_async(next_link="token123") + await client.get_next_page(next_link="token123") assert exc_info.value.status_code == 404 @@ -889,11 +926,11 @@ async def test_associate_records_success(self, mock_credential): mock_response = MockResponse(status=200, text='{}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.associate_records_patch_item_async( + await client.associate_records_patch_item( AssociateRecordsPatchItemInput(), dataset="default", table="accounts", @@ -913,12 +950,12 @@ async def test_associate_records_error_response(self, mock_credential): mock_response = MockResponse(status=400, text="Bad request") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.associate_records_patch_item_async( + await client.associate_records_patch_item( AssociateRecordsPatchItemInput(), dataset="default", table="accounts", @@ -939,11 +976,11 @@ async def test_create_attachment_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"annotationid": "abc"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.create_attachment_async( + result = await client.create_attachment( b"file-bytes", dataset="default", table="accounts", @@ -968,12 +1005,12 @@ async def test_create_attachment_error_response(self, mock_credential): mock_response = MockResponse(status=403, text="Forbidden") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.create_attachment_async( + await client.create_attachment( b"file-bytes", dataset="default", table="accounts", @@ -994,12 +1031,14 @@ async def test_get_item_attachments_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"value": []}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.get_item_attachments_async( - dataset="default", table="accounts", id="1" + await resolve_generated_result( + client.list_item_attachments( + dataset="default", table="accounts", id="1" + ) ) call_args = mock_send.call_args @@ -1013,13 +1052,15 @@ async def test_get_item_attachments_error_response(self, mock_credential): mock_response = MockResponse(status=404, text="Not found") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_item_attachments_async( - dataset="default", table="accounts", id="1" + await resolve_generated_result( + client.list_item_attachments( + dataset="default", table="accounts", id="1" + ) ) assert exc_info.value.status_code == 404 @@ -1035,11 +1076,11 @@ async def test_get_attachment_content_success(self, mock_credential): mock_response = MockResponse(status=200, content=b"binary-data") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.get_attachment_content_async( + result = await client.get_attachment_content( dataset="default", table="accounts", id="1", attachment_id="att1" ) @@ -1055,12 +1096,12 @@ async def test_get_attachment_content_error_response(self, mock_credential): mock_response = MockResponse(status=404, text="Not found") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_attachment_content_async( + await client.get_attachment_content( dataset="default", table="accounts", id="1", attachment_id="att1" ) @@ -1077,11 +1118,11 @@ async def test_delete_attachment_success(self, mock_credential): mock_response = MockResponse(status=200, text="") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.delete_attachment_async( + await client.delete_attachment( dataset="default", table="accounts", id="1", attachment_id="att1" ) @@ -1093,19 +1134,19 @@ async def test_delete_attachment_success(self, mock_credential): async def test_delete_attachment_error_response(self, mock_credential): """Test that error response raises ConnectorException.""" client = _make_client(mock_credential) - mock_response = MockResponse(status=404, text="Not found") + mock_response = MockResponse(status=500, text="Server error") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.delete_attachment_async( + await client.delete_attachment( dataset="default", table="accounts", id="1", attachment_id="att1" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestDeleteItem: @@ -1118,11 +1159,11 @@ async def test_delete_item_success(self, mock_credential): mock_response = MockResponse(status=200, text="") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.delete_item_async(dataset="default", table="accounts", id="1") + await client.delete_item(dataset="default", table="accounts", id="1") call_args = mock_send.call_args assert call_args[0][0] == "DELETE" @@ -1132,19 +1173,19 @@ async def test_delete_item_success(self, mock_credential): async def test_delete_item_error_response(self, mock_credential): """Test that error response raises ConnectorException.""" client = _make_client(mock_credential) - mock_response = MockResponse(status=404, text="Not found") + mock_response = MockResponse(status=500, text="Server error") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.delete_item_async( + await client.delete_item( dataset="default", table="accounts", id="1" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestDisassociateRecordsPostItem: @@ -1157,11 +1198,11 @@ async def test_disassociate_records_success(self, mock_credential): mock_response = MockResponse(status=200, text='{}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.disassociate_records_post_item_async( + await client.disassociate_records_post_item( dataset="default", table="accounts", id="1", @@ -1181,12 +1222,12 @@ async def test_disassociate_records_error_response(self, mock_credential): mock_response = MockResponse(status=400, text="Bad request") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.disassociate_records_post_item_async( + await client.disassociate_records_post_item( dataset="default", table="accounts", id="1", @@ -1207,11 +1248,11 @@ async def test_disassociate_single_value_success(self, mock_credential): mock_response = MockResponse(status=200, text='{}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.disassociate_single_value_record_delete_item_async( + await client.disassociate_single_value_record_delete_item( dataset="default", table="accounts", id="1", @@ -1226,22 +1267,22 @@ async def test_disassociate_single_value_success(self, mock_credential): async def test_disassociate_single_value_error_response(self, mock_credential): """Test that error response raises ConnectorException.""" client = _make_client(mock_credential) - mock_response = MockResponse(status=404, text="Not found") + mock_response = MockResponse(status=500, text="Server error") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.disassociate_single_value_record_delete_item_async( + await client.disassociate_single_value_record_delete_item( dataset="default", table="accounts", id="1", relationship="primarycontactid", ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestGetCollectionRelationships: @@ -1254,17 +1295,19 @@ async def test_get_collection_relationships_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"value": []}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.get_collection_relationships_async( - dataset="default", - table="accounts", - id="1", - collection_type="onetomany", - relationship="account_tasks", - target="task", + await resolve_generated_result( + client.list_collection_relationships( + dataset="default", + table="accounts", + id="1", + collection_type="onetomany", + relationship="account_tasks", + target="task", + ) ) call_args = mock_send.call_args @@ -1279,18 +1322,20 @@ async def test_get_collection_relationships_error_response(self, mock_credential mock_response = MockResponse(status=404, text="Not found") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_collection_relationships_async( - dataset="default", - table="accounts", - id="1", - collection_type="onetomany", - relationship="account_tasks", - target="task", + await resolve_generated_result( + client.list_collection_relationships( + dataset="default", + table="accounts", + id="1", + collection_type="onetomany", + relationship="account_tasks", + target="task", + ) ) assert exc_info.value.status_code == 404 @@ -1306,11 +1351,11 @@ async def test_get_multi_select_metadata_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"name": "col"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.get_multi_select_metadata_async( + await client.get_multi_select_metadata( dataset="default", table="accounts", item="col" ) @@ -1325,12 +1370,12 @@ async def test_get_multi_select_metadata_error_response(self, mock_credential): mock_response = MockResponse(status=404, text="Not found") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_multi_select_metadata_async( + await client.get_multi_select_metadata( dataset="default", table="accounts", item="col" ) @@ -1347,11 +1392,11 @@ async def test_get_option_set_metadata_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"name": "col"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.get_option_set_metadata_async( + await client.get_option_set_metadata( dataset="default", table="accounts", item="col", type_="Picklist" ) @@ -1367,12 +1412,12 @@ async def test_get_option_set_metadata_error_response(self, mock_credential): mock_response = MockResponse(status=404, text="Not found") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_option_set_metadata_async( + await client.get_option_set_metadata( dataset="default", table="accounts", item="col", type_="Picklist" ) @@ -1397,11 +1442,11 @@ async def test_get_items_double_encodes_dataset_environment_url(self, mock_crede mock_response = MockResponse(status=200, text='{"value": []}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = client.get_items_async( + result = client.list_items( dataset="https://org12345.crm.dynamics.com", table="accounts", ) @@ -1424,11 +1469,11 @@ async def test_get_item_double_encodes_all_segments(self, mock_credential): mock_response = MockResponse(status=200, text='{"name": "row"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.get_item_async( + await client.get_item( dataset="https://org12345.crm.dynamics.com", table="my table", id="a/b", @@ -1452,11 +1497,11 @@ async def test_post_item_double_encodes_dataset_environment_url(self, mock_crede mock_response = MockResponse(status=200, text='{"accountid": "1"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.post_item_async( + await client.post_item( input=PostItemInput(additional_properties={"name": "Contoso"}), dataset="https://org12345.crm.dynamics.com", table="accounts", diff --git a/tests/test_documentdb.py b/tests/test_documentdb.py index 27dff784..9e7deff5 100644 --- a/tests/test_documentdb.py +++ b/tests/test_documentdb.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.documentdb import DocumentdbClient from azure.connectors.documentdb import ( - DocumentdbClient, PostDocumentsResponse, CreateStoredProcedureInput, CreateStoredProcedureResponse, @@ -75,7 +75,7 @@ def test_init_with_custom_settings(self, mock_credential): client = DocumentdbClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -146,11 +146,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.query_documents_async( + result = await resolve_generated_result(client.list_query_documents( cosmos_db_account_name="mycosmosdb", database_id="mydb", container_id="mycontainer" @@ -177,11 +177,11 @@ async def test_with_query_text(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.query_documents_async( + await resolve_generated_result(client.list_query_documents( cosmos_db_account_name="mycosmosdb", database_id="mydb", container_id="mycontainer", @@ -204,11 +204,11 @@ async def test_with_partition_key(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.query_documents_async( + await resolve_generated_result(client.list_query_documents( cosmos_db_account_name="mycosmosdb", database_id="mydb", container_id="mycontainer", @@ -220,8 +220,8 @@ async def test_with_partition_key(self, mock_credential): assert "partitionKey=region-1" in url @pytest.mark.asyncio - async def test_with_all_query_parameters(self, mock_credential): - """Test GET request with all query parameters.""" + async def test_with_public_query_parameters(self, mock_credential): + """Test GET request with public query parameters.""" client = DocumentdbClient( "https://example.azure.com/connections/test", credential=mock_credential @@ -234,18 +234,17 @@ async def test_with_all_query_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.query_documents_async( + await resolve_generated_result(client.list_query_documents( cosmos_db_account_name="mycosmosdb", database_id="mydb", container_id="mycontainer", query_text="SELECT * FROM c", partition_key="pk1", max_item_count="100", - continuation_token="abc123", consistency_level="Session", session_token="session-xyz" )) @@ -255,7 +254,7 @@ async def test_with_all_query_parameters(self, mock_credential): assert "queryText=" in url assert "partitionKey=pk1" in url assert "maxItemCount=100" in url - assert "continuationToken=abc123" in url + assert "continuationToken=" not in url assert "consistencyLevel=Session" in url assert "sessionToken=session-xyz" in url @@ -271,12 +270,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.query_documents_async( + await resolve_generated_result(client.list_query_documents( cosmos_db_account_name="mycosmosdb", database_id="mydb", container_id="nonexistent" @@ -296,11 +295,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await resolve_generated_result(client.query_documents_async( + result = await resolve_generated_result(client.list_query_documents( cosmos_db_account_name="mycosmosdb", database_id="mydb", container_id="mycontainer" @@ -319,12 +318,12 @@ async def test_unauthorized_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.query_documents_async( + await resolve_generated_result(client.list_query_documents( cosmos_db_account_name="mycosmosdb", database_id="mydb", container_id="mycontainer" @@ -333,6 +332,41 @@ async def test_unauthorized_raises_exception(self, mock_credential): assert exc_info.value.status_code == 401 +class TestListDocuments: + """Tests for list_documents collection selection.""" + + @pytest.mark.asyncio + async def test_ignores_auxiliary_metadata_array(self, mock_credential): + """Test the pager yields documents rather than auxiliary metadata.""" + client = DocumentdbClient( + "https://example.azure.com/connections/test", + credential=mock_credential, + ) + mock_response = MockResponse( + status=200, + text=( + '{"Documents": [{"id": "doc-1"}], ' + '"@metadata": [{"name": "classification"}]}' + ), + ) + + with patch.object( + client._http_client, + "send", + new_callable=AsyncMock, + return_value=mock_response, + ): + result = await resolve_generated_result( + client.list_documents( + cosmos_db_account_name="mycosmosdb", + database_id="mydb", + collection_id="mycollection", + ) + ) + + assert result == [{"id": "doc-1"}] + + class TestDataClasses: """Tests for data class creation and attributes.""" @@ -649,16 +683,16 @@ async def test_multiple_consecutive_calls(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.query_documents_async( + await resolve_generated_result(client.list_query_documents( cosmos_db_account_name="account1", database_id="db1", container_id="container1" )) - await resolve_generated_result(client.query_documents_async( + await resolve_generated_result(client.list_query_documents( cosmos_db_account_name="account2", database_id="db2", container_id="container2" @@ -678,11 +712,11 @@ async def test_special_characters_in_ids(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.query_documents_async( + await resolve_generated_result(client.list_query_documents( cosmos_db_account_name="my-cosmos-db", database_id="my-database", container_id="my-container" diff --git a/tests/test_docusign.py b/tests/test_docusign.py index 61ad5724..cc78cc0b 100644 --- a/tests/test_docusign.py +++ b/tests/test_docusign.py @@ -7,10 +7,10 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.docusign import DocusignClient from azure.connectors.docusign import ( AdditionalURLForSenderView, CombinedEmailBodyAndCustomFields, - DocusignClient, DynamicSigningUrlFields, DynamicSigners, UpdateDocgenFormFieldsInput, @@ -19,6 +19,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestDocusignClientInitialization: @@ -54,7 +55,7 @@ def test_init_with_custom_settings(self, mock_credential): client = DocusignClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -146,11 +147,11 @@ async def test_generate_embedded_sender_url_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.generate_embedded_sender_url_async( + result = await client.generate_embedded_sender_url( input=payload, account_id="acct-1", envelope_id="env-1", @@ -182,11 +183,11 @@ async def test_generate_embedded_signing_url_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.generate_embedded_signing_url_async( + result = await client.generate_embedded_signing_url( input=payload, account_id="acct-1", envelope_id="env-1", @@ -219,22 +220,24 @@ async def test_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"accounts": [{"accountId": "123"}]}') + mock_response = MockResponse( + status=200, + text='{"loginAccounts": [{"accountId": "123"}]}', + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_login_accounts_async() + result = await resolve_generated_result(client.list_login_accounts()) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert path.endswith("/oauth/userinfo") - assert result is not None - assert "accounts" in result + assert result == [{"accountId": "123"}] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -247,12 +250,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.get_login_accounts_async() + await resolve_generated_result(client.list_login_accounts()) class TestSearchListEnvelopesAsync: @@ -269,11 +272,11 @@ async def test_success_with_filters(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.search_list_envelopes_async( + result = await client.search_list_envelopes( account_id="acct-1", envelope_title="Quarterly Contract", top="5", @@ -300,12 +303,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.search_list_envelopes_async(account_id="acct-1") + await client.search_list_envelopes(account_id="acct-1") class TestCreateBlankEnvelopeAsync: @@ -323,11 +326,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_blank_envelope_async( + result = await client.create_blank_envelope( input=payload, account_id="acct-1", email_subject="Please sign", @@ -354,12 +357,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.create_blank_envelope_async( + await client.create_blank_envelope( input=payload, account_id="acct-1", email_subject="Please sign", @@ -381,11 +384,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.send_envelope_async( + result = await client.send_envelope( input=payload, account_id="acct-1", status="sent", @@ -415,12 +418,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.send_envelope_async( + await client.send_envelope( input=payload, account_id="acct-1", status="sent", @@ -444,11 +447,11 @@ async def test_success_sends_body_and_returns_result(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.update_docgen_form_fields_async( + await client.update_docgen_form_fields( input=payload, account_id="acct-1", envelope_id="env-1", @@ -474,12 +477,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.update_docgen_form_fields_async( + await client.update_docgen_form_fields( input=payload, account_id="acct-1", envelope_id="env-1", @@ -491,8 +494,8 @@ class TestRemoveRecipientFromEnvelopeAsync: """Tests for remove_recipient_from_envelope_async method (DELETE).""" @pytest.mark.asyncio - async def test_success_returns_result(self, mock_credential): - """Test successful DELETE returns response.""" + async def test_success_returns_declared_response(self, mock_credential): + """Test successful DELETE returns its declared response body.""" client = DocusignClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -501,11 +504,11 @@ async def test_success_returns_result(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.remove_recipient_from_envelope_async( + result = await client.remove_recipient_from_envelope( account_id="acct-1", envelope_id="env-1", folder_id=None, @@ -515,7 +518,7 @@ async def test_success_returns_result(self, mock_credential): mock_send.assert_called_once() method = mock_send.call_args[0][0] assert method == "DELETE" - assert result is not None + assert result == {"recipientsRemoved": True} @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -524,16 +527,16 @@ async def test_error_response_raises_exception(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=404, text='{"error": "Envelope not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.remove_recipient_from_envelope_async( + await client.remove_recipient_from_envelope( account_id="acct-1", envelope_id="missing-env", folder_id=None, diff --git a/tests/test_docuware.py b/tests/test_docuware.py index 5f3febe6..fede6d88 100644 --- a/tests/test_docuware.py +++ b/tests/test_docuware.py @@ -2,13 +2,15 @@ """Unit tests for DocuwareClient.""" +from collections.abc import Mapping +from typing import Any, get_args, get_origin, get_type_hints from unittest.mock import AsyncMock, patch import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.docuware import DocuwareClient from azure.connectors.docuware import ( - DocuwareClient, SearchForDocumentsInFileCabinetInput, UpdateIndexFieldsInput, ) @@ -16,6 +18,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestDocuwareClientInitialization: @@ -51,7 +54,7 @@ def test_init_with_custom_settings(self, mock_credential): client = DocuwareClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -118,11 +121,11 @@ async def test_success_sends_get(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_organization_async() + result = await client.get_organization() mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -143,12 +146,12 @@ async def test_error_response_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.get_organization_async() + await client.get_organization() assert exc_info.value.status_code == 401 @@ -167,11 +170,13 @@ async def test_success_appends_query_parameter(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_file_cabinets_async(file_cabinet_type="FileCabinet") + result = await resolve_generated_result( + client.list_file_cabinets(file_cabinet_type="FileCabinet") + ) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -184,6 +189,21 @@ async def test_success_appends_query_parameter(self, mock_credential): class TestSearchForDocumentsInFileCabinetAsync: """Tests for search_for_documents_in_file_cabinet_async (POST with body).""" + def test_input_annotation_accepts_model_or_mapping(self): + """Test dynamic search criteria support typed models and wire mappings.""" + input_annotation = get_type_hints( + DocuwareClient.search_for_documents_in_file_cabinet + )["input"] + annotation_members = get_args(input_annotation) + + assert SearchForDocumentsInFileCabinetInput in annotation_members + mapping_annotation = next( + member + for member in annotation_members + if get_origin(member) is Mapping + ) + assert get_args(mapping_annotation) == (str, Any) + @pytest.mark.asyncio async def test_success_forwards_request_body(self, mock_credential): """Test that the POST operation forwards the request body to send_async.""" @@ -196,11 +216,11 @@ async def test_success_forwards_request_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.search_for_documents_in_file_cabinet_async( + result = await client.search_for_documents_in_file_cabinet( input=request, file_cabinet="cabinet-1", search_dialog_id="dialog-1", @@ -227,12 +247,12 @@ async def test_error_response_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.search_for_documents_in_file_cabinet_async( + await client.search_for_documents_in_file_cabinet( input=request, file_cabinet="cabinet-1", search_dialog_id="dialog-1", @@ -256,11 +276,11 @@ async def test_success_forwards_request_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.update_index_fields_async( + await client.update_index_fields( input=request, file_cabinet_id="cabinet-1", document_id="document-1", @@ -284,11 +304,11 @@ async def test_success_sends_delete(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_document_async( + result = await client.delete_document( file_cabinet_id="cabinet-1", document_id="doc-1", ) @@ -306,21 +326,21 @@ async def test_error_response_raises_connector_exception(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=404, text="Not Found") + mock_response = MockResponse(status=500, text="Server error") with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_document_async( + await client.delete_document( file_cabinet_id="cabinet-1", document_id="doc-1", ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestDownloadFileAsync: @@ -337,11 +357,11 @@ async def test_success_returns_content_bytes(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.download_file_async( + result = await client.download_file( file_cabinet_id="cabinet-1", document_id="doc-1", file_number="1", @@ -362,7 +382,7 @@ async def test_success_returns_content_bytes(self, mock_credential): OPERATION_ARGS = { "get_organization": {}, - "get_file_cabinets": {"file_cabinet_type": None}, + "list_file_cabinets": {"file_cabinet_type": None}, "get_document_information": {"file_cabinet_id": "cabinet-1", "document_id": "doc-1"}, "delete_document": {"file_cabinet_id": "cabinet-1", "document_id": "doc-1"}, "download_file": { @@ -389,11 +409,11 @@ async def test_success_returns_content_bytes(self, mock_credential): }, "transfer_document": {"input": {}, "destination_file_cabinet_id": "cabinet-2"}, "place_a_stamp": {"input": {}, "file_cabinet_id": "cabinet-1", "document_id": "doc-1"}, - "get_dialogs": {"file_cabinet": "cabinet-1"}, - "get_dialog_fields": {"file_cabinet": "cabinet-1", "dialog_id": "dialog-1"}, - "get_stamps": {"file_cabinet": "cabinet-1"}, - "get_stamp_fields": {"file_cabinet": "cabinet-1", "stamp": "stamp-1"}, - "get_file_cabinet_fields": {"file_cabinet": "cabinet-1"}, + "list_dialogs": {"file_cabinet": "cabinet-1"}, + "list_dialog_fields": {"file_cabinet": "cabinet-1", "dialog_id": "dialog-1"}, + "list_stamps": {"file_cabinet": "cabinet-1"}, + "list_stamp_fields": {"file_cabinet": "cabinet-1", "stamp": "stamp-1"}, + "list_file_cabinet_fields": {"file_cabinet": "cabinet-1"}, } ALL_OPERATIONS = sorted(OPERATION_ARGS.keys()) @@ -401,8 +421,8 @@ async def test_success_returns_content_bytes(self, mock_credential): async def _invoke_operation(client: DocuwareClient, operation: str): """Invoke a DocuWare operation by name for shared method tests.""" - method = getattr(client, f"{operation}_async") - return await method(**OPERATION_ARGS[operation]) + method = getattr(client, f"{operation}") + return await resolve_generated_result(method(**OPERATION_ARGS[operation])) class TestDocuwareClientAllOperations: @@ -417,7 +437,7 @@ async def test_all_operations_success(self, mock_credential, operation): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: @@ -443,7 +463,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_dropbox.py b/tests/test_dropbox.py index 95f47776..9cf0d0db 100644 --- a/tests/test_dropbox.py +++ b/tests/test_dropbox.py @@ -6,50 +6,53 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.dropbox import DropboxClient from azure.connectors.dropbox import ( BlobMetadata, BlobMetadataPage, - DropboxClient, ) from azure.connectors.sdk import ( ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result async def _invoke_operation(client: DropboxClient, operation: str): """Invoke a Dropbox operation by name for shared parameterized tests.""" if operation == "get_file_metadata": - return await client.get_file_metadata_async(id="file123") + return await client.get_file_metadata(id="file123") if operation == "update_file": - return await client.update_file_async(input=b"updated content", id="file123") + return await client.update_file(input=b"updated content", id="file123") if operation == "delete_file": - return await client.delete_file_async(id="file123") + return await client.delete_file(id="file123") if operation == "get_file_metadata_by_path": - return await client.get_file_metadata_by_path_async(path="/Documents/file.txt") + return await client.get_file_metadata_by_path(path="/Documents/file.txt") if operation == "get_file_content_by_path": - return await client.get_file_content_by_path_async(path="/Documents/file.txt") + return await client.get_file_content_by_path(path="/Documents/file.txt") if operation == "get_file_content": - return await client.get_file_content_async(id="file123") + return await client.get_file_content(id="file123") if operation == "create_file": - return await client.create_file_async( + return await client.create_file( input=b"file content", folder_path="/Documents", name="created.txt", ) if operation == "copy_file": - return await client.copy_file_async( + return await client.copy_file( source="/Documents/source.txt", destination="/Documents/copy.txt", ) if operation == "list_folder": - return await client.list_folder_async(id="folder123") + return await resolve_generated_result(client.list_folder(id="folder123")) if operation == "list_root_folder": - return await client.list_root_folder_async() + return await resolve_generated_result(client.list_root_folder()) if operation == "extract_folder": - return await client.extract_folder_async( - source="/Documents/archive.zip", - destination="/Documents/extracted", + return await resolve_generated_result( + client.extract_folder( + source="/Documents/archive.zip", + destination="/Documents/extracted", + ) ) raise ValueError(f"Unsupported operation '{operation}'.") @@ -88,7 +91,7 @@ def test_init_with_custom_settings(self, mock_credential): client = DropboxClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -155,11 +158,11 @@ async def test_get_file_metadata_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_file_metadata_async(id="file123") + result = await client.get_file_metadata(id="file123") assert result["name"] == "doc.txt" call_args = mock_send.call_args @@ -177,11 +180,11 @@ async def test_get_file_content_by_path_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.get_file_content_by_path_async(path="/Documents/file.txt") + result = await client.get_file_content_by_path(path="/Documents/file.txt") assert result == b"dropbox file content" @@ -196,11 +199,11 @@ async def test_create_file_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_file_async( + result = await client.create_file( input=b"file content", folder_path="/Documents", name="created.txt", @@ -247,7 +250,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_dynamicsax.py b/tests/test_dynamicsax.py index c3b9a106..c52a2310 100644 --- a/tests/test_dynamicsax.py +++ b/tests/test_dynamicsax.py @@ -6,6 +6,7 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.dynamicsax import DynamicsaxClient from azure.connectors.dynamicsax import ( AxOnlineProcedureResult, BusinessEventSubscription, @@ -13,7 +14,6 @@ BusinessEventsList, DataSet, DataSetsList, - DynamicsaxClient, ExecuteProcedureInput, GetItemResponse, Item, @@ -31,7 +31,10 @@ ConnectorException, ) from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import ( + generated_pager_response_text, + resolve_generated_result, +) BASE_URL = "https://example.azure.com/connections/test" @@ -42,7 +45,7 @@ "dataset": "ds", "procedure": "proc", }, - "get_items": {"dataset": "ds", "table": "tbl"}, + "list_items": {"dataset": "ds", "table": "tbl"}, "post_item": { "input": PostItemInput(), "dataset": "ds", @@ -56,16 +59,16 @@ "table": "tbl", "id": "1", }, - "get_tables": {"dataset": "ds"}, - "get_data_sets": {}, - "get_business_event_categories": {"dataset": "ds"}, - "get_business_events": {"dataset": "ds", "businesseventcategory": "cat"}, - "get_legal_entities": { + "list_tables": {"dataset": "ds"}, + "list_data_sets": {}, + "list_business_event_categories": {"dataset": "ds"}, + "list_business_events": {"dataset": "ds", "businesseventcategory": "cat"}, + "list_legal_entities": { "dataset": "ds", "businesseventcategory": "cat", "businessevent": "evt", }, - "get_procedures": {"dataset": "ds"}, + "list_procedures": {"dataset": "ds"}, "get_procedure": {"dataset": "ds", "procedure": "proc"}, "get_table": {"dataset": "ds", "table": "tbl"}, } @@ -79,7 +82,7 @@ async def _invoke_operation(client: DynamicsaxClient, operation: str): """Invoke a Dynamics AX operation by name for shared parametrized tests.""" return await resolve_generated_result( - getattr(client, f"{operation}_async")(**OPERATION_ARGS[operation]) + getattr(client, f"{operation}")(**OPERATION_ARGS[operation]) ) @@ -116,7 +119,7 @@ def test_init_with_custom_settings(self, mock_credential): client = DynamicsaxClient( BASE_URL, credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -171,13 +174,13 @@ async def test_get_data_sets_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_data_sets_async() + result = await resolve_generated_result(client.list_data_sets()) - assert result["value"][0]["name"] == "instance-1" + assert result == [{"name": "instance-1"}] assert mock_send.call_args[0][0] == "GET" assert mock_send.call_args[0][1].endswith("/datasets") @@ -189,11 +192,11 @@ async def test_get_items_targets_items_endpoint(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await resolve_generated_result(client.get_items_async(dataset="ds", table="tbl")) + await resolve_generated_result(client.list_items(dataset="ds", table="tbl")) request_url = mock_send.call_args[0][1] assert "/datasets/ds/tables/tbl/items" in request_url @@ -206,11 +209,11 @@ async def test_get_items_appends_odata_query_params(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await resolve_generated_result(client.get_items_async( + await resolve_generated_result(client.list_items( dataset="ds", table="tbl", filter="Name eq 'x'", @@ -230,11 +233,11 @@ async def test_post_item_sends_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.post_item_async(input=item_input, dataset="ds", table="tbl") + result = await client.post_item(input=item_input, dataset="ds", table="tbl") assert result["id"] == "1" assert mock_send.call_args[0][0] == "POST" @@ -249,11 +252,11 @@ async def test_patch_item_sends_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.patch_item_async( + result = await client.patch_item( input=item_input, dataset="ds", table="tbl", @@ -272,11 +275,11 @@ async def test_delete_item_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_item_async(dataset="ds", table="tbl", id="1") + result = await client.delete_item(dataset="ds", table="tbl", id="1") assert result is None assert mock_send.call_args[0][0] == "DELETE" @@ -289,11 +292,11 @@ async def test_get_table_targets_metadata_endpoint(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.get_table_async(dataset="ds", table="tbl") + await client.get_table(dataset="ds", table="tbl") request_url = mock_send.call_args[0][1] assert "/$metadata.json/datasets/ds/tables/tbl" in request_url @@ -303,16 +306,17 @@ async def test_get_table_targets_metadata_endpoint(self, mock_credential): async def test_all_operations_success(self, mock_credential, operation): """Test every operation returns the expected success result.""" client = _make_client(credential=mock_credential) + method = getattr(client, operation) response_text = ( - '{"value":[{"value":"ok"}]}' - if operation == "get_items" + generated_pager_response_text(method) + if operation.startswith("list_") else '{"value":"ok"}' ) mock_response = MockResponse(status=200, text=response_text) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -320,8 +324,8 @@ async def test_all_operations_success(self, mock_credential, operation): if operation in NO_JSON_OPERATIONS: assert result is None - elif operation == "get_items": - assert result == [{"value": "ok"}] + elif operation.startswith("list_"): + assert result == [{"ok": True}] else: assert result == {"value": "ok"} @@ -334,7 +338,7 @@ async def test_no_json_operations_ignore_body(self, mock_credential, operation): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -359,7 +363,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -374,7 +378,9 @@ class TestDynamicsaxTypeSerialization: def test_dataclass_instances_initialize_expected_defaults(self): """Test generated dataclasses initialize with expected default values.""" - assert BusinessEventSubscription().notification_url is None + assert BusinessEventSubscription( + notification_url="https://example.com/callback" + ).notification_url == "https://example.com/callback" assert BusinessEventSubscriptionResponse().id is None assert ExecuteProcedureInput().additional_properties == {} assert AxOnlineProcedureResult().value is None diff --git a/tests/test_elfsquaddata.py b/tests/test_elfsquaddata.py index ea27bf89..65d3b94e 100644 --- a/tests/test_elfsquaddata.py +++ b/tests/test_elfsquaddata.py @@ -8,7 +8,8 @@ import pytest import azure.connectors.elfsquaddata as elfsquaddata_module -from azure.connectors.elfsquaddata import ElfsquaddataClient, TRIGGER_OPERATIONS +from azure.connectors.elfsquaddata import ElfsquaddataClient +from azure.connectors.elfsquaddata import TRIGGER_OPERATIONS from tests.conftest import MockResponse from tests.generated_connector_test_utils import ( GeneratedConnectorContractTests, @@ -20,7 +21,7 @@ "delete_entity_by_id": ("DELETE", False), **dict.fromkeys( [ - "get_entities", + "list_entities", "get_entity_by_id", "get_function_definition", "get_functions", @@ -68,11 +69,11 @@ async def test_get_entities_serializes_query_and_response( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"value": []}'), ) as mock_send: - result = await resolve_generated_result(client.get_entities_async( + result = await resolve_generated_result(client.list_entities( entity_name="products", top=10, select="id,name", @@ -109,7 +110,7 @@ async def test_get_entities_follows_odata_pages_and_terminates( ) as client: with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, side_effect=[ MockResponse(status=200, text=json.dumps({ @@ -123,7 +124,7 @@ async def test_get_entities_follows_odata_pages_and_terminates( ], ) as transport: entities = [ - entity async for entity in client.get_entities_async( + entity async for entity in client.list_entities( entity_name="products", top=10, ) @@ -155,12 +156,12 @@ async def test_get_entities_empty_response_is_a_single_request( ) as client: with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=status, text=body), ) as transport: entities = [ - entity async for entity in client.get_entities_async( + entity async for entity in client.list_entities( entity_name="products" ) ] diff --git a/tests/test_eventbrite.py b/tests/test_eventbrite.py index 546f553e..84e3d602 100644 --- a/tests/test_eventbrite.py +++ b/tests/test_eventbrite.py @@ -3,18 +3,19 @@ """Contract tests for EventbriteClient.""" import azure.connectors.eventbrite as eventbrite_module -from azure.connectors.eventbrite import EventbriteClient, TRIGGER_OPERATIONS +from azure.connectors.eventbrite import EventbriteClient +from azure.connectors.eventbrite import TRIGGER_OPERATIONS from tests.generated_connector_test_utils import GeneratedConnectorContractTests OPERATION_CONTRACTS = { "create_event": ("POST", False), "update_event": ("POST", False), - "get_organizations": ("GET", False), - "get_organizers": ("GET", False), - "get_my_venues": ("GET", False), - "get_categories": ("GET", False), - "get_organization_events": ("GET", False), + "list_organizations": ("GET", False), + "list_organizers": ("GET", False), + "list_my_venues": ("GET", False), + "list_categories": ("GET", False), + "list_organization_events": ("GET", False), } diff --git a/tests/test_eventhubs.py b/tests/test_eventhubs.py index 15397546..3cc83d09 100644 --- a/tests/test_eventhubs.py +++ b/tests/test_eventhubs.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.eventhubs import EventhubsClient from azure.connectors.eventhubs import ( - EventhubsClient, Event, SendEventsInput, ObjectEntity, @@ -18,6 +18,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestEventhubsClientInitialization: @@ -53,7 +54,7 @@ def test_init_with_custom_settings(self, mock_credential): client = EventhubsClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -125,11 +126,11 @@ async def test_generate_event_schema(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.generate_event_schema_async( + result = await client.generate_event_schema( content_type="application/json", content_schema="schema-1" ) @@ -159,11 +160,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.send_event_async( + await client.send_event( input=event_input, event_hub_name="myeventhub" ) @@ -189,11 +190,11 @@ async def test_with_partition_key(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.send_event_async( + await client.send_event( input=event_input, event_hub_name="myeventhub", partition_key="partition-1" @@ -216,12 +217,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.send_event_async( + await client.send_event( input=event_input, event_hub_name="myeventhub" ) @@ -248,11 +249,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.send_events_async( + await client.send_events( input=events_input, event_hub_name="myeventhub", partition_key="partition-1" @@ -276,11 +277,11 @@ async def test_with_partition_key(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.send_events_async( + await client.send_events( input=events_input, event_hub_name="myeventhub", partition_key="partition-2" @@ -304,12 +305,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.send_events_async( + await client.send_events( input=events_input, event_hub_name="myeventhub", partition_key="partition-1" @@ -428,12 +429,16 @@ async def test_multiple_consecutive_calls(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_partition_keys_async(event_hub_name="hub1") - await client.get_partition_keys_async(event_hub_name="hub2") + await resolve_generated_result( + client.list_partition_keys(event_hub_name="hub1") + ) + await resolve_generated_result( + client.list_partition_keys(event_hub_name="hub2") + ) assert mock_send.call_count == 2 @@ -449,12 +454,14 @@ async def test_special_characters_in_event_hub_name(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_partition_keys_async( - event_hub_name="my-event-hub" + await resolve_generated_result( + client.list_partition_keys( + event_hub_name="my-event-hub" + ) ) call_args = mock_send.call_args @@ -473,11 +480,11 @@ async def test_unauthorized_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_event_hubs_async() + await resolve_generated_result(client.list_event_hubs()) assert exc_info.value.status_code == 401 diff --git a/tests/test_excelonline.py b/tests/test_excelonline.py index f4df36ff..85b1375a 100644 --- a/tests/test_excelonline.py +++ b/tests/test_excelonline.py @@ -6,9 +6,9 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.excelonline import ExcelonlineClient from azure.connectors.excelonline import ( CreateWorksheetInput, - ExcelonlineClient, GetAllWorksheetsResponse, GetColumnsResponse, GetTablesResponse, @@ -28,27 +28,27 @@ async def _invoke_operation(client: ExcelonlineClient, operation: str): """Invoke an Excel Online operation by name for shared error tests.""" if operation == "create_table": - return await client.create_table_async( + return await client.create_table( input=TableToCreate(table_name="Table1", range="A1:B2"), drive="drive123", file="file123", ) if operation == "create_id_column": - return await client.create_id_column_async( + return await client.create_id_column( drive="drive123", file="file123", table="Table1", id_column="ID", ) - if operation == "get_items": - return await resolve_generated_result(client.get_items_async( + if operation == "list_items": + return await resolve_generated_result(client.list_items( drive="drive123", file="file123", table="Table1", top="10", )) if operation == "get_item": - return await client.get_item_async( + return await client.get_item( drive="drive123", file="file123", table="Table1", @@ -56,7 +56,7 @@ async def _invoke_operation(client: ExcelonlineClient, operation: str): id_column="ID", ) if operation == "delete_item": - return await client.delete_item_async( + return await client.delete_item( drive="drive123", file="file123", table="Table1", @@ -64,7 +64,7 @@ async def _invoke_operation(client: ExcelonlineClient, operation: str): id_column="ID", ) if operation == "patch_item": - return await client.patch_item_async( + return await client.patch_item( input=Item(dynamic_properties={"Name": "Updated"}), drive="drive123", file="file123", @@ -72,28 +72,34 @@ async def _invoke_operation(client: ExcelonlineClient, operation: str): id="row1", id_column="ID", ) - if operation == "get_all_worksheets": - return await client.get_all_worksheets_async(drive="drive123", file="file123") + if operation == "list_all_worksheets": + return await resolve_generated_result( + client.list_all_worksheets(drive="drive123", file="file123") + ) if operation == "create_worksheet": - return await client.create_worksheet_async( + return await client.create_worksheet( input=CreateWorksheetInput(name="Sheet2"), drive="drive123", file="file123", ) - if operation == "get_tables": - return await client.get_tables_async(drive="drive123", file="file123") + if operation == "list_tables": + return await resolve_generated_result( + client.list_tables(drive="drive123", file="file123") + ) if operation == "add_row": - return await client.add_row_async( + return await client.add_row( input=Item(dynamic_properties={"Name": "Item1", "Value": 100}), drive="drive123", file="file123", table="Table1", ) - if operation == "get_columns": - return await client.get_columns_async( - drive="drive123", - file="file123", - table="Table1", + if operation == "list_columns": + return await resolve_generated_result( + client.list_columns( + drive="drive123", + file="file123", + table="Table1", + ) ) raise ValueError(f"Unsupported operation '{operation}'.") @@ -132,7 +138,7 @@ def test_init_with_custom_settings(self, mock_credential): client = ExcelonlineClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -199,11 +205,11 @@ async def test_create_table_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_table_async( + result = await client.create_table( input=TableToCreate(table_name="Table1", range="A1:B2"), drive="drive123", file="file123", @@ -224,11 +230,11 @@ async def test_get_items_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await resolve_generated_result(client.get_items_async( + result = await resolve_generated_result(client.list_items( drive="drive123", file="file123", table="Table1", @@ -252,11 +258,11 @@ async def test_patch_item_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.patch_item_async( + result = await client.patch_item( input=Item(dynamic_properties={"Name": "Updated"}), drive="drive123", file="file123", @@ -270,8 +276,8 @@ async def test_patch_item_success(self, mock_credential): assert isinstance(mock_send.call_args.kwargs["body"], Item) @pytest.mark.asyncio - async def test_get_all_worksheets_success(self, mock_credential): - """Test get_all_worksheets_async uses codeless worksheets endpoint.""" + async def test_list_all_worksheets_success(self, mock_credential): + """Test list_all_worksheets uses codeless worksheets endpoint.""" client = ExcelonlineClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -280,13 +286,15 @@ async def test_get_all_worksheets_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_all_worksheets_async(drive="drive123", file="file123") + result = await resolve_generated_result( + client.list_all_worksheets(drive="drive123", file="file123") + ) - assert len(result["value"]) == 1 + assert result == [{"name": "Sheet1"}] assert "/workbook/worksheets" in mock_send.call_args[0][1] @pytest.mark.asyncio @@ -300,11 +308,11 @@ async def test_add_row_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.add_row_async( + result = await client.add_row( input=Item(dynamic_properties={"Name": "Item1"}), drive="drive123", file="file123", @@ -324,15 +332,15 @@ class TestExcelonlineClientErrorHandling: [ "create_table", "create_id_column", - "get_items", + "list_items", "get_item", "delete_item", "patch_item", - "get_all_worksheets", + "list_all_worksheets", "create_worksheet", - "get_tables", + "list_tables", "add_row", - "get_columns", + "list_columns", ], ) async def test_error_response_raises_exception_for_all_operations( @@ -349,7 +357,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_excelonlinebusiness.py b/tests/test_excelonlinebusiness.py index 3707bc70..86dc7ba4 100644 --- a/tests/test_excelonlinebusiness.py +++ b/tests/test_excelonlinebusiness.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.excelonlinebusiness import ExcelonlinebusinessClient from azure.connectors.excelonlinebusiness import ( - ExcelonlinebusinessClient, TableToCreate, TableMetadata, Item, @@ -24,7 +24,7 @@ ConnectorException, ) from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import model_instance, resolve_generated_result class TestExcelonlinebusinessClientInitialization: @@ -60,7 +60,7 @@ def test_init_with_custom_settings(self, mock_credential): client = ExcelonlinebusinessClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -136,11 +136,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_table_async( + result = await client.create_table( input=table_input, drive="drive-id", file="file-id", @@ -162,16 +162,16 @@ async def test_error_response_raises_exception(self, mock_credential): ) mock_response = MockResponse(status=400, text='{"error": "Invalid range"}') - table_input = TableToCreate(table_name="Table1") + table_input = model_instance(TableToCreate, table_name="Table1") with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_table_async( + await client.create_table( input=table_input, drive="drive-id", file="file-id", @@ -196,11 +196,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.create_id_column_async( + await client.create_id_column( drive="drive-id", file="file-id", table="Table1", @@ -225,12 +225,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_id_column_async( + await client.create_id_column( drive="drive-id", file="file-id", table="InvalidTable", @@ -259,11 +259,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.get_items_async( + result = await resolve_generated_result(client.list_items( drive="drive-id", file="file-id", table="Table1", @@ -288,11 +288,11 @@ async def test_with_query_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.get_items_async( + await resolve_generated_result(client.list_items( drive="drive-id", file="file-id", table="Table1", @@ -322,12 +322,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.get_items_async( + await resolve_generated_result(client.list_items( drive="drive-id", file="file-id", table="NonexistentTable", @@ -337,8 +337,8 @@ async def test_error_response_raises_exception(self, mock_credential): assert exc_info.value.status_code == 404 -class TestGetComments: - """Tests for get_comments_async method.""" +class TestListComments: + """Tests for list_comments method.""" @pytest.mark.asyncio async def test_success_with_json_response(self, mock_credential): @@ -355,20 +355,22 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_comments_async( - drive="drive-id", - file="file-id" + result = await resolve_generated_result( + client.list_comments( + drive="drive-id", + file="file-id" + ) ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/workbook/comments" in call_args[0][1] - assert result["value"][0]["id"] == "comment1" + assert result[0]["id"] == "comment1" @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -382,14 +384,16 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_comments_async( - drive="drive-id", - file="nonexistent-file" + await resolve_generated_result( + client.list_comments( + drive="drive-id", + file="nonexistent-file" + ) ) assert exc_info.value.status_code == 404 @@ -413,11 +417,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_comment_async( + result = await client.get_comment( drive="drive-id", file="file-id", commentid="comment1" @@ -441,12 +445,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_comment_async( + await client.get_comment( drive="drive-id", file="file-id", commentid="nonexistent" @@ -477,11 +481,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.reply_comment_async( + result = await client.reply_comment( input=comment_details, drive="drive-id", file="file-id", @@ -507,12 +511,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.reply_comment_async( + await client.reply_comment( input=comment_details, drive="drive-id", file="file-id", @@ -540,11 +544,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_item_async( + result = await client.get_item( drive="drive-id", file="file-id", table="Table1", @@ -567,16 +571,16 @@ async def test_error_response_raises_exception(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(status=404, text='{"error": "Row not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_item_async( + await client.get_item( drive="drive-id", file="file-id", table="Table1", @@ -585,7 +589,7 @@ async def test_error_response_raises_exception(self, mock_credential): id_column="ID" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestDeleteItem: @@ -603,11 +607,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_item_async( + await client.delete_item( drive="drive-id", file="file-id", table="Table1", @@ -629,16 +633,16 @@ async def test_error_response_raises_exception(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(status=404, text='{"error": "Row not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_item_async( + await client.delete_item( drive="drive-id", file="file-id", table="Table1", @@ -647,7 +651,7 @@ async def test_error_response_raises_exception(self, mock_credential): id_column="ID" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestPatchItem: @@ -669,11 +673,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.patch_item_async( + result = await client.patch_item( input=item_input, drive="drive-id", file="file-id", @@ -702,12 +706,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.patch_item_async( + await client.patch_item( input=item_input, drive="drive-id", file="file-id", @@ -741,11 +745,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.run_script_prod_async( + result = await client.run_script_prod( input=script_input, drive="drive-id", file="file-id", @@ -774,12 +778,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.run_script_prod_async( + await client.run_script_prod( input=script_input, drive="drive-id", file="file-id", @@ -793,7 +797,7 @@ async def test_error_response_raises_exception(self, mock_credential): class TestGetAllWorksheets: - """Tests for get_all_worksheets_async method.""" + """Tests for list_all_worksheets method.""" @pytest.mark.asyncio async def test_success_with_json_response(self, mock_credential): @@ -810,21 +814,23 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_all_worksheets_async( - drive="drive-id", - file="file-id", - source="me" + result = await resolve_generated_result( + client.list_all_worksheets( + drive="drive-id", + file="file-id", + source="me" + ) ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/worksheets" in call_args[0][1] - assert result["value"][0]["name"] == "Sheet1" + assert result[0]["name"] == "Sheet1" @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -838,15 +844,17 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_all_worksheets_async( - drive="drive-id", - file="nonexistent", - source="me" + await resolve_generated_result( + client.list_all_worksheets( + drive="drive-id", + file="nonexistent", + source="me" + ) ) assert exc_info.value.status_code == 404 @@ -871,11 +879,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_worksheet_async( + result = await client.create_worksheet( input=worksheet_input, drive="drive-id", file="file-id", @@ -901,12 +909,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_worksheet_async( + await client.create_worksheet( input=worksheet_input, drive="drive-id", file="file-id", @@ -917,7 +925,7 @@ async def test_error_response_raises_exception(self, mock_credential): class TestGetTables: - """Tests for get_tables_async method.""" + """Tests for list_tables method.""" @pytest.mark.asyncio async def test_success_with_json_response(self, mock_credential): @@ -934,21 +942,23 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_tables_async( - drive="drive-id", - file="file-id", - source="me" + result = await resolve_generated_result( + client.list_tables( + drive="drive-id", + file="file-id", + source="me" + ) ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/tables" in call_args[0][1] - assert len(result["value"]) == 2 + assert len(result) == 2 @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -962,15 +972,17 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_tables_async( - drive="drive-id", - file="nonexistent", - source="me" + await resolve_generated_result( + client.list_tables( + drive="drive-id", + file="nonexistent", + source="me" + ) ) assert exc_info.value.status_code == 404 @@ -995,11 +1007,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.add_row_async( + result = await client.add_row( input=item_input, drive="drive-id", file="file-id", @@ -1026,12 +1038,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.add_row_async( + await client.add_row( input=item_input, drive="drive-id", file="file-id", @@ -1201,11 +1213,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await resolve_generated_result(client.get_items_async( + result = await resolve_generated_result(client.list_items( drive="drive-id", file="file-id", table="Table1", @@ -1225,17 +1237,17 @@ async def test_multiple_consecutive_calls(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.get_items_async( + await resolve_generated_result(client.list_items( drive="drive1", file="file1", table="Table1", source="me" )) - await resolve_generated_result(client.get_items_async( + await resolve_generated_result(client.list_items( drive="drive2", file="file2", table="Table2", diff --git a/tests/test_formstackforms.py b/tests/test_formstackforms.py index 0342c2ac..41e047de 100644 --- a/tests/test_formstackforms.py +++ b/tests/test_formstackforms.py @@ -3,7 +3,8 @@ """Contract tests for FormstackformsClient.""" import azure.connectors.formstackforms as formstackforms_module -from azure.connectors.formstackforms import FormstackformsClient, TRIGGER_OPERATIONS +from azure.connectors.formstackforms import FormstackformsClient +from azure.connectors.formstackforms import TRIGGER_OPERATIONS from tests.generated_connector_test_utils import GeneratedConnectorContractTests diff --git a/tests/test_freshservice.py b/tests/test_freshservice.py index c55c15f8..fea0a9f0 100644 --- a/tests/test_freshservice.py +++ b/tests/test_freshservice.py @@ -8,12 +8,12 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.freshservice import FreshserviceClient from azure.connectors.freshservice import ( AddNoteRequest, AddNoteResponse, CreateTicketRequest, CreateUpdateTicketResponse, - FreshserviceClient, ListTicketResponse, ListUsersResponse, TicketResponse, @@ -25,16 +25,20 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import model_instance async def _invoke_operation(client: FreshserviceClient, operation: str): """Invoke a Freshservice operation by name for shared tests.""" if operation == "add_note": - return await client.add_note_async(input=AddNoteRequest(), ticket_id="1") + return await client.add_note( + input=model_instance(AddNoteRequest), + ticket_id="1", + ) if operation == "create_ticket": - return await client.create_ticket_async(input=CreateTicketRequest()) + return await client.create_ticket(input=model_instance(CreateTicketRequest)) if operation == "update_ticket": - return await client.update_ticket_async(input=UpdateTicketRequest(), ticket_id="1") + return await client.update_ticket(input=UpdateTicketRequest(), ticket_id="1") raise ValueError(f"Unsupported operation '{operation}'.") @@ -79,7 +83,7 @@ def test_init_with_custom_settings(self, mock_credential): client = FreshserviceClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -146,11 +150,13 @@ async def test_create_ticket_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_ticket_async(input=CreateTicketRequest()) + result = await client.create_ticket( + input=model_instance(CreateTicketRequest) + ) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -169,11 +175,11 @@ async def test_update_ticket_success_targets_resource(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.update_ticket_async(input=UpdateTicketRequest(), ticket_id="5") + result = await client.update_ticket(input=UpdateTicketRequest(), ticket_id="5") method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "PUT" @@ -192,11 +198,14 @@ async def test_add_note_success_targets_notes(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.add_note_async(input=AddNoteRequest(), ticket_id="7") + result = await client.add_note( + input=model_instance(AddNoteRequest), + ticket_id="7", + ) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -215,11 +224,13 @@ async def test_empty_response_body_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.create_ticket_async(input=CreateTicketRequest()) + result = await client.create_ticket( + input=model_instance(CreateTicketRequest) + ) assert result is None @@ -243,7 +254,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -292,7 +303,12 @@ def test_response_dataclasses_initialize_expected_defaults(self): assert get_origin(ListUsersResponse) is list def test_request_dataclasses_instantiate(self): - """Test generated request dataclasses instantiate without arguments.""" - assert CreateTicketRequest().email is None + """Test generated request dataclasses honor required and optional fields.""" + create_ticket = model_instance(CreateTicketRequest) + add_note = model_instance(AddNoteRequest) + + assert create_ticket.subject == "value" + assert create_ticket.email is None assert UpdateTicketRequest().priority is None - assert AddNoteRequest().body is None + assert add_note.body == "value" + assert add_note.private is None diff --git a/tests/test_ftp.py b/tests/test_ftp.py index 4f71f4e1..01f56828 100644 --- a/tests/test_ftp.py +++ b/tests/test_ftp.py @@ -6,53 +6,56 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.ftp import FtpClient from azure.connectors.ftp import ( BlobMetadata, BlobMetadataPage, - FtpClient, ) from azure.connectors.sdk import ( ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result async def _invoke_operation(client: FtpClient, operation: str): """Invoke an FTP operation by name for shared error tests.""" if operation == "create_file": - return await client.create_file_async( + return await client.create_file( input=b"file content", folder_path="/inbound", name="sample.txt", ) if operation == "get_file_metadata": - return await client.get_file_metadata_async(id="file123") + return await client.get_file_metadata(id="file123") if operation == "update_file": - return await client.update_file_async(input=b"updated content", id="file123") + return await client.update_file(input=b"updated content", id="file123") if operation == "delete_file": - return await client.delete_file_async(id="file123") + return await client.delete_file(id="file123") if operation == "copy_file": - return await client.copy_file_async( + return await client.copy_file( source="/inbound/sample.txt", destination="/archive/sample.txt", overwrite="true", ) if operation == "get_file_metadata_by_path": - return await client.get_file_metadata_by_path_async(path="/inbound/sample.txt") + return await client.get_file_metadata_by_path(path="/inbound/sample.txt") if operation == "get_file_content_by_path": - return await client.get_file_content_by_path_async(path="/inbound/sample.txt") + return await client.get_file_content_by_path(path="/inbound/sample.txt") if operation == "get_file_content": - return await client.get_file_content_async(id="file123") + return await client.get_file_content(id="file123") if operation == "list_folder": - return await client.list_folder_async(id="folder123") + return await resolve_generated_result(client.list_folder(id="folder123")) if operation == "list_root_folder": - return await client.list_root_folder_async() + return await resolve_generated_result(client.list_root_folder()) if operation == "extract_folder": - return await client.extract_folder_async( - source="/inbound/archive.zip", - destination="/expanded", - overwrite="true", - create_folders="true", + return await resolve_generated_result( + client.extract_folder( + source="/inbound/archive.zip", + destination="/expanded", + overwrite=True, + create_folders=True, + ) ) raise ValueError(f"Unsupported operation '{operation}'.") @@ -91,7 +94,7 @@ def test_init_with_custom_settings(self, mock_credential): client = FtpClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -149,7 +152,7 @@ class TestFtpClientMethods: @pytest.mark.asyncio async def test_create_file_success(self, mock_credential): - """Test create_file_async sends query parameters and body.""" + """Test create_file sends query parameters and body.""" client = FtpClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -158,11 +161,11 @@ async def test_create_file_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_file_async( + result = await client.create_file( input=b"file content", folder_path="/inbound", name="sample.txt", @@ -176,7 +179,7 @@ async def test_create_file_success(self, mock_credential): @pytest.mark.asyncio async def test_get_file_metadata_success(self, mock_credential): - """Test get_file_metadata_async returns parsed JSON.""" + """Test get_file_metadata returns parsed JSON.""" client = FtpClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -185,18 +188,18 @@ async def test_get_file_metadata_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_file_metadata_async(id="file123") + result = await client.get_file_metadata(id="file123") assert result["name"] == "sample.txt" assert "/datasets/default/files/file123" in mock_send.call_args[0][1] @pytest.mark.asyncio async def test_get_file_content_by_path_success(self, mock_credential): - """Test get_file_content_by_path_async returns bytes content.""" + """Test get_file_content_by_path returns bytes content.""" client = FtpClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -205,60 +208,62 @@ async def test_get_file_content_by_path_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.get_file_content_by_path_async(path="/inbound/sample.txt") + result = await client.get_file_content_by_path(path="/inbound/sample.txt") assert result == b"ftp file content" @pytest.mark.asyncio async def test_list_root_folder_success(self, mock_credential): - """Test list_root_folder_async returns parsed JSON response.""" + """Test list_root_folder returns parsed JSON response.""" client = FtpClient( "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"value":[{"name":"inbound"}]}') + mock_response = MockResponse(status=200, text='[{"name":"inbound"}]') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.list_root_folder_async() + result = await resolve_generated_result(client.list_root_folder()) - assert len(result["value"]) == 1 - assert result["value"][0]["name"] == "inbound" + assert len(result) == 1 + assert result[0]["name"] == "inbound" @pytest.mark.asyncio async def test_extract_folder_success(self, mock_credential): - """Test extract_folder_async serializes extraction query parameters.""" + """Test extract_folder serializes extraction query parameters.""" client = FtpClient( "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"status":"ok"}') + mock_response = MockResponse(status=200, text='[{"status":"ok"}]') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.extract_folder_async( - source="/inbound/archive.zip", - destination="/expanded", - overwrite="true", - create_folders="true", + result = await resolve_generated_result( + client.extract_folder( + source="/inbound/archive.zip", + destination="/expanded", + overwrite=True, + create_folders=True, + ) ) call_path = mock_send.call_args[0][1] assert "source=%2Finbound%2Farchive.zip" in call_path assert "destination=%2Fexpanded" in call_path - assert result["status"] == "ok" + assert result[0]["status"] == "ok" class TestFtpClientErrorHandling: @@ -295,7 +300,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_generated_catalog_contract.py b/tests/test_generated_catalog_contract.py index a07966f4..e6a90071 100644 --- a/tests/test_generated_catalog_contract.py +++ b/tests/test_generated_catalog_contract.py @@ -8,16 +8,29 @@ import inspect from pathlib import Path from types import ModuleType -from typing import Any, get_type_hints +from typing import Any, get_args, get_origin, get_type_hints from unittest.mock import AsyncMock, MagicMock, patch import pytest +from azure.core.async_paging import AsyncItemPaged +from azure.core.credentials import AzureKeyCredential +from azure.core.credentials_async import AsyncTokenCredential +from azure.core.paging import ItemPaged +from azure.core.pipeline.transport import AsyncHttpTransport +from azure.core.polling import AsyncLROPoller, LROPoller import azure.connectors as connectors_package -from azure.connectors.sdk import ConnectorClientBase, ConnectorException +import azure.connectors.sdk as sdk_package +from azure.connectors.sdk import ( + ConnectorClientBase, + ConnectorException, + ConnectorHttpClient, + ConnectorPollingMethod, +) from azure.connectors.sdk.serialization import to_wire from tests.conftest import MockResponse from tests.generated_connector_test_utils import ( + generated_pager_response_text, get_generated_operations, invoke_generated_operation, ) @@ -27,7 +40,54 @@ CONNECTOR_MODULE_NAMES = [ path.stem for path in sorted(Path(connectors_package.__file__).parent.glob("*.py")) - if path.name != "__init__.py" + if not path.name.startswith("_") +] + +SHARED_PACKAGE_EXPORT_NAMES = { + "ConnectorClientBase", + "ConnectorException", + "ConnectorHttpClient", + "ConnectorResponse", + "ConnectorResponseHook", + "ConnectorResponseSnapshot", + "TriggerCallbackBody", + "TriggerCallbackPayload", +} + +PRIMITIVE_STRING_PAGER_OPERATIONS = [ + ("azuread", "list_member_groups"), + ("eventhubs", "list_consumer_groups"), + ("eventhubs", "list_content_types"), + ("eventhubs", "list_event_hubs"), + ("eventhubs", "list_partition_keys"), + ("meetingroommap", "list_categories"), + ("msgraphgroupsanduser", "list_member_groups"), + ("onedrive", "list_file_tags"), + ("servicebus", "list_queues"), + ("servicebus", "list_session_options"), + ("servicebus", "list_subscriptions"), + ("servicebus", "list_system_properties"), + ("servicebus", "list_topics"), +] + +EAGER_MUTATION_OPERATIONS = [ + ("azuread", "check_member_groups"), + ("docusign", "add_recipient_tabs"), + ("mq", "delete_all"), + ("mq", "read_all"), + ("mq", "receive_all"), + ("onedrive", "add_file_tag"), + ("powerbi", "execute_dataset_query"), + ("replicon", "bulk_get_project_details3"), + ("replicon", "bulk_get_time_entered_summary"), + ("replicon", "create_task_hierarchy_or_apply_modifications"), + ("sendgrid", "add_global_suppression"), + ("yammer", "post_message"), +] + +NOT_FOUND_CONTRACT_OPERATIONS = [ + ("arm", "deployments_delete", "DELETE", True), + ("zohosign", "delete_document", "PUT", False), ] @@ -46,11 +106,190 @@ def get_generated_client_type(connector_module: ModuleType) -> type[Any]: return client_types[0] +def test_package_exports_use_only_the_async_root_runtime() -> None: + """Expose one async runtime without sync or aio namespace duplicates.""" + connector_directory = Path(connectors_package.__file__).parent + assert len(CONNECTOR_MODULE_NAMES) == 99 + for directory in ( + connector_directory, + connector_directory / "sdk", + ): + for namespace in ("aio", "sync"): + assert not (directory / namespace).exists() + assert not (directory / f"{namespace}.py").exists() + + assert SHARED_PACKAGE_EXPORT_NAMES <= set(connectors_package.__all__) + assert SHARED_PACKAGE_EXPORT_NAMES <= set(sdk_package.__all__) + for name in SHARED_PACKAGE_EXPORT_NAMES: + assert getattr(connectors_package, name) is getattr(sdk_package, name) + + client_names = set(connectors_package.CLIENT_REGISTRY) + assert len(client_names) == len(CONNECTOR_MODULE_NAMES) + assert client_names <= set(connectors_package.__all__) + assert client_names <= set(dir(connectors_package)) + for client_name, module_name in connectors_package.CLIENT_REGISTRY.items(): + connector_module = importlib.import_module(f"azure.connectors.{module_name}") + assert getattr(connectors_package, client_name) is get_generated_client_type( + connector_module + ) + + for runtime_type in (ConnectorClientBase, ConnectorHttpClient): + hints = get_type_hints(runtime_type.__init__) + assert set(get_args(hints["credential"])) == { + AsyncTokenCredential, AzureKeyCredential, + } + assert set(get_args(hints["transport"])) == { + AsyncHttpTransport, type(None), + } + assert inspect.iscoroutinefunction(runtime_type.close) + assert not hasattr(runtime_type, "__enter__") + assert not hasattr(runtime_type, "__exit__") + + assert inspect.iscoroutinefunction(ConnectorClientBase.__aenter__) + assert inspect.iscoroutinefunction(ConnectorClientBase.__aexit__) + assert inspect.iscoroutinefunction(ConnectorHttpClient.send) + assert inspect.iscoroutinefunction(ConnectorPollingMethod.run) + assert "ConnectorPollingMethod" in sdk_package.__all__ + + +def test_root_client_exports_load_lazily_and_cache_identity( + monkeypatch: pytest.MonkeyPatch, +) -> None: + """Resolve a root export once without relying on global test import order.""" + client_name, module_name = next(iter(connectors_package.CLIENT_REGISTRY.items())) + monkeypatch.delattr(connectors_package, client_name, raising=False) + assert client_name not in vars(connectors_package) + + with patch.object( + connectors_package, "import_module", wraps=connectors_package.import_module, + ) as import_module: + client_type = getattr(connectors_package, client_name) + assert getattr(connectors_package, client_name) is client_type + + import_module.assert_called_once_with(f".{module_name}", "azure.connectors") + + +@pytest.mark.parametrize("module_name", CONNECTOR_MODULE_NAMES) +def test_generated_root_operations_are_async_only(module_name: str) -> None: + """Keep only lazy async pagers and awaited operations on root clients.""" + connector_module = importlib.import_module(f"azure.connectors.{module_name}") + client_type = get_generated_client_type(connector_module) + hints = get_type_hints(client_type.__init__, globalns=vars(connector_module)) + assert set(get_args(hints["credential"])) == { + AsyncTokenCredential, AzureKeyCredential, + } + assert set(get_args(hints["transport"])) == { + AsyncHttpTransport, type(None), + } + operations = get_generated_operations(client_type) + assert operations, module_name + assert not any(name.endswith("_async") for name in operations), module_name + for operation in operations: + method = getattr(client_type, operation) + return_type = get_type_hints(method, globalns=vars(connector_module))["return"] + origin = get_origin(return_type) + assert origin not in {ItemPaged, LROPoller}, operation + assert inspect.iscoroutinefunction(method) is (origin is not AsyncItemPaged), operation + if operation.startswith("begin_"): + assert origin is AsyncLROPoller, operation + assert operation.removeprefix("begin_") not in operations, operation + else: + assert origin is not AsyncLROPoller, operation + + +@pytest.mark.parametrize( + ("module_name", "operation_name"), + PRIMITIVE_STRING_PAGER_OPERATIONS, +) +def test_primitive_string_collections_use_typed_pagers( + module_name: str, + operation_name: str, +) -> None: + """Preserve primitive item types in generated pager annotations.""" + connector_module = importlib.import_module(f"azure.connectors.{module_name}") + client_type = get_generated_client_type(connector_module) + return_type = get_type_hints( + getattr(client_type, operation_name), + globalns=vars(connector_module), + )["return"] + + assert get_origin(return_type) is AsyncItemPaged + assert get_args(return_type) == (str,) + + +@pytest.mark.parametrize( + ("module_name", "operation_name"), + EAGER_MUTATION_OPERATIONS, +) +def test_mutation_collection_responses_remain_eager( + module_name: str, + operation_name: str, +) -> None: + """Keep bounded mutation responses out of the lazy paging contract.""" + connector_module = importlib.import_module(f"azure.connectors.{module_name}") + client_type = get_generated_client_type(connector_module) + return_type = get_type_hints( + getattr(client_type, operation_name), + globalns=vars(connector_module), + )["return"] + + assert get_origin(return_type) not in {ItemPaged, AsyncItemPaged} + assert inspect.iscoroutinefunction(getattr(client_type, operation_name)) + + +@pytest.mark.parametrize( + ( + "module_name", + "operation_name", + "expected_method", + "accepts_not_found", + ), + NOT_FOUND_CONTRACT_OPERATIONS, +) +@pytest.mark.asyncio +async def test_not_found_contract_follows_http_method( + module_name: str, + operation_name: str, + expected_method: str, + accepts_not_found: bool, +) -> None: + """Apply idempotent HTTP 404 handling only to DELETE requests.""" + connector_module = importlib.import_module(f"azure.connectors.{module_name}") + client_type = get_generated_client_type(connector_module) + client = client_type( + "https://example.azure.com/connections/test", + credential=AzureKeyCredential("test-key"), + ) + + with patch.object( + client._http_client, + "send", + new_callable=AsyncMock, + return_value=MockResponse(status=404, text="not found"), + ) as mock_send: + if accepts_not_found: + result = await invoke_generated_operation( + client, + operation_name, + connector_module, + ) + assert result is None + else: + with pytest.raises(ConnectorException): + await invoke_generated_operation( + client, + operation_name, + connector_module, + ) + + assert mock_send.call_args.args[0] == expected_method + mock_send.assert_awaited_once() + + @pytest.mark.parametrize("module_name", CONNECTOR_MODULE_NAMES) @pytest.mark.asyncio async def test_all_generated_operations_succeed_with_request_controls( module_name: str, - mock_credential: Any, ) -> None: """Exercise every generated operation's successful request contract.""" connector_module = importlib.import_module(f"azure.connectors.{module_name}") @@ -59,18 +298,27 @@ async def test_all_generated_operations_succeed_with_request_controls( for operation in sorted(get_generated_operations(client_type)): client = client_type( "https://example.azure.com/connections/test", - credential=mock_credential, + credential=AzureKeyCredential("test-key"), ) - generated_method = getattr(client, f"{operation}_async") - is_pageable = inspect.isasyncgenfunction(generated_method) - response_text = ( - '{"value": [{"ok": true}]}' if is_pageable else '{"ok": true}' + generated_method = getattr(client, operation) + return_type = get_type_hints( + generated_method, + globalns=vars(connector_module), + )["return"] + is_pageable = get_origin(return_type) is AsyncItemPaged + result_type = ( + get_args(return_type)[0] + if get_origin(return_type) is AsyncLROPoller + else return_type ) + response_text = '{"ok": true}' + if is_pageable: + response_text = generated_pager_response_text(generated_method) response_hook = MagicMock() with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text=response_text), ) as mock_send: @@ -87,8 +335,8 @@ async def test_all_generated_operations_succeed_with_request_controls( }, ) - assert mock_send.call_count >= 1, operation - for call in mock_send.call_args_list: + assert mock_send.await_count == mock_send.call_count == 1, operation + for call in mock_send.await_args_list: method, request_url = call.args[:2] assert method, operation assert request_url.startswith( @@ -96,23 +344,22 @@ async def test_all_generated_operations_succeed_with_request_controls( ), operation assert "{" not in request_url and "}" not in request_url, operation assert call.kwargs["timeout"] == 5.0, operation - assert call.kwargs["headers"] == {"x-test": "value"}, operation + expected_headers = {"x-test": "value"} + if "match_condition" in inspect.signature(generated_method).parameters: + expected_headers["If-Match"] = "*" + assert call.kwargs["headers"] == expected_headers, operation assert call.kwargs["client_request_id"] == "request-id", operation assert call.kwargs["response_hook"] is response_hook, operation body = call.kwargs["body"] if body is not None: - assert to_wire(body), operation + assert to_wire(body) is not None, operation - return_type = get_type_hints( - generated_method, - globalns=vars(connector_module), - )["return"] - if return_type is type(None): + if result_type is type(None): assert result is None, operation elif is_pageable: assert result == [{"ok": True}], operation - elif return_type is bytes: + elif result_type is bytes: assert result == b'{"ok": true}', operation else: assert result == {"ok": True}, operation @@ -122,7 +369,6 @@ async def test_all_generated_operations_succeed_with_request_controls( @pytest.mark.asyncio async def test_all_generated_operations_reject_error_responses( module_name: str, - mock_credential: Any, ) -> None: """Verify every generated operation raises for a non-success response.""" connector_module = importlib.import_module(f"azure.connectors.{module_name}") @@ -131,19 +377,20 @@ async def test_all_generated_operations_reject_error_responses( for operation in sorted(get_generated_operations(client_type)): client = client_type( "https://example.azure.com/connections/test", - credential=mock_credential, + credential=AzureKeyCredential("test-key"), ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=400, text="bad request"), - ): - with pytest.raises(ConnectorException): - await invoke_generated_operation( - client, - operation, - connector_module, - include_optional_parameters=True, - ) + ) as mock_send, pytest.raises(ConnectorException): + await invoke_generated_operation( + client, + operation, + connector_module, + include_optional_parameters=True, + ) + + mock_send.assert_awaited_once() diff --git a/tests/test_generated_conditional_requests.py b/tests/test_generated_conditional_requests.py new file mode 100644 index 00000000..6b39e0e6 --- /dev/null +++ b/tests/test_generated_conditional_requests.py @@ -0,0 +1,163 @@ +# ------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# ------------------------------------------------------------ + +"""Behavioral tests for generated conditional request controls.""" + +from __future__ import annotations + +from typing import Any +from unittest.mock import AsyncMock, patch + +import pytest +from azure.core import MatchConditions +from azure.core.credentials import AzureKeyCredential +from azure.connectors.azuretables import AzuretablesClient + +from tests.conftest import MockResponse + + +OPERATIONS = ("delete_entity", "merge_entity", "replace_entity") + + +def create_client() -> AzuretablesClient: + """Create the generated async root client.""" + return AzuretablesClient( + "https://example.azure.com/connections/test", + credential=AzureKeyCredential("test-key"), + ) + + +async def invoke_operation( + client: AzuretablesClient, + operation_name: str, + **controls: Any, +) -> None: + """Invoke one generated entity operation with shared path arguments.""" + arguments: dict[str, Any] = { + "storage_account_name": "sample-account", + "table_name": "sample-table", + "partition_key": "sample-partition", + "row_key": "sample-row", + **controls, + } + if operation_name in {"merge_entity", "replace_entity"}: + arguments["input"] = {"Name": "sample"} + await getattr(client, operation_name)(**arguments) + + +@pytest.mark.parametrize("operation_name", OPERATIONS) +@pytest.mark.asyncio +async def test_header_only_etag_preserves_value_and_casing( + operation_name: str, +) -> None: + """Preserve caller If-Match headers case-insensitively when controls are omitted.""" + client = create_client() + send = AsyncMock(return_value=MockResponse(status=204, text="")) + + with patch.object(client._http_client, "send", new=send): + await invoke_operation( + client, + operation_name, + headers={"if-MATCH": "caller-etag", "x-sample": "value"}, + ) + + assert send.call_args.kwargs["headers"] == { + "if-MATCH": "caller-etag", + "x-sample": "value", + } + send.assert_awaited_once() + + +@pytest.mark.parametrize( + "operation_name,expected_headers", + [ + ("delete_entity", None), + ("merge_entity", {"If-Match": "*"}), + ("replace_entity", {"If-Match": "*"}), + ], +) +@pytest.mark.asyncio +async def test_omitted_controls_apply_required_or_authored_default( + operation_name: str, + expected_headers: dict[str, str] | None, +) -> None: + """Apply wildcard fallback or the authored default only when no header exists.""" + client = create_client() + send = AsyncMock(return_value=MockResponse(status=204, text="")) + + with patch.object(client._http_client, "send", new=send): + await invoke_operation(client, operation_name) + + assert send.call_args.kwargs["headers"] == expected_headers + send.assert_awaited_once() + + +@pytest.mark.parametrize("operation_name", OPERATIONS) +@pytest.mark.asyncio +async def test_explicit_etag_overrides_caller_header( + operation_name: str, +) -> None: + """Give an explicit typed ETag precedence over an existing caller header.""" + client = create_client() + send = AsyncMock(return_value=MockResponse(status=204, text="")) + + with patch.object(client._http_client, "send", new=send): + await invoke_operation( + client, + operation_name, + etag="explicit-etag", + headers={"if-match": "caller-etag", "x-sample": "value"}, + ) + + assert send.call_args.kwargs["headers"] == { + "x-sample": "value", + "If-Match": "explicit-etag", + } + send.assert_awaited_once() + + +@pytest.mark.parametrize("operation_name", OPERATIONS) +@pytest.mark.asyncio +async def test_if_not_modified_requires_explicit_etag( + operation_name: str, +) -> None: + """Reject IfNotModified without an explicit ETag before dispatch.""" + client = create_client() + send = AsyncMock() + + with patch.object(client._http_client, "send", new=send): + with pytest.raises( + ValueError, + match=r"etag is required for MatchConditions\.IfNotModified\.", + ): + await invoke_operation( + client, + operation_name, + match_condition=MatchConditions.IfNotModified, + ) + + send.assert_not_called() + send.assert_not_awaited() + + +@pytest.mark.parametrize("operation_name", OPERATIONS) +@pytest.mark.asyncio +async def test_unconditionally_with_explicit_etag_emits_wildcard( + operation_name: str, +) -> None: + """Preserve Unconditionally semantics when an explicit ETag is also supplied.""" + client = create_client() + send = AsyncMock(return_value=MockResponse(status=204, text="")) + + with patch.object(client._http_client, "send", new=send): + await invoke_operation( + client, + operation_name, + etag="explicit-etag", + match_condition=MatchConditions.Unconditionally, + headers={"if-match": "caller-etag"}, + ) + + assert send.call_args.kwargs["headers"] == {"If-Match": "*"} + send.assert_awaited_once() diff --git a/tests/test_generated_contract.py b/tests/test_generated_contract.py new file mode 100644 index 00000000..6fde7976 --- /dev/null +++ b/tests/test_generated_contract.py @@ -0,0 +1,121 @@ +# ------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# ------------------------------------------------------------ + +"""Tests for generated connector contracts.""" + +from __future__ import annotations + +import ast +from pathlib import Path + +from azure.connectors._client_registry import CLIENT_REGISTRY + + +REPOSITORY_ROOT = Path(__file__).resolve().parent.parent +CONNECTOR_DIRECTORY = REPOSITORY_ROOT / "src" / "azure" / "connectors" + + +def generated_client_name(path: Path) -> str: + """Return the generated client class declared by a connector module.""" + tree = ast.parse(path.read_text(encoding="utf-8"), filename=str(path)) + client_names = [ + node.name + for node in tree.body + if isinstance(node, ast.ClassDef) + and any( + isinstance(base, ast.Name) and base.id == "ConnectorClientBase" + for base in node.bases + ) + ] + assert len(client_names) == 1, path + return client_names[0] + + +def stub_client_names(path: Path) -> set[str]: + """Return connector client names imported by a package type stub.""" + tree = ast.parse(path.read_text(encoding="utf-8"), filename=str(path)) + return { + alias.asname + for node in tree.body + if isinstance(node, ast.ImportFrom) + and node.module is not None + and not node.module.startswith("sdk.") + for alias in node.names + if alias.asname is not None and alias.asname.endswith("Client") + } + + +def test_generated_inventory_has_only_root_connectors() -> None: + """Keep all 99 connectors at root without duplicate client namespaces.""" + connector_names = { + path.stem + for path in CONNECTOR_DIRECTORY.glob("*.py") + if not path.name.startswith("_") + } + assert len(connector_names) == 99 + assert connector_names == set(CLIENT_REGISTRY.values()) + assert not (CONNECTOR_DIRECTORY / "aio").exists() + assert not (CONNECTOR_DIRECTORY / "sync").exists() + + +def test_generated_registry_and_type_stubs_cover_every_client() -> None: + """Keep runtime and static package exports aligned with generated clients.""" + expected_registry = { + generated_client_name(path): path.stem + for path in sorted(CONNECTOR_DIRECTORY.glob("*.py")) + if not path.name.startswith("_") + } + expected_client_names = set(expected_registry) + + assert CLIENT_REGISTRY == expected_registry + assert stub_client_names(CONNECTOR_DIRECTORY / "__init__.pyi") == expected_client_names + + +def test_generated_operations_have_structured_docstrings() -> None: + """Require structured public API documentation in the async root surface.""" + operation_count = 0 + violations: list[str] = [] + connector_paths = sorted(CONNECTOR_DIRECTORY.glob("*.py")) + + for path in connector_paths: + if path.name.startswith("_"): + continue + + tree = ast.parse(path.read_text(encoding="utf-8"), filename=str(path)) + for client in ( + node + for node in tree.body + if isinstance(node, ast.ClassDef) + and any( + isinstance(base, ast.Name) and base.id == "ConnectorClientBase" + for base in node.bases + ) + ): + for method in ( + node + for node in client.body + if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)) + and not node.name.startswith("_") + and any( + isinstance(descendant, ast.Call) + and isinstance(descendant.func, ast.Attribute) + and descendant.func.attr == "send" + for descendant in ast.walk(node) + ) + ): + operation_count += 1 + docstring = ast.get_docstring(method) or "" + if not all( + section in docstring + for section in ("Args:", "Returns:", "Raises:") + ): + violations.append( + f"{path.relative_to(REPOSITORY_ROOT).as_posix()}:" + f"{method.lineno}: {method.name}" + ) + + assert operation_count > 0 + assert not violations, "Generated operations missing structured docs:\n" + "\n".join( + violations + ) diff --git a/tests/test_generated_lro_catalog_contract.py b/tests/test_generated_lro_catalog_contract.py new file mode 100644 index 00000000..bb5af52b --- /dev/null +++ b/tests/test_generated_lro_catalog_contract.py @@ -0,0 +1,247 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. + +"""Catalog-wide contract tests for generated long-running operations.""" + +from __future__ import annotations + +import ast +import importlib +import inspect +from pathlib import Path +from types import ModuleType +from typing import Any, get_args, get_origin, get_type_hints +from unittest.mock import AsyncMock, MagicMock, patch + +import pytest +from azure.core.polling import AsyncLROPoller + +import azure.connectors as connectors_package +from azure.connectors.sdk import ConnectorClientBase, ConnectorException +from tests.conftest import MockResponse +from tests.generated_connector_test_utils import ( + get_generated_operations, + invoke_generated_operation, +) + + +EXPECTED_LRO_OPERATIONS = { + "kusto": { + "begin_list_kusto_results", + "begin_list_kusto_show_command_results", + "begin_run_async_control_command_and_wait", + "begin_run_kusto_command_and_visualize_results", + "begin_run_kusto_query_and_visualize_results", + }, + "plumsail": { + "begin_flow_v1_documents_jobs_add_watermark_to_pdf", + "begin_flow_v1_documents_jobs_any2_pdf_v2", + "begin_flow_v1_documents_jobs_apply_docx", + "begin_flow_v1_documents_jobs_apply_docx_template", + "begin_flow_v1_documents_jobs_apply_html", + "begin_flow_v1_documents_jobs_apply_pptx", + "begin_flow_v1_documents_jobs_apply_xlsx_template", + "begin_flow_v1_documents_jobs_compress_pdf", + "begin_flow_v1_documents_jobs_create_archive", + "begin_flow_v1_documents_jobs_csv2_xlsx", + "begin_flow_v1_documents_jobs_doc2_docx", + "begin_flow_v1_documents_jobs_docx2_pdf", + "begin_flow_v1_documents_jobs_email2_pdf", + "begin_flow_v1_documents_jobs_extract_archive", + "begin_flow_v1_documents_jobs_extract_text_from_pdf", + "begin_flow_v1_documents_jobs_fill_in_pdf_form", + "begin_flow_v1_documents_jobs_get_pdf_form", + "begin_flow_v1_documents_jobs_get_pdf_protection_info", + "begin_flow_v1_documents_jobs_html2_docx", + "begin_flow_v1_documents_jobs_html2_pdf", + "begin_flow_v1_documents_jobs_image2_pdf", + "begin_flow_v1_documents_jobs_json2_csv", + "begin_flow_v1_documents_jobs_json2_xlsx", + "begin_flow_v1_documents_jobs_merge_any_to_pdf_v2", + "begin_flow_v1_documents_jobs_merge_docx", + "begin_flow_v1_documents_jobs_merge_xlsx", + "begin_flow_v1_documents_jobs_parse_csv", + "begin_flow_v1_documents_jobs_pdf2_image_v2", + "begin_flow_v1_documents_jobs_ppt2_pptx", + "begin_flow_v1_documents_jobs_pptx2_pdf", + "begin_flow_v1_documents_jobs_protect_pdf", + "begin_flow_v1_documents_jobs_reg_exp_match", + "begin_flow_v1_documents_jobs_reg_exp_replace", + "begin_flow_v1_documents_jobs_reg_exp_test", + "begin_flow_v1_documents_jobs_split_pdf_v2", + "begin_flow_v1_documents_jobs_xls2_xlsx", + "begin_flow_v1_documents_jobs_xslx2_pdf", + "begin_flow_v1_processes_flow_jobs_execute_process", + "begin_flow_v1_processes_flow_jobs_execute_process_with_generated_data", + }, +} + + +assert connectors_package.__file__ is not None +CONNECTOR_DIRECTORY = Path(connectors_package.__file__).parent +CONNECTOR_MODULE_NAMES = sorted( + path.stem + for path in CONNECTOR_DIRECTORY.glob("*.py") + if path.name != "__init__.py" and not path.name.startswith("_") +) + + +def get_generated_client_type( + module: ModuleType, +) -> type[Any]: + """Return the generated client declared by a connector module.""" + client_types = [ + value + for value in vars(module).values() + if inspect.isclass(value) + and issubclass(value, ConnectorClientBase) + and value is not ConnectorClientBase + and value.__module__ == module.__name__ + ] + assert len(client_types) == 1, module.__name__ + return client_types[0] + + +def get_lro_operations(client_type: type[Any]) -> set[str]: + """Return generated begin methods declared by a connector client.""" + return { + name + for name, member in vars(client_type).items() + if name.startswith("begin_") and callable(member) + } + + +def test_generated_lro_inventory_uses_async_root_pollers() -> None: + """Keep the retained 44-operation LRO surface exact across all 99 clients.""" + assert len(CONNECTOR_MODULE_NAMES) == 99 + + for module_name in CONNECTOR_MODULE_NAMES: + root_module = importlib.import_module(f"azure.connectors.{module_name}") + root_client = get_generated_client_type(root_module) + expected_operations = EXPECTED_LRO_OPERATIONS.get(module_name, set()) + + assert get_lro_operations(root_client) == expected_operations, module_name + + for operation_name in expected_operations: + root_method = getattr(root_client, operation_name) + root_return = get_type_hints( + root_method, + globalns=vars(root_module), + )["return"] + assert get_origin(root_return) is AsyncLROPoller, operation_name + assert len(get_args(root_return)) == 1, operation_name + assert inspect.iscoroutinefunction(root_method), operation_name + assert operation_name.removeprefix("begin_") not in get_generated_operations( + root_client + ), operation_name + + assert sum(map(len, EXPECTED_LRO_OPERATIONS.values())) == 44 + + +def test_generated_lro_operations_use_only_location_polling() -> None: + """Require every retained poller to use the supported Location protocol.""" + for module_name, expected_operations in EXPECTED_LRO_OPERATIONS.items(): + tree = ast.parse( + (CONNECTOR_DIRECTORY / f"{module_name}.py").read_text(encoding="utf-8") + ) + actual_headers = {} + for node in ast.walk(tree): + if not isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)): + continue + if node.name not in expected_operations: + continue + for child in ast.walk(node): + if not isinstance(child, ast.Call): + continue + if not isinstance(child.func, ast.Name): + continue + if child.func.id != "ConnectorPollingMethod": + continue + header_keyword = next( + keyword + for keyword in child.keywords + if keyword.arg == "polling_header_name" + ) + assert isinstance(header_keyword.value, ast.Constant) + actual_headers[node.name] = header_keyword.value.value + + assert set(actual_headers) == expected_operations + assert all( + isinstance(header, str) and header.casefold() == "location" + for header in actual_headers.values() + ) + + +@pytest.mark.parametrize("terminal_status", [200, 400]) +@pytest.mark.parametrize( + "module_name,operation_name", + [ + (module_name, operation_name) + for module_name, operations in EXPECTED_LRO_OPERATIONS.items() + for operation_name in sorted(operations) + ], +) +@pytest.mark.asyncio +async def test_generated_lro_follows_location_and_preserves_controls( + module_name: str, + operation_name: str, + terminal_status: int, + mock_credential: Any, +) -> None: + """Await each root LRO through polling, deserialization, and terminal errors.""" + module = importlib.import_module(f"azure.connectors.{module_name}") + client_type = get_generated_client_type(module) + response_hook = MagicMock() + controls = { + "timeout": 5.0, + "headers": {"x-test": "value"}, + "client_request_id": "request-id", + "response_hook": response_hook, + } + async with client_type( + "https://example.azure.com/connections/test", + credential=mock_credential, + ) as client: + with patch.object( + client._http_client, + "send", + new_callable=AsyncMock, + side_effect=[ + MockResponse( + status=202, + headers={ + "Location": "https://backend.example/jobs/42", + "Retry-After": "0", + }, + ), + MockResponse(status=terminal_status, text='{"ok": true}'), + ], + ) as send, patch( + "azure.connectors.sdk.polling.asyncio.sleep", + new_callable=AsyncMock, + ): + if terminal_status == 400: + with pytest.raises(ConnectorException): + await invoke_generated_operation( + client, operation_name, module, request_controls=controls, + ) + else: + result = await invoke_generated_operation( + client, operation_name, module, request_controls=controls, + ) + return_type = get_type_hints(getattr(client_type, operation_name))["return"] + result_type = get_args(return_type)[0] + if result_type is bytes: + assert result == b'{"ok": true}' + elif result_type is type(None): + assert result is None + else: + assert result == {"ok": True} + + assert send.await_count == send.call_count == 2 + assert send.await_args_list[1].args == ( + "GET", "https://example.azure.com/connections/test/jobs/42", + ) + assert send.await_args_list[1].kwargs["body"] is None + for call in send.await_args_list: + for name, value in controls.items(): + assert call.kwargs[name] == value, (operation_name, name) diff --git a/tests/test_github.py b/tests/test_github.py index 04826cb6..b2a671a3 100644 --- a/tests/test_github.py +++ b/tests/test_github.py @@ -7,9 +7,9 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.github import GithubClient from azure.connectors.github import ( CreateRepositorySecretRequest, - GithubClient, IssueBasicDetailsModel, PullRequestUpdateRequest, QueryRequest, @@ -19,6 +19,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestGithubClientInitialization: @@ -54,7 +55,7 @@ def test_init_with_custom_settings(self, mock_credential): client = GithubClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -122,11 +123,11 @@ async def test_success_uses_acronym_aware_name(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.invoke_mcp_server_async(input=payload) + await client.invoke_mcp_server(input=payload) mock_send.assert_called_once_with( "POST", @@ -150,12 +151,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.invoke_mcp_server_async(input=QueryRequest()) + await client.invoke_mcp_server(input=QueryRequest()) class TestGetUserAsync: @@ -175,11 +176,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_user_async() + result = await client.get_user() mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -202,12 +203,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.get_user_async() + await client.get_user() class TestCreateIssueAsync: @@ -231,11 +232,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_issue_async( + result = await client.create_issue( input=payload, repository_owner="octocat", repository_name="hello-world", @@ -265,20 +266,20 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.create_issue_async( + await client.create_issue( input=payload, repository_owner="octocat", repository_name="hello-world", ) -class TestGetIssuesAsync: - """Tests for get_issues_async method.""" +class TestListIssuesAsync: + """Tests for list_issues method.""" @pytest.mark.asyncio async def test_success(self, mock_credential): @@ -294,15 +295,17 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_issues_async( - repository_owner="octocat", - repository_name="hello-world", - state="open", - per_page="10", + result = await resolve_generated_result( + client.list_issues( + repository_owner="octocat", + repository_name="hello-world", + state="open", + per_page=10, + ) ) mock_send.assert_called_once() @@ -328,14 +331,16 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.get_issues_async( - repository_owner="octocat", - repository_name="hello-world", + await resolve_generated_result( + client.list_issues( + repository_owner="octocat", + repository_name="hello-world", + ) ) @@ -357,11 +362,11 @@ async def test_success_sends_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_update_repository_secret_async( + result = await client.create_update_repository_secret( input=payload, repository_owner="octocat", repository_name="hello world", @@ -395,12 +400,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.create_update_repository_secret_async( + await client.create_update_repository_secret( input=payload, repository_owner="octocat", repository_name="hello-world", @@ -428,11 +433,11 @@ async def test_success_sends_body_and_returns_result(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.update_pull_request_async( + result = await client.update_pull_request( input=payload, repository_owner="octocat", repository_name="hello-world", @@ -462,12 +467,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.update_pull_request_async( + await client.update_pull_request( input=payload, repository_owner="octocat", repository_name="hello-world", @@ -490,11 +495,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.remove_reviewers_pull_request_async( + await client.remove_reviewers_pull_request( input=payload, repository_owner="octocat", repository_name="hello-world", @@ -513,16 +518,16 @@ async def test_error_response_raises_exception(self, mock_credential): credential=mock_credential, ) payload = RequestReviewersBody(reviewers=["alice"]) - mock_response = MockResponse(status=404, text='{"message": "Not Found"}') + mock_response = MockResponse(status=500, text='{"message": "Server error"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.remove_reviewers_pull_request_async( + await client.remove_reviewers_pull_request( input=payload, repository_owner="octocat", repository_name="missing-repo", diff --git a/tests/test_googlecalendar.py b/tests/test_googlecalendar.py index 484700ed..01dc23a9 100644 --- a/tests/test_googlecalendar.py +++ b/tests/test_googlecalendar.py @@ -8,12 +8,12 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.googlecalendar import GooglecalendarClient from azure.connectors.googlecalendar import ( CalendarEventChangedList, CalendarEventList, CalendarList, CalendarListEntry, - GooglecalendarClient, ObjectEntity, PatchEvent, RequestEvent, @@ -25,36 +25,45 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import ( + generated_pager_response_text, + model_instance, + resolve_generated_result, +) async def _invoke_operation(client: GooglecalendarClient, operation: str): """Invoke a Google Calendar operation by name for shared tests.""" if operation == "list_calendars": - return await client.list_calendars_async(min_access_role="reader") + return await resolve_generated_result( + client.list_calendars(min_access_role="reader") + ) if operation == "list_events": - return await client.list_events_async( - calendar_id="cal123", - time_min="2026-01-01T00:00:00Z", - time_max="2026-01-31T23:59:59Z", - q="planning", + return await resolve_generated_result( + client.list_events( + calendar_id="cal123", + time_min="2026-01-01T00:00:00Z", + time_max="2026-01-31T23:59:59Z", + q="planning", + ) ) if operation == "create_event": - return await client.create_event_async( - input=RequestEvent(), + return await client.create_event( + input=model_instance(RequestEvent), calendar_id="cal123", ) if operation == "get_event": - return await client.get_event_async(calendar_id="cal123", event_id="evt123") + return await client.get_event(calendar_id="cal123", event_id="evt123") if operation == "delete_event": - return await client.delete_event_async(calendar_id="cal123", event_id="evt123") + return await client.delete_event(calendar_id="cal123", event_id="evt123") if operation == "update_event": - return await client.update_event_async( + return await client.update_event( input=PatchEvent(), calendar_id="cal123", event_id="evt123", ) if operation == "list_writable_calendars": - return await client.list_writable_calendars_async() + return await resolve_generated_result(client.list_writable_calendars()) raise ValueError(f"Unsupported operation '{operation}'.") @@ -92,7 +101,7 @@ def test_init_with_custom_settings(self, mock_credential): client = GooglecalendarClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -159,17 +168,22 @@ async def test_list_calendars_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"items":[{"id":"cal1"}]}') + mock_response = MockResponse( + status=200, + text=generated_pager_response_text(client.list_calendars), + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_calendars_async(min_access_role="reader") + result = await resolve_generated_result( + client.list_calendars(min_access_role="reader") + ) - assert len(result["items"]) == 1 + assert result == [{"ok": True}] call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/users/me/calendarList" in call_args[0][1] @@ -182,22 +196,27 @@ async def test_list_events_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"items": []}') + mock_response = MockResponse( + status=200, + text=generated_pager_response_text(client.list_events), + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_events_async( - calendar_id="cal123", - time_min="2026-01-01T00:00:00Z", - time_max="2026-01-31T23:59:59Z", - q="planning", + result = await resolve_generated_result( + client.list_events( + calendar_id="cal123", + time_min="2026-01-01T00:00:00Z", + time_max="2026-01-31T23:59:59Z", + q="planning", + ) ) - assert result["items"] == [] + assert result == [{"ok": True}] call_args = mock_send.call_args assert "/calendars/cal123/events" in call_args[0][1] assert "timeMin=2026-01-01T00%3A00%3A00Z" in call_args[0][1] @@ -215,12 +234,12 @@ async def test_create_event_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_event_async( - input=RequestEvent(summary="Standup"), + result = await client.create_event( + input=model_instance(RequestEvent, summary="Standup"), calendar_id="cal123", ) @@ -236,19 +255,25 @@ async def test_list_writable_calendars_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"items": []}') + mock_response = MockResponse( + status=200, + text=generated_pager_response_text(client.list_writable_calendars), + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.list_writable_calendars_async() + result = await resolve_generated_result( + client.list_writable_calendars() + ) call_args = mock_send.call_args assert "/users/me/calendarList/1" in call_args[0][1] assert "minAccessRole=writer" in call_args[0][1] + assert result == [{"ok": True}] class TestGooglecalendarClientErrorHandling: @@ -281,7 +306,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -297,13 +322,13 @@ class TestGooglecalendarApiSurface: def test_callable_method_signatures(self): """Test the client exposes exactly the generated callable methods.""" expected_signatures = { - "create_event_async": ("self", "input", "calendar_id"), - "delete_event_async": ("self", "calendar_id", "event_id"), - "get_event_async": ("self", "calendar_id", "event_id"), - "list_calendars_async": ("self", "min_access_role"), - "list_events_async": ("self", "calendar_id", "time_min", "time_max", "q"), - "list_writable_calendars_async": ("self",), - "update_event_async": ("self", "input", "calendar_id", "event_id"), + "create_event": ("self", "input", "calendar_id"), + "delete_event": ("self", "calendar_id", "event_id"), + "get_event": ("self", "calendar_id", "event_id"), + "list_calendars": ("self", "min_access_role"), + "list_events": ("self", "calendar_id", "time_min", "time_max", "q"), + "list_writable_calendars": ("self",), + "update_event": ("self", "input", "calendar_id", "event_id"), } request_control_parameters = ( "timeout", @@ -318,10 +343,9 @@ def test_callable_method_signatures(self): actual_signatures = { name: tuple(inspect.signature(method).parameters) for name, method in vars(GooglecalendarClient).items() - if ( - inspect.iscoroutinefunction(method) - or inspect.isasyncgenfunction(method) - ) + if not name.startswith("_") + and name != "close" + and callable(method) } assert actual_signatures == expected_signatures @@ -378,7 +402,7 @@ def test_dataclass_instances_initialize_expected_defaults(self): object_entity = ObjectEntity() changed_list = CalendarEventChangedList() calendar_entry = CalendarListEntry() - request_event = RequestEvent() + request_event = model_instance(RequestEvent) patch_event = PatchEvent() changed_event = ResponseEventWithActionType() diff --git a/tests/test_googledrive.py b/tests/test_googledrive.py index e6537270..fb047dc6 100644 --- a/tests/test_googledrive.py +++ b/tests/test_googledrive.py @@ -6,9 +6,9 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.googledrive import GoogledriveClient from azure.connectors.googledrive import ( BlobMetadata, - GoogledriveClient, Table, TableMetadata, TablesList, @@ -17,41 +17,44 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result async def _invoke_operation(client: GoogledriveClient, operation: str): """Invoke a Google Drive operation by name for shared parameterized tests.""" if operation == "get_file_metadata": - return await client.get_file_metadata_async(id="file123") + return await client.get_file_metadata(id="file123") if operation == "update_file": - return await client.update_file_async(input=b"updated content", id="file123") + return await client.update_file(input=b"updated content", id="file123") if operation == "delete_file": - return await client.delete_file_async(id="file123") + return await client.delete_file(id="file123") if operation == "get_file_metadata_by_path": - return await client.get_file_metadata_by_path_async(path="/Documents/file.txt") + return await client.get_file_metadata_by_path(path="/Documents/file.txt") if operation == "get_file_content_by_path": - return await client.get_file_content_by_path_async(path="/Documents/file.txt") + return await client.get_file_content_by_path(path="/Documents/file.txt") if operation == "get_file_content": - return await client.get_file_content_async(id="file123") + return await client.get_file_content(id="file123") if operation == "create_file": - return await client.create_file_async( + return await client.create_file( input=b"file content", folder_id="folder123", name="created.txt", ) if operation == "copy_file": - return await client.copy_file_async( + return await client.copy_file( source="/Documents/source.txt", destination="/Documents/copy.txt", ) if operation == "list_folder": - return await client.list_folder_async(id="folder123") + return await resolve_generated_result(client.list_folder(id="folder123")) if operation == "list_root_folder": - return await client.list_root_folder_async() + return await resolve_generated_result(client.list_root_folder()) if operation == "extract_folder": - return await client.extract_folder_async( - source="/Documents/archive.zip", - destination="/Documents/extracted", + return await resolve_generated_result( + client.extract_folder( + source="/Documents/archive.zip", + destination="/Documents/extracted", + ) ) raise ValueError(f"Unsupported operation '{operation}'.") @@ -89,7 +92,7 @@ def test_init_with_custom_settings(self, mock_credential): client = GoogledriveClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -156,11 +159,11 @@ async def test_get_file_metadata_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_file_metadata_async(id="file123") + result = await client.get_file_metadata(id="file123") assert result["name"] == "doc.txt" call_args = mock_send.call_args @@ -178,11 +181,11 @@ async def test_get_file_content_by_path_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.get_file_content_by_path_async(path="/Documents/file.txt") + result = await client.get_file_content_by_path(path="/Documents/file.txt") assert result == b"google drive file content" @@ -197,11 +200,11 @@ async def test_create_file_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_file_async( + result = await client.create_file( input=b"file content", folder_id="folder123", name="created.txt", @@ -248,7 +251,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_googletasks.py b/tests/test_googletasks.py index df034f5b..0035d214 100644 --- a/tests/test_googletasks.py +++ b/tests/test_googletasks.py @@ -6,8 +6,8 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.googletasks import GoogletasksClient from azure.connectors.googletasks import ( - GoogletasksClient, TRIGGER_OPERATIONS, TaskCreate, TaskList, @@ -20,23 +20,30 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import ( + generated_pager_response_text, + model_instance, + resolve_generated_result, +) async def _invoke_operation(client: GoogletasksClient, operation: str): """Invoke a Google Tasks operation by name for shared tests.""" if operation == "list_task_lists": - return await client.list_task_lists_async() + return await resolve_generated_result(client.list_task_lists()) if operation == "create_task_list": - return await client.create_task_list_async(input=TaskListCreate(title="Work")) + return await client.create_task_list(input=TaskListCreate(title="Work")) if operation == "list_tasks": - return await client.list_tasks_async(task_list_id="list123") + return await resolve_generated_result( + client.list_tasks(task_list_id="list123") + ) if operation == "create_task": - return await client.create_task_async( + return await client.create_task( input=TaskCreate(title="Buy milk"), task_list_id="list123", ) if operation == "list_task": - return await client.list_task_async(task_list_id="list123", task_id="task123") + return await client.list_task(task_list_id="list123", task_id="task123") raise ValueError(f"Unsupported operation '{operation}'.") @@ -73,7 +80,7 @@ def test_init_with_custom_settings(self, mock_credential): client = GoogletasksClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -136,17 +143,20 @@ async def test_list_task_lists_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"items":[{"id":"list123"}]}') + mock_response = MockResponse( + status=200, + text=generated_pager_response_text(client.list_task_lists), + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_task_lists_async() + result = await resolve_generated_result(client.list_task_lists()) - assert len(result["items"]) == 1 + assert result == [{"ok": True}] assert "/users/@me/lists" in mock_send.call_args[0][1] @pytest.mark.asyncio @@ -160,11 +170,11 @@ async def test_create_task_list_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_task_list_async(input=TaskListCreate(title="Work")) + result = await client.create_task_list(input=TaskListCreate(title="Work")) assert result["id"] == "list123" assert isinstance(mock_send.call_args.kwargs["body"], TaskListCreate) @@ -180,11 +190,11 @@ async def test_create_task_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_task_async( + result = await client.create_task( input=TaskCreate(title="Buy milk"), task_list_id="list123", ) @@ -204,11 +214,11 @@ async def test_list_task_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_task_async(task_list_id="list123", task_id="task123") + result = await client.list_task(task_list_id="list123", task_id="task123") assert result["id"] == "task123" assert "/lists/list123/tasks/task123" in mock_send.call_args[0][1] @@ -242,7 +252,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -279,12 +289,12 @@ def test_dataclass_instances_initialize_expected_defaults(self): task_list_entry = TaskListEntry() task_list = TaskList() task_object = TaskObject() - task_list_create = TaskListCreate() - task_create = TaskCreate() + task_list_create = model_instance(TaskListCreate) + task_create = model_instance(TaskCreate) assert task_list_list.items is None assert task_list_entry.id is None assert task_list.items is None assert task_object.id is None - assert task_list_create.title is None - assert task_create.title is None + assert task_list_create.title == "value" + assert task_create.title == "value" diff --git a/tests/test_impexium.py b/tests/test_impexium.py index 4057db8e..213f36aa 100644 --- a/tests/test_impexium.py +++ b/tests/test_impexium.py @@ -3,7 +3,8 @@ """Contract tests for ImpexiumClient.""" import azure.connectors.impexium as impexium_module -from azure.connectors.impexium import ImpexiumClient, TRIGGER_OPERATIONS +from azure.connectors.impexium import ImpexiumClient +from azure.connectors.impexium import TRIGGER_OPERATIONS from tests.generated_connector_test_utils import GeneratedConnectorContractTests @@ -45,16 +46,12 @@ "get_committee_information_for_an_individual", "get_committee_members_by_committee_id_or_code", "get_course_attendees", - "get_individual_active_memberships", - "get_individual_custom_field_values", "get_individual_inactive_memberships", "get_individuals_active_subscriptions", "get_individuals_relationships", "get_list_of_active_certifications_for_an_individual", "get_list_of_active_certifications_for_an_organization", "get_nominees_by_committee", - "get_organization_active_memberships", - "get_organization_custom_field_values", "get_organization_inactive_memberships", "get_organizations_active_subscriptions", "get_organizations_relationships", @@ -70,11 +67,15 @@ "list_all_exhibits", "list_all_individuals", "list_all_open_customer_request", + "list_individual_active_memberships", + "list_individual_custom_field_values", "list_completed_user_tasks_by_user_id_or_email", "list_of_all_individual_members", "list_of_all_organization_members", "list_of_customer_relationships", "list_of_exams", + "list_organization_active_memberships", + "list_organization_custom_field_values", "list_pending_user_tasks_by_user_id_or_email", "list_registrants", "organization_get_profile", @@ -94,13 +95,10 @@ "add_customer_request", "add_email_to_individual", "add_email_to_organization", - "add_exam_scores", "add_individual", "add_nominee", "add_note_to_sales_opportunity", "add_notification_to_individual", - "add_or_update_a_list_of_custom_fields_per_individual", - "add_or_update_a_list_of_custom_fields_per_organization", "add_or_update_address_to_individual", "add_or_update_address_to_organization", "add_organization", @@ -114,6 +112,9 @@ "awards_add_award_nomination", "individual_add_education_credit", "individual_add_note", + "add_exam_scores", + "add_or_update_a_list_of_custom_fields_per_individual", + "add_or_update_a_list_of_custom_fields_per_organization", "organization_add_note", "register_an_individual_for_a_free_session", "save_relationship_for_organization", diff --git a/tests/test_infusionsoft.py b/tests/test_infusionsoft.py index 06982d3f..e682a05e 100644 --- a/tests/test_infusionsoft.py +++ b/tests/test_infusionsoft.py @@ -8,9 +8,9 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.infusionsoft import InfusionsoftClient from azure.connectors.infusionsoft import ( CreateTaskRequest, - InfusionsoftClient, ListOrdersResponse, ListTasksResponse, OnNewTaskResponse, @@ -21,16 +21,24 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import ( + generated_pager_response_text, + model_instance, + resolve_generated_result, +) async def _invoke_operation(client: InfusionsoftClient, operation: str): """Invoke an Infusionsoft operation by name for shared tests.""" if operation == "create_task": - return await client.create_task_async(input=CreateTaskRequest()) + return await client.create_task(input=model_instance(CreateTaskRequest)) if operation == "update_task": - return await client.update_task_async(input=CreateTaskRequest(), id="1") + return await client.update_task( + input=model_instance(CreateTaskRequest), + id="1", + ) if operation == "list_tasks": - return await client.list_tasks_async() + return await resolve_generated_result(client.list_tasks()) raise ValueError(f"Unsupported operation '{operation}'.") @@ -75,7 +83,7 @@ def test_init_with_custom_settings(self, mock_credential): client = InfusionsoftClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -142,11 +150,13 @@ async def test_create_task_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_task_async(input=CreateTaskRequest()) + result = await client.create_task( + input=model_instance(CreateTaskRequest) + ) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -165,11 +175,14 @@ async def test_update_task_success_targets_resource(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.update_task_async(input=CreateTaskRequest(), id="5") + result = await client.update_task( + input=model_instance(CreateTaskRequest), + id="5", + ) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "PUT" @@ -184,25 +197,28 @@ async def test_list_tasks_success_includes_order_query(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"tasks": [{"id": 1}]}') + mock_response = MockResponse( + status=200, + text=generated_pager_response_text(client.list_tasks), + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_tasks_async() + result = await resolve_generated_result(client.list_tasks()) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert "/crm/rest/v1/tasks/search?" in path assert "order=" in path - assert result == {"tasks": [{"id": 1}]} + assert result == [{"ok": True}] @pytest.mark.asyncio - async def test_empty_response_body_returns_none(self, mock_credential): - """Test a 2xx response with no body returns None.""" + async def test_empty_response_body_returns_empty_page(self, mock_credential): + """Test a pageable 2xx response with no body returns no items.""" client = InfusionsoftClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -211,13 +227,13 @@ async def test_empty_response_body_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.list_tasks_async() + result = await resolve_generated_result(client.list_tasks()) - assert result is None + assert result == [] class TestInfusionsoftClientErrorHandling: @@ -239,7 +255,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -288,6 +304,8 @@ def test_response_dataclasses_initialize_expected_defaults(self): assert get_origin(ListOrdersResponse) is list def test_request_dataclasses_instantiate(self): - """Test generated request dataclasses instantiate without arguments.""" - assert CreateTaskRequest() is not None - assert CreateTaskRequest().type_ is None + """Test generated request dataclasses initialize optional defaults.""" + request = model_instance(CreateTaskRequest) + + assert request is not None + assert request.type_ is None diff --git a/tests/test_insightly.py b/tests/test_insightly.py index d441540c..32db04b8 100644 --- a/tests/test_insightly.py +++ b/tests/test_insightly.py @@ -7,9 +7,9 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.insightly import InsightlyClient from azure.connectors.insightly import ( ContactRequest, - InsightlyClient, LeadRequest, ListContactsResponse, ListEventsResponse, @@ -26,48 +26,61 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import ( + generated_pager_response_text, + model_instance, + resolve_generated_result, +) async def _invoke_operation(client: InsightlyClient, operation: str): """Invoke an Insightly operation by name for shared tests.""" if operation == "list_tasks": - return await client.list_tasks_async() + return await resolve_generated_result(client.list_tasks()) if operation == "update_task": - return await client.update_task_async(input=TaskRequest(), id="1") + return await client.update_task(input=model_instance(TaskRequest), id="1") if operation == "add_task": - return await client.add_task_async(input=TaskRequest()) + return await client.add_task(input=model_instance(TaskRequest)) if operation == "list_projects": - return await client.list_projects_async() + return await resolve_generated_result(client.list_projects()) if operation == "update_project": - return await client.update_project_async(input=ProjectRequest(), id="1") + return await client.update_project( + input=model_instance(ProjectRequest), + id="1", + ) if operation == "add_project": - return await client.add_project_async(input=ProjectRequest()) + return await client.add_project(input=model_instance(ProjectRequest)) if operation == "list_leads": - return await client.list_leads_async() + return await resolve_generated_result(client.list_leads()) if operation == "update_lead": - return await client.update_lead_async(input=LeadRequest(), id="1") + return await client.update_lead(input=model_instance(LeadRequest), id="1") if operation == "add_lead": - return await client.add_lead_async(input=LeadRequest()) + return await client.add_lead(input=model_instance(LeadRequest)) if operation == "list_contacts": - return await client.list_contacts_async() + return await resolve_generated_result(client.list_contacts()) if operation == "update_contact": - return await client.update_contact_async(input=ContactRequest(), id="1") + return await client.update_contact( + input=model_instance(ContactRequest), + id="1", + ) if operation == "add_contact": - return await client.add_contact_async(input=ContactRequest()) + return await client.add_contact(input=model_instance(ContactRequest)) if operation == "list_users": - return await client.list_users_async() + return await resolve_generated_result(client.list_users()) if operation == "delete_task": - return await client.delete_task_async(task_id="1") + return await client.delete_task(task_id="1") if operation == "follow_task": - return await client.follow_task_async(task_id="1") + return await client.follow_task(task_id="1") if operation == "delete_project": - return await client.delete_project_async(project_id="1") + return await client.delete_project(project_id="1") if operation == "delete_lead": - return await client.delete_lead_async(lead_id="1") + return await client.delete_lead(lead_id="1") if operation == "delete_contact": - return await client.delete_contact_async(contact_id="1") + return await client.delete_contact(contact_id="1") if operation == "add_organization": - return await client.add_organization_async(input=OrganizationRequest()) + return await client.add_organization( + input=model_instance(OrganizationRequest) + ) raise ValueError(f"Unsupported operation '{operation}'.") @@ -128,7 +141,7 @@ def test_init_with_custom_settings(self, mock_credential): client = InsightlyClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -191,20 +204,23 @@ async def test_list_tasks_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"tasks": [{"TASK_ID": 1}]}') + mock_response = MockResponse( + status=200, + text=generated_pager_response_text(client.list_tasks), + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_tasks_async() + result = await resolve_generated_result(client.list_tasks()) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert path.endswith("/Tasks") - assert result == {"tasks": [{"TASK_ID": 1}]} + assert result == [{"ok": True}] @pytest.mark.asyncio async def test_add_task_success(self, mock_credential): @@ -217,11 +233,11 @@ async def test_add_task_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.add_task_async(input=TaskRequest()) + result = await client.add_task(input=model_instance(TaskRequest)) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -240,11 +256,14 @@ async def test_update_task_success_includes_id_query(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.update_task_async(input=TaskRequest(), id="5") + result = await client.update_task( + input=model_instance(TaskRequest), + id="5", + ) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "PUT" @@ -263,11 +282,11 @@ async def test_delete_task_success_targets_resource(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_task_async(task_id="7") + result = await client.delete_task(task_id="7") method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "DELETE" @@ -285,11 +304,11 @@ async def test_follow_task_success_targets_follow(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.follow_task_async(task_id="7") + result = await client.follow_task(task_id="7") method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -307,11 +326,13 @@ async def test_add_organization_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.add_organization_async(input=OrganizationRequest()) + result = await client.add_organization( + input=model_instance(OrganizationRequest) + ) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -319,8 +340,8 @@ async def test_add_organization_success(self, mock_credential): assert result == {"ORGANISATION_ID": 3} @pytest.mark.asyncio - async def test_empty_response_body_returns_none(self, mock_credential): - """Test a 2xx response with no body returns None.""" + async def test_empty_response_body_returns_empty_page(self, mock_credential): + """Test a pageable 2xx response with no body returns no items.""" client = InsightlyClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -329,13 +350,13 @@ async def test_empty_response_body_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.list_tasks_async() + result = await resolve_generated_result(client.list_tasks()) - assert result is None + assert result == [] class TestInsightlyClientErrorHandling: @@ -357,7 +378,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -417,9 +438,9 @@ def test_response_dataclasses_initialize_expected_defaults(self): assert ListEventsResponse().events is None def test_request_dataclasses_instantiate(self): - """Test generated request dataclasses instantiate without arguments.""" - assert TaskRequest() is not None - assert ProjectRequest() is not None - assert LeadRequest() is not None - assert ContactRequest() is not None - assert OrganizationRequest() is not None + """Test generated request dataclasses initialize required fields.""" + assert model_instance(TaskRequest) is not None + assert model_instance(ProjectRequest) is not None + assert model_instance(LeadRequest) is not None + assert model_instance(ContactRequest) is not None + assert model_instance(OrganizationRequest) is not None diff --git a/tests/test_jedoxodatahub.py b/tests/test_jedoxodatahub.py index 51ab3e2c..eff0b57c 100644 --- a/tests/test_jedoxodatahub.py +++ b/tests/test_jedoxodatahub.py @@ -10,39 +10,39 @@ OPERATION_CONTRACTS = dict.fromkeys( [ "cube_by_id", - "cube_cells", - "cubes", "database_by_id", - "databases", "dimension_by_id", - "dimensions", "element_by_id", - "elements", "extract_by_name", - "extract_rows", - "extracts", "get_cube_cell_result_schema", "get_extract_rows_result_schema", "get_transform_rows_result_schema", "get_view_cell_result_schema", - "integrator_project_groups", - "integrator_projects", "integrator_projects_by_id", "integrator_projects_by_name", "job_by_name", - "jobs", + "list_cube_cells", + "list_cubes", + "list_databases", + "list_dimensions", + "list_elements", + "list_extract_rows", + "list_extracts", + "list_integrator_project_groups", + "list_integrator_projects", + "list_jobs", + "list_loads", + "list_transform_rows", + "list_transforms", + "list_view_cells", + "list_views", "load_by_name", - "loads", "run_job", "run_job_with_variables", "run_load", "run_load_with_variables", "transform_by_name", - "transform_rows", - "transforms", "view_by_id", - "view_cells", - "views", ], ("GET", False), ) diff --git a/tests/test_jira.py b/tests/test_jira.py index 49d6c01f..b85fcd40 100644 --- a/tests/test_jira.py +++ b/tests/test_jira.py @@ -3,17 +3,128 @@ """Unit tests for JiraClient.""" import inspect +import json from typing import Optional, get_type_hints from unittest.mock import AsyncMock, patch import pytest from azure.core.credentials import AzureKeyCredential -from azure.connectors.jira import JiraClient, CreateIssueInput, EditIssueInput +from azure.connectors.jira import JiraClient +from azure.connectors.jira import CreateIssueInput, EditIssueInput from azure.connectors.sdk import ( ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result + + +@pytest.fixture(params=[ + pytest.param("last_page", id="last-page"), + pytest.param("empty_intermediate_page", id="empty-intermediate-page"), + pytest.param("missing_token", id="missing-token"), + pytest.param("empty_token", id="empty-token"), + pytest.param("null_token", id="null-token"), + pytest.param("stale_token", id="is-last-overrides-stale-token"), +]) +def jira_issue_token_pages(request): + """Provide opaque-token pages for the generated async client tests.""" + first_page = { + "issues": [{"id": "first"}], + "isLast": False, + "nextPageToken": "opaque/page2", + } + last_page = {"issues": [{"id": "second"}], "isLast": True} + pages = [first_page, last_page] + expected_tokens = [None, "opaque%2Fpage2"] + if request.param == "empty_intermediate_page": + pages.insert(1, { + "issues": [], + "isLast": False, + "nextPageToken": "opaque/page3", + }) + expected_tokens.append("opaque%2Fpage3") + elif request.param in {"missing_token", "empty_token", "null_token"}: + last_page["isLast"] = False + if request.param == "empty_token": + last_page["nextPageToken"] = "" + elif request.param == "null_token": + last_page["nextPageToken"] = None + elif request.param == "stale_token": + last_page["nextPageToken"] = "stale/page3" + + return ( + [MockResponse(status=200, text=json.dumps(page)) for page in pages], + expected_tokens, + ) + + +class TestListIssuesKeyCredential: + """Behavioral paging tests for the async Jira client with a key credential.""" + + @pytest.mark.asyncio + async def test_opaque_token_paging(self, jira_issue_token_pages): + """Test later items, encoded query binding, empty pages, and termination.""" + responses, expected_tokens = jira_issue_token_pages + async with JiraClient( + "https://example.azure.com/connections/test", + credential=AzureKeyCredential("test-key"), + ) as client: + with patch.object( + client._http_client, + "send", + new_callable=AsyncMock, + side_effect=responses, + ) as transport: + issues = [issue async for issue in client.list_issues( + jql="project = DEMO", + fields="summary,status", + )] + + assert issues == [{"id": "first"}, {"id": "second"}] + assert transport.await_count == len(expected_tokens) + initial_url = ( + "https://example.azure.com/connections/test/2/search" + "?expand=%2A&jql=project%20%3D%20DEMO&fields=summary%2Cstatus" + ) + assert [request.args for request in transport.await_args_list] == [ + ("GET", initial_url if token is None else ( + f"{initial_url}&nextPageToken={token}" + )) + for token in expected_tokens + ] + + @pytest.mark.asyncio + async def test_named_continuation_token_keeps_its_query_binding(self): + """Test by_page resumes with a raw opaque token and stops at exhaustion.""" + async with JiraClient( + "https://example.azure.com/connections/test", + credential=AzureKeyCredential("test-key"), + ) as client: + with patch.object( + client._http_client, + "send", + new_callable=AsyncMock, + side_effect=[MockResponse( + status=200, + text='{"issues": [{"id": "resumed"}], "isLast": false}', + )], + ) as transport: + pages = client.list_issues(jql="project = DEMO").by_page( + continuation_token="page/2", + ) + page = await anext(pages) + assert [issue async for issue in page] == [{"id": "resumed"}] + assert pages.continuation_token is None + with pytest.raises(StopAsyncIteration): + await anext(pages) + + transport.assert_awaited_once() + assert transport.await_args.args == ( + "GET", + "https://example.azure.com/connections/test/2/search" + "?expand=%2A&jql=project%20%3D%20DEMO&nextPageToken=page%2F2", + ) class TestJiraClientInitialization: @@ -49,7 +160,7 @@ def test_init_with_custom_settings(self, mock_credential): client = JiraClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -114,23 +225,22 @@ async def test_success(self, mock_credential): ) mock_response = MockResponse( status=200, - text='{"value": [{"id": "site-1"}]}', + text='[{"id": "site-1"}]', ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_resources_async() + result = await resolve_generated_result(client.list_resources()) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert "/oauth/token/accessible-resources" in path - assert result is not None - assert "value" in result + assert result == [{"id": "site-1"}] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -146,12 +256,53 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.list_resources_async() + await resolve_generated_result(client.list_resources()) + + +class TestListFiltersAsync: + """Tests for list_filters paging behavior.""" + + @pytest.mark.asyncio + async def test_follows_next_page_url(self, mock_credential): + """Test Jira's schema continuation URL is followed to the second page.""" + client = JiraClient( + "https://example.azure.com/connections/test", + credential=mock_credential, + ) + next_page_url = ( + "https://example.azure.com/connections/test/v2/filter/search" + "?startAt=50" + ) + responses = [ + MockResponse( + status=200, + text=( + '{"values": [{"id": "filter-1"}], ' + f'"nextPage": "{next_page_url}"}}' + ), + ), + MockResponse( + status=200, + text='{"values": [{"id": "filter-2"}]}', + ), + ] + + with patch.object( + client._http_client, + "send", + new_callable=AsyncMock, + side_effect=responses, + ) as transport: + result = await resolve_generated_result(client.list_filters()) + + assert result == [{"id": "filter-1"}, {"id": "filter-2"}] + assert transport.await_count == 2 + assert transport.await_args_list[1].args[1] == next_page_url class TestListIssuesAsync: @@ -159,10 +310,10 @@ class TestListIssuesAsync: def test_fields_are_an_optional_string(self): """Test the live fields parameter is exposed without an implicit all-fields default.""" - fields = inspect.signature(JiraClient.list_issues_async).parameters["fields"] + fields = inspect.signature(JiraClient.list_issues).parameters["fields"] assert fields.default is None - assert get_type_hints(JiraClient.list_issues_async)["fields"] == Optional[str] + assert get_type_hints(JiraClient.list_issues)["fields"] == Optional[str] @pytest.mark.asyncio @pytest.mark.parametrize( @@ -179,14 +330,14 @@ async def test_fields_query_matches_live_optional_contract( ) as client: with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"issues": []}'), ) as transport: arguments = {"jql": "project = DEMO"} if fields is not None: arguments["fields"] = fields - await client.list_issues_async(**arguments) + await resolve_generated_result(client.list_issues(**arguments)) transport.assert_awaited_once() method, request_url = transport.await_args.args @@ -199,22 +350,67 @@ async def test_fields_query_matches_live_optional_contract( @pytest.mark.asyncio async def test_named_continuation_token_keeps_its_query_binding(self, mock_credential): - """Test callers can retain token binding by using the existing named parameter.""" + """Test by_page resumes with a raw opaque token and stops at exhaustion.""" async with JiraClient( "https://example.azure.com/connections/test", credential=mock_credential, ) as client: with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, - return_value=MockResponse(status=200, text='{"issues": []}'), + side_effect=[MockResponse( + status=200, + text='{"issues": [{"id": "resumed"}], "isLast": false}', + )], ) as transport: - await client.list_issues_async(next_page_token="page/2") + pages = client.list_issues(jql="project = DEMO").by_page( + continuation_token="page/2", + ) + page = await anext(pages) + assert [issue async for issue in page] == [{"id": "resumed"}] + assert pages.continuation_token is None + with pytest.raises(StopAsyncIteration): + await anext(pages) + + transport.assert_awaited_once() + assert transport.await_args.args == ( + "GET", + "https://example.azure.com/connections/test/2/search" + "?expand=%2A&jql=project%20%3D%20DEMO&nextPageToken=page%2F2", + ) - request_url = transport.await_args.args[1] - assert "nextPageToken=page%2F2" in request_url - assert "fields=" not in request_url + @pytest.mark.asyncio + async def test_opaque_token_paging(self, mock_credential, jira_issue_token_pages): + """Test later items, encoded query binding, empty pages, and termination.""" + responses, expected_tokens = jira_issue_token_pages + async with JiraClient( + "https://example.azure.com/connections/test", + credential=mock_credential, + ) as client: + with patch.object( + client._http_client, + "send", + new_callable=AsyncMock, + side_effect=responses, + ) as transport: + issues = [issue async for issue in client.list_issues( + jql="project = DEMO", + fields="summary,status", + )] + + assert issues == [{"id": "first"}, {"id": "second"}] + assert transport.await_count == len(expected_tokens) + initial_url = ( + "https://example.azure.com/connections/test/2/search" + "?expand=%2A&jql=project%20%3D%20DEMO&fields=summary%2Cstatus" + ) + assert [request.args for request in transport.await_args_list] == [ + ("GET", initial_url if token is None else ( + f"{initial_url}&nextPageToken={token}" + )) + for token in expected_tokens + ] @pytest.mark.asyncio async def test_success(self, mock_credential): @@ -230,13 +426,15 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_issues_async( - jql="created >= -3650d", - fields="summary,status", + result = await resolve_generated_result( + client.list_issues( + jql="created >= -3650d", + fields="summary,status", + ) ) mock_send.assert_called_once() @@ -246,8 +444,7 @@ async def test_success(self, mock_credential): assert "jql=created%20%3E%3D%20-3650d" in path assert "fields=summary%2Cstatus" in path assert "fields=%2Aall" not in path - assert result is not None - assert "issues" in result + assert result == [{"key": "PROJ-1"}] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -263,12 +460,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.list_issues_async() + await resolve_generated_result(client.list_issues()) class TestCreateIssueAsync: @@ -291,11 +488,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_issue_async( + result = await client.create_issue( input=payload, project_key="PROJ", issue_type_ids="10001", @@ -327,12 +524,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.create_issue_async( + await client.create_issue( input=payload, project_key="PROJ", issue_type_ids="10001", @@ -356,11 +553,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_issue_async(issue_key="PROJ-1") + result = await client.get_issue(issue_key="PROJ-1") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -384,11 +581,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.delete_project_async(project_id_or_key="PROJ") + await client.delete_project(project_id_or_key="PROJ") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -406,12 +603,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.delete_project_async(project_id_or_key="PROJ") + await client.delete_project(project_id_or_key="PROJ") class TestEditIssueAsync: @@ -429,11 +626,11 @@ async def test_success_sends_body_and_returns_result(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.edit_issue_async( + result = await client.edit_issue( input=payload, issue_id_or_key="PROJ-1", ) @@ -458,12 +655,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.edit_issue_async( + await client.edit_issue( input=payload, issue_id_or_key="PROJ-1", ) diff --git a/tests/test_keyvault.py b/tests/test_keyvault.py index ef650b69..204c259f 100644 --- a/tests/test_keyvault.py +++ b/tests/test_keyvault.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.keyvault import KeyvaultClient from azure.connectors.keyvault import ( - KeyvaultClient, KeyMetadataCollection, KeyMetadata, KeyEncryptOutput, @@ -66,7 +66,7 @@ def test_init_with_custom_settings(self, mock_credential): client = KeyvaultClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -128,7 +128,7 @@ async def test_context_manager(self, mock_credential): class TestListKeysAsync: - """Tests for list_keys_async method.""" + """Tests for list_keys method.""" @pytest.mark.asyncio async def test_success_returns_keys(self, mock_credential): @@ -146,22 +146,21 @@ async def test_success_returns_keys(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.list_keys_async() + result = [item async for item in client.list_keys()] mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/keys" in call_args[0][1] - assert result is not None - assert "value" in result + assert result == [{"name": "key1", "version": "v1"}] @pytest.mark.asyncio - async def test_empty_response_returns_none(self, mock_credential): - """Test empty response returns None.""" + async def test_empty_response_returns_empty_page(self, mock_credential): + """Test empty response returns an empty page.""" mock_response = MockResponse(status=200, text='') client = KeyvaultClient( @@ -171,12 +170,12 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.list_keys_async() - assert result is None + result = [item async for item in client.list_keys()] + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -193,18 +192,18 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.list_keys_async() + [item async for item in client.list_keys()] assert exc_info.value.status_code == 403 class TestListKeyVersionsAsync: - """Tests for list_key_versions_async method.""" + """Tests for list_key_versions method.""" @pytest.mark.asyncio async def test_success(self, mock_credential): @@ -219,17 +218,21 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.list_key_versions_async(key_name="mykey") + result = [ + item async for item in client.list_key_versions( + key_name="mykey" + ) + ] mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/keys/mykey/versions" in call_args[0][1] - assert result is not None + assert result == [{"version": "v1"}, {"version": "v2"}] class TestGetKeyMetadataAsync: @@ -251,11 +254,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_key_metadata_async(key_name="mykey") + result = await client.get_key_metadata(key_name="mykey") mock_send.assert_called_once() call_args = mock_send.call_args @@ -276,12 +279,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_key_metadata_async(key_name="nonexistent") + await client.get_key_metadata(key_name="nonexistent") assert exc_info.value.status_code == 404 @@ -302,11 +305,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_key_version_metadata_async( + result = await client.get_key_version_metadata( key_name="mykey", key_version="v1" ) @@ -339,11 +342,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.encrypt_data_async( + result = await client.encrypt_data( input=encrypt_input, key_name="mykey" ) @@ -375,12 +378,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.encrypt_data_async( + await client.encrypt_data( input=encrypt_input, key_name="mykey" ) @@ -409,11 +412,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.encrypt_data_with_version_async( + result = await client.encrypt_data_with_version( input=encrypt_input, key_name="mykey", key_version="v1" @@ -447,11 +450,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.decrypt_data_async( + result = await client.decrypt_data( input=decrypt_input, key_name="mykey" ) @@ -485,11 +488,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.decrypt_data_with_version_async( + result = await client.decrypt_data_with_version( input=decrypt_input, key_name="mykey", key_version="v1" @@ -503,7 +506,7 @@ async def test_success(self, mock_credential): class TestListSecretsAsync: - """Tests for list_secrets_async method.""" + """Tests for list_secrets method.""" @pytest.mark.asyncio async def test_success(self, mock_credential): @@ -518,17 +521,17 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.list_secrets_async() + result = [item async for item in client.list_secrets()] mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/secrets" in call_args[0][1] - assert result is not None + assert result == [{"name": "secret1"}, {"name": "secret2"}] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -542,18 +545,18 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.list_secrets_async() + [item async for item in client.list_secrets()] assert exc_info.value.status_code == 403 class TestListSecretVersionsAsync: - """Tests for list_secret_versions_async method.""" + """Tests for list_secret_versions method.""" @pytest.mark.asyncio async def test_success(self, mock_credential): @@ -568,19 +571,21 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.list_secret_versions_async( - secret_name="mysecret" - ) + result = [ + item async for item in client.list_secret_versions( + secret_name="mysecret" + ) + ] mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/secrets/mysecret/versions" in call_args[0][1] - assert result is not None + assert result == [{"version": "v1"}, {"version": "v2"}] class TestGetSecretMetadataAsync: @@ -602,11 +607,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_secret_metadata_async( + result = await client.get_secret_metadata( secret_name="mysecret" ) @@ -634,11 +639,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_secret_version_metadata_async( + result = await client.get_secret_version_metadata( secret_name="mysecret", secret_version="v1" ) @@ -669,11 +674,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_secret_async(secret_name="mysecret") + result = await client.get_secret(secret_name="mysecret") mock_send.assert_called_once() call_args = mock_send.call_args @@ -694,12 +699,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_secret_async(secret_name="nonexistent") + await client.get_secret(secret_name="nonexistent") assert exc_info.value.status_code == 404 @@ -720,11 +725,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_secret_version_async( + result = await client.get_secret_version( secret_name="mysecret", secret_version="v1" ) @@ -770,11 +775,14 @@ def test_key_metadata_collection_defaults(self): assert collection.value is None assert collection.continuation_token is None - def test_key_encrypt_input_defaults(self): - """Test KeyEncryptInput dataclass with defaults.""" - input_obj = KeyEncryptInput() - assert input_obj.algorithm is None - assert input_obj.raw_data is None + def test_key_encrypt_input_required_fields(self): + """Test KeyEncryptInput dataclass required fields.""" + input_obj = KeyEncryptInput( + algorithm="RSA-OAEP", + raw_data="data to encrypt", + ) + assert input_obj.algorithm == "RSA-OAEP" + assert input_obj.raw_data == "data to encrypt" def test_key_encrypt_input_with_values(self): """Test KeyEncryptInput dataclass with values.""" @@ -785,11 +793,14 @@ def test_key_encrypt_input_with_values(self): assert input_obj.algorithm == "RSA-OAEP" assert input_obj.raw_data == "data to encrypt" - def test_key_decrypt_input_defaults(self): - """Test KeyDecryptInput dataclass with defaults.""" - input_obj = KeyDecryptInput() - assert input_obj.algorithm is None - assert input_obj.encrypted_data is None + def test_key_decrypt_input_required_fields(self): + """Test KeyDecryptInput dataclass required fields.""" + input_obj = KeyDecryptInput( + algorithm="RSA-OAEP", + encrypted_data="encrypted data", + ) + assert input_obj.algorithm == "RSA-OAEP" + assert input_obj.encrypted_data == "encrypted data" def test_key_encrypt_output_defaults(self): """Test KeyEncryptOutput dataclass with defaults.""" diff --git a/tests/test_kusto.py b/tests/test_kusto.py index 3cf5364f..d47195b8 100644 --- a/tests/test_kusto.py +++ b/tests/test_kusto.py @@ -6,8 +6,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.kusto import KustoClient from azure.connectors.kusto import ( - KustoClient, QueryAndListSchema, ControlCommandAndListSchema, QueryAndVisualizeSchema, @@ -18,6 +18,13 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import model_instance + + +async def resolve_lro(poller_awaitable): + """Await a generated asynchronous poller and return its terminal result.""" + poller = await poller_awaitable + return await poller.result() class TestKustoClientInitialization: @@ -53,7 +60,7 @@ def test_init_with_custom_settings(self, mock_credential): client = KustoClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -124,7 +131,7 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: @@ -133,7 +140,9 @@ async def test_success_with_json_response(self, mock_credential): db="testdb", csl="TestTable | take 10" ) - result = await client.list_kusto_results_async(input_schema) + result = await resolve_lro( + client.begin_list_kusto_results(input_schema) + ) mock_send.assert_called_once_with( "POST", @@ -158,12 +167,14 @@ async def test_success_with_empty_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - input_schema = QueryAndListSchema() - result = await client.list_kusto_results_async(input_schema) + input_schema = model_instance(QueryAndListSchema) + result = await resolve_lro( + client.begin_list_kusto_results(input_schema) + ) assert result is None @@ -182,14 +193,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - input_schema = QueryAndListSchema() + input_schema = model_instance(QueryAndListSchema) with pytest.raises(ConnectorException) as exc_info: - await client.list_kusto_results_async(input_schema) + await client.begin_list_kusto_results(input_schema) assert exc_info.value.status_code == 400 assert exc_info.value.response_body == '{"error": "Invalid query"}' @@ -211,12 +222,14 @@ async def test_500_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.list_kusto_results_async(QueryAndListSchema()) + await client.begin_list_kusto_results( + model_instance(QueryAndListSchema) + ) assert exc_info.value.status_code == 500 @@ -239,7 +252,7 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: @@ -248,7 +261,9 @@ async def test_success_with_json_response(self, mock_credential): db="testdb", csl=".show tables" ) - result = await client.list_kusto_show_command_results_async(input_schema) + result = await resolve_lro( + client.begin_list_kusto_show_command_results(input_schema) + ) mock_send.assert_called_once_with( "POST", @@ -273,12 +288,14 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.list_kusto_show_command_results_async( - ControlCommandAndListSchema() + result = await resolve_lro( + client.begin_list_kusto_show_command_results( + model_instance(ControlCommandAndListSchema) + ) ) assert result is None @@ -298,13 +315,13 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.list_kusto_show_command_results_async( - ControlCommandAndListSchema() + await client.begin_list_kusto_show_command_results( + model_instance(ControlCommandAndListSchema) ) assert exc_info.value.status_code == 403 @@ -328,7 +345,7 @@ async def test_success_with_chart_data(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: @@ -338,7 +355,9 @@ async def test_success_with_chart_data(self, mock_credential): csl="TestTable | summarize count() by timestamp", chart_type="line" ) - result = await client.run_kusto_query_and_visualize_results_async(input_schema) + result = await resolve_lro( + client.begin_run_kusto_query_and_visualize_results(input_schema) + ) mock_send.assert_called_once_with( "POST", @@ -366,13 +385,13 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.run_kusto_query_and_visualize_results_async( - QueryAndVisualizeSchema() + await client.begin_run_kusto_query_and_visualize_results( + model_instance(QueryAndVisualizeSchema) ) assert exc_info.value.status_code == 400 @@ -396,7 +415,7 @@ async def test_success_with_chart_data(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: @@ -406,7 +425,9 @@ async def test_success_with_chart_data(self, mock_credential): csl=".show schema", chart_type="bar" ) - result = await client.run_kusto_command_and_visualize_results_async(input_schema) + result = await resolve_lro( + client.begin_run_kusto_command_and_visualize_results(input_schema) + ) mock_send.assert_called_once_with( "POST", @@ -431,12 +452,14 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.run_kusto_command_and_visualize_results_async( - CommandAndVisualizeSchema() + result = await resolve_lro( + client.begin_run_kusto_command_and_visualize_results( + model_instance(CommandAndVisualizeSchema) + ) ) assert result is None @@ -460,7 +483,7 @@ async def test_success_with_command_id(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: @@ -469,7 +492,9 @@ async def test_success_with_command_id(self, mock_credential): db="testdb", csl=".set-or-append async TargetTable <| SourceTable" ) - result = await client.run_async_control_command_and_wait_async(input_schema) + result = await resolve_lro( + client.begin_run_async_control_command_and_wait(input_schema) + ) mock_send.assert_called_once_with( "POST", @@ -499,13 +524,13 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.run_async_control_command_and_wait_async( - ControlCommandAndListSchema() + await client.begin_run_async_control_command_and_wait( + model_instance(ControlCommandAndListSchema) ) assert exc_info.value.status_code == 408 @@ -529,7 +554,7 @@ async def test_success_without_session_id(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: @@ -539,7 +564,7 @@ async def test_success_without_session_id(self, mock_credential): method="query", params={"query": "TestTable | take 1"} ) - result = await client.mcp_kusto_query_management_async(input_request) + result = await client.mcp_kusto_query_management(input_request) mock_send.assert_called_once_with( "POST", @@ -568,12 +593,12 @@ async def test_success_with_session_id(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_request = MCPQueryRequest(jsonrpc="2.0", id="2", method="init") - result = await client.mcp_kusto_query_management_async( + result = await client.mcp_kusto_query_management( input_request, session_id="session-123" ) @@ -603,11 +628,11 @@ async def test_session_id_with_special_characters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.mcp_kusto_query_management_async( + await client.mcp_kusto_query_management( MCPQueryRequest(), session_id="session with spaces" ) @@ -628,11 +653,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.mcp_kusto_query_management_async(MCPQueryRequest()) + result = await client.mcp_kusto_query_management(MCPQueryRequest()) assert result is None @@ -651,12 +676,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.mcp_kusto_query_management_async(MCPQueryRequest()) + await client.mcp_kusto_query_management(MCPQueryRequest()) assert exc_info.value.status_code == 500 @@ -734,13 +759,10 @@ def test_mcp_query_request_creation(self): assert request.params == {"query": "test"} assert request.callback_endpoint == "https://callback.example.com" - def test_dataclasses_with_defaults(self): - """Test that dataclasses can be created with default None values.""" - schema = QueryAndListSchema() - - assert schema.cluster is None - assert schema.db is None - assert schema.csl is None + def test_required_dataclass_fields(self): + """Test that Swagger-required dataclass fields must be provided.""" + with pytest.raises(TypeError): + QueryAndListSchema() class TestEdgeCases: @@ -759,12 +781,20 @@ async def test_multiple_consecutive_calls(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, side_effect=[mock_response_1, mock_response_2] ): - result_1 = await client.list_kusto_results_async(QueryAndListSchema()) - result_2 = await client.list_kusto_results_async(QueryAndListSchema()) + result_1 = await resolve_lro( + client.begin_list_kusto_results( + model_instance(QueryAndListSchema) + ) + ) + result_2 = await resolve_lro( + client.begin_list_kusto_results( + model_instance(QueryAndListSchema) + ) + ) assert result_1 == {"result": "first"} assert result_2 == {"result": "second"} @@ -781,12 +811,16 @@ async def test_json_parse_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(json.JSONDecodeError): - await client.list_kusto_results_async(QueryAndListSchema()) + await resolve_lro( + client.begin_list_kusto_results( + model_instance(QueryAndListSchema) + ) + ) @pytest.mark.asyncio async def test_url_construction_with_multiple_trailing_slashes(self): @@ -828,14 +862,14 @@ async def test_success_returns_schema(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=MockResponse( status=200, text='{"columns": [{"name": "Timestamp"}]}' ) ) as mock_send: - result = await client.list_kusto_results_schema_async(input_schema) + result = await client.list_kusto_results_schema(input_schema) mock_send.assert_called_once_with( "POST", @@ -858,13 +892,13 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=MockResponse(status=400, text="Invalid query") ): with pytest.raises(ConnectorException) as exc_info: - await client.list_kusto_results_schema_async( - QueryAndListSchema() + await client.list_kusto_results_schema( + model_instance(QueryAndListSchema) ) assert exc_info.value.status_code == 400 diff --git a/tests/test_mailchimp.py b/tests/test_mailchimp.py index d0ab645a..a7c053f4 100644 --- a/tests/test_mailchimp.py +++ b/tests/test_mailchimp.py @@ -7,8 +7,8 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.mailchimp import MailchimpClient from azure.connectors.mailchimp import ( - MailchimpClient, NewCampaignRequest, NewListRequest, NewMemberInListRequest, @@ -20,6 +20,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import model_instance, resolve_generated_result class TestMailchimpClientInitialization: @@ -55,7 +56,7 @@ def test_init_with_custom_settings(self, mock_credential): client = MailchimpClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -112,7 +113,7 @@ class TestMailchimpClientOperations: """Tests for MailchimpClient operations against expected HTTP calls.""" @pytest.mark.asyncio - async def test_get_campaigns_success(self, mock_credential): + async def test_list_campaigns_success(self, mock_credential): """Test list campaigns issues a GET to the campaigns route.""" client = MailchimpClient( "https://example.azure.com/connections/test", @@ -122,16 +123,16 @@ async def test_get_campaigns_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_campaigns_async() + result = await resolve_generated_result(client.list_campaigns()) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert url.endswith("/campaigns") - assert result == {"campaigns": []} + assert result == [] @pytest.mark.asyncio async def test_sendcampaign_success(self, mock_credential): @@ -144,11 +145,11 @@ async def test_sendcampaign_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.sendcampaign_async(campaign_id="c1") + result = await client.sendcampaign(campaign_id="c1") method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -166,11 +167,11 @@ async def test_get_lists_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_lists_async(count="10", offset="0") + result = await client.get_lists(count="10", offset="0") method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -190,11 +191,13 @@ async def test_newlist_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.newlist_async(input=NewListRequest(name="Test")) + result = await client.newlist( + input=model_instance(NewListRequest, name="Test"), + ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -213,12 +216,12 @@ async def test_add_members_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.add_members_async( - input=NewMembersInListRequest(), + result = await client.add_members( + input=model_instance(NewMembersInListRequest), list_id="L1", ) @@ -239,11 +242,11 @@ async def test_get_list_members_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_list_members_async(list_id="L1") + result = await client.get_list_members(list_id="L1") method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -261,12 +264,12 @@ async def test_addmember_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.addmember_async( - input=NewMemberInListRequest(), + result = await client.addmember( + input=model_instance(NewMemberInListRequest), list_id="L1", ) @@ -287,11 +290,13 @@ async def test_newcampaign_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.newcampaign_async(input=NewCampaignRequest()) + result = await client.newcampaign( + input=model_instance(NewCampaignRequest), + ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -310,11 +315,11 @@ async def test_removemember_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.removemember_async(list_id="L1") + result = await client.removemember(list_id="L1") method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "DELETE" @@ -333,12 +338,12 @@ async def test_updatemember_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.updatemember_async( - input=UpdateMemberInListRequest(), + result = await client.updatemember( + input=model_instance(UpdateMemberInListRequest), list_id="L1", ) @@ -350,8 +355,8 @@ async def test_updatemember_success(self, mock_credential): assert result == {"id": "m1"} @pytest.mark.asyncio - async def test_empty_response_body_returns_none(self, mock_credential): - """Test a 2xx response with no body returns None.""" + async def test_empty_response_body_returns_empty_page(self, mock_credential): + """Test a paged 2xx response with no body yields no items.""" client = MailchimpClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -360,13 +365,13 @@ async def test_empty_response_body_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.get_campaigns_async() + result = await resolve_generated_result(client.list_campaigns()) - assert result is None + assert result == [] class TestMailchimpClientErrorHandling: @@ -376,7 +381,7 @@ class TestMailchimpClientErrorHandling: @pytest.mark.parametrize( "operation", [ - "get_campaigns", + "list_campaigns", "sendcampaign", "get_lists", "newlist", @@ -398,36 +403,41 @@ async def test_error_response_raises_exception(self, mock_credential, operation) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - if operation == "get_campaigns": - await client.get_campaigns_async() + if operation == "list_campaigns": + await resolve_generated_result(client.list_campaigns()) elif operation == "sendcampaign": - await client.sendcampaign_async(campaign_id="c1") + await client.sendcampaign(campaign_id="c1") elif operation == "get_lists": - await client.get_lists_async() + await client.get_lists() elif operation == "newlist": - await client.newlist_async(input=NewListRequest()) + await client.newlist(input=model_instance(NewListRequest)) elif operation == "add_members": - await client.add_members_async( - input=NewMembersInListRequest(), list_id="L1" + await client.add_members( + input=model_instance(NewMembersInListRequest), + list_id="L1", ) elif operation == "get_list_members": - await client.get_list_members_async(list_id="L1") + await client.get_list_members(list_id="L1") elif operation == "addmember": - await client.addmember_async( - input=NewMemberInListRequest(), list_id="L1" + await client.addmember( + input=model_instance(NewMemberInListRequest), + list_id="L1", ) elif operation == "newcampaign": - await client.newcampaign_async(input=NewCampaignRequest()) + await client.newcampaign( + input=model_instance(NewCampaignRequest), + ) elif operation == "removemember": - await client.removemember_async(list_id="L1") + await client.removemember(list_id="L1") else: - await client.updatemember_async( - input=UpdateMemberInListRequest(), list_id="L1" + await client.updatemember( + input=model_instance(UpdateMemberInListRequest), + list_id="L1", ) assert exc_info.value.status_code == 500 @@ -475,11 +485,11 @@ def test_triggers_are_not_client_methods(self): class TestMailchimpTypeSerialization: - """Tests for Mailchimp connector dataclass defaults.""" + """Tests for Mailchimp connector dataclass construction.""" def test_request_dataclasses_instantiate(self): - """Test generated request dataclasses instantiate without arguments.""" - assert NewListRequest().name is None - assert NewCampaignRequest().type_ is None - assert NewMemberInListRequest().email_address is None - assert UpdateMemberInListRequest().status is None + """Test generated request dataclasses populate required fields.""" + assert model_instance(NewListRequest).name is not None + assert model_instance(NewCampaignRequest).type_ is not None + assert model_instance(NewMemberInListRequest).email_address is not None + assert model_instance(UpdateMemberInListRequest).status is not None diff --git a/tests/test_meetingroommap.py b/tests/test_meetingroommap.py index 626b38a8..063f0ceb 100644 --- a/tests/test_meetingroommap.py +++ b/tests/test_meetingroommap.py @@ -10,23 +10,23 @@ OPERATION_CONTRACTS = { "get_custom_locations": ("POST", True), "get_custom_locations_by_image_name": ("POST", True), - "get_categories": ("GET", False), + "list_categories": ("GET", False), "location_details": ("GET", False), - "search_locations": ("GET", False), + "list_search_locations": ("GET", False), "get_custom_location_image": ("GET", False), - "images": ("GET", False), + "list_images": ("GET", False), "get_meeting_room_image": ("GET", False), "next_meetings": ("GET", False), "get_meeting_room_details": ("GET", False), "get_office_locations": ("GET", False), - "search_coworkers": ("GET", False), + "list_search_coworkers": ("GET", False), "get_office_locations_by_image": ("GET", False), "get_room_with_persons_details": ("GET", False), "get_office_location_image": ("GET", False), - "get_rooms": ("GET", False), - "search_meeting_rooms": ("GET", False), - "room_lists": ("GET", False), - "rooms_by_list_address": ("GET", False), + "list_rooms": ("GET", False), + "list_search_meeting_rooms": ("GET", False), + "list_room_lists": ("GET", False), + "list_rooms_by_list_address": ("GET", False), "get_rooms_by_image_name": ("GET", False), } diff --git a/tests/test_microsoftbookings.py b/tests/test_microsoftbookings.py index 356dbe71..e3240637 100644 --- a/tests/test_microsoftbookings.py +++ b/tests/test_microsoftbookings.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.microsoftbookings import MicrosoftbookingsClient from azure.connectors.microsoftbookings import ( - MicrosoftbookingsClient, CreateAppointmentInput, UpdateAppointmentInput, CancelAppointmentInput, @@ -24,6 +24,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestMicrosoftbookingsClientInitialization: @@ -69,7 +70,7 @@ def test_init_with_custom_settings(self, mock_credential): client = MicrosoftbookingsClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -170,22 +171,28 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.list_bookings_business_user_as_admin_async() + result = await resolve_generated_result( + client.list_bookings_business_user_as_admin() + ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/bookingBusinessesUserAsAdmin" in call_args[0][1] - assert result is not None - assert "mailboxes" in result + assert result == [ + { + "display_name": "Contoso Bookings", + "email": "bookings@contoso.com", + } + ] @pytest.mark.asyncio - async def test_empty_response_returns_none(self, mock_credential): - """Test empty response returns None.""" + async def test_empty_response_returns_empty_page(self, mock_credential): + """Test empty response yields no mailbox items.""" mock_response = MockResponse(status=200, text='') client = MicrosoftbookingsClient( @@ -195,12 +202,14 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.list_bookings_business_user_as_admin_async() - assert result is None + result = await resolve_generated_result( + client.list_bookings_business_user_as_admin() + ) + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -217,12 +226,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.list_bookings_business_user_as_admin_async() + await resolve_generated_result( + client.list_bookings_business_user_as_admin() + ) assert exc_info.value.status_code == 401 @@ -230,10 +241,12 @@ async def test_error_response_raises_exception(self, mock_credential): class TestDataClasses: """Tests for dataclass definitions.""" - def test_create_appointment_input_defaults(self): - """Test CreateAppointmentInput dataclass with defaults.""" - input_obj = CreateAppointmentInput() - assert input_obj.webhook is None + def test_create_appointment_input_required_webhook(self): + """Test CreateAppointmentInput requires webhook data.""" + input_obj = CreateAppointmentInput( + webhook={"callbackUrl": "https://example.com/create"} + ) + assert input_obj.webhook["callbackUrl"] == "https://example.com/create" def test_create_appointment_input_with_values(self): """Test CreateAppointmentInput dataclass with values.""" @@ -242,15 +255,19 @@ def test_create_appointment_input_with_values(self): ) assert input_obj.webhook["callbackUrl"] == "https://example.com/callback" - def test_update_appointment_input_defaults(self): - """Test UpdateAppointmentInput dataclass with defaults.""" - input_obj = UpdateAppointmentInput() - assert input_obj.webhook is None + def test_update_appointment_input_required_webhook(self): + """Test UpdateAppointmentInput requires webhook data.""" + input_obj = UpdateAppointmentInput( + webhook={"callbackUrl": "https://example.com/update"} + ) + assert input_obj.webhook["callbackUrl"] == "https://example.com/update" - def test_cancel_appointment_input_defaults(self): - """Test CancelAppointmentInput dataclass with defaults.""" - input_obj = CancelAppointmentInput() - assert input_obj.webhook is None + def test_cancel_appointment_input_required_webhook(self): + """Test CancelAppointmentInput requires webhook data.""" + input_obj = CancelAppointmentInput( + webhook={"callbackUrl": "https://example.com/cancel"} + ) + assert input_obj.webhook["callbackUrl"] == "https://example.com/cancel" def test_webhook_response_defaults(self): """Test WebhookResponse dataclass with defaults.""" diff --git a/tests/test_microsoftforms.py b/tests/test_microsoftforms.py index 8e6b1f0a..ea471c42 100644 --- a/tests/test_microsoftforms.py +++ b/tests/test_microsoftforms.py @@ -7,11 +7,13 @@ import pytest from azure.core.credentials import AzureKeyCredential -from azure.connectors.microsoftforms import MicrosoftformsClient, TRIGGER_OPERATIONS +from azure.connectors.microsoftforms import MicrosoftformsClient +from azure.connectors.microsoftforms import TRIGGER_OPERATIONS from azure.connectors.sdk import ( ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestMicrosoftformsClientInitialization: @@ -47,7 +49,7 @@ def test_init_with_custom_settings(self, mock_credential): client = MicrosoftformsClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -120,22 +122,21 @@ async def test_success(self, mock_credential): credential=mock_credential, ) mock_response = MockResponse( - status=200, text='{"value": [{"id": "form-1", "title": "Survey"}]}') + status=200, text='[{"id": "form-1", "title": "Survey"}]') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_forms_async() + result = await resolve_generated_result(client.list_forms()) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert path.endswith("/formapi/api/forms") - assert result is not None - assert "value" in result + assert result == [{"id": "form-1", "title": "Survey"}] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -148,12 +149,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.list_forms_async() + await resolve_generated_result(client.list_forms()) class TestGetFormDetailsByIdAsync: @@ -170,11 +171,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_form_details_by_id_async(form_id="form-123") + result = await client.get_form_details_by_id(form_id="form-123") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -195,12 +196,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.get_form_details_by_id_async(form_id="missing") + await client.get_form_details_by_id(form_id="missing") class TestGetQuestionsAsync: @@ -218,11 +219,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_questions_async(form_id="form-123") + result = await client.get_questions(form_id="form-123") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -241,9 +242,9 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.get_questions_async(form_id="form-123") + await client.get_questions(form_id="form-123") diff --git a/tests/test_monday.py b/tests/test_monday.py index 1d02012c..464c76b7 100644 --- a/tests/test_monday.py +++ b/tests/test_monday.py @@ -7,112 +7,36 @@ import pytest from azure.core.credentials import AzureKeyCredential +import azure.connectors.monday as monday_module +from azure.connectors.monday import MondayClient from azure.connectors.monday import ( CreateBoardInput, - CreateColumnInput, - CreateGroupInput, CreateItemInput, CreateItemResponse, CreateNotificationInput, - CreateSubitemInput, - CreateUpdateInput, CreateWorkspaceInput, - DuplicateBoardInput, GetSubitemSchemaResponse, GetTagsResponse, GetUsersResponse, GetWorkspacesResponse, - MondayClient, - MoveItemToGroupInput, UpdateItemColumnInput, - UpdateMultipleItemColumnsInput, TRIGGER_OPERATIONS, ) from azure.connectors.sdk import ( ConnectorException, ) from tests.conftest import MockResponse -from tests.generated_connector_test_utils import get_generated_operations +from tests.generated_connector_test_utils import ( + get_generated_operations, + invoke_generated_operation, + model_instance, + resolve_generated_result, +) async def _invoke_operation(client: MondayClient, operation: str): """Invoke a Monday operation by name for shared tests.""" - if operation == "create_item": - return await client.create_item_async(input=CreateItemInput()) - if operation == "duplicate_board": - return await client.duplicate_board_async(input=DuplicateBoardInput()) - if operation == "create_board": - return await client.create_board_async(input=CreateBoardInput()) - if operation == "create_column": - return await client.create_column_async(input=CreateColumnInput()) - if operation == "create_group": - return await client.create_group_async(input=CreateGroupInput()) - if operation == "update_item_column": - return await client.update_item_column_async(input=UpdateItemColumnInput()) - if operation == "update_multiple_item_columns": - return await client.update_multiple_item_columns_async( - input=UpdateMultipleItemColumnsInput() - ) - if operation == "move_item_to_group": - return await client.move_item_to_group_async(input=MoveItemToGroupInput()) - if operation == "create_notification": - return await client.create_notification_async(input=CreateNotificationInput()) - if operation == "create_subitem": - return await client.create_subitem_async(input=CreateSubitemInput()) - if operation == "create_update": - return await client.create_update_async(input=CreateUpdateInput()) - if operation == "create_workspace": - return await client.create_workspace_async(input=CreateWorkspaceInput()) - if operation == "get_subitems": - return await client.get_subitems_async( - workspace_id="1", board_id="2", item_id="3" - ) - if operation == "get_item_by_id": - return await client.get_item_by_id_async( - item_id="1", workspace_id="2", board_id="3" - ) - if operation == "get_items": - return await client.get_items_async( - workspace_id="1", board_id="2", group_id="3" - ) - if operation == "get_tags": - return await client.get_tags_async() - if operation == "get_users": - return await client.get_users_async() - if operation == "get_workspaces": - return await client.get_workspaces_async() - if operation == "get_boards": - return await client.get_boards_async() - if operation == "get_groups_for_get_items": - return await client.get_groups_for_get_items_async(board_id="1") - if operation == "get_columns_for_item_filtering": - return await client.get_columns_for_item_filtering_async(board_id="1") - if operation == "get_column_filter_operator": - return await client.get_column_filter_operator_async(board_id="1") - if operation == "get_column_names_schema": - return await client.get_column_names_schema_async() - if operation == "get_single_column_schema": - return await client.get_single_column_schema_async() - if operation == "get_column_names_schema_for_webhook": - return await client.get_column_names_schema_for_webhook_async() - if operation == "get_schema_for_get_items_action": - return await client.get_schema_for_get_items_action_async() - if operation == "get_column_names_schema_for_update_webhook": - return await client.get_column_names_schema_for_update_webhook_async() - if operation == "get_column_names_schema_for_item_name_change_webhook": - return await client.get_column_names_schema_for_item_name_change_webhook_async() - if operation == "get_column_names_schema_for_subitem_name_change_webhook": - return await client.get_column_names_schema_for_subitem_name_change_webhook_async( - parent_board_id="1" - ) - if operation == "get_column_names_schema_for_column_changes_webhook": - return await client.get_column_names_schema_for_column_changes_webhook_async() - if operation == "get_subitem_column_names": - return await client.get_subitem_column_names_async(parent_board_id="1") - if operation == "get_subitem_schema": - return await client.get_subitem_schema_async(parent_board_id="1") - - raise ValueError(f"Unsupported operation '{operation}'.") + return await invoke_generated_operation(client, operation, monday_module) ALL_OPERATIONS = [ @@ -134,10 +58,10 @@ async def _invoke_operation(client: MondayClient, operation: str): "get_tags", "get_users", "get_workspaces", - "get_boards", - "get_groups_for_get_items", - "get_columns_for_item_filtering", - "get_column_filter_operator", + "list_boards", + "list_groups_for_get_items", + "list_columns_for_item_filtering", + "list_column_filter_operator", "get_column_names_schema", "get_single_column_schema", "get_column_names_schema_for_webhook", @@ -184,7 +108,7 @@ def test_init_with_custom_settings(self, mock_credential): client = MondayClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -255,11 +179,13 @@ async def test_create_item_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_item_async(input=CreateItemInput()) + result = await client.create_item( + input=model_instance(CreateItemInput), + ) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -278,11 +204,13 @@ async def test_update_item_column_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.update_item_column_async(input=UpdateItemColumnInput()) + result = await client.update_item_column( + input=model_instance(UpdateItemColumnInput), + ) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -301,11 +229,11 @@ async def test_get_tags_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_tags_async() + result = await client.get_tags() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -313,8 +241,8 @@ async def test_get_tags_success(self, mock_credential): assert result == {"data": []} @pytest.mark.asyncio - async def test_get_boards_includes_query_parameter(self, mock_credential): - """Test get boards appends the workspaceId query parameter.""" + async def test_list_boards_includes_query_parameter(self, mock_credential): + """Test list boards appends the workspaceId query parameter.""" client = MondayClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -323,11 +251,13 @@ async def test_get_boards_includes_query_parameter(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.get_boards_async(workspace_id="42") + await resolve_generated_result( + client.list_boards(workspace_id="42") + ) method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -345,11 +275,11 @@ async def test_get_subitems_includes_query_parameters(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.get_subitems_async(workspace_id="1", board_id="2", item_id="3") + await client.get_subitems(workspace_id="1", board_id="2", item_id="3") method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -367,11 +297,13 @@ async def test_empty_response_body_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.create_item_async(input=CreateItemInput()) + result = await client.create_item( + input=model_instance(CreateItemInput), + ) assert result is None @@ -395,7 +327,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -439,7 +371,7 @@ def test_triggers_are_not_client_methods(self): class TestMondayTypeSerialization: - """Tests for Monday connector dataclass defaults.""" + """Tests for Monday connector dataclass construction.""" def test_response_dataclasses_initialize_expected_defaults(self): """Test generated response dataclasses initialize with None defaults.""" @@ -450,8 +382,8 @@ def test_response_dataclasses_initialize_expected_defaults(self): assert GetSubitemSchemaResponse().schema is None def test_request_dataclasses_instantiate(self): - """Test generated request dataclasses instantiate without arguments.""" - assert CreateItemInput().item_name is None - assert CreateBoardInput().board_name is None - assert CreateNotificationInput().text is None - assert CreateWorkspaceInput() is not None + """Test generated request dataclasses populate required fields.""" + assert model_instance(CreateItemInput).item_name is not None + assert model_instance(CreateBoardInput).board_name is not None + assert model_instance(CreateNotificationInput).text is not None + assert model_instance(CreateWorkspaceInput).name is not None diff --git a/tests/test_mq.py b/tests/test_mq.py index 3942a70d..772e9977 100644 --- a/tests/test_mq.py +++ b/tests/test_mq.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.mq import MqClient from azure.connectors.mq import ( - MqClient, SingleGetValidOptions, MultipleGetValidOptions, SendValidDataOptions, @@ -15,6 +15,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestMqClientInitialization: @@ -50,7 +51,7 @@ def test_init_with_custom_settings(self, mock_credential): client = MqClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -122,11 +123,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.delete_async(input=input_options) + result = await client.delete(input=input_options) mock_send.assert_called_once() call_args = mock_send.call_args @@ -146,11 +147,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.delete_async(input=SingleGetValidOptions()) + result = await client.delete(input=SingleGetValidOptions()) assert result is None @pytest.mark.asyncio @@ -165,18 +166,18 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_async(input=SingleGetValidOptions()) + await client.delete(input=SingleGetValidOptions()) assert exc_info.value.status_code == 404 class TestDeleteAll: - """Tests for delete_all_async method.""" + """Tests for delete_all method.""" @pytest.mark.asyncio async def test_success_with_json_response(self, mock_credential): @@ -188,27 +189,29 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"deletedCount": 5, "messages": []}' + text='{"value": [{"deletedCount": 5, "messages": []}]}' ) input_options = MultipleGetValidOptions(queue="QUEUE.NAME", batch_size=10) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.delete_all_async(input=input_options) + result = await resolve_generated_result( + client.delete_all(input=input_options) + ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "POST" assert "/v2/deleteall" in call_args[0][1] - assert result["deletedCount"] == 5 + assert result["value"][0]["deletedCount"] == 5 @pytest.mark.asyncio - async def test_empty_response_returns_none(self, mock_credential): - """Test that empty response returns None.""" + async def test_empty_response_returns_empty_page(self, mock_credential): + """Test that empty response yields no items.""" client = MqClient( "https://example.azure.com/connections/test", credential=mock_credential @@ -218,11 +221,13 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.delete_all_async(input=MultipleGetValidOptions()) + result = await resolve_generated_result( + client.delete_all(input=MultipleGetValidOptions()) + ) assert result is None @pytest.mark.asyncio @@ -237,12 +242,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_all_async(input=MultipleGetValidOptions()) + await resolve_generated_result( + client.delete_all(input=MultipleGetValidOptions()) + ) assert exc_info.value.status_code == 500 @@ -266,11 +273,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.read_async(input=input_options) + result = await client.read(input=input_options) mock_send.assert_called_once() call_args = mock_send.call_args @@ -290,11 +297,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.read_async(input=SingleGetValidOptions()) + result = await client.read(input=SingleGetValidOptions()) assert result is None @pytest.mark.asyncio @@ -309,18 +316,18 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.read_async(input=SingleGetValidOptions()) + await client.read(input=SingleGetValidOptions()) assert exc_info.value.status_code == 403 class TestReadAll: - """Tests for read_all_async method.""" + """Tests for read_all method.""" @pytest.mark.asyncio async def test_success_with_json_response(self, mock_credential): @@ -332,27 +339,29 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"messages": [{"messageId": "msg1"}, {"messageId": "msg2"}]}' + text='{"value": [{"messageId": "msg1"}, {"messageId": "msg2"}]}' ) input_options = MultipleGetValidOptions(queue="QUEUE.NAME", batch_size=10) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.read_all_async(input=input_options) + result = await resolve_generated_result( + client.read_all(input=input_options) + ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "POST" assert "/v2/readall" in call_args[0][1] - assert len(result["messages"]) == 2 + assert len(result["value"]) == 2 @pytest.mark.asyncio - async def test_empty_response_returns_none(self, mock_credential): - """Test that empty response returns None.""" + async def test_empty_response_returns_empty_page(self, mock_credential): + """Test that empty response yields no items.""" client = MqClient( "https://example.azure.com/connections/test", credential=mock_credential @@ -362,11 +371,13 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.read_all_async(input=MultipleGetValidOptions()) + result = await resolve_generated_result( + client.read_all(input=MultipleGetValidOptions()) + ) assert result is None @pytest.mark.asyncio @@ -381,12 +392,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.read_all_async(input=MultipleGetValidOptions()) + await resolve_generated_result( + client.read_all(input=MultipleGetValidOptions()) + ) assert exc_info.value.status_code == 408 @@ -410,11 +423,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.receive_async(input=input_options) + result = await client.receive(input=input_options) mock_send.assert_called_once() call_args = mock_send.call_args @@ -434,11 +447,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.receive_async(input=SingleGetValidOptions()) + result = await client.receive(input=SingleGetValidOptions()) assert result is None @pytest.mark.asyncio @@ -453,18 +466,18 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.receive_async(input=SingleGetValidOptions()) + await client.receive(input=SingleGetValidOptions()) assert exc_info.value.status_code == 503 class TestReceiveAll: - """Tests for receive_all_async method.""" + """Tests for receive_all method.""" @pytest.mark.asyncio async def test_success_with_json_response(self, mock_credential): @@ -476,7 +489,7 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"messages": [{"messageId": "msg1", "messageData": "Data1"}]}' + text='{"value": [{"messageId": "msg1", "messageData": "Data1"}]}' ) input_options = MultipleGetValidOptions( queue="QUEUE.NAME", @@ -486,21 +499,23 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.receive_all_async(input=input_options) + result = await resolve_generated_result( + client.receive_all(input=input_options) + ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "POST" assert "/v2/receiveall" in call_args[0][1] - assert len(result["messages"]) == 1 + assert len(result["value"]) == 1 @pytest.mark.asyncio - async def test_empty_response_returns_none(self, mock_credential): - """Test that empty response returns None.""" + async def test_empty_response_returns_empty_page(self, mock_credential): + """Test that empty response yields no items.""" client = MqClient( "https://example.azure.com/connections/test", credential=mock_credential @@ -510,11 +525,13 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.receive_all_async(input=MultipleGetValidOptions()) + result = await resolve_generated_result( + client.receive_all(input=MultipleGetValidOptions()) + ) assert result is None @pytest.mark.asyncio @@ -529,12 +546,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.receive_all_async(input=MultipleGetValidOptions()) + await resolve_generated_result( + client.receive_all(input=MultipleGetValidOptions()) + ) assert exc_info.value.status_code == 401 @@ -562,11 +581,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.send_async(input=input_options) + result = await client.send(input=input_options) mock_send.assert_called_once() call_args = mock_send.call_args @@ -594,11 +613,11 @@ async def test_with_correlation_id(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.send_async(input=input_options) + result = await client.send(input=input_options) mock_send.assert_called_once() assert result["correlationId"] == "corr123" @@ -621,11 +640,11 @@ async def test_with_reply_to_queue(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.send_async(input=input_options) + result = await client.send(input=input_options) mock_send.assert_called_once() assert result["itemInternalId"] == "item789" @@ -642,11 +661,13 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.send_async(input=SendValidDataOptions()) + result = await client.send( + input=SendValidDataOptions(message="test message") + ) assert result is None @pytest.mark.asyncio @@ -661,12 +682,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.send_async(input=SendValidDataOptions()) + await client.send( + input=SendValidDataOptions(message="test message") + ) assert exc_info.value.status_code == 400 @@ -682,11 +705,11 @@ async def test_queue_full_error(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.send_async(input=SendValidDataOptions(message="test")) + await client.send(input=SendValidDataOptions(message="test")) assert exc_info.value.status_code == 507 diff --git a/tests/test_msgraph.py b/tests/test_msgraph.py index a9c2cbb4..74117591 100644 --- a/tests/test_msgraph.py +++ b/tests/test_msgraph.py @@ -4,8 +4,8 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.msgraphgroupsanduser import MsgraphgroupsanduserClient from azure.connectors.msgraphgroupsanduser import ( - MsgraphgroupsanduserClient, ListUsersResponse, ListGroupsByDisplayNameSearchResponse, ListSubscribedSkusResponse, @@ -16,6 +16,7 @@ GetMemberGroupsResponse, ) from azure.connectors.sdk import ConnectorException +from tests.generated_connector_test_utils import resolve_generated_result class TestMsgraphClientInitialization: @@ -51,7 +52,7 @@ def test_init_with_custom_settings(self, mock_credential): client = MsgraphgroupsanduserClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) @@ -119,14 +120,14 @@ async def test_success_with_json_response(self, mock_credential, mock_response_s with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - result = await client.list_users_async() + result = await resolve_generated_result(client.list_users()) assert result is not None - assert result["value"][0]["id"] == "user1" + assert result[0]["id"] == "user1" mock_send.assert_called_once_with( "GET", "https://example.azure.com/connections/test/v1.0/users", @@ -147,13 +148,13 @@ async def test_success_with_empty_response(self, mock_credential, mock_response_ with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_empty ): - result = await client.list_users_async() + result = await resolve_generated_result(client.list_users()) - assert result is None + assert result == [] @pytest.mark.asyncio async def test_error_raises_exception(self, mock_credential, mock_response_error): @@ -165,12 +166,12 @@ async def test_error_raises_exception(self, mock_credential, mock_response_error with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_error ): with pytest.raises(ConnectorException) as exc_info: - await client.list_users_async() + await resolve_generated_result(client.list_users()) assert exc_info.value.status_code == 400 @@ -193,16 +194,15 @@ async def test_success_with_search_and_count(self, mock_credential, mock_respons with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - result = await client.list_groups_by_display_name_search_async( - search="Test" + result = await resolve_generated_result( + client.list_groups_by_display_name_search(search="Test") ) - assert result is not None - assert "@odata.count" in result + assert result == [{"id": "group1", "displayName": "Test Group"}] mock_send.assert_called_once() call_path = mock_send.call_args[0][1] assert "$search=Test" in call_path @@ -219,13 +219,15 @@ async def test_success_with_count_only(self, mock_credential, mock_response_succ with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - result = await client.list_groups_by_display_name_search_async() + result = await resolve_generated_result( + client.list_groups_by_display_name_search() + ) - assert result is not None + assert result == [] call_path = mock_send.call_args[0][1] assert "$search" not in call_path @@ -241,12 +243,12 @@ async def test_url_encodes_search_parameter(self, mock_credential, mock_response with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - await client.list_groups_by_display_name_search_async( - search="Test Group Name" + await resolve_generated_result( + client.list_groups_by_display_name_search(search="Test Group Name") ) call_path = mock_send.call_args[0][1] @@ -262,12 +264,14 @@ async def test_error_raises_exception(self, mock_credential, mock_response_error with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_error ): with pytest.raises(ConnectorException) as exc_info: - await client.list_groups_by_display_name_search_async() + await resolve_generated_result( + client.list_groups_by_display_name_search() + ) assert exc_info.value.status_code == 400 @@ -289,14 +293,13 @@ async def test_success_with_json_response(self, mock_credential, mock_response_s with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - result = await client.list_subscribed_skus_async() + result = await resolve_generated_result(client.list_subscribed_skus()) - assert result is not None - assert result["value"][0]["skuPartNumber"] == "ENTERPRISEPACK" + assert result[0]["skuPartNumber"] == "ENTERPRISEPACK" mock_send.assert_called_once_with( "GET", "https://example.azure.com/connections/test/v1.0/subscribedSkus", @@ -317,12 +320,12 @@ async def test_error_raises_exception(self, mock_credential, mock_response_error with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_error ): with pytest.raises(ConnectorException) as exc_info: - await client.list_subscribed_skus_async() + await resolve_generated_result(client.list_subscribed_skus()) assert exc_info.value.status_code == 400 @@ -345,18 +348,19 @@ async def test_success_with_all_parameters(self, mock_credential, mock_response_ with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - result = await client.list_direct_group_members_async( - group_id="group-123", - filter="userType eq 'Member'", - select="id,displayName" + result = await resolve_generated_result( + client.list_direct_group_members( + group_id="group-123", + filter="userType eq 'Member'", + select="id,displayName" + ) ) - assert result is not None - assert result["@odata.count"] == 5 + assert result == [{"id": "member1", "displayName": "Member One"}] call_path = mock_send.call_args[0][1] assert "/v1.0/groups/group-123/members" in call_path assert "$filter=userType%20eq%20%27Member%27" in call_path @@ -376,15 +380,15 @@ async def test_success_with_group_id_and_count_only( with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - result = await client.list_direct_group_members_async( - group_id="group-456" + result = await resolve_generated_result( + client.list_direct_group_members(group_id="group-456") ) - assert result is not None + assert result == [] call_path = mock_send.call_args[0][1] assert "/v1.0/groups/group-456/members" in call_path assert "$filter" not in call_path @@ -402,12 +406,12 @@ async def test_group_id_in_path(self, mock_credential, mock_response_success): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - await client.list_direct_group_members_async( - group_id="test-group-id" + await resolve_generated_result( + client.list_direct_group_members(group_id="test-group-id") ) call_path = mock_send.call_args[0][1] @@ -423,13 +427,13 @@ async def test_error_raises_exception(self, mock_credential, mock_response_error with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_error ): with pytest.raises(ConnectorException) as exc_info: - await client.list_direct_group_members_async( - group_id="group-123" + await resolve_generated_result( + client.list_direct_group_members(group_id="group-123") ) assert exc_info.value.status_code == 400 @@ -450,17 +454,19 @@ async def test_success_with_select_parameter(self, mock_credential, mock_respons with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - result = await client.get_member_license_details_async( - id="user-123", - select="skuId,servicePlans" + result = await resolve_generated_result( + client.list_member_license_details( + id="user-123", + select="skuId,servicePlans" + ) ) assert result is not None - assert result["value"][0]["skuId"] == "sku1" + assert result[0]["skuId"] == "sku1" call_path = mock_send.call_args[0][1] assert "/v1.0/users/user-123/licenseDetails" in call_path assert "$select=skuId%2CservicePlans" in call_path @@ -479,11 +485,13 @@ async def test_success_without_select_parameter( with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - result = await client.get_member_license_details_async(id="user-456") + result = await resolve_generated_result( + client.list_member_license_details(id="user-456") + ) assert result is not None call_path = mock_send.call_args[0][1] @@ -500,12 +508,14 @@ async def test_error_raises_exception(self, mock_credential, mock_response_error with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_error ): with pytest.raises(ConnectorException) as exc_info: - await client.get_member_license_details_async(id="user-123") + await resolve_generated_result( + client.list_member_license_details(id="user-123") + ) assert exc_info.value.status_code == 400 @@ -528,11 +538,11 @@ async def test_success_with_json_response(self, mock_credential, mock_response_s with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - result = await client.get_group_properties_async(group_id="group-123") + result = await client.get_group_properties(group_id="group-123") assert result is not None assert result["id"] == "group-123" @@ -559,11 +569,11 @@ async def test_group_id_in_path(self, mock_credential, mock_response_success): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - await client.get_group_properties_async(group_id="my-group-id") + await client.get_group_properties(group_id="my-group-id") call_path = mock_send.call_args[0][1] assert "groups/my-group-id" in call_path @@ -578,12 +588,12 @@ async def test_error_raises_exception(self, mock_credential, mock_response_error with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_error ): with pytest.raises(ConnectorException) as exc_info: - await client.get_group_properties_async(group_id="group-123") + await client.get_group_properties(group_id="group-123") assert exc_info.value.status_code == 400 @@ -607,17 +617,19 @@ async def test_success_with_security_enabled_only_true( with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - result = await client.get_member_groups_async( - input=input_data, - member_id="user-123" + result = await resolve_generated_result( + client.list_member_groups( + input=input_data, + member_id="user-123" + ) ) assert result is not None - assert len(result["value"]) == 3 + assert len(result) == 3 mock_send.assert_called_once_with( "POST", "https://example.azure.com/connections/test/v1.0/users/user-123/getMemberGroups", @@ -644,17 +656,19 @@ async def test_success_with_security_enabled_only_false( with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ): - result = await client.get_member_groups_async( - input=input_data, - member_id="user-456" + result = await resolve_generated_result( + client.list_member_groups( + input=input_data, + member_id="user-456" + ) ) assert result is not None - assert result["value"] == [] + assert result == [] @pytest.mark.asyncio async def test_member_id_in_path(self, mock_credential, mock_response_success): @@ -666,17 +680,19 @@ async def test_member_id_in_path(self, mock_credential, mock_response_success): mock_response_success.text = '{}' - input_data = GetMemberGroupsInput() + input_data = GetMemberGroupsInput(security_enabled_only=True) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - await client.get_member_groups_async( - input=input_data, - member_id="member-789" + await resolve_generated_result( + client.list_member_groups( + input=input_data, + member_id="member-789" + ) ) call_path = mock_send.call_args[0][1] @@ -694,14 +710,16 @@ async def test_error_raises_exception(self, mock_credential, mock_response_error with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_error ): with pytest.raises(ConnectorException) as exc_info: - await client.get_member_groups_async( - input=input_data, - member_id="user-123" + await resolve_generated_result( + client.list_member_groups( + input=input_data, + member_id="user-123" + ) ) assert exc_info.value.status_code == 400 @@ -805,13 +823,13 @@ async def test_multiple_consecutive_calls(self, mock_credential, mock_response_s with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ): - result1 = await client.list_users_async() - result2 = await client.list_subscribed_skus_async() - result3 = await client.get_group_properties_async(group_id="group-123") + result1 = await resolve_generated_result(client.list_users()) + result2 = await resolve_generated_result(client.list_subscribed_skus()) + result3 = await client.get_group_properties(group_id="group-123") assert result1 is not None assert result2 is not None @@ -831,12 +849,12 @@ async def test_json_parse_error_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(Exception): # JSON parse error - await client.list_users_async() + await resolve_generated_result(client.list_users()) @pytest.mark.asyncio async def test_boolean_parameter_conversion(self, mock_credential, mock_response_success): @@ -850,11 +868,13 @@ async def test_boolean_parameter_conversion(self, mock_credential, mock_response with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - await client.list_groups_by_display_name_search_async(search="Group") + await resolve_generated_result( + client.list_groups_by_display_name_search(search="Group") + ) call_path = mock_send.call_args[0][1] assert "$search=Group" in call_path @@ -873,14 +893,16 @@ async def test_empty_string_parameters_excluded( with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: - await client.list_direct_group_members_async( - group_id="group-123", - filter=None, - select=None + await resolve_generated_result( + client.list_direct_group_members( + group_id="group-123", + filter=None, + select=None + ) ) call_path = mock_send.call_args[0][1] @@ -899,12 +921,12 @@ async def test_special_characters_in_ids(self, mock_credential, mock_response_su with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: # ID with hyphen and numbers - await client.get_group_properties_async(group_id="abc-123-def-456") + await client.get_group_properties(group_id="abc-123-def-456") call_path = mock_send.call_args[0][1] assert "groups/abc-123-def-456" in call_path @@ -921,18 +943,20 @@ async def test_http_methods_used_correctly(self, mock_credential, mock_response_ with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response_success ) as mock_send: # GET methods - await client.list_users_async() + await resolve_generated_result(client.list_users()) assert mock_send.call_args[0][0] == "GET" - await client.get_group_properties_async(group_id="group-123") + await client.get_group_properties(group_id="group-123") assert mock_send.call_args[0][0] == "GET" # POST method - input_data = GetMemberGroupsInput() - await client.get_member_groups_async(input=input_data, member_id="user-123") + input_data = GetMemberGroupsInput(security_enabled_only=True) + await resolve_generated_result( + client.list_member_groups(input=input_data, member_id="user-123") + ) assert mock_send.call_args[0][0] == "POST" diff --git a/tests/test_office365.py b/tests/test_office365.py index 682dcbba..adf45453 100644 --- a/tests/test_office365.py +++ b/tests/test_office365.py @@ -6,8 +6,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.office365 import Office365Client from azure.connectors.office365 import ( - Office365Client, DraftEmailInput, ClientReceiveFileAttachment, ClientReceiveMessage, @@ -18,7 +18,7 @@ MarkAsReadInput, MCPQueryRequest, ResponseToEventInvite, - CalendarEventBackend, + GraphCalendarEventClient, GetAttachmentResponse, SensitivityLabelMetadata, SendEmailInput, @@ -27,7 +27,7 @@ ConnectorException, ) from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import model_instance, resolve_generated_result class TestOffice365ClientInitialization: @@ -63,7 +63,7 @@ def test_init_with_custom_settings(self, mock_credential): client = Office365Client( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -118,11 +118,11 @@ async def test_success_uses_response_path_parameter(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=202, text=""), ) as mock_send: - await client.respond_to_event_async( + await client.respond_to_event( input=input_value, event_id="event/1", response="tentatively accept", @@ -149,12 +149,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=404, text="Event not found"), ): with pytest.raises(ConnectorException) as exc_info: - await client.respond_to_event_async( + await client.respond_to_event( input=ResponseToEventInvite(), event_id="missing", response="decline", @@ -188,16 +188,18 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"value": [{"displayName": "Red category"}, {"displayName": "Blue category"}]}' + text='[{"displayName": "Red category"}, {"displayName": "Blue category"}]' ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_outlook_category_names_async() + result = await resolve_generated_result( + client.list_outlook_category_names() + ) mock_send.assert_called_once_with( "GET", @@ -208,8 +210,7 @@ async def test_success_with_json_response(self, mock_credential): client_request_id=None, response_hook=None, ) - assert "value" in result - assert len(result["value"]) == 2 + assert len(result) == 2 @pytest.mark.asyncio async def test_empty_response_returns_none(self, mock_credential): @@ -223,12 +224,14 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_outlook_category_names_async() - assert result is None + result = await resolve_generated_result( + client.list_outlook_category_names() + ) + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -245,12 +248,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_outlook_category_names_async() + await resolve_generated_result( + client.list_outlook_category_names() + ) assert exc_info.value.status_code == 401 @@ -273,12 +278,16 @@ async def test_success_with_body_and_no_query_params(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - input_message = DraftEmailInput() - result = await client.draft_email_async(input_message) + input_message = DraftEmailInput( + to="recipient@example.com", + subject="Test Email", + body="Hello", + ) + result = await client.draft_email(input_message) mock_send.assert_called_once_with( "POST", @@ -306,12 +315,16 @@ async def test_success_with_query_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - input_message = DraftEmailInput() - await client.draft_email_async( + input_message = DraftEmailInput( + to="recipient@example.com", + subject="Test Email", + body="Hello", + ) + await client.draft_email( input_message, message_id="original123", draft_type="reply", @@ -339,12 +352,16 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.draft_email_async(DraftEmailInput()) + await client.draft_email(DraftEmailInput( + to="recipient@example.com", + subject="Test Email", + body="Hello", + )) assert exc_info.value.status_code == 400 @@ -364,12 +381,16 @@ async def test_success_no_return_value(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - input_message = DraftEmailInput() - result = await client.update_draft_email_async(input_message, "message123") + input_message = DraftEmailInput( + to="recipient@example.com", + subject="Test Email", + body="Hello", + ) + result = await client.update_draft_email(input_message, "message123") call_args = mock_send.call_args assert call_args[0][0] == "PATCH" @@ -389,13 +410,17 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - input_message = DraftEmailInput() - await client.update_draft_email_async(input_message, "nonexistent") + input_message = DraftEmailInput( + to="recipient@example.com", + subject="Test Email", + body="Hello", + ) + await client.update_draft_email(input_message, "nonexistent") assert exc_info.value.status_code == 404 @@ -415,11 +440,11 @@ async def test_success_with_path_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.send_draft_email_async("message123") + result = await client.send_draft_email("message123") # NOTE: The generated code uses template syntax instead of f-string interpolation call_args = mock_send.call_args @@ -439,11 +464,11 @@ async def test_path_parameter_construction(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.send_draft_email_async("test123") + await client.send_draft_email("test123") call_args = mock_send.call_args path = call_args[0][1] @@ -461,12 +486,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.send_draft_email_async("nonexistent") + await client.send_draft_email("nonexistent") assert exc_info.value.status_code == 404 @@ -486,11 +511,11 @@ async def test_success_with_multiple_query_params(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.assign_category_async( + await client.assign_category( message_id="msg123", category="Red category" ) @@ -512,12 +537,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.assign_category_async( + await client.assign_category( message_id="nonexistent", category="Red category" ) @@ -540,11 +565,11 @@ async def test_delete_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.delete_email_async("message123") + result = await client.delete_email("message123") call_args = mock_send.call_args assert call_args[0][0] == "DELETE" @@ -572,11 +597,11 @@ async def test_success_with_complex_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_email_async("message123") + result = await client.get_email("message123") assert result["id"] == "msg123" assert result["subject"] == "Test" @@ -601,14 +626,16 @@ async def test_success_with_filtering_and_pagination(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_emails_async( - folder_path="Inbox", - top="10", - search_query="subject:Important" + await resolve_generated_result( + client.list_emails( + folder_path="Inbox", + top=10, + search_query="subject:Important" + ) ) call_args = mock_send.call_args @@ -633,12 +660,16 @@ async def test_send_email_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - email_message = SendEmailInput() - result = await client.send_email_async(email_message) + email_message = SendEmailInput( + to="recipient@example.com", + subject="Test Email", + body="Hello", + ) + result = await client.send_email(email_message) call_args = mock_send.call_args assert call_args[0][0] == "POST" @@ -665,7 +696,7 @@ async def test_success_with_input_schema(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): @@ -674,7 +705,7 @@ async def test_success_with_input_schema(self, mock_credential): meeting_duration=60, max_candidates=5 ) - result = await client.find_meeting_times_async(input_data) + result = await client.find_meeting_times(input_data) assert "emptySuggestionsReason" in result @@ -700,11 +731,11 @@ async def test_success_with_attachment_data(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_attachment_async("message123", "att123") + result = await client.get_attachment("message123", "att123") assert result["id"] == "att123" assert result["name"] == "document.pdf" @@ -729,12 +760,12 @@ async def test_success_without_session_id(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: request = MCPQueryRequest(jsonrpc="2.0", id="1", method="list") - result = await client.mcp_emails_management_async(request) + result = await client.mcp_emails_management(request) mock_send.assert_called_once_with( "POST", @@ -762,12 +793,12 @@ async def test_success_with_session_id(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: request = MCPQueryRequest(jsonrpc="2.0", id="2", method="init") - await client.mcp_emails_management_async( + await client.mcp_emails_management( request, session_id="session-abc" ) @@ -795,13 +826,14 @@ async def test_get_calendars(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.calendar_get_tables_async() - assert "value" in result - assert len(result["value"]) == 1 + result = await resolve_generated_result( + client.list_calendar_get_tables() + ) + assert len(result) == 1 @pytest.mark.asyncio async def test_create_calendar_event(self, mock_credential): @@ -818,12 +850,12 @@ async def test_create_calendar_event(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - event = CalendarEventBackend() - result = await client.calendar_post_item_async("Calendar", event) + event = model_instance(GraphCalendarEventClient) + result = await client.calendar_post_item("Calendar", event) call_args = mock_send.call_args assert call_args[0][0] == "POST" @@ -841,11 +873,11 @@ async def test_delete_calendar_event(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.calendar_delete_item_async("Calendar", "event123") + result = await client.calendar_delete_item("Calendar", "event123") call_args = mock_send.call_args assert call_args[0][0] == "DELETE" @@ -870,11 +902,11 @@ async def test_get_contacts(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await resolve_generated_result(client.contact_get_items_async("Contacts")) + result = await resolve_generated_result(client.list_contact_get_items("Contacts")) assert result diff --git a/tests/test_office365groups.py b/tests/test_office365groups.py index d84fdb46..a2e5bbfc 100644 --- a/tests/test_office365groups.py +++ b/tests/test_office365groups.py @@ -6,8 +6,8 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.office365groups import Office365groupsClient from azure.connectors.office365groups import ( - Office365groupsClient, ListGroupMembersResponse, OnGroupMemberAddedOrRemovedResponse, ListGroupsResponse, @@ -60,7 +60,7 @@ def test_init_with_custom_settings(self, mock_credential): client = Office365groupsClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -140,12 +140,12 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: result = await resolve_generated_result( - client.list_group_members_async(group_id="group-123") + client.list_group_members(group_id="group-123") ) mock_send.assert_called_once() @@ -168,12 +168,12 @@ async def test_with_top_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: await resolve_generated_result( - client.list_group_members_async(group_id="group-123", top="10") + client.list_group_members(group_id="group-123", top="10") ) call_args = mock_send.call_args @@ -191,12 +191,12 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): result = await resolve_generated_result( - client.list_group_members_async(group_id="group-123") + client.list_group_members(group_id="group-123") ) assert result == [] @@ -212,13 +212,13 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): await resolve_generated_result( - client.list_group_members_async(group_id="group-123") + client.list_group_members(group_id="group-123") ) @@ -240,11 +240,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.list_groups_async()) + result = await resolve_generated_result(client.list_groups()) mock_send.assert_called_once() assert result is not None @@ -262,12 +262,12 @@ async def test_with_filter_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: await resolve_generated_result( - client.list_groups_async(filter="displayName eq 'Engineering'") + client.list_groups(filter="displayName eq 'Engineering'") ) call_args = mock_send.call_args @@ -285,11 +285,11 @@ async def test_with_pagination_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.list_groups_async(top="50", skiptoken="token123")) + await resolve_generated_result(client.list_groups(top="50", skiptoken="token123")) call_args = mock_send.call_args path = call_args[0][1] @@ -312,11 +312,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.add_member_to_group_async( + await client.add_member_to_group( group_id="group-123", user_upn="user@contoso.com" ) @@ -342,11 +342,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.remove_member_from_group_async( + await client.remove_member_from_group( group_id="group-123", user_upn="user@contoso.com" ) @@ -374,16 +374,18 @@ async def test_success(self, mock_credential): event_input = UpdateCalendarEventHTMLRequest( subject="Team Meeting", + start={"dateTime": "2026-10-12T09:00:00Z"}, + end={"dateTime": "2026-10-12T10:00:00Z"}, is_all_day=False ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_calendar_event_async( + result = await client.create_calendar_event( input=event_input, group_id="group-123" ) @@ -410,16 +412,18 @@ async def test_success(self, mock_credential): ) event_input = UpdateCalendarEventHTMLRequest( - subject="Updated Meeting" + subject="Updated Meeting", + start={"dateTime": "2026-10-12T09:00:00Z"}, + end={"dateTime": "2026-10-12T10:00:00Z"}, ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.update_calendar_event_async( + result = await client.update_calendar_event( input=event_input, event="event-123", group_id="group-123" @@ -446,11 +450,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.calendar_delete_item_async( + await client.calendar_delete_item( event="event-123", group_id="group-123" ) @@ -478,11 +482,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.list_deleted_groups_async()) + result = await resolve_generated_result(client.list_deleted_groups()) mock_send.assert_called_once() assert result is not None @@ -500,11 +504,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await resolve_generated_result(client.list_deleted_groups_async()) + result = await resolve_generated_result(client.list_deleted_groups()) assert result == [] @@ -523,11 +527,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.restore_deleted_group_async(group_id="deleted-group-123") + await client.restore_deleted_group(group_id="deleted-group-123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -553,15 +557,14 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.list_owned_groups_async() + result = await resolve_generated_result(client.list_owned_groups()) mock_send.assert_called_once() - assert result is not None - assert "value" in result + assert result == [{"id": "my-group", "displayName": "My Team"}] class TestHttpRequestAsync: @@ -584,11 +587,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.http_request_async(input=request_input) + result = await client.http_request(input=request_input) mock_send.assert_called_once() assert result is not None @@ -607,12 +610,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.http_request_async(input=request_input) + await client.http_request(input=request_input) class TestOnGroupMembershipChangeAsync: @@ -657,11 +660,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.list_deleted_groups_by_owner_async()) + result = await resolve_generated_result(client.list_deleted_groups_by_owner()) mock_send.assert_called_once() call_args = mock_send.call_args @@ -762,16 +765,22 @@ def test_list_owned_groups_response_versioned_defaults(self): assert response.context is None assert response.value is None - def test_update_calendar_event_request_defaults(self): - """Test UpdateCalendarEventRequest default values.""" - request = UpdateCalendarEventRequest() - assert request.subject is None + def test_update_calendar_event_request_optional_defaults(self): + """Test UpdateCalendarEventRequest optional default values.""" + request = UpdateCalendarEventRequest( + subject="Team Meeting", + start={"dateTime": "2026-10-12T09:00:00Z"}, + end={"dateTime": "2026-10-12T10:00:00Z"}, + ) + assert request.subject == "Team Meeting" assert request.is_all_day is None def test_update_calendar_event_request_with_values(self): """Test UpdateCalendarEventRequest with values.""" request = UpdateCalendarEventRequest( subject="Team Standup", + start={"dateTime": "2026-10-12T09:00:00Z"}, + end={"dateTime": "2026-10-12T09:30:00Z"}, importance="Normal", is_all_day=False, is_reminder_on=True, @@ -781,16 +790,22 @@ def test_update_calendar_event_request_with_values(self): assert request.is_reminder_on is True assert request.reminder_minutes_before_start == 15 - def test_update_calendar_event_html_request_defaults(self): - """Test UpdateCalendarEventHTMLRequest default values.""" - request = UpdateCalendarEventHTMLRequest() - assert request.subject is None + def test_update_calendar_event_html_request_optional_defaults(self): + """Test UpdateCalendarEventHTMLRequest optional default values.""" + request = UpdateCalendarEventHTMLRequest( + subject="HTML Meeting", + start={"dateTime": "2026-10-12T09:00:00Z"}, + end={"dateTime": "2026-10-12T10:00:00Z"}, + ) + assert request.subject == "HTML Meeting" assert request.body is None def test_update_calendar_event_html_request_with_values(self): """Test UpdateCalendarEventHTMLRequest with values.""" request = UpdateCalendarEventHTMLRequest( subject="HTML Meeting", + start={"dateTime": "2026-10-12T09:00:00Z"}, + end={"dateTime": "2026-10-12T10:00:00Z"}, body={"contentType": "HTML", "content": "

Meeting details

"}, is_all_day=True ) @@ -813,11 +828,11 @@ async def test_pageable_group_operation_empty_response_yields_no_items( "https://example.azure.com/connections/test", credential=mock_credential, ) - method = getattr(client, f"{operation}_async") + method = getattr(client, f"{operation}") arguments = {"group_id": "group-123"} if operation == "list_group_members" else {} with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text=""), ): diff --git a/tests/test_office365groupsmail.py b/tests/test_office365groupsmail.py index 82660c4d..4b74e9b9 100644 --- a/tests/test_office365groupsmail.py +++ b/tests/test_office365groupsmail.py @@ -6,12 +6,13 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.office365groupsmail import Office365groupsmailClient from azure.connectors.office365groupsmail import ( Conversation, CreateConversationBody, ForwardPostBody, + GetUsersGraphAction, ListConversationsResponse, - Office365groupsmailClient, ReplyConversationThreadBody, TRIGGER_OPERATIONS, ) @@ -20,93 +21,93 @@ ) from azure.connectors.sdk.serialization import to_wire from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import model_instance, resolve_generated_result async def _invoke_operation(client: Office365groupsmailClient, operation: str): """Invoke an operation by name for shared parameterized tests.""" if operation == "list_conversations": - return await resolve_generated_result(client.list_conversations_async(group_id="group123")) + return await resolve_generated_result(client.list_conversations(group_id="group123")) if operation == "create_conversation": - return await client.create_conversation_async( + return await client.create_conversation( input=CreateConversationBody(topic="Hello"), group_id="group123", ) if operation == "get_group_conversation": - return await client.get_group_conversation_async( + return await client.get_group_conversation( group_id="group123", conversation_id="conv123", ) if operation == "list_conversation_threads": - return await resolve_generated_result(client.list_conversation_threads_async( + return await resolve_generated_result(client.list_conversation_threads( group_id="group123", conversation_id="conv123", )) if operation == "create_conversation_thread": - return await client.create_conversation_thread_async( + return await client.create_conversation_thread( input=CreateConversationBody(topic="Thread"), group_id="group123", conversation_id="conv123", ) if operation == "list_group_threads": - return await resolve_generated_result(client.list_group_threads_async(group_id="group123")) + return await resolve_generated_result(client.list_group_threads(group_id="group123")) if operation == "create_group_thread": - return await client.create_group_thread_async( + return await client.create_group_thread( input=CreateConversationBody(topic="Group thread"), group_id="group123", ) if operation == "get_conversation_thread": - return await client.get_conversation_thread_async( + return await client.get_conversation_thread( group_id="group123", thread_id="thread123", ) if operation == "delete_conversation_thread": - return await client.delete_conversation_thread_async( + return await client.delete_conversation_thread( group_id="group123", thread_id="thread123", ) if operation == "list_thread_posts": - return await resolve_generated_result(client.list_thread_posts_async( + return await resolve_generated_result(client.list_thread_posts( group_id="group123", thread_id="thread123", )) if operation == "get_thread": - return await client.get_thread_async( + return await client.get_thread( group_id="group123", thread_id="thread123", post_id="post123", ) - if operation == "get_attachments": - return await resolve_generated_result(client.get_attachments_async( + if operation == "list_attachments": + return await resolve_generated_result(client.list_attachments( group_id="group123", thread_id="thread123", post_id="post123", )) if operation == "reply_to_a_thread": - return await client.reply_to_a_thread_async( + return await client.reply_to_a_thread( input=ReplyConversationThreadBody(), group_id="group123", thread_id="thread123", ) if operation == "reply": - return await client.reply_async( + return await client.reply( input=ReplyConversationThreadBody(), group_id="group123", thread_id="thread123", post_id="post123", ) if operation == "http_request": - return await client.http_request_async(input=b"request") + return await client.http_request(input=b"request") if operation == "forward": - return await client.forward_async( - input=ForwardPostBody(comment="Forward this"), + return await client.forward( + input=model_instance(ForwardPostBody, comment="Forward this"), group_mail="group@contoso.com", conversation_id="conv123", thread_id="thread123", post_id="post123", ) if operation == "list_groups": - return await client.list_groups_async() + return await resolve_generated_result(client.list_groups()) raise ValueError(f"Unsupported operation '{operation}'.") @@ -144,7 +145,7 @@ def test_init_with_custom_settings(self, mock_credential): client = Office365groupsmailClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -202,12 +203,12 @@ async def test_list_conversations_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: result = await resolve_generated_result( - client.list_conversations_async(group_id="group123") + client.list_conversations(group_id="group123") ) assert len(result) == 1 @@ -224,11 +225,11 @@ async def test_create_conversation_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_conversation_async( + result = await client.create_conversation( input=CreateConversationBody(topic="Hi"), group_id="group123", ) @@ -247,11 +248,11 @@ async def test_get_thread_expands_attachments(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.get_thread_async( + await client.get_thread( group_id="group123", thread_id="thread123", post_id="post123", @@ -270,11 +271,11 @@ async def test_list_groups_uses_expected_filters(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.list_groups_async() + await resolve_generated_result(client.list_groups()) call_path = mock_send.call_args[0][1] assert "$filter=" in call_path @@ -300,7 +301,7 @@ class TestOffice365groupsmailClientErrorHandling: "delete_conversation_thread", "list_thread_posts", "get_thread", - "get_attachments", + "list_attachments", "reply_to_a_thread", "reply", "http_request", @@ -322,7 +323,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -359,6 +360,12 @@ def test_dataclass_instances_initialize_expected_defaults(self): def test_forward_post_body_uses_swagger_wire_names(self): """Test the current forward-post request preserves Swagger casing.""" - request = ForwardPostBody(comment="Please review") + request = ForwardPostBody( + to_recipients=[GetUsersGraphAction()], + comment="Please review", + ) - assert to_wire(request) == {"Comment": "Please review"} + assert to_wire(request) == { + "Comment": "Please review", + "ToRecipients": [{}], + } diff --git a/tests/test_office365users.py b/tests/test_office365users.py index aa7f690d..8bf0faaf 100644 --- a/tests/test_office365users.py +++ b/tests/test_office365users.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.office365users import Office365usersClient from azure.connectors.office365users import ( - Office365usersClient, GraphUserUpdateable, ) from azure.connectors.sdk import ( @@ -49,7 +49,7 @@ def test_init_with_custom_settings(self, mock_credential): client = Office365usersClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -118,11 +118,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.update_my_profile_async(input=profile_input) + await client.update_my_profile(input=profile_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -146,11 +146,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.update_my_photo_async(input=photo_input) + await client.update_my_photo(input=photo_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -176,15 +176,16 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.my_trending_documents_async() + result = await resolve_generated_result( + client.list_my_trending_documents() + ) mock_send.assert_called_once() - assert "value" in result - assert len(result["value"]) == 1 + assert len(result) == 1 @pytest.mark.asyncio async def test_with_filter_parameter(self, mock_credential): @@ -198,11 +199,13 @@ async def test_with_filter_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.my_trending_documents_async(filter="resourceVisualization/type eq 'Excel'") + await resolve_generated_result(client.list_my_trending_documents( + filter="resourceVisualization/type eq 'Excel'" + )) call_args = mock_send.call_args assert "$filter=" in call_args[0][1] @@ -219,12 +222,14 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.my_trending_documents_async() - assert result is None + result = await resolve_generated_result( + client.list_my_trending_documents() + ) + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -238,12 +243,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.my_trending_documents_async() + await resolve_generated_result( + client.list_my_trending_documents() + ) assert exc_info.value.status_code == 401 @@ -266,16 +273,18 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.relevant_people_async(user_id="user123") + result = await resolve_generated_result( + client.list_relevant_people(user_id="user123") + ) mock_send.assert_called_once() call_args = mock_send.call_args assert "users/user123/relevantpeople" in call_args[0][1] - assert "value" in result + assert result[0]["id"] == "person1" @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -289,12 +298,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.relevant_people_async(user_id="invalid") + await resolve_generated_result( + client.list_relevant_people(user_id="invalid") + ) assert exc_info.value.status_code == 404 @@ -317,11 +328,11 @@ async def test_success_with_user_id(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.user_photo_metadata_async(user_id="user123") + result = await client.user_photo_metadata(user_id="user123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -340,11 +351,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.user_photo_metadata_async(user_id=None) + result = await client.user_photo_metadata(user_id=None) assert result is None @@ -366,16 +377,18 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.trending_documents_async(id="user123") + result = await resolve_generated_result( + client.list_trending_documents(id="user123") + ) mock_send.assert_called_once() call_args = mock_send.call_args assert "users/user123/insights/trending" in call_args[0][1] - assert "value" in result + assert result[0]["id"] == "doc1" @pytest.mark.asyncio async def test_with_filter_parameter(self, mock_credential): @@ -389,13 +402,15 @@ async def test_with_filter_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.trending_documents_async( - id="user123", - filter="resourceVisualization/type eq 'Word'" + await resolve_generated_result( + client.list_trending_documents( + id="user123", + filter="resourceVisualization/type eq 'Word'" + ) ) call_args = mock_send.call_args @@ -413,12 +428,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.trending_documents_async(id="user123") + await resolve_generated_result( + client.list_trending_documents(id="user123") + ) assert exc_info.value.status_code == 500 @@ -442,11 +459,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.http_request_async(input=request_input) + result = await client.http_request(input=request_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -466,11 +483,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.http_request_async(input=b"request content") + result = await client.http_request(input=b"request content") assert result is None @pytest.mark.asyncio @@ -485,12 +502,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.http_request_async(input=b"request content") + await client.http_request(input=b"request content") assert exc_info.value.status_code == 400 @@ -513,16 +530,18 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.direct_reports_async(id="manager123") + result = await resolve_generated_result( + client.list_direct_reports(id="manager123") + ) mock_send.assert_called_once() call_args = mock_send.call_args assert "users/manager123/directReports" in call_args[0][1] - assert "value" in result + assert result[0]["id"] == "report1" @pytest.mark.asyncio async def test_with_select_and_top_parameters(self, mock_credential): @@ -536,14 +555,16 @@ async def test_with_select_and_top_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.direct_reports_async( - id="manager123", - select="displayName,mail", - top="10" + await resolve_generated_result( + client.list_direct_reports( + id="manager123", + select="displayName,mail", + top=10 + ) ) call_args = mock_send.call_args @@ -562,12 +583,14 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.direct_reports_async(id="manager123") - assert result is None + result = await resolve_generated_result( + client.list_direct_reports(id="manager123") + ) + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -581,12 +604,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.direct_reports_async(id="manager123") + await resolve_generated_result( + client.list_direct_reports(id="manager123") + ) assert exc_info.value.status_code == 403 @@ -609,11 +634,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.manager_async(id="user123") + result = await client.manager(id="user123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -632,11 +657,11 @@ async def test_with_select_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.manager_async(id="user123", select="displayName") + await client.manager(id="user123", select="displayName") call_args = mock_send.call_args assert "$select=displayName" in call_args[0][1] @@ -653,12 +678,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.manager_async(id="user123") + await client.manager(id="user123") assert exc_info.value.status_code == 404 @@ -681,11 +706,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.my_profile_async() + result = await client.my_profile() mock_send.assert_called_once() call_args = mock_send.call_args @@ -704,11 +729,11 @@ async def test_with_select_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.my_profile_async(select="displayName,mail") + await client.my_profile(select="displayName,mail") call_args = mock_send.call_args assert "$select=" in call_args[0][1] @@ -725,11 +750,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.my_profile_async() + result = await client.my_profile() assert result is None @pytest.mark.asyncio @@ -744,12 +769,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.my_profile_async() + await client.my_profile() assert exc_info.value.status_code == 401 @@ -772,11 +797,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.search_user_async(search_term="John")) + result = await resolve_generated_result(client.list_search_user(search_term="John")) mock_send.assert_called_once() call_args = mock_send.call_args @@ -795,11 +820,11 @@ async def test_with_all_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.search_user_async( + await resolve_generated_result(client.list_search_user( search_term="John", top=25, is_search_term_required=True @@ -822,11 +847,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await resolve_generated_result(client.search_user_async()) + result = await resolve_generated_result(client.list_search_user()) assert result == [] @pytest.mark.asyncio @@ -841,12 +866,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.search_user_async(search_term="test")) + await resolve_generated_result(client.list_search_user(search_term="test")) assert exc_info.value.status_code == 500 @@ -867,11 +892,11 @@ async def test_success_returns_binary_content(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.user_photo_async(id="user123") + result = await client.user_photo(id="user123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -890,12 +915,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.user_photo_async(id="user123") + await client.user_photo(id="user123") assert exc_info.value.status_code == 404 @@ -918,11 +943,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.user_profile_async(id="user123") + result = await client.user_profile(id="user123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -941,11 +966,11 @@ async def test_with_select_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.user_profile_async(id="user123", select="displayName,mail,jobTitle") + await client.user_profile(id="user123", select="displayName,mail,jobTitle") call_args = mock_send.call_args assert "$select=" in call_args[0][1] @@ -962,11 +987,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.user_profile_async(id="user123") + result = await client.user_profile(id="user123") assert result is None @pytest.mark.asyncio @@ -981,11 +1006,11 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.user_profile_async(id="invalid_user") + await client.user_profile(id="invalid_user") assert exc_info.value.status_code == 404 diff --git a/tests/test_onedrive.py b/tests/test_onedrive.py index c41aae12..f48fe037 100644 --- a/tests/test_onedrive.py +++ b/tests/test_onedrive.py @@ -7,8 +7,8 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.onedrive import OnedriveClient from azure.connectors.onedrive import ( - OnedriveClient, BlobMetadata, BlobMetadataPage, SharingLink, @@ -55,7 +55,7 @@ def test_init_with_custom_settings(self, mock_credential): client = OnedriveClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -126,11 +126,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_file_metadata_async(id="file123") + result = await client.get_file_metadata(id="file123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -150,11 +150,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_file_metadata_async(id="file123") + result = await client.get_file_metadata(id="file123") assert result is None @@ -166,18 +166,18 @@ async def test_error_response_raises_exception(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(status=404, text='{"error": "File not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_file_metadata_async(id="nonexistent") + await client.get_file_metadata(id="nonexistent") - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestGetFileContent: @@ -197,11 +197,11 @@ async def test_success_returns_binary_content(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_file_content_async(id="file123") + result = await client.get_file_content(id="file123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -222,11 +222,11 @@ async def test_with_infer_content_type_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_file_content_async( + await client.get_file_content( id="file123", infer_content_type="true" ) @@ -246,12 +246,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_file_content_async(id="nonexistent") + await client.get_file_content(id="nonexistent") assert exc_info.value.status_code == 404 @@ -273,11 +273,11 @@ async def test_success_returns_binary_content(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_file_content_by_path_async( + result = await client.get_file_content_by_path( path="/Documents/file.txt" ) @@ -299,12 +299,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_file_content_by_path_async(path="/invalid/path") + await client.get_file_content_by_path(path="/invalid/path") assert exc_info.value.status_code == 404 @@ -327,12 +327,12 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = b"file content" - result = await client.create_file_async( + result = await client.create_file( input=input_data, folder_path="/Documents", name="newfile.txt" @@ -357,12 +357,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_file_async( + await client.create_file( input=b"file content", folder_path="/invalid", name="file.txt" @@ -389,12 +389,12 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = b"updated content" - result = await client.update_file_async( + result = await client.update_file( input=input_data, id="file123" ) @@ -417,12 +417,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.update_file_async( + await client.update_file( input=b"updated content", id="nonexistent" ) @@ -445,11 +445,11 @@ async def test_success_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_file_async(id="file123") + await client.delete_file(id="file123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -464,18 +464,18 @@ async def test_error_response_raises_exception(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(status=404, text='{"error": "File not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_file_async(id="nonexistent") + await client.delete_file(id="nonexistent") - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestCopyFile: @@ -496,11 +496,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.copy_file_async( + result = await client.copy_file( source="https://example.com/source.txt", destination="/Documents/destination.txt" ) @@ -525,11 +525,11 @@ async def test_with_overwrite_parameter(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.copy_file_async( + await client.copy_file( source="https://example.com/source.txt", destination="/Documents/destination.txt", overwrite="true" @@ -550,12 +550,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.copy_file_async( + await client.copy_file( source="invalid", destination="invalid" ) @@ -581,11 +581,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.copy_drive_file_async( + result = await client.copy_drive_file( id="sourcefile123", destination="/Documents/copy.txt" ) @@ -609,12 +609,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.copy_drive_file_async( + await client.copy_drive_file( id="nonexistent", destination="/Documents/copy.txt" ) @@ -640,11 +640,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.move_file_async( + result = await client.move_file( id="file123", destination="/Archive/moved_file.txt" ) @@ -668,12 +668,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.move_file_async( + await client.move_file( id="nonexistent", destination="/Archive/file.txt" ) @@ -700,11 +700,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.list_folder_async(id="folder123")) + result = await resolve_generated_result(client.list_folder(id="folder123")) mock_send.assert_called_once() call_args = mock_send.call_args @@ -726,23 +726,25 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"value": [{"id": "folder1", "name": "Documents"}, ' - '{"id": "folder2", "name": "Pictures"}]}' + text=( + '[{"id": "folder1", "name": "Documents"}, ' + '{"id": "folder2", "name": "Pictures"}]' + ) ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.list_root_folder_async() + result = await resolve_generated_result(client.list_root_folder()) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/folders" in call_args[0][1] - assert len(result["value"]) == 2 + assert len(result) == 2 class TestFindFiles: @@ -758,19 +760,21 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"value": [{"id": "file1", "name": "report.docx"}]}' + text='[{"id": "file1", "name": "report.docx"}]' ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.find_files_async( - id="folder123", - query="report", - find_mode="search" + result = await resolve_generated_result( + client.list_find_files( + id="folder123", + query="report", + find_mode="search" + ) ) mock_send.assert_called_once() @@ -778,7 +782,7 @@ async def test_success_with_json_response(self, mock_credential): assert call_args[0][0] == "GET" assert "/search" in call_args[0][1] assert "query=report" in call_args[0][1] - assert len(result["value"]) == 1 + assert len(result) == 1 class TestCreateShareLink: @@ -799,11 +803,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_share_link_async( + result = await client.create_share_link( id="file123", type_="view" ) @@ -829,22 +833,24 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"tags": ["important", "work", "2026"]}' + text='{"Tags": ["important", "work", "2026"]}' ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_file_tags_async(id="file123") + result = await resolve_generated_result( + client.list_file_tags(id="file123") + ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/tags" in call_args[0][1] - assert "important" in result["tags"] + assert "important" in result class TestAddFileTag: @@ -860,18 +866,20 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"tags": ["important", "work", "new-tag"]}' + text='{"Tags": ["important", "work", "new-tag"]}' ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.add_file_tag_async( - id="file123", - tag="new-tag" + await resolve_generated_result( + client.add_file_tag( + id="file123", + tag="new-tag" + ) ) mock_send.assert_called_once() @@ -896,11 +904,11 @@ async def test_success_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.remove_file_tag_async( + await client.remove_file_tag( id="file123", tag="old-tag" ) @@ -930,11 +938,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_file_thumbnail_async( + result = await client.get_file_thumbnail( id="file123", size="medium" ) @@ -964,11 +972,11 @@ async def test_success_returns_binary_content(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.convert_file_async( + result = await client.convert_file( id="file123", type_="pdf" ) @@ -994,18 +1002,20 @@ async def test_success_with_json_response(self, mock_credential): mock_response = MockResponse( status=200, - text='{"id": "folder123", "name": "extracted"}' + text='[{"id": "folder123", "name": "extracted"}]' ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.extract_folder_async( - source="/Documents/archive.zip", - destination="/Documents/extracted" + await resolve_generated_result( + client.extract_folder( + source="/Documents/archive.zip", + destination="/Documents/extracted" + ) ) mock_send.assert_called_once() @@ -1088,11 +1098,11 @@ async def test_special_characters_in_path(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_file_metadata_by_path_async( + await client.get_file_metadata_by_path( path="/Documents/My File (2026).docx" ) @@ -1112,15 +1122,15 @@ async def test_multiple_consecutive_calls(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - await client.get_file_metadata_async(id="file1") - await client.get_file_metadata_async(id="file2") - await client.get_file_metadata_async(id="file3") + await client.get_file_metadata(id="file1") + await client.get_file_metadata(id="file2") + await client.get_file_metadata(id="file3") - assert client._http_client.send_async.call_count == 3 + assert client._http_client.send.call_count == 3 @pytest.mark.asyncio async def test_http_client_property_access(self, mock_credential): diff --git a/tests/test_onedriveforbusiness.py b/tests/test_onedriveforbusiness.py index 03df2c9c..d5cb5688 100644 --- a/tests/test_onedriveforbusiness.py +++ b/tests/test_onedriveforbusiness.py @@ -7,11 +7,11 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.onedriveforbusiness import OnedriveforbusinessClient from azure.connectors.onedriveforbusiness import ( BlobMetadata, BlobMetadataPage, ForASelectedFileResponse, - OnedriveforbusinessClient, SharingLink, Tags, Thumbnail, @@ -24,14 +24,14 @@ METHOD_ARGUMENTS: list[tuple[str, dict]] = [ - ("get_file_metadata_async", {"id": "file123"}), - ("update_file_async", {"id": "file123", "input": b"updated content"}), - ("delete_file_async", {"id": "file123"}), - ("get_file_metadata_by_path_async", {"path": "/Documents/file.txt"}), - ("get_file_content_by_path_async", {"path": "/Documents/file.txt"}), - ("get_file_content_async", {"id": "file123"}), + ("get_file_metadata", {"id": "file123"}), + ("update_file", {"id": "file123", "input": b"updated content"}), + ("delete_file", {"id": "file123"}), + ("get_file_metadata_by_path", {"path": "/Documents/file.txt"}), + ("get_file_content_by_path", {"path": "/Documents/file.txt"}), + ("get_file_content", {"id": "file123"}), ( - "create_file_async", + "create_file", { "input": b"file content", "folder_path": "/Documents", @@ -39,51 +39,51 @@ }, ), ( - "copy_file_async", + "copy_file", {"source": "https://contoso.com/file.txt", "destination": "/Documents/copy.txt"}, ), ( - "copy_drive_file_async", + "copy_drive_file", {"id": "file123", "destination": "/Documents/copy.txt"}, ), ( - "copy_drive_file_by_path_async", + "copy_drive_file_by_path", {"source": "/Documents/source.txt", "destination": "/Documents/copy.txt"}, ), ( - "move_file_async", + "move_file", {"id": "file123", "destination": "/Documents/moved.txt"}, ), ( - "move_file_by_path_async", + "move_file_by_path", {"source": "/Documents/source.txt", "destination": "/Documents/moved.txt"}, ), - ("convert_file_async", {"id": "file123"}), - ("convert_file_by_path_async", {"path": "/Documents/file.docx"}), - ("get_file_thumbnail_async", {"id": "file123", "size": "small"}), - ("list_root_folder_async", {}), + ("convert_file", {"id": "file123"}), + ("convert_file_by_path", {"path": "/Documents/file.docx"}), + ("get_file_thumbnail", {"id": "file123", "size": "small"}), + ("list_root_folder", {}), ( - "find_files_async", + "list_find_files", {"id": "folder123", "query": "report", "find_mode": "search"}, ), ( - "find_files_by_path_async", + "list_find_files_by_path", { "query": "report", "path": "/Documents", "find_mode": "search", }, ), - ("create_share_link_async", {"id": "file123", "type_": "view"}), + ("create_share_link", {"id": "file123", "type_": "view"}), ( - "create_share_link_by_path_async", + "create_share_link_by_path", {"path": "/Documents/file.txt", "type_": "view"}, ), ( - "extract_folder_async", + "extract_folder", {"source": "/Documents/archive.zip", "destination": "/Documents/extracted"}, ), - ("list_folder_async", {"id": "folder123"}), + ("list_folder", {"id": "folder123"}), ] @@ -113,7 +113,7 @@ def test_init_with_custom_settings(self, mock_credential): client = OnedriveforbusinessClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -172,11 +172,11 @@ async def test_get_file_metadata_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_file_metadata_async(id="file123") + result = await client.get_file_metadata(id="file123") assert result["id"] == "file123" assert result["name"] == "doc.txt" @@ -195,11 +195,11 @@ async def test_get_file_content_returns_bytes(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.get_file_content_async(id="file123") + result = await client.get_file_content(id="file123") assert result == content @@ -224,7 +224,7 @@ async def test_all_methods_raise_connector_exception_on_error( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_onenote.py b/tests/test_onenote.py index 349ae0ee..270138a3 100644 --- a/tests/test_onenote.py +++ b/tests/test_onenote.py @@ -6,8 +6,8 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.onenote import OnenoteClient from azure.connectors.onenote import ( - OnenoteClient, CreateSectionInNotebookResponse, CreatePageInSectionInput, Page, @@ -70,7 +70,7 @@ def test_init_with_custom_settings(self, mock_credential): client = OnenoteClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -145,20 +145,19 @@ async def test_success(self, mock_credential): mock_response = MockResponse( status=200, - text='{"value": [{"fileName": "Work Notes", "key": "nb-123"}]}' + text='[{"fileName": "Work Notes", "key": "nb-123"}]' ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_notebooks_async() + result = await resolve_generated_result(client.list_notebooks()) mock_send.assert_called_once() - assert result is not None - assert "value" in result + assert result[0]["key"] == "nb-123" @pytest.mark.asyncio async def test_empty_response_returns_none(self, mock_credential): @@ -172,12 +171,12 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_notebooks_async() - assert result is None + result = await resolve_generated_result(client.list_notebooks()) + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -191,12 +190,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.get_notebooks_async() + await resolve_generated_result(client.list_notebooks()) class TestGetSectionsInNotebookAsync: @@ -217,11 +216,13 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_sections_in_notebook_async(notebook_key="nb-123") + result = await resolve_generated_result( + client.list_sections_in_notebook(notebook_key="nb-123") + ) mock_send.assert_called_once() call_args = mock_send.call_args @@ -240,12 +241,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.get_sections_in_notebook_async(notebook_key="invalid") + await resolve_generated_result( + client.list_sections_in_notebook(notebook_key="invalid") + ) class TestCreateSectionInNotebookAsync: @@ -268,11 +271,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_section_in_notebook_async( + result = await client.create_section_in_notebook( input=section_request, notebook_key="nb-123" ) @@ -297,11 +300,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.create_section_in_notebook_async( + result = await client.create_section_in_notebook( input=section_request, notebook_key="nb-123" ) @@ -326,11 +329,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.get_pages_in_section_async( + result = await resolve_generated_result(client.list_pages_in_section( notebook_key="nb-123", section_id="sec-123" )) @@ -354,12 +357,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await resolve_generated_result(client.get_pages_in_section_async( + await resolve_generated_result(client.list_pages_in_section( notebook_key="nb-123", section_id="sec-123" )) @@ -385,11 +388,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_page_in_section_async( + result = await client.create_page_in_section( input=page_input, notebook_key="nb-123", section_id="sec-123" @@ -421,11 +424,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_page_in_quick_notes_async(input=page_input) + result = await client.create_page_in_quick_notes(input=page_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -446,12 +449,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.create_page_in_quick_notes_async(input=page_input) + await client.create_page_in_quick_notes(input=page_input) class TestDeletePageAsync: @@ -469,11 +472,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_page_async( + await client.delete_page( notebook_key="nb-123", section_id="sec-123", page_id="page-123" @@ -506,11 +509,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_page_content_async( + result = await client.get_page_content( notebook_key="nb-123", section_id="sec-123", page_id="page-123" @@ -534,12 +537,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.get_page_content_async( + await client.get_page_content( notebook_key="nb-123", section_id="sec-123", page_id="invalid" @@ -568,11 +571,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.update_page_content_async( + result = await client.update_page_content( input=update_request, notebook_key="nb-123", section_id="sec-123", @@ -698,10 +701,10 @@ def test_new_page_response_defaults(self): response = NewPageResponse() assert response.value is None - def test_create_section_request_defaults(self): - """Test CreateSectionRequest default values.""" - request = CreateSectionRequest() - assert request.name is None + def test_create_section_request_required_value(self): + """Test CreateSectionRequest required value.""" + request = CreateSectionRequest(name="New Section") + assert request.name == "New Section" def test_create_section_request_with_values(self): """Test CreateSectionRequest with values.""" @@ -736,26 +739,31 @@ def test_parent_notebook_with_values(self): assert parent.id == "nb-123" assert parent.name == "Work Notebook" - def test_link_defaults(self): - """Test Link default values.""" - link = Link() - assert link.one_note_client_url is None - assert link.one_note_web_url is None + def test_link_required_values(self): + """Test Link required values.""" + client_url = OneNoteClientUrl(href="onenote:https://example.com/notebook") + web_url = OneNoteWebUrl(href="https://example.com/notebook") + link = Link( + one_note_client_url=client_url, + one_note_web_url=web_url, + ) + assert link.one_note_client_url is client_url + assert link.one_note_web_url is web_url - def test_one_note_client_url_defaults(self): - """Test OneNoteClientUrl default values.""" - url = OneNoteClientUrl() - assert url.href is None + def test_one_note_client_url_required_value(self): + """Test OneNoteClientUrl required value.""" + url = OneNoteClientUrl(href="onenote:https://example.com/notebook") + assert url.href == "onenote:https://example.com/notebook" def test_one_note_client_url_with_values(self): """Test OneNoteClientUrl with values.""" url = OneNoteClientUrl(href="onenote:https://example.com/notebook") assert url.href == "onenote:https://example.com/notebook" - def test_one_note_web_url_defaults(self): - """Test OneNoteWebUrl default values.""" - url = OneNoteWebUrl() - assert url.href is None + def test_one_note_web_url_required_value(self): + """Test OneNoteWebUrl required value.""" + url = OneNoteWebUrl(href="https://example.com/notebook") + assert url.href == "https://example.com/notebook" def test_section_list_item_defaults(self): """Test SectionListItem default values.""" diff --git a/tests/test_orderful.py b/tests/test_orderful.py index c82f6195..012ca04e 100644 --- a/tests/test_orderful.py +++ b/tests/test_orderful.py @@ -5,7 +5,8 @@ from typing import get_type_hints import azure.connectors.orderful as orderful_module -from azure.connectors.orderful import OrderfulClient, TRIGGER_OPERATIONS +from azure.connectors.orderful import OrderfulClient +from azure.connectors.orderful import TRIGGER_OPERATIONS from tests.generated_connector_test_utils import GeneratedConnectorContractTests @@ -32,6 +33,6 @@ def test_trigger_operations() -> None: def test_transaction_id_uses_integer_annotation() -> None: """Test transaction identifiers preserve the Swagger integer type.""" - type_hints = get_type_hints(OrderfulClient.get_transaction_by_id_async) + type_hints = get_type_hints(OrderfulClient.get_transaction_by_id) assert type_hints["transaction_id"] is int diff --git a/tests/test_outlook.py b/tests/test_outlook.py index 9f13e123..8f93e563 100644 --- a/tests/test_outlook.py +++ b/tests/test_outlook.py @@ -7,8 +7,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.outlook import OutlookClient from azure.connectors.outlook import ( - OutlookClient, ClientReceiveMessage, ContactResponse, ClientSendAttachment, @@ -25,6 +25,7 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestOutlookClientInitialization: @@ -60,7 +61,7 @@ def test_init_with_custom_settings(self, mock_credential): client = OutlookClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -131,11 +132,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_email_async(message_id="msg123") + result = await client.get_email(message_id="msg123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -155,19 +156,19 @@ async def test_with_include_attachments(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_email_async(message_id="msg123", include_attachments="true") + await client.get_email(message_id="msg123", include_attachments="true") call_args = mock_send.call_args url = call_args[0][1] assert "includeAttachments=true" in url @pytest.mark.asyncio - async def test_error_response_raises_exception(self, mock_credential): - """Test that error response raises ConnectorException.""" + async def test_not_found_succeeds(self, mock_credential): + """Test deleting an absent email succeeds.""" client = OutlookClient( "https://example.azure.com/connections/test", credential=mock_credential @@ -177,12 +178,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_email_async(message_id="nonexistent") + await client.get_email(message_id="nonexistent") assert exc_info.value.status_code == 404 @@ -202,11 +203,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_email_async(message_id="msg123") + await client.delete_email(message_id="msg123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -225,14 +226,35 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_email_async(message_id="nonexistent") + await client.delete_email(message_id="nonexistent") - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 404 + + @pytest.mark.asyncio + async def test_other_error_response_raises_exception(self, mock_credential): + """Test that non-404 error responses still raise ConnectorException.""" + client = OutlookClient( + "https://example.azure.com/connections/test", + credential=mock_credential + ) + + mock_response = MockResponse(status=500, text='{"error": "Failed"}') + + with patch.object( + client._http_client, + 'send', + new_callable=AsyncMock, + return_value=mock_response + ): + with pytest.raises(ConnectorException) as exc_info: + await client.delete_email(message_id="nonexistent") + + assert exc_info.value.status_code == 500 class TestMoveEmail: @@ -253,11 +275,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - _ = await client.move_async(message_id="msg123", folder_path="Archive") + _ = await client.move(message_id="msg123", folder_path="Archive") mock_send.assert_called_once() call_args = mock_send.call_args @@ -277,12 +299,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.move_async(message_id="nonexistent", folder_path="Archive") + await client.move(message_id="nonexistent", folder_path="Archive") assert exc_info.value.status_code == 404 @@ -302,11 +324,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.flag_async(message_id="msg123") + await client.flag(message_id="msg123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -325,12 +347,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.flag_async(message_id="nonexistent") + await client.flag(message_id="nonexistent") assert exc_info.value.status_code == 404 @@ -350,11 +372,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.mark_as_read_async(message_id="msg123") + await client.mark_as_read(message_id="msg123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -373,12 +395,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.mark_as_read_async(message_id="nonexistent") + await client.mark_as_read(message_id="nonexistent") assert exc_info.value.status_code == 404 @@ -398,11 +420,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_attachment_async( + result = await client.get_attachment( message_id="msg123", attachment_id="att456" ) @@ -425,12 +447,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_attachment_async( + await client.get_attachment( message_id="msg123", attachment_id="nonexistent" ) @@ -458,11 +480,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -486,12 +508,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) assert exc_info.value.status_code == 400 @@ -515,11 +537,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.reply_to_async(input=reply_input, message_id="msg123") + await client.reply_to(input=reply_input, message_id="msg123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -542,12 +564,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.reply_to_async(input=reply_input, message_id="nonexistent") + await client.reply_to(input=reply_input, message_id="nonexistent") assert exc_info.value.status_code == 404 @@ -570,17 +592,17 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_emails_async() + result = await resolve_generated_result(client.list_emails()) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/v2/Mail" in call_args[0][1] - assert len(result["value"]) == 2 + assert len(result) == 2 @pytest.mark.asyncio async def test_with_query_parameters(self, mock_credential): @@ -594,15 +616,17 @@ async def test_with_query_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_emails_async( - folder_path="Inbox", - fetch_only_unread="true", - importance="High", - top="10" + await resolve_generated_result( + client.list_emails( + folder_path="Inbox", + fetch_only_unread=True, + importance="High", + top=10 + ) ) call_args = mock_send.call_args @@ -631,17 +655,19 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.calendar_get_tables_async() + result = await resolve_generated_result( + client.list_calendar_get_tables() + ) mock_send.assert_called_once() call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/datasets/calendars/tables" in call_args[0][1] - assert len(result["value"]) == 1 + assert len(result) == 1 class TestCalendarGetItem: @@ -662,11 +688,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.calendar_get_item_async( + result = await client.calendar_get_item( table="Calendar", id="event123" ) @@ -701,11 +727,11 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.calendar_post_item_async( + result = await client.calendar_post_item( input=event_input, table="Calendar" ) @@ -732,11 +758,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.calendar_delete_item_async(table="Calendar", id="event123") + await client.calendar_delete_item(table="Calendar", id="event123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -762,11 +788,13 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - _ = await client.contact_get_tables_async() + _ = await resolve_generated_result( + client.list_contact_get_tables() + ) mock_send.assert_called_once() call_args = mock_send.call_args @@ -792,11 +820,13 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - _ = await client.contact_get_items_async(table="Contacts") + _ = await resolve_generated_result( + client.list_contact_get_items(table="Contacts") + ) mock_send.assert_called_once() call_args = mock_send.call_args @@ -810,45 +840,45 @@ class TestOutlookApiSurface: def test_callable_method_signatures(self): """Test the client exposes exactly the generated callable methods.""" expected_signatures = { - "calendar_delete_item_async": ("self", "table", "id"), - "calendar_get_item_async": ("self", "table", "id"), - "calendar_get_items_async": ( + "calendar_delete_item": ("self", "table", "id"), + "calendar_get_item": ("self", "table", "id"), + "list_calendar_get_items": ( "self", "table", "filter", "orderby", "top", "skip" ), - "calendar_get_tables_async": ("self",), - "calendar_patch_item_async": ("self", "input", "table", "id"), - "calendar_post_item_async": ("self", "input", "table"), - "contact_delete_item_async": ("self", "table", "id"), - "contact_get_item_async": ("self", "table", "id"), - "contact_get_items_async": ( + "list_calendar_get_tables": ("self",), + "calendar_patch_item": ("self", "input", "table", "id"), + "calendar_post_item": ("self", "input", "table"), + "contact_delete_item": ("self", "table", "id"), + "contact_get_item": ("self", "table", "id"), + "list_contact_get_items": ( "self", "table", "filter", "orderby", "top", "skip" ), - "contact_get_tables_async": ("self",), - "contact_patch_item_async": ("self", "input", "table", "id"), - "contact_post_item_async": ("self", "input", "table"), - "delete_email_async": ("self", "message_id"), - "flag_async": ("self", "message_id"), - "forward_email_async": ("self", "input", "message_id"), - "get_attachment_async": ("self", "message_id", "attachment_id"), - "get_email_async": ( + "list_contact_get_tables": ("self",), + "contact_patch_item": ("self", "input", "table", "id"), + "contact_post_item": ("self", "input", "table"), + "delete_email": ("self", "message_id"), + "flag": ("self", "message_id"), + "forward_email": ("self", "input", "message_id"), + "get_attachment": ("self", "message_id", "attachment_id"), + "get_email": ( "self", "message_id", "include_attachments", "internet_message_id" ), - "get_emails_async": ( + "list_emails": ( "self", "folder_path", "to", "cc", "to_or_cc", "from_", "importance", "fetch_only_with_attachment", "subject_filter", "fetch_only_unread", "include_attachments", "search_query", "top" ), - "get_events_calendar_view_async": ( + "list_events_calendar_view": ( "self", "calendar_id", "start_date_time_offset", "end_date_time_offset", "filter", "orderby", "top", "skip", "search" ), - "mark_as_read_async": ("self", "message_id"), - "move_async": ("self", "message_id", "folder_path"), - "reply_to_async": ("self", "input", "message_id"), - "respond_to_event_async": ("self", "input", "event_id", "response"), - "send_approval_mail_async": ("self", "input"), - "send_email_async": ("self", "input"), - "send_mail_with_options_async": ("self", "input"), + "mark_as_read": ("self", "message_id"), + "move": ("self", "message_id", "folder_path"), + "reply_to": ("self", "input", "message_id"), + "respond_to_event": ("self", "input", "event_id", "response"), + "send_approval_mail": ("self", "input"), + "send_email": ("self", "input"), + "send_mail_with_options": ("self", "input"), } request_control_parameters = ( "timeout", @@ -863,10 +893,7 @@ def test_callable_method_signatures(self): actual_signatures = { name: tuple(inspect.signature(method).parameters) for name, method in vars(OutlookClient).items() - if ( - inspect.iscoroutinefunction(method) - or inspect.isasyncgenfunction(method) - ) + if callable(method) and not name.startswith("_") } assert actual_signatures == expected_signatures @@ -1064,12 +1091,12 @@ async def test_multiple_consecutive_calls(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_emails_async() - await client.calendar_get_tables_async() + await resolve_generated_result(client.list_emails()) + await resolve_generated_result(client.list_calendar_get_tables()) assert mock_send.call_count == 2 @@ -1085,12 +1112,12 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_emails_async() - assert result is None + result = await resolve_generated_result(client.list_emails()) + assert result == [] @pytest.mark.asyncio async def test_unauthorized_raises_exception(self, mock_credential): @@ -1104,11 +1131,11 @@ async def test_unauthorized_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_email_async(message_id="msg123") + await client.get_email(message_id="msg123") assert exc_info.value.status_code == 401 diff --git a/tests/test_pdfco.py b/tests/test_pdfco.py index 182d9f81..4e5d514c 100644 --- a/tests/test_pdfco.py +++ b/tests/test_pdfco.py @@ -7,8 +7,8 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.pdfco import PdfcoClient from azure.connectors.pdfco import ( - PdfcoClient, HtmlToPdfInput, UrlToPdfInput, PdfFillerInput, @@ -52,7 +52,7 @@ def test_init_with_custom_settings(self, mock_credential): client = PdfcoClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -115,16 +115,16 @@ async def test_success_forwards_request_body(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - request = HtmlToPdfInput() + request = HtmlToPdfInput(html="

Hello

") mock_response = MockResponse(status=200, text='{"url": "https://example.com/out.pdf"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.html_to_pdf_async(input=request) + result = await client.html_to_pdf(input=request) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -145,12 +145,12 @@ async def test_error_response_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.html_to_pdf_async(input=HtmlToPdfInput()) + await client.html_to_pdf(input=HtmlToPdfInput(html="

Hello

")) assert exc_info.value.status_code == 400 @@ -165,16 +165,16 @@ async def test_success_forwards_request_body(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - request = UrlToPdfInput() + request = UrlToPdfInput(url="https://example.com/document") mock_response = MockResponse(status=200, text='{"url": "https://example.com/out.pdf"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.url_to_pdf_async(input=request) + result = await client.url_to_pdf(input=request) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -194,12 +194,14 @@ async def test_server_error_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.url_to_pdf_async(input=UrlToPdfInput()) + await client.url_to_pdf( + input=UrlToPdfInput(url="https://example.com/document") + ) class TestPdfFillerAsync: @@ -212,16 +214,16 @@ async def test_success_forwards_request_body(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - request = PdfFillerInput() + request = PdfFillerInput(url="https://example.com/form.pdf") mock_response = MockResponse(status=200, text='{"url": "https://example.com/filled.pdf"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.pdf_filler_async(input=request) + result = await client.pdf_filler(input=request) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -241,11 +243,13 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.pdf_filler_async(input=PdfFillerInput()) + result = await client.pdf_filler( + input=PdfFillerInput(url="https://example.com/form.pdf") + ) assert result is None @@ -260,12 +264,14 @@ async def test_error_response_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.pdf_filler_async(input=PdfFillerInput()) + await client.pdf_filler( + input=PdfFillerInput(url="https://example.com/form.pdf") + ) BASE_URL = "https://example.azure.com/connections/test" @@ -331,7 +337,7 @@ async def test_error_response_raises_connector_exception(self, mock_credential): async def _invoke_operation(client: PdfcoClient, operation: str): """Invoke a PDF.co operation by name for shared method tests.""" - method = getattr(client, f"{operation}_async") + method = getattr(client, f"{operation}") return await method(**OPERATION_ARGS[operation]) @@ -363,7 +369,7 @@ async def test_all_operations_success(self, mock_credential, operation): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: @@ -389,7 +395,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_pipedrive.py b/tests/test_pipedrive.py index cdd8e438..09f13957 100644 --- a/tests/test_pipedrive.py +++ b/tests/test_pipedrive.py @@ -6,10 +6,10 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.pipedrive import PipedriveClient from azure.connectors.pipedrive import ( AddActivityRequest, AddDealRequest, - PipedriveClient, UpdateDealStageRequest, UpdateDealStatusRequest, TRIGGER_OPERATIONS, @@ -18,30 +18,33 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result async def _invoke_operation(client: PipedriveClient, operation: str): """Invoke a Pipedrive operation by name for shared tests.""" if operation == "get_deal": - return await client.get_deal_async(deal_id="1") + return await client.get_deal(deal_id="1") if operation == "update_deal_status": - return await client.update_deal_status_async( - input=UpdateDealStatusRequest(), + return await client.update_deal_status( + input=UpdateDealStatusRequest(status="won"), deal_id="1", ) if operation == "add_activity": - return await client.add_activity_async(input=AddActivityRequest()) + return await client.add_activity( + input=AddActivityRequest(type_="call", subject="Customer follow-up") + ) if operation == "get_stage": - return await client.get_stage_async(stage_id="1") + return await client.get_stage(stage_id="1") if operation == "add_deal": - return await client.add_deal_async(input=AddDealRequest()) + return await client.add_deal(input=AddDealRequest(title="New Deal")) if operation == "update_deal_stage": - return await client.update_deal_stage_async( - input=UpdateDealStageRequest(), + return await client.update_deal_stage( + input=UpdateDealStageRequest(pipeline_id="1", stage_id="2"), deal_id="1", ) if operation == "list_deals": - return await client.list_deals_async() + return await resolve_generated_result(client.list_deals()) raise ValueError(f"Unsupported operation '{operation}'.") @@ -79,7 +82,7 @@ def test_init_with_custom_settings(self, mock_credential): client = PipedriveClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -146,11 +149,11 @@ async def test_get_deal_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_deal_async(deal_id="42") + result = await client.get_deal(deal_id="42") assert result["data"]["id"] == 42 assert mock_send.call_args[0][0] == "GET" @@ -164,15 +167,15 @@ async def test_update_deal_status_success(self, mock_credential): credential=mock_credential, ) mock_response = MockResponse(status=200, text='{"data":{"id":42}}') - body = UpdateDealStatusRequest() + body = UpdateDealStatusRequest(status="won") with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.update_deal_status_async(input=body, deal_id="42") + await client.update_deal_status(input=body, deal_id="42") assert mock_send.call_args[0][0] == "PUT" assert "/update_status_deal/v1/deals/42" in mock_send.call_args[0][1] @@ -186,15 +189,15 @@ async def test_add_activity_success(self, mock_credential): credential=mock_credential, ) mock_response = MockResponse(status=201, text='{"data":{"id":7}}') - body = AddActivityRequest() + body = AddActivityRequest(type_="call", subject="Customer follow-up") with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.add_activity_async(input=body) + result = await client.add_activity(input=body) assert result["data"]["id"] == 7 assert mock_send.call_args[0][0] == "POST" @@ -212,11 +215,11 @@ async def test_get_stage_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_stage_async(stage_id="3") + result = await client.get_stage(stage_id="3") assert result["data"]["id"] == 3 assert mock_send.call_args[0][0] == "GET" @@ -230,15 +233,15 @@ async def test_add_deal_success(self, mock_credential): credential=mock_credential, ) mock_response = MockResponse(status=201, text='{"data":{"id":99}}') - body = AddDealRequest() + body = AddDealRequest(title="New Deal") with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.add_deal_async(input=body) + result = await client.add_deal(input=body) assert result["data"]["id"] == 99 assert mock_send.call_args[0][0] == "POST" @@ -253,15 +256,15 @@ async def test_update_deal_stage_success(self, mock_credential): credential=mock_credential, ) mock_response = MockResponse(status=200, text='{"data":{"id":42}}') - body = UpdateDealStageRequest() + body = UpdateDealStageRequest(pipeline_id="1", stage_id="2") with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.update_deal_stage_async(input=body, deal_id="42") + await client.update_deal_stage(input=body, deal_id="42") assert mock_send.call_args[0][0] == "PUT" assert "/connector-v2/update_stage_deal/v1/deals/42" in mock_send.call_args[0][1] @@ -278,13 +281,13 @@ async def test_list_deals_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_deals_async() + result = await resolve_generated_result(client.list_deals()) - assert result["data"][0]["id"] == 1 + assert result[0]["id"] == 1 assert mock_send.call_args[0][0] == "GET" assert "/v1/deals" in mock_send.call_args[0][1] @@ -299,13 +302,13 @@ async def test_list_deals_empty_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.list_deals_async() + result = await resolve_generated_result(client.list_deals()) - assert result is None + assert result == [] class TestPipedriveClientErrorHandling: @@ -338,7 +341,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_planner.py b/tests/test_planner.py index 301129d6..a1ae07f2 100644 --- a/tests/test_planner.py +++ b/tests/test_planner.py @@ -6,8 +6,8 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.planner import PlannerClient from azure.connectors.planner import ( - PlannerClient, UnassignUsersInput, GetTaskResponse, AssignUsersInput, @@ -69,7 +69,7 @@ def test_init_with_custom_settings(self, mock_credential): client = PlannerClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -149,11 +149,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.list_my_tasks_async()) + result = await resolve_generated_result(client.list_my_tasks()) mock_send.assert_called_once() assert result is not None @@ -171,11 +171,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await resolve_generated_result(client.list_my_tasks_async()) + result = await resolve_generated_result(client.list_my_tasks()) assert result == [] @pytest.mark.asyncio @@ -190,12 +190,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await resolve_generated_result(client.list_my_tasks_async()) + await resolve_generated_result(client.list_my_tasks()) class TestListGroupPlansAsync: @@ -216,11 +216,13 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.list_group_plans_async(group_id="group-123") + result = await resolve_generated_result( + client.list_group_plans(group_id="group-123") + ) mock_send.assert_called_once() call_args = mock_send.call_args @@ -239,12 +241,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.list_group_plans_async(group_id="invalid") + await resolve_generated_result( + client.list_group_plans(group_id="invalid") + ) class TestGetTaskAsync: @@ -265,11 +269,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_task_async(id="task-123") + result = await client.get_task(id="task-123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -289,12 +293,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.get_task_async(id="invalid") + await client.get_task(id="invalid") class TestGetTaskDetailsAsync: @@ -315,11 +319,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_task_details_async(id="task-123") + result = await client.get_task_details(id="task-123") mock_send.assert_called_once() assert result is not None @@ -337,11 +341,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_task_details_async(id="task-123") + result = await client.get_task_details(id="task-123") assert result is None @@ -363,11 +367,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_plan_details_async(id="plan-123") + result = await client.get_plan_details(id="plan-123") mock_send.assert_called_once() assert result is not None @@ -384,12 +388,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.get_plan_details_async(id="plan-123") + await client.get_plan_details(id="plan-123") class TestCreateTaskAsync: @@ -416,11 +420,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_task_async(input=task_input) + result = await client.create_task(input=task_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -438,16 +442,20 @@ async def test_error_response_raises_exception(self, mock_credential): mock_response = MockResponse(status=400, text='{"error": "Bad request"}') - task_input = CreateTaskRequest(title="New Task") + task_input = CreateTaskRequest( + group_id="group-123", + plan_id="plan-123", + title="New Task", + ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.create_task_async(input=task_input) + await client.create_task(input=task_input) class TestCreateBucketAsync: @@ -474,11 +482,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.create_bucket_async(input=bucket_input) + result = await client.create_bucket(input=bucket_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -510,11 +518,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.update_task_async( + result = await client.update_task( input=update_input, id="task-123" ) @@ -539,12 +547,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.update_task_async(input=update_input, id="invalid") + await client.update_task(input=update_input, id="invalid") class TestUpdateTaskDetailsAsync: @@ -569,11 +577,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.update_task_details_async( + result = await client.update_task_details( input=update_input, id="task-123" ) @@ -599,11 +607,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_task_async(id="task-123") + await client.delete_task(id="task-123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -633,11 +641,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.assign_users_async( + result = await client.assign_users( input=assign_input, id="task-123" ) @@ -661,12 +669,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.assign_users_async(input=assign_input, id="task-123") + await client.assign_users(input=assign_input, id="task-123") class TestUnassignUsersAsync: @@ -691,11 +699,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.unassign_users_async( + result = await client.unassign_users( input=unassign_input, id="task-123" ) @@ -726,16 +734,17 @@ def test_triggers_are_not_client_methods(self): class TestDataclasses: """Tests for dataclass serialization and defaults.""" - def test_unassign_users_input_defaults(self): - """Test UnassignUsersInput default values.""" - input_obj = UnassignUsersInput() - assert input_obj.assignments is None + def test_unassign_users_input_required_value(self): + """Test UnassignUsersInput required value.""" + input_obj = UnassignUsersInput(assignments="user@contoso.com") + assert input_obj.assignments == "user@contoso.com" def test_current_task_requests_use_swagger_wire_names(self): """Test current create and update requests preserve Swagger keys.""" create_request = CreateTaskRequest( group_id="group-123", plan_id="plan-123", + title="New Task", bucket_id="bucket-123", ) update_request = UpdateTaskRequest( @@ -746,6 +755,7 @@ def test_current_task_requests_use_swagger_wire_names(self): assert to_wire(create_request) == { "groupId": "group-123", "planId": "plan-123", + "title": "New Task", "bucketId": "bucket-123", } assert to_wire(update_request) == { @@ -777,10 +787,10 @@ def test_get_task_response_with_values(self): assert response.title == "My Task" assert response.percent_complete == 50 - def test_assign_users_input_defaults(self): - """Test AssignUsersInput default values.""" - input_obj = AssignUsersInput() - assert input_obj.assignments is None + def test_assign_users_input_required_value(self): + """Test AssignUsersInput required value.""" + input_obj = AssignUsersInput(assignments="user@contoso.com") + assert input_obj.assignments == "user@contoso.com" def test_list_my_plans_response_defaults(self): """Test ListMyPlansResponse default values.""" @@ -793,12 +803,16 @@ def test_get_plan_details_response_defaults(self): assert response.id is None assert response.category_descriptions is None - def test_create_bucket_input_defaults(self): - """Test CreateBucketInput default values.""" - input_obj = CreateBucketInput() - assert input_obj.name is None - assert input_obj.group_id is None - assert input_obj.plan_id is None + def test_create_bucket_input_required_values(self): + """Test CreateBucketInput required values.""" + input_obj = CreateBucketInput( + name="New Bucket", + group_id="group-123", + plan_id="plan-123", + ) + assert input_obj.name == "New Bucket" + assert input_obj.group_id == "group-123" + assert input_obj.plan_id == "plan-123" def test_create_bucket_input_with_values(self): """Test CreateBucketInput with values.""" @@ -894,11 +908,15 @@ def test_update_task_request_with_values(self): assert request.title == "Updated Title" assert request.percent_complete == 100 - def test_create_task_request_defaults(self): - """Test CreateTaskRequest default values.""" - request = CreateTaskRequest() + def test_create_task_request_optional_defaults(self): + """Test CreateTaskRequest optional default values.""" + request = CreateTaskRequest( + group_id="group-123", + plan_id="plan-123", + title="New Task", + ) assert request.priority is None - assert request.title is None + assert request.title == "New Task" def test_create_task_request_with_priority(self): """Test CreateTaskRequest with priority.""" diff --git a/tests/test_plivo.py b/tests/test_plivo.py index 6f1274f1..d2f634d5 100644 --- a/tests/test_plivo.py +++ b/tests/test_plivo.py @@ -8,7 +8,8 @@ from azure.core.credentials import AzureKeyCredential import azure.connectors.plivo as plivo_module -from azure.connectors.plivo import Call, PlivoClient, SMS +from azure.connectors.plivo import PlivoClient +from azure.connectors.plivo import Call, SMS from azure.connectors.sdk import ConnectorException from tests.conftest import MockResponse from tests.generated_connector_test_utils import ( @@ -81,12 +82,17 @@ async def test_generated_operation_success_contract( "https://example.azure.com/connections/test", credential=mock_credential, ) + response_text = ( + '{"objects": [{"ok": true}]}' + if operation == "list_messages" + else '{"ok": true}' + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, - return_value=MockResponse(status=200, text='{"ok": true}'), + return_value=MockResponse(status=200, text=response_text), ) as mock_send: result = await invoke_generated_operation(client, operation, plivo_module) @@ -94,7 +100,8 @@ async def test_generated_operation_success_contract( assert method == expected_method assert url.endswith(expected_url_suffix) assert (mock_send.call_args.kwargs["body"] is not None) is expects_body - assert result == {"ok": True} + expected_result = [{"ok": True}] if operation == "list_messages" else {"ok": True} + assert result == expected_result @pytest.mark.asyncio async def test_send_sms_success(self, mock_credential): @@ -106,11 +113,11 @@ async def test_send_sms_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=202, text='{"message_uuid": ["id"]}'), ) as mock_send: - result = await client.send_sms_async( + result = await client.send_sms( input=SMS(src="15550000000", dst="15551111111", text="Hello"), auth_id="account/id", ) @@ -131,11 +138,11 @@ async def test_make_call_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=201, text='{"request_uuid": "id"}'), ) as mock_send: - await client.make_call_async( + await client.make_call( input=Call( from_="15550000000", to="15551111111", @@ -162,7 +169,7 @@ async def test_non_success_response_raises_exception( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=400, text="bad request"), ): diff --git a/tests/test_plumsail.py b/tests/test_plumsail.py index 9238d7f5..7fe2f797 100644 --- a/tests/test_plumsail.py +++ b/tests/test_plumsail.py @@ -7,8 +7,9 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.core.polling import AsyncLROPoller +from azure.connectors.plumsail import PlumsailClient from azure.connectors.plumsail import ( - PlumsailClient, Pdf2TextRequest, TRIGGER_OPERATIONS, ) @@ -51,7 +52,7 @@ def test_init_with_custom_settings(self, mock_credential): client = PlumsailClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -118,11 +119,11 @@ async def test_success_sends_get(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.profiles_me_get_async() + result = await client.profiles_me_get() mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -143,12 +144,12 @@ async def test_error_response_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.profiles_me_get_async() + await client.profiles_me_get() assert exc_info.value.status_code == 401 @@ -163,16 +164,19 @@ async def test_success_forwards_request_body(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - request = Pdf2TextRequest() + request = Pdf2TextRequest(document_content="base64-document-content") mock_response = MockResponse(status=200, text='{"text": "hello"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.flow_v1_documents_jobs_extract_text_from_pdf_async(input=request) + poller = await client.begin_flow_v1_documents_jobs_extract_text_from_pdf( + input=request + ) + result = await poller.result() mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -193,19 +197,19 @@ async def test_error_response_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.flow_v1_documents_jobs_extract_text_from_pdf_async( - input=Pdf2TextRequest() + await client.begin_flow_v1_documents_jobs_extract_text_from_pdf( + input=Pdf2TextRequest(document_content="base64-document-content") ) BASE_URL = "https://example.azure.com/connections/test" -OPERATION_ARGS = { +IMMEDIATE_OPERATION_ARGS = { "flow_v1_documents_flow_schema_add_watermark_to_pdf": {"type_": "test"}, "flow_v1_documents_flow_schema_parse_csv": {"headers_parameter": "test"}, "flow_v1_documents_flow_schema_reg_exp_match": {"pattern": "test"}, @@ -258,13 +262,28 @@ async def test_error_response_raises_connector_exception(self, mock_credential): "profiles_me_get": {}, } +OPERATION_ARGS = { + ( + f"begin_{operation}" + if operation.startswith( + ("flow_v1_documents_jobs_", "flow_v1_processes_flow_jobs_") + ) + else operation + ): arguments + for operation, arguments in IMMEDIATE_OPERATION_ARGS.items() +} + ALL_OPERATIONS = sorted(OPERATION_ARGS.keys()) async def _invoke_operation(client: PlumsailClient, operation: str): """Invoke a Plumsail operation by name for shared method tests.""" - method = getattr(client, f"{operation}_async") - return await method(**OPERATION_ARGS[operation]) + method = getattr(client, f"{operation}") + result = await method(**OPERATION_ARGS[operation]) + if isinstance(result, AsyncLROPoller): + return await result.result() + + return result class TestPlumsailClientAllOperations: @@ -279,7 +298,7 @@ async def test_all_operations_success(self, mock_credential, operation): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: @@ -305,7 +324,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_powerbi.py b/tests/test_powerbi.py index bcb9cd7a..12f82d64 100644 --- a/tests/test_powerbi.py +++ b/tests/test_powerbi.py @@ -7,11 +7,13 @@ import pytest from azure.core.credentials import AzureKeyCredential -from azure.connectors.powerbi import PowerbiClient, UpdateGoalRequest, QuerySpecification +from azure.connectors.powerbi import PowerbiClient +from azure.connectors.powerbi import UpdateGoalRequest, QuerySpecification from azure.connectors.sdk import ( ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestPowerbiClientInitialization: @@ -47,7 +49,7 @@ def test_init_with_custom_settings(self, mock_credential): client = PowerbiClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -115,19 +117,18 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_groups_async() + result = await resolve_generated_result(client.list_groups()) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert "/v1.0/myorg/groups" in path assert "pbi_source=powerAutomate" in path - assert result is not None - assert "value" in result + assert result[0]["id"] == "group-1" @pytest.mark.asyncio async def test_empty_response_returns_none(self, mock_credential): @@ -141,12 +142,12 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.list_groups_async() - assert result is None + result = await resolve_generated_result(client.list_groups()) + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -160,12 +161,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.list_groups_async() + await resolve_generated_result(client.list_groups()) class TestListDatasetsAsync: @@ -183,11 +184,13 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_datasets_async(groupid="group-123") + result = await resolve_generated_result( + client.list_datasets(groupid="group-123") + ) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -208,12 +211,14 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.list_datasets_async(groupid="missing-group") + await resolve_generated_result( + client.list_datasets(groupid="missing-group") + ) class TestExecuteDatasetQueryAsync: @@ -227,19 +232,21 @@ async def test_success(self, mock_credential): credential=mock_credential, ) - query = QuerySpecification() - mock_response = MockResponse(status=200, text='{"results": [{"tables": []}]}') + query = QuerySpecification(query="EVALUATE ROW(\"Value\", 1)") + mock_response = MockResponse(status=200, text='{"firstTableRows": [{"Value": 1}]}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.execute_dataset_query_async( - input=query, - groupid="group-123", - datasetid="dataset-456", + result = await resolve_generated_result( + client.execute_dataset_query( + input=query, + groupid="group-123", + datasetid="dataset-456", + ) ) mock_send.assert_called_once() @@ -249,8 +256,7 @@ async def test_success(self, mock_credential): assert "/groups/group-123/datasets/dataset-456/executeQueries" in path assert "pbi_source=powerAutomate" in path assert body is query - assert result is not None - assert "results" in result + assert result == {"firstTableRows": [{"Value": 1}]} @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -260,20 +266,22 @@ async def test_error_response_raises_exception(self, mock_credential): credential=mock_credential, ) - query = QuerySpecification() + query = QuerySpecification(query="EVALUATE ROW(\"Value\", 1)") mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.execute_dataset_query_async( - input=query, - groupid="group-123", - datasetid="dataset-456", + await resolve_generated_result( + client.execute_dataset_query( + input=query, + groupid="group-123", + datasetid="dataset-456", + ) ) @@ -292,11 +300,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.refresh_dataset_async( + result = await client.refresh_dataset( groupid="group-123", datasetid="dataset-456", ) @@ -320,12 +328,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.refresh_dataset_async( + await client.refresh_dataset( groupid="group-123", datasetid="dataset-456", ) @@ -346,11 +354,11 @@ async def test_success_sends_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.update_goal_async( + await client.update_goal( input=payload, groupid="group-1", scorecard_id="sc-1", @@ -376,12 +384,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.update_goal_async( + await client.update_goal( input=payload, groupid="group-1", scorecard_id="sc-1", diff --git a/tests/test_projectplace.py b/tests/test_projectplace.py index 264fb258..de530c49 100644 --- a/tests/test_projectplace.py +++ b/tests/test_projectplace.py @@ -7,16 +7,17 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.projectplace import ProjectplaceClient from azure.connectors.projectplace import ( CreateCardInput, MoveCardInput, - ProjectplaceClient, TRIGGER_OPERATIONS, ) from azure.connectors.sdk import ( ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestProjectplaceClientInitialization: @@ -52,7 +53,7 @@ def test_init_with_custom_settings(self, mock_credential): client = ProjectplaceClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -119,11 +120,14 @@ async def test_create_card_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_card_async(input=CreateCardInput(), board_id="42") + result = await client.create_card( + input=CreateCardInput(title="New Card"), + board_id="42", + ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -142,11 +146,14 @@ async def test_move_card_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.move_card_async(input=MoveCardInput(), board_id="7") + result = await client.move_card( + input=MoveCardInput(card_id=5), + board_id="7", + ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" @@ -165,11 +172,11 @@ async def test_list_boards_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_boards_async() + result = await resolve_generated_result(client.list_boards()) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -187,11 +194,14 @@ async def test_empty_response_body_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.create_card_async(input=CreateCardInput(), board_id="1") + result = await client.create_card( + input=CreateCardInput(title="New Card"), + board_id="1", + ) assert result is None @@ -214,17 +224,23 @@ async def test_error_response_raises_exception(self, mock_credential, operation) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: if operation == "create_card": - await client.create_card_async(input=CreateCardInput(), board_id="1") + await client.create_card( + input=CreateCardInput(title="New Card"), + board_id="1", + ) elif operation == "move_card": - await client.move_card_async(input=MoveCardInput(), board_id="1") + await client.move_card( + input=MoveCardInput(card_id=5), + board_id="1", + ) else: - await client.list_boards_async() + await resolve_generated_result(client.list_boards()) assert exc_info.value.status_code == 500 @@ -262,8 +278,11 @@ class TestProjectplaceTypeSerialization: """Tests for Projectplace connector dataclass defaults.""" def test_request_dataclasses_instantiate(self): - """Test generated request dataclasses instantiate without arguments.""" - assert CreateCardInput().title is None - assert CreateCardInput().column_id is None - assert MoveCardInput().card_id is None - assert MoveCardInput().column_id is None + """Test generated request dataclasses preserve required values and defaults.""" + create_card = CreateCardInput(title="New Card") + move_card = MoveCardInput(card_id=5) + + assert create_card.title == "New Card" + assert create_card.column_id is None + assert move_card.card_id == 5 + assert move_card.column_id is None diff --git a/tests/test_regenerated_connector_samples.py b/tests/test_regenerated_connector_samples.py index a4e8dac8..eb2b4649 100644 --- a/tests/test_regenerated_connector_samples.py +++ b/tests/test_regenerated_connector_samples.py @@ -7,12 +7,15 @@ import ast import importlib import importlib.util -from collections.abc import AsyncIterator +import inspect +import subprocess +import sys from dataclasses import dataclass from pathlib import Path from unittest.mock import AsyncMock, MagicMock import pytest +from azure.core.async_paging import AsyncItemPaged from scripts.validate_connector_samples import SampleVisitor, validate_samples @@ -32,27 +35,37 @@ class TypedInput: value: str -class TypedClient: - """Provide a typed client surface for sample validator tests.""" +class TypedAsyncClient: + """Provide a typed asynchronous client surface for sample validator tests.""" def __init__(self, connection_runtime_url: str) -> None: """Initialize the test client.""" - async def list_items_async(self, *, top: int) -> None: + async def __aenter__(self) -> TypedAsyncClient: + """Expose the async lifecycle used to recognize generated clients.""" + return self + + async def list_items(self, *, top: int) -> None: """Represent a generated method with an integer argument.""" - async def create_item_async(self, *, input: TypedInput) -> None: + async def create_item(self, *, input: TypedInput) -> None: """Represent a generated method with a typed request body.""" - async def get_items_async(self) -> AsyncIterator[dict[str, str]]: - """Represent a generated pageable method.""" - yield {"id": "item-1"} + def get_items(self) -> AsyncItemPaged[dict[str, str]]: + """Represent a generated asynchronous pageable method.""" + + +async def invoke_sample(module: object, function_name: str, *arguments: str) -> None: + """Require and await the async root sample entry point.""" + function = getattr(module, function_name) + assert inspect.iscoroutinefunction(function), function_name + await function(*arguments) @pytest.mark.parametrize( "sample_path", SAMPLE_PATHS, - ids=lambda sample_path: sample_path.stem, + ids=lambda sample_path: f"{sample_path.parent.name}-{sample_path.stem}", ) def test_regenerated_connector_sample_imports(sample_path: Path) -> None: """Test every connector sample imports its current public models.""" @@ -76,13 +89,39 @@ def test_all_connector_samples_match_generated_apis() -> None: sample_paths, issues = validate_samples(repo_root) - assert len(sample_paths) == 99 + assert len(SAMPLE_PATHS) == 99 + assert set(sample_paths) == set(SAMPLE_PATHS) + assert not (SAMPLE_DIRECTORY / "aio").exists() + assert not (SAMPLE_DIRECTORY / "sync").exists() assert issues == [] +def test_connector_samples_have_no_undefined_names() -> None: + """Test every sample resolves all names used by executable code.""" + repo_root = Path(__file__).parent.parent + result = subprocess.run( + [ + sys.executable, + "-m", + "flake8", + "--isolated", + "--select", + "F821", + str(SAMPLE_DIRECTORY), + ], + check=False, + capture_output=True, + cwd=repo_root, + text=True, + ) + + assert result.returncode == 0, result.stdout + result.stderr + + def test_sample_validator_rejects_unscoped_async_credential() -> None: """Test asynchronous credentials must use an async context manager.""" tree = ast.parse( + "from azure.identity.aio import DefaultAzureCredential\n" "async def main():\n" " credential = DefaultAzureCredential()\n" ) @@ -91,30 +130,60 @@ def test_sample_validator_rejects_unscoped_async_credential() -> None: visitor.visit(tree) assert [issue.message for issue in visitor.issues] == [ - "DefaultAzureCredential must use an async context manager", + "asynchronous DefaultAzureCredential must use an async context manager", + ] + + +def test_sample_validator_rejects_sync_credential() -> None: + """Reject synchronous credentials even when their lifecycle is scoped.""" + tree = ast.parse( + "from azure.identity import DefaultAzureCredential\n" + "with DefaultAzureCredential() as credential:\n" + " pass\n" + ) + visitor = SampleVisitor(Path("sample.py"), modules={}) + + visitor.visit(tree) + + assert [issue.message for issue in visitor.issues] == [ + "connector samples require azure.identity.aio credentials", + ] + + +@pytest.mark.parametrize( + "module_name", ["azure.connectors.aio.office365", "azure.connectors.sdk.aio"], +) +def test_sample_validator_rejects_aio_connector_namespace(module_name: str) -> None: + """Reject stale aio connector imports rather than accepting a second surface.""" + visitor = SampleVisitor(Path("sample.py"), modules={}) + + visitor.visit(ast.parse(f"from {module_name} import Office365Client\n")) + + assert [issue.message for issue in visitor.issues] == [ + "import async clients from root connector modules, not aio", ] def test_sample_validator_rejects_awaiting_pageable_method() -> None: """Test pageable methods require iteration rather than await.""" tree = ast.parse( - "client = TypedClient('https://example.azure.com/connections/test')\n" - "await client.get_items_async()\n" + "client = TypedAsyncClient('https://example.azure.com/connections/test')\n" + "await client.get_items()\n" ) visitor = SampleVisitor(Path("sample.py"), modules={}) - visitor.imported_symbols["TypedClient"] = TypedClient + visitor.imported_symbols["TypedAsyncClient"] = TypedAsyncClient visitor.visit(tree) assert [issue.message for issue in visitor.issues] == [ - "'get_items_async' must be consumed with async for", + "'get_items' must be consumed with async for", ] def test_sample_validator_rejects_dictionary_access_on_collected_items() -> None: """Test collecting an async iterator does not permit response-envelope access.""" tree = ast.parse( - "items = [item async for item in client.get_items_async()]\n" + "items = [item async for item in client.get_items()]\n" "items.get('value', [])\n" ) visitor = SampleVisitor(Path("sample.py"), modules={}) @@ -131,7 +200,7 @@ def test_sample_validator_checks_rhs_before_reassigning_the_same_name() -> None: visitor = SampleVisitor(Path("sample.py"), modules={}) visitor.visit(ast.parse( - "items = [item async for item in client.get_items_async()]\n" + "items = [item async for item in client.get_items()]\n" "items = items.get('value', [])\n" )) @@ -147,11 +216,11 @@ def test_sample_validator_parameters_shadow_outer_facts( ) -> None: """Test parameters shadow outer container and client facts without losing outer checks.""" visitor = SampleVisitor(Path("sample.py"), modules={}) - visitor.imported_symbols["TypedClient"] = TypedClient + visitor.imported_symbols["TypedAsyncClient"] = TypedAsyncClient visitor.visit(ast.parse( "items = []\n" - "client = TypedClient('https://example.com')\n" + "client = TypedAsyncClient('https://example.com')\n" f"{function_kind} consume({parameters}):\n" " items.get('value', [])\n" " client.unrelated_method()\n" @@ -165,16 +234,16 @@ def test_sample_validator_parameters_shadow_outer_facts( def test_sample_validator_function_defaults_use_outer_facts() -> None: """Test default expressions are validated before a parameter shadows its outer name.""" visitor = SampleVisitor(Path("sample.py"), modules={}) - visitor.imported_symbols["TypedClient"] = TypedClient + visitor.imported_symbols["TypedAsyncClient"] = TypedAsyncClient visitor.visit(ast.parse( - "client = TypedClient('https://example.com')\n" + "client = TypedAsyncClient('https://example.com')\n" "async def consume(client=client.missing_method()):\n" " pass\n" )) assert [issue.message for issue in visitor.issues] == [ - "'TypedClient' has no method 'missing_method'", + "'TypedAsyncClient' has no method 'missing_method'", ] @@ -200,15 +269,15 @@ def test_sample_validator_comprehension_targets_shadow_outer_facts(expression: s def test_sample_validator_comprehension_clears_client_target_facts() -> None: """Test comprehension-local receivers do not retain an outer generated client type.""" visitor = SampleVisitor(Path("sample.py"), modules={}) - visitor.imported_symbols["TypedClient"] = TypedClient + visitor.imported_symbols["TypedAsyncClient"] = TypedAsyncClient visitor.visit(ast.parse( - "client = TypedClient('https://example.com')\n" + "client = TypedAsyncClient('https://example.com')\n" "identifiers = [client.get('id') for client in [{'id': 'entry-1'}]]\n" )) assert visitor.issues == [] - assert visitor.client_variables["client"] is TypedClient + assert visitor.client_variables["client"] is TypedAsyncClient def test_sample_validator_comprehension_iterable_uses_outer_facts() -> None: @@ -227,15 +296,15 @@ def test_sample_validator_comprehension_iterable_uses_outer_facts() -> None: "source,expected_messages", [ ( - "result = [item async for item in client.get_items_async()]", + "result = [item async for item in client.get_items()]", ["capture collected items in a semantic name instead of 'result'"], ), ("if items and items:\n pass", ["remove repeated conditions"]), - ("items = [item async for item in client.get_items_async()]", []), + ("items = [item async for item in client.get_items()]", []), ("if items and ready:\n pass", []), ("if response and response.get('value'):\n pass", []), ( - "items = [item async for item in client.get_items_async()]\n" + "items = [item async for item in client.get_items()]\n" "items = items if items else []", ["remove redundant fallback for collected items"], ), @@ -258,17 +327,20 @@ def test_sample_validator_checks_consumer_principles( "connector,function_name,client_name,operation_name,expected_noun", [ ("documentdb", "example_3_query_with_pagination", "DocumentdbClient", - "query_documents_async", "document(s)"), + "list_query_documents", "document(s)"), ("documentdb", "example_5_query_with_consistency", "DocumentdbClient", - "query_documents_async", "document(s)"), + "list_query_documents", "document(s)"), ("office365groupsmail", "main", "Office365groupsmailClient", - "list_conversations_async", "conversation(s)"), + "list_conversations", "conversation(s)"), + ("planner", "example_2_list_group_plans", "PlannerClient", + "list_group_plans", "plans in group"), ("zendesk", "example_2_get_items", "ZendeskClient", - "get_items_async", "item(s)"), + "list_items", "item(s)"), ("azuretables", "example_4_get_entities", "AzuretablesClient", - "get_entities_async", "entity(s)"), + "list_entities", "entity(s)"), ], ) +@pytest.mark.asyncio async def test_pageable_samples_report_collected_items( connector: str, function_name: str, @@ -284,7 +356,7 @@ async def test_pageable_samples_report_collected_items( f"samples.sample_connector_usage.sample_connector_usage_{connector}" ) - async def items() -> AsyncIterator[dict[str, str]]: + async def async_items(): """Yield distinct items to expose incorrect counts or lost data.""" for index in range(item_count): yield { @@ -294,11 +366,11 @@ async def items() -> AsyncIterator[dict[str, str]]: } client = MagicMock() - getattr(client, operation_name).return_value = items() - client.list_groups_async = AsyncMock(return_value={"value": []}) - context = MagicMock() - context.__aenter__.return_value = client - monkeypatch.setattr(module, client_name, MagicMock(return_value=context)) + operation = getattr(client, operation_name) + operation.return_value = async_items() + client.list_groups.return_value = async_items() + client.__aenter__.return_value = client + monkeypatch.setattr(module, client_name, MagicMock(return_value=client)) if hasattr(module, "DefaultAzureCredential"): monkeypatch.setattr(module, "DefaultAzureCredential", MagicMock()) for setting in ( @@ -309,8 +381,10 @@ async def items() -> AsyncIterator[dict[str, str]]: monkeypatch.setenv("OFFICE365GROUPSMAIL_CONNECTION_URL", "https://example.com") monkeypatch.setenv("OFFICE365GROUPSMAIL_GROUP_ID", "sample-group") - await getattr(module, function_name)() + arguments = ["sample-group"] if connector == "planner" else [] + await invoke_sample(module, function_name, *arguments) + operation.assert_called_once() output = capsys.readouterr().out assert "Error:" not in output assert "Connector error" not in output @@ -323,6 +397,8 @@ async def items() -> AsyncIterator[dict[str, str]]: assert "No entities found" not in output elif connector == "documentdb" and item_count == 0: assert "No documents found." in output + elif connector == "planner" and item_count == 0: + assert "No plans found" in output elif connector == "documentdb" and function_name.endswith("consistency"): assert f"Documents retrieved: {item_count}" in output else: @@ -334,13 +410,12 @@ async def items() -> AsyncIterator[dict[str, str]]: "connector,function_name,client_name,operation_name,item_key,empty_message", [ ("azuredigitaltwins", "example_3_query_twins", "AzuredigitaltwinsClient", - "query_twins_async", "value", "No twins found matching query"), - ("planner", "example_2_list_group_plans", "PlannerClient", - "list_group_plans_async", "value", "No plans found"), + "query_twins", "value", "No twins found matching query"), ("wdatp", "example_3_advanced_hunting", "WdatpClient", - "advanced_hunting_async", "results", "No results from query."), + "advanced_hunting", "results", "No results from query."), ], ) +@pytest.mark.asyncio async def test_nonpageable_samples_preserve_nullable_responses( connector: str, function_name: str, @@ -360,14 +435,15 @@ async def test_nonpageable_samples_preserve_nullable_responses( if response_kind == "populated": response = {item_key: [{"id": "matched-item", "title": "matched-plan"}]} client = MagicMock() - setattr(client, operation_name, AsyncMock(return_value=response)) + operation = AsyncMock(return_value=response) + setattr(client, operation_name, operation) client.__aenter__.return_value = client monkeypatch.setattr(module, client_name, MagicMock(return_value=client)) monkeypatch.setattr(module, "DefaultAzureCredential", MagicMock()) - arguments = ["sample-group"] if connector == "planner" else [] - await getattr(module, function_name)(*arguments) + await invoke_sample(module, function_name) + operation.assert_awaited_once() output = capsys.readouterr().out assert "Error:" not in output assert "Connector error" not in output @@ -377,14 +453,141 @@ async def test_nonpageable_samples_preserve_nullable_responses( assert empty_message in output +@pytest.mark.parametrize("response_kind", ["none", "empty", "populated"]) +@pytest.mark.parametrize( + "connector,function_name,client_name,operation_name,item_key,marker", + [ + ( + "docusign", + "example_2_search_envelopes", + "DocusignClient", + "search_list_envelopes", + "value", + "sample-envelope", + ), + ( + "azuremonitorlogs", + "example_run_query", + "AzuremonitorlogsClient", + "query_data", + "value", + "sample-row", + ), + ], +) +@pytest.mark.asyncio +async def test_eager_list_samples_unwrap_nullable_envelopes( + connector: str, + function_name: str, + client_name: str, + operation_name: str, + item_key: str, + marker: str, + response_kind: str, + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + """Execute eager async samples without treating response envelopes as lists.""" + module = importlib.import_module( + f"samples.sample_connector_usage.sample_connector_usage_{connector}" + ) + response = None if response_kind == "none" else {} + if response_kind == "populated": + response = {item_key: [{"envelopeId": marker, "status": marker, "row": marker}]} + client = MagicMock() + operation = AsyncMock(return_value=response) + setattr(client, operation_name, operation) + client.__aenter__.return_value = client + monkeypatch.setattr(module, client_name, MagicMock(return_value=client)) + monkeypatch.setattr(module, "DefaultAzureCredential", MagicMock()) + for setting in ( + "SUBSCRIPTION_ID", + "RESOURCE_GROUP", + "RESOURCE_NAME", + "RESOURCE_TYPE", + ): + if hasattr(module, setting): + monkeypatch.setattr(module, setting, "sample-value") + + arguments = ["sample-account"] if connector == "docusign" else [] + await invoke_sample(module, function_name, *arguments) + + output = capsys.readouterr().out + assert "Error:" not in output + assert "Connector error" not in output + operation.assert_awaited_once() + if response_kind == "populated": + assert marker in output + else: + assert "0" in output + + +@pytest.mark.asyncio +async def test_eventhubs_batch_sample_passes_send_event_list( + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + """Execute the batch sample and verify its list alias is passed directly.""" + module = importlib.import_module( + "samples.sample_connector_usage.sample_connector_usage_eventhubs" + ) + client = MagicMock() + operation = AsyncMock(return_value=None) + client.send_events = operation + client.__aenter__.return_value = client + monkeypatch.setattr(module, "EventhubsClient", MagicMock(return_value=client)) + monkeypatch.setattr(module, "DefaultAzureCredential", MagicMock()) + monkeypatch.setattr(module, "EVENT_HUB_NAME", "sample-hub") + + await invoke_sample(module, "example_3_send_batch_events") + + output = capsys.readouterr().out + assert "Error:" not in output + assert "Connector error" not in output + operation.assert_awaited_once() + batch_input = operation.call_args.kwargs["input"] + assert isinstance(batch_input, list) + assert len(batch_input) == 3 + assert all(isinstance(event, module.SendEvent) for event in batch_input) + assert "Batch of 3 events" in output + + +@pytest.mark.asyncio +async def test_azuretables_create_sample_passes_scalar_table_name( + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + """Execute the create-table sample and verify its string alias is passed directly.""" + module = importlib.import_module( + "samples.sample_connector_usage.sample_connector_usage_azuretables" + ) + client = MagicMock() + operation = AsyncMock(return_value={}) + client.create_table = operation + client.__aenter__.return_value = client + monkeypatch.setattr(module, "AzuretablesClient", MagicMock(return_value=client)) + monkeypatch.setattr(module, "DefaultAzureCredential", MagicMock()) + monkeypatch.setattr(module, "STORAGE_ACCOUNT", "sample-account") + monkeypatch.setenv("AZURETABLES_NEW_TABLE_NAME", "SampleTable") + + await invoke_sample(module, "example_2_create_table") + + output = capsys.readouterr().out + assert "Error:" not in output + assert "Connector error" not in output + operation.assert_awaited_once() + assert operation.call_args.kwargs["input"] == "SampleTable" + assert "Table 'SampleTable' created successfully." in output + + def test_sample_validator_rejects_incompatible_literal_type() -> None: """Test a string literal is rejected for an integer parameter.""" tree = ast.parse( - "client = TypedClient('https://example.azure.com/connections/test')\n" - "client.list_items_async(top='10')\n" + "client = TypedAsyncClient('https://example.azure.com/connections/test')\n" + "await client.list_items(top='10')\n" ) visitor = SampleVisitor(Path("sample.py"), modules={}) - visitor.imported_symbols["TypedClient"] = TypedClient + visitor.imported_symbols["TypedAsyncClient"] = TypedAsyncClient visitor.visit(tree) @@ -396,12 +599,12 @@ def test_sample_validator_rejects_incompatible_literal_type() -> None: def test_sample_validator_rejects_environment_string_for_integer() -> None: """Test an environment string is rejected for an integer parameter.""" tree = ast.parse( - "client = TypedClient('https://example.azure.com/connections/test')\n" + "client = TypedAsyncClient('https://example.azure.com/connections/test')\n" "top = os.environ.get('TOP', '')\n" - "client.list_items_async(top=top)\n" + "await client.list_items(top=top)\n" ) visitor = SampleVisitor(Path("sample.py"), modules={}) - visitor.imported_symbols["TypedClient"] = TypedClient + visitor.imported_symbols["TypedAsyncClient"] = TypedAsyncClient visitor.visit(tree) @@ -413,12 +616,12 @@ def test_sample_validator_rejects_environment_string_for_integer() -> None: def test_sample_validator_accepts_cast_environment_value() -> None: """Test casting an environment value satisfies an integer parameter.""" tree = ast.parse( - "client = TypedClient('https://example.azure.com/connections/test')\n" + "client = TypedAsyncClient('https://example.azure.com/connections/test')\n" "top = int(os.environ.get('TOP', '0'))\n" - "client.list_items_async(top=top)\n" + "await client.list_items(top=top)\n" ) visitor = SampleVisitor(Path("sample.py"), modules={}) - visitor.imported_symbols["TypedClient"] = TypedClient + visitor.imported_symbols["TypedAsyncClient"] = TypedAsyncClient visitor.visit(tree) @@ -428,12 +631,12 @@ def test_sample_validator_accepts_cast_environment_value() -> None: def test_sample_validator_rejects_dynamic_dict_for_typed_input() -> None: """Test a dictionary with a dynamic value is rejected for a typed input.""" tree = ast.parse( - "client = TypedClient('https://example.azure.com/connections/test')\n" + "client = TypedAsyncClient('https://example.azure.com/connections/test')\n" "index = 0\n" - "client.create_item_async(input={'value': f'Item {index + 1}'})\n" + "await client.create_item(input={'value': f'Item {index + 1}'})\n" ) visitor = SampleVisitor(Path("sample.py"), modules={}) - visitor.imported_symbols["TypedClient"] = TypedClient + visitor.imported_symbols["TypedAsyncClient"] = TypedAsyncClient visitor.visit(tree) diff --git a/tests/test_regenerated_operation_coverage.py b/tests/test_regenerated_operation_coverage.py index ebe49373..353f0646 100644 --- a/tests/test_regenerated_operation_coverage.py +++ b/tests/test_regenerated_operation_coverage.py @@ -4,14 +4,14 @@ from __future__ import annotations -import inspect import json from types import ModuleType -from typing import Any +from typing import Any, get_origin, get_type_hints from unittest.mock import AsyncMock, patch from urllib.parse import urlsplit import pytest +from azure.core.async_paging import AsyncItemPaged import azure.connectors.azureautomation as azureautomation import azure.connectors.azureblob as azureblob @@ -20,31 +20,41 @@ import azure.connectors.excelonlinebusiness as excelonlinebusiness import azure.connectors.teams as teams import azure.connectors.wdatp as wdatp +from azure.connectors.azureautomation import AzureautomationClient +from azure.connectors.azureblob import AzureblobClient +from azure.connectors.azuredatafactory import AzuredatafactoryClient +from azure.connectors.azurevm import AzurevmClient +from azure.connectors.excelonlinebusiness import ExcelonlinebusinessClient +from azure.connectors.teams import TeamsClient +from azure.connectors.wdatp import WdatpClient from azure.connectors.sdk import ConnectorException from tests.conftest import MockResponse -from tests.generated_connector_test_utils import invoke_generated_operation +from tests.generated_connector_test_utils import ( + generated_pager_response_text, + invoke_generated_operation, +) CONNECTOR_OPERATION_CASES = [ ( azureautomation, - azureautomation.AzureautomationClient, + AzureautomationClient, [ - ("subscriptions_list", "GET", "/subscriptions?", False), - ("resource_groups_list", "GET", "/resourcegroups?", False), - ("automation_accounts_list", "GET", "/automationAccounts?", False), - ("runbooks_list", "GET", "/runbooks?", False), - ("get_runbook", "GET", "/runbooks/value?", False), + ("list_subscriptions", "GET", "/subscriptions?", False), + ("list_resource_groups", "GET", "/resourcegroups?", False), + ("list_automation_accounts", "GET", "/automationAccounts?", False), + ("list_runbooks", "GET", "/runbooks?", False), + ("list_runbook", "GET", "/runbooks/value?", False), ], ), ( azureblob, - azureblob.AzureblobClient, - [("get_data_sets", "GET", "/v2/codeless/GetDataSets", False)], + AzureblobClient, + [("list_data_sets", "GET", "/v2/codeless/GetDataSets", False)], ), ( azuredatafactory, - azuredatafactory.AzuredatafactoryClient, + AzuredatafactoryClient, [ ("list_subscriptions", "GET", "/subscriptions?", False), ("list_resource_groups", "GET", "/resourcegroups?", False), @@ -59,24 +69,24 @@ ), ( azurevm, - azurevm.AzurevmClient, + AzurevmClient, [ - ("subscriptions_list", "GET", "/subscriptions?", False), - ("resource_groups_list", "GET", "/resourcegroups?", False), + ("list_subscriptions", "GET", "/subscriptions?", False), + ("list_resource_groups", "GET", "/resourcegroups?", False), ( - "virtual_machine_scale_sets_list", + "list_virtual_machine_scale_sets", "GET", "/virtualMachineScaleSets?", False, ), ( - "virtual_machines_in_scale_set_list", + "list_virtual_machines_in_scale_set", "GET", "/virtualMachineScaleSets/value/virtualMachines?", False, ), ( - "virtual_machines_list", + "list_virtual_machines", "GET", "/Microsoft.Compute/virtualMachines?", False, @@ -85,11 +95,11 @@ ), ( excelonlinebusiness, - excelonlinebusiness.ExcelonlinebusinessClient, + ExcelonlinebusinessClient, [ - ("get_sources", "GET", "/codeless/v1.0/sources?", False), - ("get_drives", "GET", "/codeless/v1.0/drives?", False), - ("get_columns", "GET", "/workbook/tables/value/columns?", False), + ("list_sources", "GET", "/codeless/v1.0/sources?", False), + ("list_drives", "GET", "/codeless/v1.0/drives?", False), + ("list_columns", "GET", "/workbook/tables/value/columns?", False), ("get_table", "GET", "/workbook/tables/value/metadata?", False), ( "get_single_script", @@ -101,7 +111,7 @@ ), ( teams, - teams.TeamsClient, + TeamsClient, [ ( "archive_channel", @@ -119,7 +129,7 @@ ), ( wdatp, - wdatp.WdatpClient, + WdatpClient, [ ( "advanced_hunting_schema", @@ -145,17 +155,38 @@ ) EXPECTED_PAGEABLE_OPERATIONS = { - (azureautomation.AzureautomationClient, "subscriptions_list"), - (azureautomation.AzureautomationClient, "resource_groups_list"), - (azuredatafactory.AzuredatafactoryClient, "list_subscriptions"), - (azuredatafactory.AzuredatafactoryClient, "list_resource_groups"), - (azuredatafactory.AzuredatafactoryClient, "list_data_factories"), - (azuredatafactory.AzuredatafactoryClient, "list_pipelines"), - (azurevm.AzurevmClient, "subscriptions_list"), - (azurevm.AzurevmClient, "resource_groups_list"), - (azurevm.AzurevmClient, "virtual_machine_scale_sets_list"), - (azurevm.AzurevmClient, "virtual_machines_in_scale_set_list"), - (azurevm.AzurevmClient, "virtual_machines_list"), + (AzureautomationClient, "list_subscriptions"), + (AzureautomationClient, "list_resource_groups"), + (AzureautomationClient, "list_automation_accounts"), + (AzureautomationClient, "list_runbooks"), + (AzureautomationClient, "list_runbook"), + (AzureblobClient, "list_data_sets"), + (AzuredatafactoryClient, "list_subscriptions"), + (AzuredatafactoryClient, "list_resource_groups"), + (AzuredatafactoryClient, "list_data_factories"), + (AzuredatafactoryClient, "list_pipelines"), + (AzurevmClient, "list_subscriptions"), + (AzurevmClient, "list_resource_groups"), + (AzurevmClient, "list_virtual_machine_scale_sets"), + (AzurevmClient, "list_virtual_machines_in_scale_set"), + (AzurevmClient, "list_virtual_machines"), + (ExcelonlinebusinessClient, "list_sources"), + (ExcelonlinebusinessClient, "list_drives"), + (ExcelonlinebusinessClient, "list_columns"), +} + +CONTINUATION_PAGEABLE_OPERATIONS = { + (AzureautomationClient, "list_subscriptions"), + (AzureautomationClient, "list_resource_groups"), + (AzuredatafactoryClient, "list_subscriptions"), + (AzuredatafactoryClient, "list_resource_groups"), + (AzuredatafactoryClient, "list_data_factories"), + (AzuredatafactoryClient, "list_pipelines"), + (AzurevmClient, "list_subscriptions"), + (AzurevmClient, "list_resource_groups"), + (AzurevmClient, "list_virtual_machine_scale_sets"), + (AzurevmClient, "list_virtual_machines_in_scale_set"), + (AzurevmClient, "list_virtual_machines"), } PAGEABLE_OPERATION_CASES = [ @@ -163,20 +194,29 @@ if (operation_case[1], operation_case[2]) in EXPECTED_PAGEABLE_OPERATIONS ] +CONTINUATION_PAGEABLE_OPERATION_CASES = [ + operation_case for operation_case in OPERATION_CASES + if (operation_case[1], operation_case[2]) in CONTINUATION_PAGEABLE_OPERATIONS +] + def test_expected_pageable_operations_remain_iterator_contracts() -> None: - """Test every declared pageable operation stays in coverage and is an async iterator.""" + """Test every declared pageable operation returns an asynchronous pager.""" assert {(case[1], case[2]) for case in PAGEABLE_OPERATION_CASES} == EXPECTED_PAGEABLE_OPERATIONS - assert len(PAGEABLE_OPERATION_CASES) == 11 + assert len(PAGEABLE_OPERATION_CASES) == 18 for client_type, operation in EXPECTED_PAGEABLE_OPERATIONS: - assert inspect.isasyncgenfunction(getattr(client_type, f"{operation}_async")), operation + return_type = get_type_hints(getattr(client_type, operation))["return"] + assert get_origin(return_type) is AsyncItemPaged, operation @pytest.mark.parametrize("empty_first_page", [False, True]) @pytest.mark.parametrize( CASE_PARAMETER_NAMES, - PAGEABLE_OPERATION_CASES, - ids=[f"{case[0].__name__}.{case[2]}" for case in PAGEABLE_OPERATION_CASES], + CONTINUATION_PAGEABLE_OPERATION_CASES, + ids=[ + f"{case[0].__name__}.{case[2]}" + for case in CONTINUATION_PAGEABLE_OPERATION_CASES + ], ) @pytest.mark.asyncio async def test_newly_generated_pageable_contract_follows_later_pages( @@ -199,7 +239,7 @@ async def test_newly_generated_pageable_contract_follows_later_pages( ) as client: with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, side_effect=[ MockResponse(status=200, text=json.dumps({ @@ -230,11 +270,55 @@ async def test_newly_generated_pageable_contract_follows_later_pages( } +@pytest.mark.asyncio +async def test_relative_continuation_resolves_against_current_page( + mock_credential: Any, +) -> None: + """Test a bare relative continuation keeps the current nested route.""" + async with AzurevmClient( + "https://example.azure.com/connections/test", + credential=mock_credential, + ) as client: + with patch.object( + client._http_client, + "send", + new_callable=AsyncMock, + side_effect=[ + MockResponse( + status=200, + text=json.dumps({"value": [], "nextLink": "next-page"}), + ), + MockResponse( + status=200, + text=json.dumps({"value": [{"id": "vm-2"}]}), + ), + ], + ) as transport: + items = [ + item async for item in client.list_virtual_machines_in_scale_set( + subscription_id="subscription", + resource_group_name="group", + virtual_machine_scale_set_name="scale-set", + ) + ] + + assert items == [{"id": "vm-2"}] + assert transport.await_args_list[1].args == ( + "GET", + "https://example.azure.com/connections/test/subscriptions/subscription/" + "resourcegroups/group/providers/Microsoft.Compute/virtualMachineScaleSets/" + "scale-set/next-page", + ) + + @pytest.mark.parametrize("status,body", [(200, ""), (200, '{"value": []}'), (204, "")]) @pytest.mark.parametrize( CASE_PARAMETER_NAMES, - PAGEABLE_OPERATION_CASES, - ids=[f"{case[0].__name__}.{case[2]}" for case in PAGEABLE_OPERATION_CASES], + CONTINUATION_PAGEABLE_OPERATION_CASES, + ids=[ + f"{case[0].__name__}.{case[2]}" + for case in CONTINUATION_PAGEABLE_OPERATION_CASES + ], ) @pytest.mark.asyncio async def test_newly_generated_pageable_contract_preserves_empty_response( @@ -255,7 +339,7 @@ async def test_newly_generated_pageable_contract_preserves_empty_response( ) as client: with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=status, text=body), ) as transport: @@ -288,13 +372,17 @@ async def test_newly_generated_operation_success_contract( credential=mock_credential, ) is_pageable = (client_type, operation) in EXPECTED_PAGEABLE_OPERATIONS - response_payload = {"value": [{"id": "item-1"}]} if is_pageable else {"ok": True} + response_text = ( + generated_pager_response_text(getattr(client_type, operation)) + if is_pageable + else '{"ok": true}' + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, - return_value=MockResponse(status=200, text=json.dumps(response_payload)), + return_value=MockResponse(status=200, text=response_text), ) as mock_send: result = await invoke_generated_operation( client, @@ -307,7 +395,7 @@ async def test_newly_generated_operation_success_contract( assert method == expected_method assert expected_path in request_url assert (mock_send.call_args.kwargs["body"] is not None) is expects_body - assert result == (response_payload["value"] if is_pageable else response_payload) + assert result == ([{"ok": True}] if is_pageable else {"ok": True}) @pytest.mark.parametrize( @@ -333,7 +421,7 @@ async def test_newly_generated_operation_rejects_error_response( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=400, text="bad request"), ): diff --git a/tests/test_replicon.py b/tests/test_replicon.py index 172c29b5..9d653a54 100644 --- a/tests/test_replicon.py +++ b/tests/test_replicon.py @@ -3,7 +3,8 @@ """Contract tests for RepliconClient.""" import azure.connectors.replicon as replicon_module -from azure.connectors.replicon import RepliconClient, TRIGGER_OPERATIONS +from azure.connectors.replicon import RepliconClient +from azure.connectors.replicon import TRIGGER_OPERATIONS from tests.generated_connector_test_utils import GeneratedConnectorContractTests diff --git a/tests/test_retry_safety.py b/tests/test_retry_safety.py index e05534a6..f561df10 100644 --- a/tests/test_retry_safety.py +++ b/tests/test_retry_safety.py @@ -78,7 +78,7 @@ async def send_with_transport( retry_unsafe_http_methods=retry_unsafe_http_methods, transport=transport, ) - response = await client.send_async( + response = await client.send( method, "https://example.com/action", body=body, @@ -136,7 +136,7 @@ async def test_method_case_is_normalized_before_retry_and_dispatch( transport=transport, ) with pytest.raises(ServiceRequestError): - await client.send_async(method, "https://example.com/action") + await client.send(method, "https://example.com/action") else: response, transport = await send_with_transport(method, *outcomes) assert response.status == (200 if expected_attempts == 2 else 500) @@ -234,7 +234,7 @@ async def test_cancellation_does_not_retry() -> None: ) with pytest.raises(asyncio.CancelledError): - await client.send_async("GET", "https://example.com/action") + await client.send("GET", "https://example.com/action") assert len(transport.requests) == 1 diff --git a/tests/test_revai.py b/tests/test_revai.py index 917955c9..57718471 100644 --- a/tests/test_revai.py +++ b/tests/test_revai.py @@ -8,10 +8,12 @@ from azure.core.credentials import AzureKeyCredential import azure.connectors.revai as revai_module -from azure.connectors.revai import AlignmentInput, RevaiClient, TranscriptionInput +from azure.connectors.revai import RevaiClient +from azure.connectors.revai import AlignmentInput, TranscriptionInput from azure.connectors.sdk import ConnectorException from tests.conftest import MockResponse from tests.generated_connector_test_utils import ( + generated_pager_response_text, get_generated_operations, invoke_generated_operation, ) @@ -22,16 +24,16 @@ "alignment": ("POST", "/alignment/v1/jobs", True), "alignment_delete": ("DELETE", "/alignment/v1/jobs/value", False), "alignment_get": ("GET", "/alignment/v1/jobs/value", False), - "alignment_transcript_get": ( + "list_alignment_transcript_get": ( "GET", "/alignment/v1/jobs/value/transcript", False, ), - "alignments_get": ("GET", "/alignment/v1/jobs", False), + "list_alignments_get": ("GET", "/alignment/v1/jobs", False), "analysis": ("POST", "/sentiment_analysis/v1/jobs", True), "analysis_delete": ("DELETE", "/sentiment_analysis/v1/jobs/value", False), "analysis_get": ("GET", "/sentiment_analysis/v1/jobs/value", False), - "analysis_result_get": ( + "list_analysis_result_get": ( "GET", "/sentiment_analysis/v1/jobs/value/result", False, @@ -45,12 +47,12 @@ "extraction": ("POST", "/topic_extraction/v1/jobs", True), "extraction_delete": ("DELETE", "/topic_extraction/v1/jobs/value", False), "extraction_get": ("GET", "/topic_extraction/v1/jobs/value", False), - "extraction_result_get": ( + "list_extraction_result_get": ( "GET", "/topic_extraction/v1/jobs/value/result", False, ), - "extractions_get": ("GET", "/topic_extraction/v1/jobs", False), + "list_extractions_get": ("GET", "/topic_extraction/v1/jobs", False), "identification": ("POST", "/languageid/v1/jobs", True), "identification_delete": ("DELETE", "/languageid/v1/jobs/value", False), "identification_get": ("GET", "/languageid/v1/jobs/value", False), @@ -59,8 +61,8 @@ "/languageid/v1/jobs/value/result", False, ), - "identifications_get": ("GET", "/languageid/v1/jobs", False), - "transcript_get": ( + "list_identifications_get": ("GET", "/languageid/v1/jobs", False), + "list_transcript_get": ( "GET", "/speechtotext/v1/jobs/value/transcript", False, @@ -68,8 +70,8 @@ "transcription": ("POST", "/speechtotext/v1/jobs", True), "transcription_delete": ("DELETE", "/speechtotext/v1/jobs/value", False), "transcription_get": ("GET", "/speechtotext/v1/jobs/value", False), - "transcriptions_get": ("GET", "/speechtotext/v1/jobs", False), - "vocabularies_get": ("GET", "/speechtotext/v1/vocabularies", False), + "list_transcriptions_get": ("GET", "/speechtotext/v1/jobs", False), + "list_vocabularies_get": ("GET", "/speechtotext/v1/vocabularies", False), "vocabulary": ("POST", "/speechtotext/v1/vocabularies", True), "vocabulary_delete": ( "DELETE", @@ -79,7 +81,14 @@ "vocabulary_get": ("GET", "/speechtotext/v1/vocabularies/value", False), } ALL_OPERATIONS = list(SUCCESS_CONTRACTS) -NO_RESULT_OPERATIONS = {"analysises_get"} +NO_RESULT_OPERATIONS = { + "analysises_get", +} +PAGEABLE_OPERATIONS = { + operation + for operation in ALL_OPERATIONS + if operation.startswith("list_") +} class TestRevaiClient: @@ -137,12 +146,17 @@ async def test_generated_operation_success_contract( "https://example.azure.com/connections/test", credential=mock_credential, ) + response_text = ( + generated_pager_response_text(getattr(client, operation)) + if operation in PAGEABLE_OPERATIONS + else '{"ok": true}' + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, - return_value=MockResponse(status=200, text='{"ok": true}'), + return_value=MockResponse(status=200, text=response_text), ) as mock_send: result = await invoke_generated_operation(client, operation, revai_module) @@ -150,7 +164,13 @@ async def test_generated_operation_success_contract( assert method == expected_method assert url.endswith(expected_url_suffix) assert (mock_send.call_args.kwargs["body"] is not None) is expects_body - expected_result = None if operation in NO_RESULT_OPERATIONS else {"ok": True} + expected_result = ( + None + if operation in NO_RESULT_OPERATIONS + else [{"ok": True}] + if operation in PAGEABLE_OPERATIONS + else {"ok": True} + ) assert result == expected_result @pytest.mark.asyncio @@ -163,12 +183,13 @@ async def test_create_transcription_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"id": "job-1"}'), ) as mock_send: - result = await client.transcription_async( + result = await client.transcription( input=TranscriptionInput( + notification_config={"url": "https://example.com/callback"}, source_config={"url": "https://example.com/audio.wav"}, metadata="sample", ), @@ -190,11 +211,11 @@ async def test_alignment_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"id": "alignment-1"}'), ) as mock_send: - await client.alignment_async( + await client.alignment( input=AlignmentInput( source_config={"url": "https://example.com/audio.wav"}, transcript_text="Hello world", @@ -215,11 +236,11 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=204, text=""), ): - result = await client.account_get_async() + result = await client.account_get() assert result is None @@ -238,7 +259,7 @@ async def test_non_success_response_raises_exception( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=400, text="bad request"), ): diff --git a/tests/test_root_client_exports.py b/tests/test_root_client_exports.py new file mode 100644 index 00000000..3db3d75e --- /dev/null +++ b/tests/test_root_client_exports.py @@ -0,0 +1,100 @@ +# ------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# ------------------------------------------------------------ + +"""Tests for lazy package-root connector exports.""" + +from __future__ import annotations + +import ast +import inspect +import subprocess +import sys +from pathlib import Path + +import pytest + +import azure.connectors as connectors +from azure.connectors import sdk + + +@pytest.mark.parametrize( + ("package_name", "module_name"), + [ + ("azure.connectors", "azure.connectors.arm"), + ], +) +def test_client_export_is_loaded_lazily( + package_name: str, + module_name: str, +) -> None: + """Keep connector modules unloaded until a package export is requested.""" + script = f""" +import importlib +import inspect +import sys + +package = importlib.import_module("{package_name}") +assert "{module_name}" not in sys.modules +client_type = package.ArmClient +assert "{module_name}" in sys.modules +assert client_type is sys.modules["{module_name}"].ArmClient +assert issubclass(client_type, package.ConnectorClientBase) +assert inspect.iscoroutinefunction(client_type.close) +assert inspect.iscoroutinefunction(client_type.__aenter__) +assert not hasattr(client_type, "__enter__") +""" + + subprocess.run([sys.executable, "-c", script], check=True) + + +@pytest.mark.parametrize("package", [connectors]) +def test_client_export_propagates_import_error( + package: object, + monkeypatch: pytest.MonkeyPatch, +) -> None: + """Raise a connector import failure instead of hiding it.""" + monkeypatch.delitem(vars(package), "ArmClient", raising=False) + + def fail_import(name: str, package_name: str) -> None: + raise ImportError(f"Failed to import '{name}' from '{package_name}'.") + + monkeypatch.setattr(package, "import_module", fail_import) + + with pytest.raises(ImportError, match="Failed to import '.arm'"): + getattr(package, "ArmClient") + + +def test_client_inventory_matches_generated_registry() -> None: + """Expose every generated async client through the package root.""" + expected_names = set(connectors.CLIENT_REGISTRY) + + assert expected_names <= set(dir(connectors)) + assert expected_names <= set(connectors.__all__) + + +def test_root_runtime_exports_are_the_async_sdk_types() -> None: + """Keep runtime exports identical to the single async SDK implementation.""" + assert connectors.ConnectorClientBase is sdk.ConnectorClientBase + assert connectors.ConnectorHttpClient is sdk.ConnectorHttpClient + assert inspect.iscoroutinefunction(connectors.ConnectorClientBase.close) + assert inspect.iscoroutinefunction(connectors.ConnectorHttpClient.send) + assert inspect.iscoroutinefunction(connectors.ConnectorHttpClient.close) + assert not hasattr(connectors.ConnectorClientBase, "__enter__") + + +def test_client_type_exports_match_root_connector_modules() -> None: + """Keep static client exports aligned with the root lazy-loading registry.""" + stub_path = Path(connectors.__file__).with_suffix(".pyi") + declarations = ast.parse(stub_path.read_text(encoding="utf-8")) + client_imports = { + alias.asname or alias.name: declaration.module + for declaration in declarations.body + if isinstance(declaration, ast.ImportFrom) + and declaration.level == 1 + for alias in declaration.names + if alias.name.endswith("Client") + and alias.name != "ConnectorHttpClient" + } + + assert client_imports == connectors.CLIENT_REGISTRY diff --git a/tests/test_root_schema_serialization.py b/tests/test_root_schema_serialization.py index baac85a1..a2172dd3 100644 --- a/tests/test_root_schema_serialization.py +++ b/tests/test_root_schema_serialization.py @@ -62,7 +62,7 @@ async def test_array_root_is_serialized_through_send_async( new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.send_async( + await client.send( "POST", "https://api.example.com/messages", body=messages, diff --git a/tests/test_rss.py b/tests/test_rss.py index 780e0c63..ca5296c1 100644 --- a/tests/test_rss.py +++ b/tests/test_rss.py @@ -8,9 +8,9 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.rss import RssClient from azure.connectors.rss import ( FeedItem, - RssClient, TRIGGER_OPERATIONS, TriggerBatchResponseFeedItem, ) @@ -18,15 +18,18 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result async def _invoke_operation(client: RssClient, operation: str): """Invoke an RSS operation by name for shared parameterized tests.""" if operation == "list_feed_items": - return await client.list_feed_items_async( - feed_url="https://contoso.example/feed.xml", - since="2026-01-01T00:00:00Z", - since_property="UpdatedOn", + return await resolve_generated_result( + client.list_feed_items( + feed_url="https://contoso.example/feed.xml", + since="2026-01-01T00:00:00Z", + since_property="UpdatedOn", + ) ) raise ValueError(f"Unsupported operation '{operation}'.") @@ -65,7 +68,7 @@ def test_init_with_custom_settings(self, mock_credential): client = RssClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -123,14 +126,16 @@ async def test_list_feed_items_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_feed_items_async( - feed_url="https://contoso.example/feed.xml", - since="2026-01-01T00:00:00Z", - since_property="UpdatedOn", + result = await resolve_generated_result( + client.list_feed_items( + feed_url="https://contoso.example/feed.xml", + since="2026-01-01T00:00:00Z", + since_property="UpdatedOn", + ) ) assert len(result) == 1 @@ -161,7 +166,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -179,11 +184,11 @@ def test_callable_method_signatures(self): actual_signatures = { name: tuple(inspect.signature(method).parameters) for name, method in vars(RssClient).items() - if inspect.iscoroutinefunction(method) + if callable(method) and not name.startswith("_") } assert actual_signatures == { - "list_feed_items_async": ( + "list_feed_items": ( "self", "feed_url", "since", @@ -213,9 +218,9 @@ class TestRssTypeSerialization: def test_dataclass_instances_initialize_expected_defaults(self): """Test generated dataclasses initialize with expected default values.""" - feed_item = FeedItem() + feed_item = FeedItem(title="Item") trigger_response = TriggerBatchResponseFeedItem() assert feed_item.id is None - assert feed_item.title is None + assert feed_item.title == "Item" assert trigger_response.value is None diff --git a/tests/test_salesforce.py b/tests/test_salesforce.py index 8a2bd6c8..a1eae086 100644 --- a/tests/test_salesforce.py +++ b/tests/test_salesforce.py @@ -7,9 +7,9 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.salesforce import SalesforceClient from azure.connectors.salesforce import ( CloseJobRequest, - SalesforceClient, TRIGGER_OPERATIONS, ) from azure.connectors.sdk import ( @@ -58,7 +58,7 @@ def test_init_with_custom_settings(self, mock_credential): client = SalesforceClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -141,11 +141,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await resolve_generated_result(client.get_tables_async()) + result = await resolve_generated_result(client.list_tables()) mock_send.assert_called_once() call_args = mock_send.call_args @@ -165,12 +165,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.get_tables_async()) + await resolve_generated_result(client.list_tables()) assert exc_info.value.status_code == 401 @@ -190,11 +190,11 @@ async def test_with_query_parameters(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await resolve_generated_result(client.get_items_async( + await resolve_generated_result(client.list_items( table="account", filter="Name eq 'Contoso'", top="5", @@ -229,11 +229,11 @@ async def test_sends_request_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_job_async(input=payload) + result = await client.create_job(input=payload) call_args = mock_send.call_args assert call_args[0][0] == "POST" @@ -257,12 +257,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: with pytest.raises(ConnectorException) as exc_info: - await client.create_job_async(input=payload) + await client.create_job(input=payload) mock_send.assert_called_once_with( "POST", @@ -295,11 +295,11 @@ async def test_sends_request_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.post_item_async(input=payload, table="account") + result = await client.post_item(input=payload, table="account") call_args = mock_send.call_args assert call_args[0][0] == "POST" @@ -322,11 +322,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.delete_item_async(table="account", id="001xx0000000001") + await client.delete_item(table="account", id="001xx0000000001") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -340,16 +340,16 @@ async def test_error_response_raises_exception(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=404, text='{"error": "Not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.delete_item_async(table="account", id="missing-id") + await client.delete_item(table="account", id="missing-id") class TestUploadJobDataAsync: @@ -367,11 +367,11 @@ async def test_success_sends_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.upload_job_data_async(input=payload, job_id="job-1") + await client.upload_job_data(input=payload, job_id="job-1") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -395,12 +395,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.upload_job_data_async(input=payload, job_id="job-1") + await client.upload_job_data(input=payload, job_id="job-1") class TestHttpRequestAsync: @@ -418,11 +418,11 @@ async def test_success_sends_raw_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.http_request_async(input=payload) + result = await client.http_request(input=payload) mock_send.assert_called_once_with( "POST", @@ -447,12 +447,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.http_request_async(input=b"invalid request") + await client.http_request(input=b"invalid request") assert exc_info.value.status_code == 400 @@ -471,11 +471,11 @@ async def test_success_uses_acronym_aware_name(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.execute_sosl_query_async(q="FIND {Contoso}") + result = await client.execute_sosl_query(q="FIND {Contoso}") assert mock_send.call_args.args[0] == "GET" assert "/codeless/search?q=FIND%20%7BContoso%7D" in ( @@ -495,12 +495,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.execute_sosl_query_async(q="FIND") + await client.execute_sosl_query(q="FIND") class TestCloseJobAsync: @@ -518,11 +518,11 @@ async def test_success_sends_body_and_returns_result(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.close_job_async(input=payload, job_id="job-1") + result = await client.close_job(input=payload, job_id="job-1") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -544,12 +544,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.close_job_async(input=payload, job_id="missing-job") + await client.close_job(input=payload, job_id="missing-job") class TestSalesforceDiscoveryOperations: @@ -560,23 +560,23 @@ class TestSalesforceDiscoveryOperations: ("method_name", "path_suffix"), [ ( - "get_external_id_fields_async", + "list_external_id_fields", "/datasets/default/tables/account/externalIdFields", ), ( - "get_metadata_for_get_item_async", + "get_metadata_for_get_item", "/$metadata.json/datasets/default/tables/account/getitem", ), ( - "get_metadata_for_patch_item_async", + "get_metadata_for_patch_item", "/$metadata.json/datasets/default/tables/account/patchitem", ), ( - "get_metadata_for_post_item_async", + "get_metadata_for_post_item", "/$metadata.json/datasets/default/tables/account/postitem", ), ( - "get_table_async", + "get_table", "/$metadata.json/datasets/default/tables/account", ), ], @@ -592,15 +592,22 @@ async def test_success_uses_expected_path( "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"name": "account"}') + response_text = ( + '{"value": [{"name": "account"}]}' + if method_name == "list_external_id_fields" + else '{"name": "account"}' + ) + mock_response = MockResponse(status=200, text=response_text) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await getattr(client, method_name)(table="account") + result = await resolve_generated_result( + getattr(client, method_name)(table="account") + ) mock_send.assert_called_once_with( "GET", @@ -611,17 +618,22 @@ async def test_success_uses_expected_path( client_request_id=None, response_hook=None, ) - assert result == {"name": "account"} + expected_result = ( + [{"name": "account"}] + if method_name == "list_external_id_fields" + else {"name": "account"} + ) + assert result == expected_result @pytest.mark.asyncio @pytest.mark.parametrize( "method_name", [ - "get_external_id_fields_async", - "get_metadata_for_get_item_async", - "get_metadata_for_patch_item_async", - "get_metadata_for_post_item_async", - "get_table_async", + "list_external_id_fields", + "get_metadata_for_get_item", + "get_metadata_for_patch_item", + "get_metadata_for_post_item", + "get_table", ], ) async def test_error_response_raises_exception( @@ -638,12 +650,14 @@ async def test_error_response_raises_exception( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await getattr(client, method_name)(table="account") + await resolve_generated_result( + getattr(client, method_name)(table="account") + ) assert exc_info.value.status_code == 404 diff --git a/tests/test_sample_entry_points.py b/tests/test_sample_entry_points.py new file mode 100644 index 00000000..5c143a09 --- /dev/null +++ b/tests/test_sample_entry_points.py @@ -0,0 +1,66 @@ +# ------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# ------------------------------------------------------------ + +"""Offline regression tests for asynchronous sample entry points.""" + +from __future__ import annotations + +import ast +import gc +import importlib.util +import warnings +from pathlib import Path +from unittest.mock import AsyncMock + +import pytest + + +def test_sharepoint_main_guard_awaits_examples_without_coroutine_warnings( + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + """Run the actual main guard with only the seven example functions mocked.""" + sample_path = ( + Path(__file__).resolve().parent.parent + / "samples/sample_connector_usage/sample_connector_usage_sharepoint.py" + ) + tree = ast.parse(sample_path.read_text(encoding="utf-8"), filename=str(sample_path)) + guard, = ( + node for node in tree.body + if isinstance(node, ast.If) and ast.unparse(node.test) == "__name__ == '__main__'" + ) + specification = importlib.util.spec_from_file_location("sharepoint_entry_point", sample_path) + assert specification is not None and specification.loader is not None + module = importlib.util.module_from_spec(specification) + specification.loader.exec_module(module) + assert module.IMPORTS_AVAILABLE + + example_names = ( + "example_1_get_lists", + "example_2_get_list_items", + "example_3_create_list_item", + "example_4_update_list_item", + "example_5_query_with_filters", + "example_6_file_operations", + "example_7_error_handling", + ) + examples = {name: AsyncMock(name=name) for name in example_names} + for name, example in examples.items(): + monkeypatch.setattr(module, name, example) + module.__name__ = "__main__" + + with warnings.catch_warnings(record=True) as recorded_warnings: + warnings.simplefilter("always", RuntimeWarning) + exec(compile(ast.Module(body=[guard], type_ignores=[]), str(sample_path), "exec"), + vars(module)) + gc.collect() + + for example in examples.values(): + example.assert_awaited_once_with() + assert "Sample completed!" in capsys.readouterr().out + assert not [ + str(warning.message) for warning in recorded_warnings + if issubclass(warning.category, RuntimeWarning) + and "was never awaited" in str(warning.message) + ] diff --git a/tests/test_sdk_azure_core_pipeline.py b/tests/test_sdk_azure_core_pipeline.py index f142198c..8cd37119 100644 --- a/tests/test_sdk_azure_core_pipeline.py +++ b/tests/test_sdk_azure_core_pipeline.py @@ -23,8 +23,9 @@ AsyncioRequestsTransport, ) -from azure.connectors.sdk import ConnectorClientBase, ConnectorException, ConnectorHttpClient +from azure.connectors.sdk import ConnectorClientBase, ConnectorHttpClient from azure.connectors.sdk.http_client import _JitterRetryPolicy +from azure.connectors.sdk.exceptions import ConnectorException class RecordingCredential: @@ -134,7 +135,7 @@ async def test_token_credential_uses_fixed_scope_and_remains_open() -> None: transport = RecordingTransport(create_response(status=204, content=b"")) client = ConnectorHttpClient(credential, transport=transport) - await client.send_async("GET", "https://example.test/items") + await client.send("GET", "https://example.test/items") await client.close() assert credential.scopes == ("https://apihub.azure.com/.default",) @@ -152,7 +153,7 @@ async def test_key_credential_uses_bearer_authorization() -> None: transport=transport, ) - await client.send_async("GET", "https://example.test/items") + await client.send("GET", "https://example.test/items") assert transport.requests[0].headers["Authorization"] == "Bearer test-key" @@ -170,7 +171,7 @@ async def test_request_controls_and_response_hook_are_applied() -> None: transport=transport, ) - response = await client.send_async( + response = await client.send( "GET", "https://example.test/items", timeout=5.0, @@ -204,7 +205,7 @@ async def test_request_controls_override_client_default_headers() -> None: transport=transport, ) - await client.send_async( + await client.send( "GET", "https://example.test/items", headers={"x-custom": "operation"}, @@ -252,7 +253,7 @@ async def delayed_body(request: web.Request) -> web.StreamResponse: try: with pytest.raises(ServiceResponseTimeoutError): - await client.send_async( + await client.send( "GET", str(server.make_url("/")), timeout=request_timeout, @@ -284,7 +285,7 @@ async def test_nonpositive_timeout_disables_request_deadlines( transport=transport, ) - response = await client.send_async( + response = await client.send( "GET", "https://example.test/items", timeout=request_timeout, @@ -329,7 +330,7 @@ async def delayed_body(request: web.Request) -> web.StreamResponse: ) try: - response = await client.send_async( + response = await client.send( "GET", str(server.make_url("/")), timeout=request_timeout, @@ -372,7 +373,7 @@ async def empty_response(request: web.Request) -> web.Response: ) try: - response = await client.send_async( + response = await client.send( method, str(server.make_url("/")), response_hook=hook, @@ -406,7 +407,7 @@ async def empty_error(request: web.Request) -> web.Response: try: with pytest.raises(ConnectorException) as error: - await client.get_async(str(server.make_url("/"))) + await client.get(str(server.make_url("/"))) finally: await client.close() await server.close() @@ -439,7 +440,7 @@ async def test_requests_transport_accepts_timeout_controls( side_effect=requests.ConnectionError("synthetic connection error"), ) as request: with pytest.raises(ServiceRequestError): - await client.send_async( + await client.send( "GET", "https://example.test/items", **request_options, @@ -481,7 +482,7 @@ async def test_unsafe_method_does_not_retry_by_default() -> None: transport=transport, ) - response = await client.send_async("POST", "https://example.test/items") + response = await client.send("POST", "https://example.test/items") assert response.status == 500 assert len(transport.requests) == 1 @@ -502,7 +503,7 @@ async def test_unsafe_method_retries_when_enabled() -> None: transport=transport, ) - response = await client.send_async("POST", "https://example.test/items") + response = await client.send("POST", "https://example.test/items") assert response.status == 200 assert len(transport.requests) == 2 @@ -581,7 +582,7 @@ async def test_injected_policies_run_at_their_configured_retry_scope() -> None: transport=transport, ) - response = await client.send_async("GET", "https://example.test/items") + response = await client.send("GET", "https://example.test/items") assert response.status == 200 assert events == [ @@ -610,7 +611,7 @@ async def test_explicit_chain_composes_injected_policy_scopes() -> None: transport=transport, ) - response = await client.send_async("GET", "https://example.test/items") + response = await client.send("GET", "https://example.test/items") assert response.status == 200 assert events == [ @@ -674,7 +675,7 @@ async def successful_response(request: web.Request) -> web.Response: ) try: - response = await client.send_async( + response = await client.send( "GET", str(server.make_url("/")), **request_options, @@ -700,7 +701,7 @@ async def test_explicit_no_retry_chain_omits_retry_policy_options() -> None: transport=transport, ) - response = await client.send_async("POST", "https://example.test/items") + response = await client.send("POST", "https://example.test/items") assert response.status == 200 assert "timeout" not in transport.request_options[0] diff --git a/tests/test_sdk_client_base.py b/tests/test_sdk_client_base.py index 6a825b2b..ae89ee3c 100644 --- a/tests/test_sdk_client_base.py +++ b/tests/test_sdk_client_base.py @@ -53,7 +53,7 @@ def test_init_forwards_pipeline_settings(self, mock_credential) -> None: TestClient( mock_credential, max_retry_attempts=5, - timeout_seconds=60.0, + timeout=60.0, retry_unsafe_http_methods=True, retry_status=2, ) diff --git a/tests/test_sdk_exceptions.py b/tests/test_sdk_exceptions.py index 24977d26..e289f864 100644 --- a/tests/test_sdk_exceptions.py +++ b/tests/test_sdk_exceptions.py @@ -1,8 +1,10 @@ """Unit tests for SDK exceptions module.""" import pytest +from azure.core.exceptions import HttpResponseError from azure.connectors.sdk.exceptions import ConnectorException +from azure.connectors.sdk.response import ConnectorResponseSnapshot class TestConnectorException: @@ -55,6 +57,46 @@ def test_exception_inherits_from_exception(self): assert isinstance(ex, Exception) + def test_exception_inherits_from_http_response_error(self): + """Test that connector failures use the Azure Core HTTP hierarchy.""" + ex = ConnectorException("GET", "/", 500, "error") + + assert isinstance(ex, HttpResponseError) + assert ex.status_code == 500 + assert ex.reason == "Internal Server Error" + assert ex.response is not None + assert ex.response.status_code == 500 + assert ex.response.body() == b"error" + + def test_exception_preserves_completed_response(self): + """Expose response headers and content through the Azure Core contract.""" + response = ConnectorResponseSnapshot( + status=429, + headers={"Content-Type": "application/json", "Retry-After": "30"}, + text='{"error": "throttled"}', + content=b'{"error": "throttled"}', + ) + + ex = ConnectorException( + "POST", + "/items", + 429, + response.text, + response=response, + ) + + assert ex.reason == "Too Many Requests" + assert ex.response is not None + assert ex.response.request.method == "POST" + assert ex.response.request.url == "/items" + assert ex.response.headers["Retry-After"] == "30" + assert ex.response.content_type == "application/json" + assert ex.response.text() == response.text + assert ex.message == ( + 'POST /items failed with status 429: {"error": "throttled"}' + ) + assert str(ex).endswith('\nContent: {"error": "throttled"}') + def test_exception_can_be_raised_and_caught(self): """Test that exception can be raised and caught.""" with pytest.raises(ConnectorException) as exc_info: diff --git a/tests/test_sdk_http_client.py b/tests/test_sdk_http_client.py index 49d438b9..ba81ed68 100644 --- a/tests/test_sdk_http_client.py +++ b/tests/test_sdk_http_client.py @@ -7,7 +7,7 @@ from unittest.mock import AsyncMock, MagicMock, patch import pytest -from azure.core.pipeline.transport import AsyncHttpTransport +from azure.core.pipeline.transport import AioHttpTransport, AsyncHttpTransport from azure.connectors.sdk.exceptions import ConnectorException from azure.connectors.sdk.http_client import ConnectorHttpClient, ConnectorResponse @@ -115,6 +115,21 @@ def test_init_rejects_none_credential(self) -> None: with pytest.raises(ValueError, match="credential cannot be None"): ConnectorHttpClient(None) + def test_default_transport_uses_standard_tls_options( + self, + mock_credential, + ) -> None: + """Forward standard TLS options to the owned aio transport.""" + client = ConnectorHttpClient( + mock_credential, + connection_verify=False, + connection_cert="client.pem", + ) + + assert isinstance(client._transport, AioHttpTransport) + assert client._transport.connection_config.verify is False + assert client._transport.connection_config.cert == "client.pem" + def test_api_hub_scopes_constant(self) -> None: """Keep the fixed API Hub token scope.""" assert ConnectorHttpClient.API_HUB_SCOPES == [ @@ -134,7 +149,7 @@ async def test_close_exits_transport_not_credential(self, mock_credential) -> No mock_credential.close.assert_not_awaited() @pytest.mark.asyncio - async def test_send_async_serializes_dataclass_body(self, mock_credential) -> None: + async def test_send_serializes_dataclass_body(self, mock_credential) -> None: """Serialize dataclasses as JSON and omit None fields.""" client = ConnectorHttpClient(mock_credential) body = TestDataClass(name="test", value=42) @@ -145,7 +160,7 @@ async def test_send_async_serializes_dataclass_body(self, mock_credential) -> No new_callable=AsyncMock, return_value=create_snapshot(), ) as mock_send: - await client.send_async( + await client.send( "POST", "https://api.example.com/items", body=body, @@ -156,7 +171,7 @@ async def test_send_async_serializes_dataclass_body(self, mock_credential) -> No assert call.args[3]["Content-Type"] == "application/json" @pytest.mark.asyncio - async def test_send_async_preserves_wire_names_and_extensions( + async def test_send_preserves_wire_names_and_extensions( self, mock_credential, ) -> None: @@ -175,7 +190,7 @@ async def test_send_async_preserves_wire_names_and_extensions( new_callable=AsyncMock, return_value=create_snapshot(), ) as mock_send: - await client.send_async( + await client.send( "POST", "https://api.example.com/items", body=body, @@ -189,7 +204,7 @@ async def test_send_async_preserves_wire_names_and_extensions( } @pytest.mark.asyncio - async def test_send_async_serializes_dict_and_none_bodies( + async def test_send_serializes_dict_and_none_bodies( self, mock_credential, ) -> None: @@ -202,12 +217,12 @@ async def test_send_async_serializes_dict_and_none_bodies( new_callable=AsyncMock, return_value=create_snapshot(), ) as mock_send: - await client.send_async( + await client.send( "POST", "https://api.example.com/items", body={"key": "value"}, ) - await client.send_async( + await client.send( "GET", "https://api.example.com/items", body=None, @@ -224,7 +239,7 @@ async def test_send_async_serializes_dict_and_none_bodies( ("application/pdf", "application/pdf"), ], ) - async def test_send_async_sends_binary_body_verbatim( + async def test_send_sends_binary_body_verbatim( self, mock_credential, content_type: str | None, @@ -240,7 +255,7 @@ async def test_send_async_sends_binary_body_verbatim( new_callable=AsyncMock, return_value=create_snapshot(), ) as mock_send: - await client.send_async( + await client.send( "POST", "https://api.example.com/upload", body=body, @@ -252,7 +267,7 @@ async def test_send_async_sends_binary_body_verbatim( assert call.args[4] == body @pytest.mark.asyncio - async def test_send_async_filters_protected_headers(self, mock_credential) -> None: + async def test_send_filters_protected_headers(self, mock_credential) -> None: """Prevent callers from replacing authentication and request identity.""" client = ConnectorHttpClient(mock_credential) @@ -262,7 +277,7 @@ async def test_send_async_filters_protected_headers(self, mock_credential) -> No new_callable=AsyncMock, return_value=create_snapshot(), ) as mock_send: - await client.send_async( + await client.send( "GET", "https://api.example.com/items", headers={ @@ -279,7 +294,7 @@ async def test_send_async_filters_protected_headers(self, mock_credential) -> No } @pytest.mark.asyncio - async def test_send_async_forwards_controls_and_invokes_hook( + async def test_send_forwards_controls_and_invokes_hook( self, mock_credential, ) -> None: @@ -294,7 +309,7 @@ async def test_send_async_forwards_controls_and_invokes_hook( new_callable=AsyncMock, return_value=response, ) as mock_send: - result = await client.send_async( + result = await client.send( "GET", "https://api.example.com/items", timeout=5.0, @@ -313,9 +328,9 @@ async def test_send_async_forwards_controls_and_invokes_hook( @pytest.mark.parametrize( "method_name, expected_method, arguments", [ - ("get_async", "GET", ("https://api.example.com/item",)), + ("get", "GET", ("https://api.example.com/item",)), ( - "post_async", + "post", "POST", ("https://api.example.com/item", {"name": "item"}), ), @@ -330,22 +345,22 @@ async def test_json_helpers_return_successful_payloads( ) -> None: """Deserialize successful GET and POST helper responses.""" client = ConnectorHttpClient(mock_credential) - client.send_async = AsyncMock( + client.send = AsyncMock( return_value=create_snapshot(text='{"name": "item"}') ) result = await getattr(client, method_name)(*arguments) assert result == {"name": "item"} - assert client.send_async.await_args.args[0] == expected_method + assert client.send.await_args.args[0] == expected_method @pytest.mark.asyncio @pytest.mark.parametrize( "method_name, expected_method, arguments", [ - ("get_async", "GET", ("https://api.example.com/item",)), + ("get", "GET", ("https://api.example.com/item",)), ( - "post_async", + "post", "POST", ("https://api.example.com/item", {"name": "item"}), ), @@ -360,7 +375,7 @@ async def test_json_helpers_raise_for_non_success( ) -> None: """Raise ConnectorException for non-success helper responses.""" client = ConnectorHttpClient(mock_credential) - client.send_async = AsyncMock( + client.send = AsyncMock( return_value=create_snapshot(status=404, text="missing") ) @@ -372,7 +387,7 @@ async def test_json_helpers_raise_for_non_success( assert exc_info.value.status_code == 404 @pytest.mark.asyncio - @pytest.mark.parametrize("method_name", ["get_async", "post_async"]) + @pytest.mark.parametrize("method_name", ["get", "post"]) async def test_json_helpers_return_none_for_empty_body( self, mock_credential, @@ -380,10 +395,10 @@ async def test_json_helpers_return_none_for_empty_body( ) -> None: """Return None for a successful response without content.""" client = ConnectorHttpClient(mock_credential) - client.send_async = AsyncMock(return_value=create_snapshot(text="")) + client.send = AsyncMock(return_value=create_snapshot(text="")) arguments = ( ("https://api.example.com/item", {}) - if method_name == "post_async" + if method_name == "post" else ("https://api.example.com/item",) ) diff --git a/tests/test_sdk_json_bom.py b/tests/test_sdk_json_bom.py new file mode 100644 index 00000000..7721edbb --- /dev/null +++ b/tests/test_sdk_json_bom.py @@ -0,0 +1,72 @@ +# ------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# ------------------------------------------------------------ + +"""Verify Azure Core JSON decoding through the generated async client.""" + +from __future__ import annotations + +import json + +import pytest +from aiohttp import web +from aiohttp.test_utils import TestServer +from azure.core.credentials import AzureKeyCredential + +from azure.connectors.jira import JiraClient + + +@pytest.mark.parametrize("timeout", [None, 5.0, 0.0]) +@pytest.mark.parametrize( + ("content_type", "payload"), + [ + ("application/json", b'\xef\xbb\xbf{"issues":[{"id":"bom"}],"isLast":true}'), + ( + "application/json; charset=utf-8", + b'\xef\xbb\xbf{"issues":[{"id":"bom"}],"isLast":true}', + ), + ("application/json", b'{"issues":[{"id":"plain"}],"isLast":true}'), + ( + "application/json; charset=windows-1252", + b'{"issues":[{"id":"caf\xe9"}],"isLast":true}', + ), + ], +) +@pytest.mark.asyncio +async def test_generated_pager_decodes_json_and_preserves_raw_bytes( + timeout: float | None, + content_type: str, + payload: bytes, +) -> None: + """Decode BOM JSON and charset controls without changing response bytes.""" + async def serve_response(request: web.Request) -> web.Response: + assert request.headers["Authorization"] == "Bearer test-key" + return web.Response(body=payload, headers={"Content-Type": content_type}) + + application = web.Application() + application.router.add_get("/{path:.*}", serve_response) + server = TestServer(application) + await server.start_server() + snapshots = [] + request_options = {} if timeout is None else {"timeout": timeout} + try: + async with JiraClient( + str(server.make_url("/connections/test")), + credential=AzureKeyCredential("test-key"), + ) as client: + issues = [ + issue async for issue in client.list_issues( + response_hook=lambda response, headers: snapshots.append(response), + **request_options, + ) + ] + finally: + await server.close() + + expected_text = payload.decode( + "windows-1252" if "windows-1252" in content_type else "utf-8-sig", + ) + assert issues == json.loads(expected_text)["issues"] + assert len(snapshots) == 1 + assert snapshots[0].content == payload + assert json.loads(snapshots[0].text) == json.loads(expected_text) diff --git a/tests/test_sdk_polling.py b/tests/test_sdk_polling.py new file mode 100644 index 00000000..cc5b8bd8 --- /dev/null +++ b/tests/test_sdk_polling.py @@ -0,0 +1,341 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. + +"""Unit tests for connector long-running operation polling.""" + +from datetime import datetime, timedelta, timezone +from email.utils import format_datetime +from unittest.mock import AsyncMock, MagicMock, patch + +import pytest +from azure.core.polling import AsyncLROPoller + +from azure.connectors.sdk._polling import ( + get_retry_after_seconds, + resolve_polling_url, +) +from azure.connectors.sdk.exceptions import ConnectorException +from azure.connectors.sdk.polling import ConnectorPollingMethod +from azure.connectors.sdk.response import ConnectorResponseSnapshot + + +def create_response( + status: int, + headers: dict[str, str] | None = None, + text: str = "", +) -> ConnectorResponseSnapshot: + """Create an immutable connector response for polling tests.""" + return ConnectorResponseSnapshot( + status=status, + headers=headers or {}, + text=text, + content=text.encode("utf-8"), + ) + + +@pytest.mark.asyncio +async def test_async_poller_follows_location_and_forwards_request_controls() -> None: + """Poll asynchronously through the runtime URL with all request controls.""" + initial_response = create_response( + 202, + {"location": "https://backend.example/jobs/42", "Retry-After": "2"}, + ) + http_client = MagicMock() + http_client.send = AsyncMock( + return_value=create_response(200, text='{"status": "done"}'), + ) + client = MagicMock() + client._connection_runtime_url = "https://runtime.example/connections/1" + response_hook = MagicMock() + polling_method = ConnectorPollingMethod( + http_client=http_client, + polling_header_name="location", + timeout=5.0, + headers={"x-test": "value"}, + client_request_id="request-id", + response_hook=response_hook, + ) + + with patch( + "azure.connectors.sdk.polling.asyncio.sleep", new_callable=AsyncMock, + ) as sleep: + poller = AsyncLROPoller( + client, + initial_response, + lambda response: response.text, + polling_method, + ) + result = await poller.result() + + assert result == '{"status": "done"}' + sleep.assert_awaited_once_with(2.0) + http_client.send.assert_awaited_once_with( + "GET", + "https://runtime.example/connections/1/jobs/42", + body=None, + timeout=5.0, + headers={"x-test": "value"}, + client_request_id="request-id", + response_hook=response_hook, + ) + assert poller.done() is True + assert poller.status() == "Succeeded" + + +@pytest.mark.asyncio +@pytest.mark.parametrize( + ("updated_location", "expected_url"), + [ + ("43", "https://runtime.example/connections/1/jobs/pending/43"), + ("../43", "https://runtime.example/connections/1/jobs/43"), + ], +) +async def test_async_poller_resolves_relative_location_with_request_controls( + updated_location: str, + expected_url: str, +) -> None: + """Resolve Location updates and preserve the per-request timeout.""" + http_client = MagicMock() + http_client.send = AsyncMock(side_effect=[ + create_response(202, {"Location": updated_location, "Retry-After": "0"}), + create_response(200), + ]) + client = MagicMock() + client._connection_runtime_url = "https://runtime.example/connections/1" + + with patch( + "azure.connectors.sdk.polling.asyncio.sleep", new_callable=AsyncMock, + ): + poller = AsyncLROPoller( + client, + create_response( + 202, + {"Location": "/jobs/pending/42", "Retry-After": "0"}, + ), + lambda response: response.text, + ConnectorPollingMethod(http_client, "Location", timeout=5.0), + ) + await poller.result() + + assert [call.args[1] for call in http_client.send.await_args_list] == [ + "https://runtime.example/connections/1/jobs/pending/42", + expected_url, + ] + assert all( + call.kwargs["timeout"] == 5.0 + for call in http_client.send.await_args_list + ) + + +@pytest.mark.asyncio +async def test_async_poller_updates_location_until_terminal_response() -> None: + """Poll asynchronously and honor a changed Location header.""" + initial_response = create_response( + 202, + {"Location": "/jobs/42", "Retry-After": "0"}, + ) + http_client = MagicMock() + http_client.send = AsyncMock( + side_effect=[ + create_response(202, {"Location": "?step=2", "Retry-After": "0"}), + create_response(204), + ] + ) + client = MagicMock() + client._connection_runtime_url = "https://runtime.example/connections/1" + polling_method = ConnectorPollingMethod(http_client, "Location") + poller = AsyncLROPoller( + client, + initial_response, + lambda response: response.text or None, + polling_method, + ) + + with patch( + "azure.connectors.sdk.polling.asyncio.sleep", + new_callable=AsyncMock, + ) as sleep: + result = await poller.result() + + assert result is None + assert sleep.await_count == 2 + assert [call.args[1] for call in http_client.send.await_args_list] == [ + "https://runtime.example/connections/1/jobs/42", + "https://runtime.example/connections/1/jobs/42?step=2", + ] + assert poller.done() is True + assert poller.status() == "Succeeded" + + +@pytest.mark.asyncio +@pytest.mark.parametrize( + ("updated_location", "expected_url"), + [ + ("43", "https://runtime.example/connections/1/jobs/pending/43"), + ("../43", "https://runtime.example/connections/1/jobs/43"), + ], +) +async def test_async_poller_resolves_relative_location_against_current_url( + updated_location: str, + expected_url: str, +) -> None: + """Resolve async Location updates relative to the current polling request.""" + http_client = MagicMock() + http_client.send = AsyncMock( + side_effect=[ + create_response( + 202, + {"Location": updated_location, "Retry-After": "0"}, + ), + create_response(200), + ] + ) + client = MagicMock() + client._connection_runtime_url = "https://runtime.example/connections/1" + poller = AsyncLROPoller( + client, + create_response( + 202, + {"Location": "/jobs/pending/42", "Retry-After": "0"}, + ), + lambda response: response.text, + ConnectorPollingMethod(http_client, "Location"), + ) + + with patch( + "azure.connectors.sdk.polling.asyncio.sleep", + new_callable=AsyncMock, + ): + await poller.result() + + assert [call.args[1] for call in http_client.send.await_args_list] == [ + "https://runtime.example/connections/1/jobs/pending/42", + expected_url, + ] + + +@pytest.mark.asyncio +async def test_immediate_success_requires_no_polling() -> None: + """Return an immediate successful response without issuing a poll request.""" + http_client = MagicMock() + http_client.send = AsyncMock() + client = MagicMock() + client._connection_runtime_url = "https://runtime.example/connections/1" + poller = AsyncLROPoller( + client, + create_response(200, text='{"status": "done"}'), + lambda response: response.text, + ConnectorPollingMethod(http_client, "Location"), + ) + + assert await poller.result() == '{"status": "done"}' + http_client.send.assert_not_awaited() + + +def test_missing_location_rejects_accepted_response() -> None: + """Reject an accepted response that cannot identify a polling URL.""" + client = MagicMock() + client._connection_runtime_url = "https://runtime.example/connections/1" + + with pytest.raises(ValueError, match="Location"): + AsyncLROPoller( + client, + create_response(202), + lambda response: response.text, + ConnectorPollingMethod(MagicMock(), "Location"), + ) + + +@pytest.mark.asyncio +async def test_terminal_error_raises_connector_exception() -> None: + """Raise a connector exception for a failed terminal polling response.""" + http_client = MagicMock() + http_client.send = AsyncMock(return_value=create_response(500, text="failed")) + client = MagicMock() + client._connection_runtime_url = "https://runtime.example/connections/1" + + with patch( + "azure.connectors.sdk.polling.asyncio.sleep", new_callable=AsyncMock, + ): + poller = AsyncLROPoller( + client, + create_response(202, {"Location": "/jobs/42", "Retry-After": "0"}), + lambda response: response.text, + ConnectorPollingMethod(http_client, "Location"), + ) + with pytest.raises(ConnectorException): + await poller.result() + + assert poller.status() == "Failed" + + +def test_resource_rejects_access_before_completion() -> None: + """Reject terminal resource access while polling remains in progress.""" + client = MagicMock() + client._connection_runtime_url = "https://runtime.example/connections/1" + polling_method = ConnectorPollingMethod(MagicMock(), "Location") + polling_method.initialize( + client, + create_response(202, {"Location": "/jobs/42"}), + lambda response: response.text, + ) + + with pytest.raises(RuntimeError, match="has not completed"): + polling_method.resource() + + +def test_continuation_tokens_are_explicitly_unsupported() -> None: + """Defer poller serialization to a later protocol phase.""" + polling_method = ConnectorPollingMethod(MagicMock(), "Location") + + with pytest.raises(TypeError, match="doesn't support"): + polling_method.get_continuation_token() + + +def test_retry_after_supports_http_dates_and_defaults() -> None: + """Parse HTTP-date delays and use the bounded default for malformed values.""" + retry_at = datetime.now(timezone.utc) + timedelta(seconds=60) + + delay = get_retry_after_seconds( + create_response(202, {"Retry-After": format_datetime(retry_at)}) + ) + + assert 55.0 <= delay <= 60.0 + assert get_retry_after_seconds(create_response(202)) == 1.0 + assert get_retry_after_seconds( + create_response(202, {"Retry-After": "invalid"}) + ) == 1.0 + + +@pytest.mark.parametrize("retry_after", ["Infinity", "-Infinity", "NaN", "1e309"]) +def test_retry_after_defaults_for_non_finite_numbers(retry_after: str) -> None: + """Use the finite default when Retry-After cannot represent a sleep delay.""" + assert get_retry_after_seconds( + create_response(202, {"Retry-After": retry_after}) + ) == 1.0 + + +def test_foreign_polling_url_is_rebased_without_forwarding_its_origin() -> None: + """Preserve backend path and query while using the authenticated runtime.""" + resolved = resolve_polling_url( + "https://backend.example/jobs/42?state=running", + "https://runtime.example/connections/1", + ) + + assert resolved == ( + "https://runtime.example/connections/1/jobs/42?state=running" + ) + + +def test_same_host_polling_url_rejects_scheme_or_port_changes() -> None: + """Reject an origin that resembles the runtime but changes its security boundary.""" + with pytest.raises(ValueError, match="scheme and port"): + resolve_polling_url( + "http://runtime.example/jobs/42", + "https://runtime.example/connections/1", + ) + + +def test_polling_method_rejects_unsupported_header_protocol() -> None: + """Reject status-document protocols outside the current Location contract.""" + with pytest.raises(ValueError, match="Only the 'Location'"): + ConnectorPollingMethod(MagicMock(), "Azure-AsyncOperation") diff --git a/tests/test_sdk_polling_initial_location.py b/tests/test_sdk_polling_initial_location.py new file mode 100644 index 00000000..1b6808b4 --- /dev/null +++ b/tests/test_sdk_polling_initial_location.py @@ -0,0 +1,220 @@ +# ------------------------------------------------------------ +# Copyright (c) Microsoft Corporation. All rights reserved. +# ------------------------------------------------------------ + +"""Regression coverage for initiating and subsequent relative LRO Locations.""" + +from __future__ import annotations + +from types import SimpleNamespace +from unittest.mock import AsyncMock, MagicMock, patch +from urllib.parse import urljoin, urlsplit + +import pytest +from azure.core.credentials import AzureKeyCredential +from azure.core.polling import AsyncLROPoller +from requests import Request + +from azure.connectors.kusto import KustoClient as AsyncKustoClient +from azure.connectors.sdk._polling import resolve_polling_url +from azure.connectors.sdk.polling import ( + ConnectorPollingMethod as AsyncConnectorPollingMethod, +) +from azure.connectors.sdk.response import ConnectorResponseSnapshot + +RUNTIME_URL = "https://runtime.example/connections/1" +REQUEST_URL = f"{RUNTIME_URL}/ListKustoResults/false" +LOCATION_CASES = [ + ("43", f"{RUNTIME_URL}/ListKustoResults/43"), + ("../43", f"{RUNTIME_URL}/43"), + ("?step=1", f"{REQUEST_URL}?step=1"), + ("/jobs/43", f"{RUNTIME_URL}/jobs/43"), + ("https://backend.example/jobs/43", f"{RUNTIME_URL}/jobs/43"), + ( + "https://runtime.example/jobs/43", + "https://runtime.example/jobs/43", + ), +] +UNSAFE_LOCATIONS = [ + "https://evil.invalid\\@runtime.example/jobs", + "https://runtime.example\\@evil.invalid/jobs", + "https://user@runtime.example/jobs", + "https://user:password@backend.example/jobs", + "https://runtime.example%2f.evil.invalid/jobs", + "https://runtime.example:/jobs", + "https://[::1]runtime.example/jobs", + "https:/runtime.example/jobs", + "//evil.invalid/jobs", + "///evil.invalid/jobs", + "\\\\evil.invalid/jobs", + "https://runtime.example\t.evil.invalid/jobs", + "\nhttps://runtime.example/jobs", + "https://runtime.example/jobs\r\nignored", + "https://runtime.example/jobs\x00", + "https://runtime.example/jobs\x7f", + " https://runtime.example/jobs", + "../jobs\\@evil.invalid", + "?state=running\n", +] + + +def assert_prepared_runtime_origin(url: str) -> None: + """Check the credential-bearing URL after Requests transport normalization.""" + prepared = Request( + "GET", url, headers={"Authorization": "Bearer test-token"}, + ).prepare() + parsed = urlsplit(prepared.url) + assert (parsed.scheme, parsed.hostname, parsed.port or 443) == ( + "https", "runtime.example", 443, + ) + assert prepared.headers["Authorization"] == "Bearer test-token" + + +def response( + status: int, location: str | None = None, +) -> ConnectorResponseSnapshot: + """Create a zero-delay response for a polling sequence.""" + headers = {"Retry-After": "0"} + if location is not None: + headers["Location"] = location + return ConnectorResponseSnapshot(status, headers, '{}', b'{}') + + +@pytest.mark.asyncio +@pytest.mark.parametrize("initial_location,expected_url", LOCATION_CASES) +@pytest.mark.parametrize("subsequent_location", ["44", "../44", "?step=2"]) +async def test_aio_initial_and_subsequent_relative_locations( + initial_location: str, + expected_url: str, + subsequent_location: str, +) -> None: + """Use the initiating URI first and the actual polling URI thereafter.""" + http_client = SimpleNamespace(send=AsyncMock(side_effect=[ + response(202, subsequent_location), response(200), + ])) + poller = AsyncLROPoller( + SimpleNamespace(_connection_runtime_url=RUNTIME_URL), + response(202, initial_location), + lambda terminal: terminal.text, + AsyncConnectorPollingMethod( + http_client, "Location", request_url=REQUEST_URL, + ), + ) + with patch( + "azure.connectors.sdk.polling.asyncio.sleep", new_callable=AsyncMock, + ): + assert await poller.result() == '{}' + + assert [call.args[1] for call in http_client.send.await_args_list] == [ + expected_url, urljoin(expected_url, subsequent_location), + ] + for call in http_client.send.await_args_list: + assert_prepared_runtime_origin(call.args[1]) + + +@pytest.mark.parametrize("location", UNSAFE_LOCATIONS) +def test_polling_rejects_ambiguous_initial_authority_before_sending( + location: str, +) -> None: + """Reject malformed initial Locations before authentication.""" + http_client = SimpleNamespace(send=AsyncMock()) + method = AsyncConnectorPollingMethod( + http_client, "Location", request_url=REQUEST_URL, + ) + with pytest.raises(ValueError): + method.initialize( + SimpleNamespace(_connection_runtime_url=RUNTIME_URL), + response(202, location), + lambda terminal: terminal.text, + ) + http_client.send.assert_not_called() + + +@pytest.mark.asyncio +@pytest.mark.parametrize("location", UNSAFE_LOCATIONS) +async def test_aio_polling_rejects_ambiguous_subsequent_location( + location: str, +) -> None: + """Never issue a follow-up async request to an ambiguous Location.""" + http_client = SimpleNamespace(send=AsyncMock(return_value=response(202, location))) + method = AsyncConnectorPollingMethod( + http_client, "Location", request_url=REQUEST_URL, + ) + method.initialize( + SimpleNamespace(_connection_runtime_url=RUNTIME_URL), + response(202, "43"), + lambda terminal: terminal.text, + ) + with patch( + "azure.connectors.sdk.polling.asyncio.sleep", new_callable=AsyncMock, + ): + with pytest.raises(ValueError): + await method.run() + http_client.send.assert_awaited_once() + assert_prepared_runtime_origin(http_client.send.await_args.args[1]) + + +@pytest.mark.parametrize("location", ["43", "../43", "?step=1"]) +@pytest.mark.parametrize("unsafe_base", UNSAFE_LOCATIONS) +def test_relative_polling_rejects_ambiguous_request_base( + location: str, unsafe_base: str, +) -> None: + """Validate a relative initiating URI before urljoin can strip unsafe input.""" + with pytest.raises(ValueError): + resolve_polling_url(location, RUNTIME_URL, unsafe_base) + + +@pytest.mark.parametrize("unsafe_runtime", UNSAFE_LOCATIONS) +def test_polling_validates_runtime_before_rebasing(unsafe_runtime: str) -> None: + """Reject ambiguous configured authorities even for runtime-relative paths.""" + with pytest.raises(ValueError): + resolve_polling_url("/jobs/43", unsafe_runtime) + + +def test_same_origin_polling_reconstructs_trusted_runtime_authority() -> None: + """Do not forward the connector-provided authority spelling to Requests.""" + resolved = resolve_polling_url( + "https://RUNTIME.EXAMPLE:443/jobs/43?state=running", RUNTIME_URL, + ) + assert resolved == "https://runtime.example/jobs/43?state=running" + assert_prepared_runtime_origin(resolved) + + +@pytest.mark.parametrize("location", ["43", "../43", "?step=1"]) +@pytest.mark.parametrize( + "request_url", [ + "http://runtime.example/operation/false", + "https://runtime.example:444/operation/false", + ], +) +def test_relative_location_cannot_inherit_an_unsafe_origin( + location: str, request_url: str, +) -> None: + """Validate joined relative URLs through the existing origin checks.""" + with pytest.raises(ValueError, match="scheme and port"): + resolve_polling_url(location, RUNTIME_URL, request_url) + + +@pytest.mark.asyncio +@pytest.mark.parametrize("initial_location,expected_url", LOCATION_CASES[:2]) +async def test_aio_kusto_begin_carries_initiating_request_uri( + initial_location: str, expected_url: str, +) -> None: + """Catch missing request_url propagation in the generated asynchronous API.""" + client = AsyncKustoClient(RUNTIME_URL, AzureKeyCredential("test-key")) + client._http_client = MagicMock() + client.http_client.send = AsyncMock(side_effect=[ + response(202, initial_location), response(200), + ]) + client.http_client.close = AsyncMock() + async with client: + with patch( + "azure.connectors.sdk.polling.asyncio.sleep", + new_callable=AsyncMock, + ): + poller = await client.begin_list_kusto_results(input={}) + assert await poller.result() == {} + + assert [call.args[:2] for call in client.http_client.send.await_args_list] == [ + ("POST", REQUEST_URL), ("GET", expected_url), + ] diff --git a/tests/test_sdk_serialization.py b/tests/test_sdk_serialization.py index b8f84dd0..046a2a57 100644 --- a/tests/test_sdk_serialization.py +++ b/tests/test_sdk_serialization.py @@ -1,6 +1,8 @@ """Unit tests for SDK wire serialization module.""" +from collections import UserDict from dataclasses import dataclass, field +from types import MappingProxyType from azure.connectors.sdk.serialization import to_wire @@ -87,3 +89,20 @@ def test_dict_values_are_converted_and_none_omitted(self): result = to_wire({"a": Leaf(leaf_value="x"), "b": None, "c": 1}) assert result == {"a": {"leafValue": "x"}, "c": 1} + + def test_mapping_values_are_recursively_converted(self): + """Test arbitrary mappings recurse and omit None values.""" + payload = UserDict( + { + "nested": MappingProxyType( + { + "model": Leaf(leaf_value="deep"), + "omitted": None, + } + ) + } + ) + + result = to_wire(payload) + + assert result == {"nested": {"model": {"leafValue": "deep"}}} diff --git a/tests/test_seismicplanner.py b/tests/test_seismicplanner.py index 7836d719..259e4437 100644 --- a/tests/test_seismicplanner.py +++ b/tests/test_seismicplanner.py @@ -2,42 +2,45 @@ """Contract tests for SeismicplannerClient.""" -from typing import Any, Dict, Optional, get_type_hints +from typing import Any, Dict, Mapping, Optional, get_type_hints from unittest.mock import AsyncMock, patch import pytest import azure.connectors.seismicplanner as seismicplanner_module +from azure.connectors.seismicplanner import SeismicplannerClient from azure.connectors.seismicplanner import ( CustomPropertyDataDisplay, CustomPropertyValues, - SeismicplannerClient, ) from tests.conftest import MockResponse -from tests.generated_connector_test_utils import GeneratedConnectorContractTests +from tests.generated_connector_test_utils import ( + GeneratedConnectorContractTests, + resolve_generated_result, +) OPERATION_CONTRACTS = { - "get_comments": ("GET", False), + "list_comments": ("GET", False), "create_comment": ("POST", True), "get_comment": ("GET", False), "delete_comment": ("DELETE", False), "update_comment": ("PUT", True), - "get_projects": ("GET", False), + "list_projects": ("GET", False), "delete_projects": ("DELETE", False), "create_project": ("POST", True), "get_project": ("GET", False), "delete_project": ("DELETE", False), "update_project": ("PUT", True), - "get_requests": ("GET", False), + "list_requests": ("GET", False), "delete_requests": ("DELETE", True), "create_request": ("POST", True), "get_request": ("GET", False), "delete_request": ("DELETE", False), "update_request": ("PUT", True), - "get_status_schemas": ("GET", False), + "list_status_schemas": ("GET", False), "get_status_schema": ("GET", False), - "get_tasks": ("GET", False), + "list_tasks": ("GET", False), "create_task": ("POST", True), "get_task": ("GET", False), "delete_task": ("DELETE", False), @@ -73,11 +76,13 @@ async def test_get_requests_encodes_csv_and_compatibility_values( ) as client: with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"value": []}'), ) as transport: - await client.get_requests_async(space_id="space-id", ids=identifiers) + await resolve_generated_result( + client.list_requests(space_id="space-id", ids=identifiers) + ) transport.assert_awaited_once() method, request_url = transport.await_args.args @@ -96,7 +101,7 @@ def test_localizations_use_typed_map_values(self) -> None: ) assert type_hints["localizations"] == Optional[ - Dict[str, CustomPropertyDataDisplay] + Dict[str, CustomPropertyDataDisplay | Mapping[str, Any]] ] assert model.localizations is not None assert model.localizations["en-US"].name == "English" diff --git a/tests/test_sendgrid.py b/tests/test_sendgrid.py index 5b236cc7..38b15004 100644 --- a/tests/test_sendgrid.py +++ b/tests/test_sendgrid.py @@ -7,15 +7,16 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.sendgrid import SendgridClient from azure.connectors.sendgrid import ( AddGlobalSuppressRequestAndResponse, EmailRequest, - SendgridClient, ) from azure.connectors.sdk import ( ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import model_instance, resolve_generated_result class TestSendgridClientInitialization: @@ -51,7 +52,7 @@ def test_init_with_custom_settings(self, mock_credential): client = SendgridClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -114,23 +115,30 @@ async def test_add_global_suppression_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"recipient_emails": []}') + mock_response = MockResponse( + status=200, + text='{"recipient_emails": ["a@b.com"]}', + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.add_global_suppression_async( - input=AddGlobalSuppressRequestAndResponse(recipient_emails=["a@b.com"]), + result = await resolve_generated_result( + client.add_global_suppression( + input=AddGlobalSuppressRequestAndResponse( + recipient_emails=["a@b.com"] + ), + ) ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "POST" assert url.endswith("/suppressions/global") assert mock_send.call_args.kwargs["body"] is not None - assert result == {"recipient_emails": []} + assert result == {"recipient_emails": ["a@b.com"]} @pytest.mark.asyncio async def test_get_global_suppression_success(self, mock_credential): @@ -143,11 +151,11 @@ async def test_get_global_suppression_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_global_suppression_async(email="a@b.com") + result = await client.get_global_suppression(email="a@b.com") method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -165,11 +173,11 @@ async def test_delete_global_suppression_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_global_suppression_async(email="a@b.com") + result = await client.delete_global_suppression(email="a@b.com") method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "DELETE" @@ -187,11 +195,11 @@ async def test_add_recipient_to_list_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.add_recipient_to_list_async( + result = await client.add_recipient_to_list( list_id="L1", recipient_id="R1", ) @@ -208,20 +216,22 @@ async def test_get_bounce_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"email": "a@b.com"}') + mock_response = MockResponse(status=200, text='[{"email": "a@b.com"}]') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_bounce_async(email="a@b.com") + result = await resolve_generated_result( + client.list_bounce(email="a@b.com") + ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert url.endswith("/suppression/bounces/a%40b.com") - assert result == {"email": "a@b.com"} + assert result == [{"email": "a@b.com"}] @pytest.mark.asyncio async def test_delete_bounce_success(self, mock_credential): @@ -234,11 +244,11 @@ async def test_delete_bounce_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_bounce_async(email="a@b.com") + result = await client.delete_bounce(email="a@b.com") method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "DELETE" @@ -256,11 +266,11 @@ async def test_check_email_is_in_unsubscribes_list_success(self, mock_credential with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.check_email_is_in_unsubscribes_list_async(email="a@b.com") + result = await client.check_email_is_in_unsubscribes_list(email="a@b.com") method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -278,12 +288,17 @@ async def test_send_email_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.send_email_async( - input=EmailRequest(to="a@b.com", subject="Hi", text="Hello"), + result = await client.send_email( + input=model_instance( + EmailRequest, + to="a@b.com", + subject="Hi", + text="Hello", + ), ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -303,16 +318,16 @@ async def test_list_recipient_lists_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_recipient_lists_async() + result = await resolve_generated_result(client.list_recipient_lists()) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert url.endswith("/v3/contactdb/lists") - assert result == {"lists": []} + assert result == [] @pytest.mark.asyncio async def test_list_recipients_success(self, mock_credential): @@ -325,20 +340,20 @@ async def test_list_recipients_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_recipients_async() + result = await resolve_generated_result(client.list_recipients()) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert url.endswith("/v3/contactdb/recipients") - assert result == {"recipients": []} + assert result == [] @pytest.mark.asyncio - async def test_empty_response_body_returns_none(self, mock_credential): - """Test a 2xx response with no body returns None.""" + async def test_empty_response_body_returns_empty_page(self, mock_credential): + """Test a paged 2xx response with no body returns no items.""" client = SendgridClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -347,13 +362,13 @@ async def test_empty_response_body_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.list_recipients_async() + result = await resolve_generated_result(client.list_recipients()) - assert result is None + assert result == [] class TestSendgridClientErrorHandling: @@ -367,7 +382,7 @@ class TestSendgridClientErrorHandling: "get_global_suppression", "delete_global_suppression", "add_recipient_to_list", - "get_bounce", + "list_bounce", "delete_bounce", "check_email_is_in_unsubscribes_list", "send_email", @@ -385,35 +400,39 @@ async def test_error_response_raises_exception(self, mock_credential, operation) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: if operation == "add_global_suppression": - await client.add_global_suppression_async( - input=AddGlobalSuppressRequestAndResponse() + await resolve_generated_result( + client.add_global_suppression( + input=AddGlobalSuppressRequestAndResponse() + ) ) elif operation == "get_global_suppression": - await client.get_global_suppression_async(email="a@b.com") + await client.get_global_suppression(email="a@b.com") elif operation == "delete_global_suppression": - await client.delete_global_suppression_async(email="a@b.com") + await client.delete_global_suppression(email="a@b.com") elif operation == "add_recipient_to_list": - await client.add_recipient_to_list_async( + await client.add_recipient_to_list( list_id="L1", recipient_id="R1" ) - elif operation == "get_bounce": - await client.get_bounce_async(email="a@b.com") + elif operation == "list_bounce": + await resolve_generated_result( + client.list_bounce(email="a@b.com") + ) elif operation == "delete_bounce": - await client.delete_bounce_async(email="a@b.com") + await client.delete_bounce(email="a@b.com") elif operation == "check_email_is_in_unsubscribes_list": - await client.check_email_is_in_unsubscribes_list_async(email="a@b.com") + await client.check_email_is_in_unsubscribes_list(email="a@b.com") elif operation == "send_email": - await client.send_email_async(input=EmailRequest()) + await client.send_email(input=model_instance(EmailRequest)) elif operation == "list_recipient_lists": - await client.list_recipient_lists_async() + await resolve_generated_result(client.list_recipient_lists()) else: - await client.list_recipients_async() + await resolve_generated_result(client.list_recipients()) assert exc_info.value.status_code == 500 @@ -423,6 +442,8 @@ class TestSendgridTypeSerialization: def test_dataclass_defaults(self): """Test dataclasses default to None and reserved names are renamed.""" - assert EmailRequest().from_ is None - assert EmailRequest().subject is None + email_request = model_instance(EmailRequest) + + assert email_request.from_ == "value" + assert email_request.attachments is None assert AddGlobalSuppressRequestAndResponse().recipient_emails is None diff --git a/tests/test_servicebus.py b/tests/test_servicebus.py index 140d1e7b..d287e350 100644 --- a/tests/test_servicebus.py +++ b/tests/test_servicebus.py @@ -6,8 +6,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.servicebus import ServicebusClient from azure.connectors.servicebus import ( - ServicebusClient, ServiceBusMessage, SendMessagesInput, CreateTopicSubscriptionInput, @@ -17,16 +17,17 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result DISCOVERY_OPERATIONS = [ - ("get_entities", {}, "/entities"), - ("get_system_properties", {}, "/systemproperties"), - ("get_queues", {}, "/queues"), - ("get_session_options", {}, "/sessionoptions"), - ("get_topics", {}, "/topics"), + ("list_entities", {}, "/entities"), + ("list_system_properties", {}, "/systemproperties"), + ("list_queues", {}, "/queues"), + ("list_session_options", {}, "/sessionoptions"), + ("list_topics", {}, "/topics"), ( - "get_subscriptions", + "list_subscriptions", {"topic_name": "topic/one"}, "/topics/topic%252Fone/subscriptions", ), @@ -71,7 +72,7 @@ def test_init_with_custom_settings(self, mock_credential): client = ServicebusClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -137,10 +138,10 @@ async def test_send_message_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: message = ServiceBusMessage(content_data="Test message") - await client.send_message_async(input=message, entity_name="myqueue") + await client.send_message(input=message, entity_name="myqueue") mock_send.assert_called_once() call_args = mock_send.call_args @@ -157,10 +158,10 @@ async def test_send_message_with_system_properties(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: message = ServiceBusMessage(content_data="Test message") - await client.send_message_async( + await client.send_message( input=message, entity_name="myqueue", system_properties="true" @@ -183,10 +184,10 @@ async def test_send_messages_batch_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data: SendMessagesInput = [ServiceBusMessage(content_data="message")] - await client.send_messages_async(input=input_data, entity_name="myqueue") + await client.send_messages(input=input_data, entity_name="myqueue") mock_send.assert_called_once() call_args = mock_send.call_args @@ -203,11 +204,11 @@ async def test_send_messages_error_response(self, mock_credential): mock_response = MockResponse(400, '{"error": "Invalid batch format"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: input_data: SendMessagesInput = [] - await client.send_messages_async(input=input_data, entity_name="myqueue") + await client.send_messages(input=input_data, entity_name="myqueue") assert exc_info.value.status_code == 400 @@ -257,18 +258,19 @@ async def test_success_returns_json( "https://example.azure.com/connections/test", credential=mock_credential, ) + is_pageable = operation.startswith("list_") with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse( status=200, - text='{"value": ["item"]}', + text='["item"]' if is_pageable else '{"value": ["item"]}', ), ) as mock_send: - method = getattr(client, f"{operation}_async") - result = await method(**operation_args) + method = getattr(client, f"{operation}") + result = await resolve_generated_result(method(**operation_args)) mock_send.assert_called_once_with( "GET", @@ -279,7 +281,8 @@ async def test_success_returns_json( client_request_id=None, response_hook=None, ) - assert result == {"value": ["item"]} + expected_result = ["item"] if is_pageable else {"value": ["item"]} + assert result == expected_result @pytest.mark.asyncio @pytest.mark.parametrize( @@ -301,13 +304,13 @@ async def test_error_response_raises_exception( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=500, text="Server error"), ): - method = getattr(client, f"{operation}_async") + method = getattr(client, f"{operation}") with pytest.raises(ConnectorException) as exc_info: - await method(**operation_args) + await resolve_generated_result(method(**operation_args)) assert expected_path in exc_info.value.operation assert exc_info.value.status_code == 500 @@ -326,9 +329,9 @@ async def test_complete_message_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.complete_message_in_queue_async( + await client.complete_message_in_queue( queue_name="myqueue", lock_token="token-123" ) @@ -347,17 +350,17 @@ async def test_complete_message_error_response(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(404, '{"error": "Lock token expired"}') + mock_response = MockResponse(500, '{"error": "Server error"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.complete_message_in_queue_async( + await client.complete_message_in_queue( queue_name="myqueue", lock_token="expired-token" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestAbandonMessageInQueue: @@ -373,9 +376,9 @@ async def test_abandon_message_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.abandon_message_in_queue_async( + await client.abandon_message_in_queue( queue_name="myqueue", lock_token="token-123" ) @@ -395,10 +398,10 @@ async def test_abandon_message_error_response(self, mock_credential): mock_response = MockResponse(404, '{"error": "Lock token expired"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.abandon_message_in_queue_async( + await client.abandon_message_in_queue( queue_name="myqueue", lock_token="expired-token" ) @@ -419,9 +422,9 @@ async def test_defer_message_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.defer_message_in_queue_async( + await client.defer_message_in_queue( queue_name="myqueue", lock_token="token-123" ) @@ -440,10 +443,10 @@ async def test_defer_message_error_response(self, mock_credential): mock_response = MockResponse(404, '{"error": "Lock token expired"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.defer_message_in_queue_async( + await client.defer_message_in_queue( queue_name="myqueue", lock_token="expired-token" ) @@ -465,9 +468,9 @@ async def test_get_deferred_message_success(self, mock_credential): response_data = {"contentData": "Deferred message", "sequenceNumber": 42} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_deferred_message_from_queue_async( + result = await client.get_deferred_message_from_queue( queue_name="myqueue", sequence_number="42" ) @@ -487,10 +490,10 @@ async def test_get_deferred_message_error_response(self, mock_credential): mock_response = MockResponse(404, '{"error": "Message not found"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_deferred_message_from_queue_async( + await client.get_deferred_message_from_queue( queue_name="myqueue", sequence_number="999" ) @@ -511,9 +514,9 @@ async def test_dead_letter_message_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.dead_letter_message_in_queue_async( + await client.dead_letter_message_in_queue( queue_name="myqueue", lock_token="token-123", dead_letter_reason="Processing failed" @@ -534,10 +537,10 @@ async def test_dead_letter_error_response(self, mock_credential): mock_response = MockResponse(404, '{"error": "Lock token expired"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.dead_letter_message_in_queue_async( + await client.dead_letter_message_in_queue( queue_name="myqueue", lock_token="expired-token", dead_letter_reason="Failed" @@ -559,9 +562,9 @@ async def test_renew_lock_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.renew_lock_on_message_in_queue_async( + await client.renew_lock_on_message_in_queue( queue_name="myqueue", lock_token="token-123" ) @@ -584,9 +587,9 @@ async def test_close_session_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.close_session_in_queue_async( + await client.close_session_in_queue( queue_name="myqueue", session_id="session-123" ) @@ -604,17 +607,17 @@ async def test_close_session_error_response(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(404, '{"error": "Session not found"}') + mock_response = MockResponse(500, '{"error": "Server error"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.close_session_in_queue_async( + await client.close_session_in_queue( queue_name="myqueue", session_id="nonexistent" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestRenewLockOnSessionInQueue: @@ -630,9 +633,9 @@ async def test_renew_session_lock_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.renew_lock_on_session_in_queue_async( + await client.renew_lock_on_session_in_queue( queue_name="myqueue", session_id="session-123" ) @@ -651,10 +654,10 @@ async def test_renew_session_lock_error_response(self, mock_credential): mock_response = MockResponse(404, '{"error": "Session not found"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.renew_lock_on_session_in_queue_async( + await client.renew_lock_on_session_in_queue( queue_name="myqueue", session_id="nonexistent" ) @@ -675,9 +678,9 @@ async def test_complete_topic_message_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.complete_message_in_topic_async( + await client.complete_message_in_topic( topic_name="mytopic", subscription_name="mysub", lock_token="token-123" @@ -696,18 +699,18 @@ async def test_complete_topic_message_error_response(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(404, '{"error": "Lock token expired"}') + mock_response = MockResponse(500, '{"error": "Server error"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.complete_message_in_topic_async( + await client.complete_message_in_topic( topic_name="mytopic", subscription_name="mysub", lock_token="expired-token" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestAbandonMessageInTopic: @@ -723,9 +726,9 @@ async def test_abandon_topic_message_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.abandon_message_in_topic_async( + await client.abandon_message_in_topic( topic_name="mytopic", subscription_name="mysub", lock_token="token-123" @@ -745,10 +748,10 @@ async def test_abandon_topic_message_error_response(self, mock_credential): mock_response = MockResponse(404, '{"error": "Lock token expired"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.abandon_message_in_topic_async( + await client.abandon_message_in_topic( topic_name="mytopic", subscription_name="mysub", lock_token="expired-token" @@ -771,10 +774,10 @@ async def test_create_subscription_success(self, mock_credential): response_data = {"subscriptionName": "newsub"} mock_response = MockResponse(201, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = CreateTopicSubscriptionInput() - result = await client.create_topic_subscription_async( + result = await client.create_topic_subscription( input=input_data, topic_name="mytopic", subscription_name="newsub" @@ -795,11 +798,11 @@ async def test_create_subscription_error_response(self, mock_credential): mock_response = MockResponse(400, '{"error": "Invalid subscription name"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: input_data = CreateTopicSubscriptionInput() - await client.create_topic_subscription_async( + await client.create_topic_subscription( input=input_data, topic_name="mytopic", subscription_name="invalid" @@ -821,9 +824,9 @@ async def test_delete_subscription_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_topic_subscription_async( + await client.delete_topic_subscription( topic_name="mytopic", subscription_name="mysub" ) @@ -841,17 +844,17 @@ async def test_delete_subscription_error_response(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(404, '{"error": "Subscription not found"}') + mock_response = MockResponse(500, '{"error": "Server error"}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_topic_subscription_async( + await client.delete_topic_subscription( topic_name="mytopic", subscription_name="nonexistent" ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestDeadLetterMessageInTopic: @@ -867,9 +870,9 @@ async def test_dead_letter_topic_message_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.dead_letter_message_in_topic_async( + await client.dead_letter_message_in_topic( topic_name="mytopic", subscription_name="mysub", lock_token="token-123", @@ -893,9 +896,9 @@ async def test_close_topic_session_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.close_session_in_topic_async( + await client.close_session_in_topic( topic_name="mytopic", subscription_name="mysub", session_id="session-456" @@ -919,9 +922,9 @@ async def test_renew_topic_session_lock_success(self, mock_credential): mock_response = MockResponse(200) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.renew_lock_on_session_in_topic_async( + await client.renew_lock_on_session_in_topic( topic_name="mytopic", subscription_name="mysub", session_id="session-456" diff --git a/tests/test_sharepointonline.py b/tests/test_sharepointonline.py index 34dc175f..8ac1b32a 100644 --- a/tests/test_sharepointonline.py +++ b/tests/test_sharepointonline.py @@ -6,8 +6,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.sharepointonline import SharepointonlineClient from azure.connectors.sharepointonline import ( - SharepointonlineClient, PostItemInput, PatchItemInput, CreateApprovalRequestInput, @@ -26,7 +26,7 @@ ) from azure.connectors.sdk.serialization import to_wire from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import model_instance, resolve_generated_result class TestSharepointonlineClientInitialization: @@ -62,7 +62,7 @@ def test_init_with_custom_settings(self, mock_credential): client = SharepointonlineClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -136,18 +136,19 @@ async def test_success_with_json_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_all_tables_async("https://contoso.sharepoint.com/sites/site1") + result = await resolve_generated_result( + client.list_all_tables("https://contoso.sharepoint.com/sites/site1") + ) call_args = mock_send.call_args assert call_args[0][0] == "GET" assert "/datasets/" in call_args[0][1] assert "/alltables" in call_args[0][1] - assert "value" in result - assert len(result["value"]) == 2 + assert len(result) == 2 @pytest.mark.asyncio async def test_dataset_url_encoding(self, mock_credential): @@ -161,12 +162,14 @@ async def test_dataset_url_encoding(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_all_tables_async( - "https://contoso.sharepoint.com/sites/site with spaces" + await resolve_generated_result( + client.list_all_tables( + "https://contoso.sharepoint.com/sites/site with spaces" + ) ) call_args = mock_send.call_args @@ -175,8 +178,8 @@ async def test_dataset_url_encoding(self, mock_credential): assert "/datasets/" in path @pytest.mark.asyncio - async def test_empty_response_returns_none(self, mock_credential): - """Test that empty response returns None.""" + async def test_empty_response_returns_empty_page(self, mock_credential): + """Test that an empty paged response returns no items.""" client = SharepointonlineClient( "https://example.azure.com/connections/test", credential=mock_credential @@ -186,12 +189,14 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_all_tables_async("https://contoso.sharepoint.com/sites/site1") - assert result is None + result = await resolve_generated_result( + client.list_all_tables("https://contoso.sharepoint.com/sites/site1") + ) + assert result == [] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -208,12 +213,16 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_all_tables_async("https://contoso.sharepoint.com/sites/missing") + await resolve_generated_result( + client.list_all_tables( + "https://contoso.sharepoint.com/sites/missing" + ) + ) assert exc_info.value.status_code == 404 @@ -239,12 +248,12 @@ async def test_create_file_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = b"document content" - result = await client.create_file_async( + result = await client.create_file( input_data, "https://contoso.sharepoint.com/sites/site1", "/Shared Documents", @@ -271,11 +280,11 @@ async def test_get_file_metadata(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_file_metadata_async( + result = await client.get_file_metadata( "https://contoso.sharepoint.com/sites/site1", "file123" ) @@ -299,12 +308,12 @@ async def test_update_file(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = b"updated document content" - result = await client.update_file_async( + result = await client.update_file( "https://contoso.sharepoint.com/sites/site1", "file123", input_data @@ -326,11 +335,11 @@ async def test_delete_file(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.delete_file_async( + result = await client.delete_file( "https://contoso.sharepoint.com/sites/site1", "file123" ) @@ -355,11 +364,11 @@ async def test_get_file_content(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_file_content_async( + result = await client.get_file_content( "https://contoso.sharepoint.com/sites/site1", "file123" ) @@ -381,12 +390,12 @@ async def test_create_file_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_file_async( + await client.create_file( b"document content", "https://contoso.sharepoint.com/sites/site1", "/Shared Documents", @@ -410,12 +419,12 @@ async def test_get_file_metadata_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_file_metadata_async( + await client.get_file_metadata( "https://contoso.sharepoint.com/sites/site1", "missing_file" ) @@ -437,12 +446,12 @@ async def test_delete_file_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_file_async( + await client.delete_file( "https://contoso.sharepoint.com/sites/site1", "protected_file" ) @@ -468,15 +477,15 @@ async def test_create_new_folder(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.create_new_folder_async( + result = await client.create_new_folder( "https://contoso.sharepoint.com/sites/site1", "Documents", "/Shared Documents", - "NewFolder" + view="NewFolder" ) assert result["Name"] == "NewFolder" @@ -496,11 +505,11 @@ async def test_get_folder_metadata(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_folder_metadata_async( + result = await client.get_folder_metadata( "https://contoso.sharepoint.com/sites/site1", "folder123" ) @@ -522,16 +531,16 @@ async def test_create_folder_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_new_folder_async( + await client.create_new_folder( "https://contoso.sharepoint.com/sites/site1", "Documents", "/Shared Documents", - "ExistingFolder" + view="ExistingFolder" ) assert exc_info.value.status_code == 409 @@ -551,12 +560,12 @@ async def test_get_folder_metadata_error_raises_exception(self, mock_credential) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_folder_metadata_async( + await client.get_folder_metadata( "https://contoso.sharepoint.com/sites/site1", "missing_folder" ) @@ -582,11 +591,11 @@ async def test_get_items(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await resolve_generated_result(client.get_items_async( + result = await resolve_generated_result(client.list_items( "https://contoso.sharepoint.com/sites/site1", "CustomList" )) @@ -609,12 +618,12 @@ async def test_post_item(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = PostItemInput() - result = await client.post_item_async( + result = await client.post_item( "https://contoso.sharepoint.com/sites/site1", "CustomList", input_data @@ -639,11 +648,11 @@ async def test_get_item(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_item_async( + result = await client.get_item( "https://contoso.sharepoint.com/sites/site1", "CustomList", 1 @@ -667,12 +676,12 @@ async def test_patch_item(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = PatchItemInput() - result = await client.patch_item_async( + result = await client.patch_item( "https://contoso.sharepoint.com/sites/site1", "CustomList", 1, @@ -695,11 +704,11 @@ async def test_delete_item(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.delete_item_async( + result = await client.delete_item( "https://contoso.sharepoint.com/sites/site1", "CustomList", 1 @@ -724,12 +733,12 @@ async def test_get_items_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.get_items_async( + await resolve_generated_result(client.list_items( "https://contoso.sharepoint.com/sites/site1", "MissingList" )) @@ -751,12 +760,12 @@ async def test_post_item_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.post_item_async( + await client.post_item( "https://contoso.sharepoint.com/sites/site1", "CustomList", PostItemInput() @@ -779,12 +788,12 @@ async def test_delete_item_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_item_async( + await client.delete_item( "https://contoso.sharepoint.com/sites/site1", "CustomList", 999 @@ -811,12 +820,12 @@ async def test_create_sharing_link(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - input_data = ItemPermissionCreateLinkBody() - result = await client.create_sharing_link_async( + input_data = model_instance(ItemPermissionCreateLinkBody) + result = await client.create_sharing_link( input_data, "https://contoso.sharepoint.com/sites/site1", "Documents", @@ -837,13 +846,13 @@ async def test_grant_access(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: from azure.connectors.sharepointonline import ItemGrantAccessBody - input_data = ItemGrantAccessBody() - result = await client.grant_access_async( + input_data = model_instance(ItemGrantAccessBody) + result = await client.grant_access( input_data, "https://contoso.sharepoint.com/sites/site1", "Documents", @@ -869,13 +878,13 @@ async def test_create_sharing_link_error_raises_exception(self, mock_credential) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_sharing_link_async( - ItemPermissionCreateLinkBody(), + await client.create_sharing_link( + model_instance(ItemPermissionCreateLinkBody), "https://contoso.sharepoint.com/sites/site1", "Documents", "item123" @@ -898,13 +907,13 @@ async def test_grant_access_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.grant_access_async( - ItemGrantAccessBody(), + await client.grant_access( + model_instance(ItemGrantAccessBody), "https://contoso.sharepoint.com/sites/site1", "Documents", "item123" @@ -931,11 +940,11 @@ async def test_copy_file(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.copy_file_async( + result = await client.copy_file( dataset="https://contoso.sharepoint.com/sites/site1", source="/Shared Documents/document.docx", destination="/Shared Documents/Backup/document_copy.docx" @@ -955,16 +964,19 @@ async def test_copy_file_async_route_is_preserved(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential ) - input_data = CopyFileParameters(source_file_id="file123") + input_data = model_instance( + CopyFileParameters, + source_file_id="file123", + ) mock_response = MockResponse(status=200, text='{"Name": "copy.docx"}') with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.copy_file_2_async( + result = await client.copy_file_2( input=input_data, dataset="https://contoso.sharepoint.com/sites/site1" ) @@ -1000,7 +1012,10 @@ async def test_copy_file_async_error_raises_exception( "https://example.azure.com/connections/test", credential=mock_credential ) - input_data = CopyFileParameters(source_file_id="file123") + input_data = model_instance( + CopyFileParameters, + source_file_id="file123", + ) mock_response = MockResponse( status=409, text='{"error": "Destination already exists"}' @@ -1008,12 +1023,12 @@ async def test_copy_file_async_error_raises_exception( with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.copy_file_2_async( + await client.copy_file_2( input=input_data, dataset="https://contoso.sharepoint.com/sites/site1" ) @@ -1035,13 +1050,13 @@ async def test_move_file(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): from azure.connectors.sharepointonline import MoveFileParameters - input_data = MoveFileParameters() - result = await client.move_file_async( + input_data = model_instance(MoveFileParameters) + result = await client.move_file( input_data, "https://contoso.sharepoint.com/sites/site1" ) @@ -1060,12 +1075,12 @@ async def test_copy_folder(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - input_data = CopyFolderParameters() - result = await client.copy_folder_async( + input_data = model_instance(CopyFolderParameters) + result = await client.copy_folder( input_data, "https://contoso.sharepoint.com/sites/site1" ) @@ -1087,12 +1102,12 @@ async def test_copy_file_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.copy_file_async( + await client.copy_file( dataset="https://contoso.sharepoint.com/sites/site1", source="/Shared Documents/missing.docx", destination="/Backup/missing.docx" @@ -1115,13 +1130,13 @@ async def test_move_file_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.move_file_async( - MoveFileParameters(), + await client.move_file( + model_instance(MoveFileParameters), "https://contoso.sharepoint.com/sites/site1" ) @@ -1146,12 +1161,12 @@ async def test_create_approval_request(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): input_data = CreateApprovalRequestInput() - result = await client.create_approval_request_async( + result = await client.create_approval_request( input_data, "https://contoso.sharepoint.com/sites/site1", "Documents", @@ -1173,11 +1188,11 @@ async def test_set_approval_status(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.set_approval_status_async( + result = await client.set_approval_status( "https://contoso.sharepoint.com/sites/site1", "Documents", "item123", @@ -1201,12 +1216,12 @@ async def test_create_approval_request_error_raises_exception(self, mock_credent with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_approval_request_async( + await client.create_approval_request( CreateApprovalRequestInput(), "https://contoso.sharepoint.com/sites/site1", "Documents", @@ -1231,12 +1246,12 @@ async def test_set_approval_status_error_raises_exception(self, mock_credential) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.set_approval_status_async( + await client.set_approval_status( "https://contoso.sharepoint.com/sites/site1", "Documents", "missing_item", @@ -1271,21 +1286,27 @@ async def test_multiple_consecutive_calls(self, mock_credential): credential=mock_credential ) - mock_response_1 = MockResponse(status=200, text='{"result": "first"}') - mock_response_2 = MockResponse(status=200, text='{"result": "second"}') + mock_response_1 = MockResponse( + status=200, + text='{"value": [{"result": "first"}]}', + ) + mock_response_2 = MockResponse( + status=200, + text='{"value": [{"result": "second"}]}', + ) with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, side_effect=[mock_response_1, mock_response_2] ): site_url = "https://contoso.sharepoint.com/sites/site1" - result_1 = await client.get_all_tables_async(site_url) - result_2 = await client.get_all_tables_async(site_url) + result_1 = await resolve_generated_result(client.list_all_tables(site_url)) + result_2 = await resolve_generated_result(client.list_all_tables(site_url)) - assert result_1 == {"result": "first"} - assert result_2 == {"result": "second"} + assert result_1 == [{"result": "first"}] + assert result_2 == [{"result": "second"}] @pytest.mark.asyncio async def test_json_parse_error_raises_exception(self, mock_credential): @@ -1299,12 +1320,16 @@ async def test_json_parse_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(json.JSONDecodeError): - await client.get_all_tables_async("https://contoso.sharepoint.com/sites/site1") + await resolve_generated_result( + client.list_all_tables( + "https://contoso.sharepoint.com/sites/site1" + ) + ) @pytest.mark.asyncio async def test_url_construction_with_multiple_trailing_slashes(self): @@ -1338,12 +1363,14 @@ async def test_dataset_with_special_characters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_all_tables_async( - "https://contoso.sharepoint.com/sites/site-name/subsite" + await resolve_generated_result( + client.list_all_tables( + "https://contoso.sharepoint.com/sites/site-name/subsite" + ) ) # Verify the call was made (URL encoding handled internally) @@ -1364,12 +1391,16 @@ async def test_server_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_all_tables_async("https://contoso.sharepoint.com/sites/site1") + await resolve_generated_result( + client.list_all_tables( + "https://contoso.sharepoint.com/sites/site1" + ) + ) assert exc_info.value.status_code == 500 @@ -1389,11 +1420,11 @@ async def test_check_out_file(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.check_out_file_async( + await client.check_out_file( "https://contoso.sharepoint.com/sites/site1", "Documents", "file123" @@ -1415,12 +1446,12 @@ async def test_check_in_file(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - input_data = FileCheckInParameters() - await client.check_in_file_async( + input_data = model_instance(FileCheckInParameters) + await client.check_in_file( input_data, "https://contoso.sharepoint.com/sites/site1", "Documents", @@ -1443,11 +1474,11 @@ async def test_discard_check_out(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.discard_file_check_out_async( + await client.discard_file_check_out( "https://contoso.sharepoint.com/sites/site1", "Documents", "file123" @@ -1472,12 +1503,12 @@ async def test_check_out_file_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.check_out_file_async( + await client.check_out_file( "https://contoso.sharepoint.com/sites/site1", "Documents", "locked_file" @@ -1504,14 +1535,16 @@ async def test_get_item_attachments(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_item_attachments_async( - "https://contoso.sharepoint.com/sites/site1", - "CustomList", - "1" + result = await resolve_generated_result( + client.list_item_attachments( + "https://contoso.sharepoint.com/sites/site1", + "CustomList", + "1" + ) ) assert isinstance(result, list) @@ -1531,12 +1564,12 @@ async def test_create_attachment(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = b"attachment content" - result = await client.create_attachment_async( + result = await client.create_attachment( input_data, "https://contoso.sharepoint.com/sites/site1", "CustomList", @@ -1562,11 +1595,11 @@ async def test_delete_attachment(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.delete_attachment_async( + await client.delete_attachment( "https://contoso.sharepoint.com/sites/site1", "CustomList", "1", @@ -1592,11 +1625,11 @@ async def test_get_attachment_content(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_attachment_content_async( + result = await client.get_attachment_content( "https://contoso.sharepoint.com/sites/site1", "CustomList", "1", @@ -1620,12 +1653,12 @@ async def test_create_attachment_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_attachment_async( + await client.create_attachment( b"attachment content", "https://contoso.sharepoint.com/sites/site1", "CustomList", @@ -1654,11 +1687,11 @@ async def test_search_for_user(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.search_for_user_async( + result = await client.search_for_user( "https://contoso.sharepoint.com/sites/site1", "CustomList", "entity1", @@ -1682,12 +1715,12 @@ async def test_search_for_user_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.search_for_user_async( + await client.search_for_user( "https://contoso.sharepoint.com/sites/site1", "CustomList", "entity1", @@ -1715,11 +1748,11 @@ async def test_get_file_item(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_file_item_async( + result = await client.get_file_item( "https://contoso.sharepoint.com/sites/site1", "Documents", "file123" @@ -1742,12 +1775,12 @@ async def test_patch_file_item(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = PatchFileItemInput() - result = await client.patch_file_item_async( + result = await client.patch_file_item( input_data, "https://contoso.sharepoint.com/sites/site1", "Documents", @@ -1770,11 +1803,11 @@ async def test_unshare_item(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.unshare_item_async( + await client.unshare_item( "https://contoso.sharepoint.com/sites/site1", "Documents", "item123" @@ -1799,12 +1832,12 @@ async def test_get_file_item_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_file_item_async( + await client.get_file_item( "https://contoso.sharepoint.com/sites/site1", "Documents", "missing_file" @@ -1831,12 +1864,12 @@ async def test_move_folder(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - input_data = MoveFolderParameters() - result = await client.move_folder_async( + input_data = model_instance(MoveFolderParameters) + result = await client.move_folder( input_data, "https://contoso.sharepoint.com/sites/site1" ) @@ -1858,13 +1891,13 @@ async def test_move_folder_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.move_folder_async( - MoveFolderParameters(), + await client.move_folder( + model_instance(MoveFolderParameters), "https://contoso.sharepoint.com/sites/site1" ) @@ -1887,7 +1920,7 @@ class TestGeneratedContractSurface: def test_day_of_week_discovery_is_generated(self): """Test day-of-week option discovery is callable.""" - assert hasattr(SharepointonlineClient, "get_day_of_week_options_async") + assert hasattr(SharepointonlineClient, "get_day_of_week_options") class TestByPathOperations: @@ -1909,11 +1942,11 @@ async def test_get_file_metadata_by_path(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_file_metadata_by_path_async( + result = await client.get_file_metadata_by_path( "https://contoso.sharepoint.com/sites/site1", "/Shared Documents/document.docx" ) @@ -1936,11 +1969,11 @@ async def test_get_file_content_by_path(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_file_content_by_path_async( + result = await client.get_file_content_by_path( "https://contoso.sharepoint.com/sites/site1", "/Shared Documents/document.docx" ) @@ -1962,11 +1995,11 @@ async def test_get_folder_metadata_by_path(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_folder_metadata_by_path_async( + result = await client.get_folder_metadata_by_path( "https://contoso.sharepoint.com/sites/site1", "/Shared Documents" ) @@ -1988,12 +2021,12 @@ async def test_get_file_metadata_by_path_error_raises_exception(self, mock_crede with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_file_metadata_by_path_async( + await client.get_file_metadata_by_path( "https://contoso.sharepoint.com/sites/site1", "/Shared Documents/missing.docx" ) diff --git a/tests/test_shifts.py b/tests/test_shifts.py index bfdc928d..f5d61f41 100644 --- a/tests/test_shifts.py +++ b/tests/test_shifts.py @@ -7,9 +7,9 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.shifts import ShiftsClient from azure.connectors.shifts import ( TRIGGER_OPERATIONS, - ShiftsClient, CreateShiftRequest, EditOpenShiftRequest, WebhookPushResponseResourceEntity, @@ -19,7 +19,7 @@ ) from azure.connectors.sdk.serialization import to_wire from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import model_instance, resolve_generated_result class TestShiftsClientInitialization: @@ -55,7 +55,7 @@ def test_init_with_custom_settings(self, mock_credential): client = ShiftsClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -139,18 +139,17 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_all_teams_async() + result = await resolve_generated_result(client.list_all_teams()) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert "/v1.0/me/joinedTeams" in path - assert result is not None - assert "value" in result + assert result == [{"id": "team-1", "displayName": "Store Team"}] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -163,12 +162,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.get_all_teams_async() + await resolve_generated_result(client.list_all_teams()) class TestGetScheduleAsync: @@ -185,11 +184,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_schedule_async(team_id="team-123") + result = await client.get_schedule(team_id="team-123") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -209,12 +208,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.get_schedule_async(team_id="missing-team") + await client.get_schedule(team_id="missing-team") class TestListShiftsAsync: @@ -231,11 +230,11 @@ async def test_success_with_query_params(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await resolve_generated_result(client.list_shifts_async( + result = await resolve_generated_result(client.list_shifts( team_id="team-123", start_time="2026-07-01T00:00:00Z", end_time="2026-07-31T00:00:00Z", @@ -262,12 +261,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await resolve_generated_result(client.list_shifts_async(team_id="team-123")) + await resolve_generated_result(client.list_shifts(team_id="team-123")) class TestCreateShiftAsync: @@ -280,16 +279,20 @@ async def test_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - payload = CreateShiftRequest(scheduling_group_id="group-1", user_id="user-1") + payload = model_instance( + CreateShiftRequest, + scheduling_group_id="group-1", + user_id="user-1", + ) mock_response = MockResponse(status=201, text='{"id": "shift-1"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_shift_async(input=payload, team_id="team-123") + result = await client.create_shift(input=payload, team_id="team-123") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -306,17 +309,21 @@ async def test_error_response_raises_exception(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - payload = CreateShiftRequest(scheduling_group_id="group-1", user_id="user-1") + payload = model_instance( + CreateShiftRequest, + scheduling_group_id="group-1", + user_id="user-1", + ) mock_response = MockResponse(status=400, text='{"error": "Bad request"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.create_shift_async(input=payload, team_id="team-123") + await client.create_shift(input=payload, team_id="team-123") class TestTriggerForShifts: @@ -346,11 +353,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.delete_time_off_async(team_id="team-1", time_off_id="toff-1") + await client.delete_time_off(team_id="team-1", time_off_id="toff-1") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -364,16 +371,16 @@ async def test_error_response_raises_exception(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=404, text='{"error": "Time off not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.delete_time_off_async(team_id="team-1", time_off_id="missing") + await client.delete_time_off(team_id="team-1", time_off_id="missing") class TestUpdateOpenShiftAsync: @@ -391,11 +398,11 @@ async def test_success_sends_body_and_returns_result(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.update_open_shift_async( + result = await client.update_open_shift( input=payload, team_id="team-1", open_shift_id="oshift-1", @@ -421,12 +428,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.update_open_shift_async( + await client.update_open_shift( input=payload, team_id="team-1", open_shift_id="oshift-1", diff --git a/tests/test_signinghub.py b/tests/test_signinghub.py index d6a884a3..1706e711 100644 --- a/tests/test_signinghub.py +++ b/tests/test_signinghub.py @@ -7,8 +7,8 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.signinghub import SigninghubClient from azure.connectors.signinghub import ( - SigninghubClient, CheckBoxFieldRequest, UploadDocument, UpdateCheckBoxFieldRequest, @@ -18,6 +18,8 @@ ) from azure.connectors.sdk.serialization import to_wire from tests.conftest import MockResponse +from tests.generated_connector_test_utils import model_instance +from tests.generated_connector_test_utils import resolve_generated_result class TestSigninghubClientInitialization: @@ -53,7 +55,7 @@ def test_init_with_custom_settings(self, mock_credential): client = SigninghubClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -99,7 +101,8 @@ class TestSigninghubModelSerialization: def test_upload_document_preserves_colliding_document_ids(self): """Test that all three document ID wire names survive serialization.""" - model = UploadDocument( + model = model_instance( + UploadDocument, document_id_2=101, documentid=102, document_id=103, @@ -127,11 +130,11 @@ async def test_forwards_exact_bytes_and_media_type(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.documents_upload_stream_async( + await client.documents_upload_stream( input=document, package_id="package-1", ) @@ -153,7 +156,7 @@ async def test_context_manager(self, mock_credential): class TestContactsGetAsync: - """Tests for contacts_get_async method (GET with query parameters).""" + """Tests for list_contacts_get method (GET with query parameters).""" @pytest.mark.asyncio async def test_success_serializes_path_and_query(self, mock_credential): @@ -166,15 +169,17 @@ async def test_success_serializes_path_and_query(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.contacts_get_async( - record_per_page="10", - page_no="1", - sort_by="name", - asc="true", + result = await resolve_generated_result( + client.list_contacts_get( + record_per_page="10", + page_no="1", + sort_by="name", + asc="true", + ) ) mock_send.assert_called_once() @@ -197,12 +202,14 @@ async def test_error_response_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.contacts_get_async(record_per_page="10", page_no="1") + await resolve_generated_result( + client.list_contacts_get(record_per_page="10", page_no="1") + ) assert exc_info.value.status_code == 404 @@ -217,16 +224,16 @@ async def test_success_forwards_request_body(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - request = CheckBoxFieldRequest() + request = model_instance(CheckBoxFieldRequest) mock_response = MockResponse(status=200, text='{"field_id": "cb-1"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.checkbox_add_check_box_async( + result = await client.checkbox_add_check_box( input=request, package_id="pkg-1", document_id="doc-1", @@ -250,13 +257,13 @@ async def test_error_response_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.checkbox_add_check_box_async( - input=CheckBoxFieldRequest(), + await client.checkbox_add_check_box( + input=model_instance(CheckBoxFieldRequest), package_id="pkg-1", document_id="doc-1", ) @@ -272,16 +279,16 @@ async def test_success_forwards_request_body(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - request = UpdateCheckBoxFieldRequest() + request = model_instance(UpdateCheckBoxFieldRequest) mock_response = MockResponse(status=200, text='{"field_id": "cb-1"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.checkbox_update_check_box_async( + result = await client.checkbox_update_check_box( input=request, package_id="pkg-1", document_id="doc-1", @@ -303,13 +310,13 @@ async def test_error_response_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.checkbox_update_check_box_async( - input=UpdateCheckBoxFieldRequest(), + await client.checkbox_update_check_box( + input=model_instance(UpdateCheckBoxFieldRequest), package_id="pkg-1", document_id="doc-1", ) @@ -329,11 +336,11 @@ async def test_success_completes_without_error(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.attachment_delete_attachment_async( + result = await client.attachment_delete_attachment( package_id="pkg-1", document_id="doc-1", attachment_id="att-1", @@ -349,7 +356,7 @@ async def test_success_completes_without_error(self, mock_credential): @pytest.mark.asyncio async def test_not_found_raises_connector_exception(self, mock_credential): - """Test that a 404 response raises ConnectorException.""" + """Test that an uncurated DELETE preserves a not-found response.""" client = SigninghubClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -358,18 +365,18 @@ async def test_not_found_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.attachment_delete_attachment_async( + await client.attachment_delete_attachment( package_id="pkg-1", document_id="doc-1", attachment_id="missing", ) - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 404 @pytest.mark.asyncio async def test_server_error_raises_connector_exception(self, mock_credential): @@ -382,12 +389,12 @@ async def test_server_error_raises_connector_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.attachment_delete_attachment_async( + await client.attachment_delete_attachment( package_id="pkg-1", document_id="doc-1", attachment_id="att-1", @@ -407,7 +414,10 @@ async def test_server_error_raises_connector_exception(self, mock_credential): "document_id": "doc-1", "attachment_id": "att-1", }, - "attachment_get_attachments": {"package_id": "package-1", "document_id": "doc-1"}, + "list_attachment_get_attachments": { + "package_id": "package-1", + "document_id": "doc-1", + }, "attachment_upload_attachment": { "input": b"raw-attachment-bytes", "package_id": "package-1", @@ -423,7 +433,7 @@ async def test_server_error_raises_connector_exception(self, mock_credential): "package_id": "package-1", "document_id": "doc-1", }, - "contacts_get": {"record_per_page": "10", "page_no": "1"}, + "list_contacts_get": {"record_per_page": "10", "page_no": "1"}, "documents_delete_document": {"package_id": "package-1", "document_id": "doc-1"}, "documents_download_document_bytes": { "package_id": "package-1", @@ -507,7 +517,7 @@ async def test_server_error_raises_connector_exception(self, mock_credential): "package_finish": {"package_id": "package-1"}, "package_gatekeeper_approve": {"input": {}, "package_id": "package-1"}, "package_gatekeeper_decline": {"input": {}, "package_id": "package-1"}, - "package_get_all_packages": { + "list_package_get_all_packages": { "document_status": "PENDING", "page_no": "1", "record_per_page": "10", @@ -535,7 +545,7 @@ async def test_server_error_raises_connector_exception(self, mock_credential): "package_id": "package-1", "document_id": "doc-1", }, - "settings_get_templates": {"record_per_page": "10", "page_no": "1"}, + "list_settings_get_templates": {"record_per_page": "10", "page_no": "1"}, "signature_add_signature": { "input": {}, "package_id": "package-1", @@ -556,7 +566,10 @@ async def test_server_error_raises_connector_exception(self, mock_credential): "package_id": "package-1", "document_id": "doc-1", }, - "template_get_enterprise_templates": {"record_per_page": "10", "page_no": "1"}, + "list_template_get_enterprise_templates": { + "record_per_page": "10", + "page_no": "1", + }, "text_box_add_text_box": { "input": {}, "package_id": "package-1", @@ -580,7 +593,7 @@ async def test_server_error_raises_connector_exception(self, mock_credential): "records_per_page": "10", }, "workflow_get_workflow_reminder": {"package_id": "package-1", "order": "1"}, - "workflow_get_workflow_users": {"package_id": "package-1"}, + "list_workflow_get_workflow_users": {"package_id": "package-1"}, "workflow_mark_workflow_completed": {"package_id": "package-1"}, "workflow_permission_get_workflow_permissions": { "package_id": "package-1", @@ -601,7 +614,10 @@ async def test_server_error_raises_connector_exception(self, mock_credential): "order": "1", }, "workflow_workflow_add_group": {"input": {}, "package_id": "package-1"}, - "workflow_workflow_add_placeholder": {"input": {}, "package_id": "package-1"}, + "workflow_workflow_add_placeholder": { + "input": {}, + "package_id": "package-1", + }, "workflow_workflow_add_user": {"input": {}, "package_id": "package-1"}, "workflow_workflow_delete_user": {"package_id": "package-1", "order": "1"}, "workflow_workflow_update_placeholder": { @@ -629,8 +645,8 @@ async def test_server_error_raises_connector_exception(self, mock_credential): async def _invoke_operation(client: SigninghubClient, operation: str): """Invoke a SigningHub operation by name for shared method tests.""" - method = getattr(client, f"{operation}_async") - return await method(**OPERATION_ARGS[operation]) + method = getattr(client, f"{operation}") + return await resolve_generated_result(method(**OPERATION_ARGS[operation])) class TestSigninghubClientAllOperations: @@ -645,7 +661,7 @@ async def test_all_operations_success(self, mock_credential, operation): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: @@ -671,7 +687,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): diff --git a/tests/test_slack.py b/tests/test_slack.py index 42cbd2b1..b7d1b5a5 100644 --- a/tests/test_slack.py +++ b/tests/test_slack.py @@ -11,7 +11,8 @@ from azure.connectors.sdk import ( ConnectorException, ) -from azure.connectors.slack import PostMessageRequest, SlackClient, TRIGGER_OPERATIONS +from azure.connectors.slack import SlackClient +from azure.connectors.slack import PostMessageRequest, TRIGGER_OPERATIONS from tests.conftest import MockResponse from tests.generated_connector_test_utils import resolve_generated_result @@ -49,7 +50,7 @@ def test_init_with_custom_settings(self, mock_credential): client = SlackClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -116,11 +117,11 @@ async def test_success_uses_acronym_aware_name(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.set_dnd_async(num_minutes="30") + result = await client.set_dnd(num_minutes="30") mock_send.assert_called_once_with( "GET", @@ -145,12 +146,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.set_dnd_async(num_minutes="invalid") + await client.set_dnd(num_minutes="invalid") class TestSlackContractSurface: @@ -171,7 +172,7 @@ def test_trigger_is_metadata_only(self): def test_deprecated_group_operation_is_not_generated(self): """Test the deprecated group operation is absent.""" - assert not hasattr(SlackClient, "create_group_async") + assert not hasattr(SlackClient, "create_group") class TestListChannelsAsync: @@ -191,11 +192,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await resolve_generated_result(client.list_channels_async()) + result = await resolve_generated_result(client.list_channels()) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -218,12 +219,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await resolve_generated_result(client.list_channels_async()) + await resolve_generated_result(client.list_channels()) class TestCreateChannelAsync: @@ -243,11 +244,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_channel_async(name="dev-chat", is_private="false") + result = await client.create_channel(name="dev-chat", is_private="false") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -272,12 +273,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.create_channel_async(name="") + await client.create_channel(name="") class TestPostMessageAsync: @@ -298,11 +299,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.post_message_async(input=payload) + result = await client.post_message(input=payload) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -328,12 +329,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.post_message_async(input=payload) + await client.post_message(input=payload) @pytest.mark.asyncio @@ -353,7 +354,7 @@ async def test_channels_continuation_yields_later_channels( ) as client: with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, side_effect=[ MockResponse(status=200, text=json.dumps({ @@ -367,7 +368,7 @@ async def test_channels_continuation_yields_later_channels( ], ) as transport: channels = [ - channel async for channel in client.list_channels_async() + channel async for channel in client.list_channels() ] assert channels == first_items + later_items diff --git a/tests/test_smtp.py b/tests/test_smtp.py index e4072394..f530a0ea 100644 --- a/tests/test_smtp.py +++ b/tests/test_smtp.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.smtp import SmtpClient from azure.connectors.smtp import ( - SmtpClient, Email, Attachment, ) @@ -15,6 +15,7 @@ ) from azure.connectors.sdk.serialization import to_wire from tests.conftest import MockResponse +from tests.generated_connector_test_utils import model_instance class TestSmtpClientInitialization: @@ -50,7 +51,7 @@ def test_init_with_custom_settings(self, mock_credential): client = SmtpClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -124,11 +125,11 @@ async def test_success_basic_email(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -155,11 +156,11 @@ async def test_success_with_multiple_recipients(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) mock_send.assert_called_once() call_args = mock_send.call_args @@ -197,11 +198,11 @@ async def test_success_with_all_fields(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) mock_send.assert_called_once() @@ -234,11 +235,11 @@ async def test_success_with_multiple_attachments(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) mock_send.assert_called_once() @@ -261,11 +262,11 @@ async def test_with_high_importance(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -285,12 +286,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) assert exc_info.value.status_code == 400 @@ -343,14 +344,14 @@ def test_current_email_model_uses_swagger_wire_names(self): from_="sender@contoso.com", to="recipient@contoso.com", c_c="copy@contoso.com", - attachments=[Attachment(content_data="filedata")], + attachments=[model_instance(Attachment, content_data="filedata")], ) assert to_wire(email) == { "From": "sender@contoso.com", "To": "recipient@contoso.com", "CC": "copy@contoso.com", - "Attachments": [{"ContentData": "filedata"}], + "Attachments": [{"ContentData": "filedata", "ContentType": "value"}], } def test_email_with_defaults(self): @@ -397,11 +398,11 @@ async def test_empty_body_email(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) @pytest.mark.asyncio async def test_html_body_email(self, mock_credential): @@ -421,11 +422,11 @@ async def test_html_body_email(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) @pytest.mark.asyncio async def test_multiple_consecutive_sends(self, mock_credential): @@ -439,7 +440,7 @@ async def test_multiple_consecutive_sends(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: @@ -449,7 +450,7 @@ async def test_multiple_consecutive_sends(self, mock_credential): subject="First Email", body="First message" ) - await client.send_email_async(input=email1) + await client.send_email(input=email1) email2 = Email( from_="sender@contoso.com", @@ -457,7 +458,7 @@ async def test_multiple_consecutive_sends(self, mock_credential): subject="Second Email", body="Second message" ) - await client.send_email_async(input=email2) + await client.send_email(input=email2) assert mock_send.call_count == 2 @@ -479,11 +480,11 @@ async def test_special_characters_in_subject(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) @pytest.mark.asyncio async def test_long_recipient_list(self, mock_credential): @@ -504,8 +505,8 @@ async def test_long_recipient_list(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - await client.send_email_async(input=email_input) + await client.send_email(input=email_input) diff --git a/tests/test_sql.py b/tests/test_sql.py index ab7e4491..15e15231 100644 --- a/tests/test_sql.py +++ b/tests/test_sql.py @@ -8,8 +8,8 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.sql import SqlClient from azure.connectors.sql import ( - SqlClient, DatabasesList, ExecuteProcedureInput, GetItemsResponse, @@ -30,40 +30,45 @@ ConnectorException, ) from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import ( + get_generated_operations, + resolve_generated_result, +) async def _invoke_operation(client: SqlClient, operation: str): """Invoke a SQL operation by name for shared method tests.""" if operation == "delete_item": - return await client.delete_item_async( + return await client.delete_item( server="srv", database="db", table="tbl", id="1" ) if operation == "execute_pass_through_native_query": - return await client.execute_pass_through_native_query_async( + return await client.execute_pass_through_native_query( input=SqlPassThroughNativeQueryBody(query="SELECT 1"), server="srv", database="db", ) if operation == "execute_procedure": - return await client.execute_procedure_async( + return await client.execute_procedure( input=ExecuteProcedureInput(), server="srv", database="db", procedure="proc", ) if operation == "get_item": - return await client.get_item_async( + return await client.get_item( server="srv", database="db", table="tbl", id="1" ) - if operation == "get_items": + if operation == "list_items": + return await resolve_generated_result( + client.list_items(server="srv", database="db", table="tbl") + ) + if operation == "list_tables": return await resolve_generated_result( - client.get_items_async(server="srv", database="db", table="tbl") + client.list_tables(server="srv", database="db") ) - if operation == "get_tables": - return await client.get_tables_async(server="srv", database="db") if operation == "patch_item": - return await client.patch_item_async( + return await client.patch_item( input=PatchItemInput(), server="srv", database="db", @@ -71,59 +76,61 @@ async def _invoke_operation(client: SqlClient, operation: str): id="1", ) if operation == "post_item": - return await client.post_item_async( + return await client.post_item( input=PostItemInput(), server="srv", database="db", table="tbl" ) - if operation == "get_servers": - return await client.get_servers_async() - if operation == "get_databases": - return await client.get_databases_async(server="srv") - if operation == "get_tables_for_delete_item": + if operation == "list_servers": + return await resolve_generated_result(client.list_servers()) + if operation == "list_databases": + return await resolve_generated_result(client.list_databases(server="srv")) + if operation == "list_tables_for_delete_item": return await resolve_generated_result( - client.get_tables_for_delete_item_async(server="srv", database="db") + client.list_tables_for_delete_item(server="srv", database="db") + ) + if operation == "list_procedures_v2": + return await resolve_generated_result( + client.list_procedures_v2(server="srv", database="db") ) - if operation == "get_procedures_v2": - return await client.get_procedures_v2_async(server="srv", database="db") if operation == "get_procedure_v2": - return await client.get_procedure_v2_async( + return await client.get_procedure_v2( server="srv", database="db", procedure="proc" ) - if operation == "get_tables_for_get_item": + if operation == "list_tables_for_get_item": return await resolve_generated_result( - client.get_tables_for_get_item_async(server="srv", database="db") + client.list_tables_for_get_item(server="srv", database="db") ) - if operation == "get_tables_for_get_on_new_items": - return await resolve_generated_result(client.get_tables_for_get_on_new_items_async( + if operation == "list_tables_for_get_on_new_items": + return await resolve_generated_result(client.list_tables_for_get_on_new_items( server="srv", database="db" )) - if operation == "get_tables_for_get_on_updated_items": - return await resolve_generated_result(client.get_tables_for_get_on_updated_items_async( + if operation == "list_tables_for_get_on_updated_items": + return await resolve_generated_result(client.list_tables_for_get_on_updated_items( server="srv", database="db" )) - if operation == "get_tables_for_patch_item": + if operation == "list_tables_for_patch_item": return await resolve_generated_result( - client.get_tables_for_patch_item_async(server="srv", database="db") + client.list_tables_for_patch_item(server="srv", database="db") ) if operation == "get_table_for_patch": - return await client.get_table_for_patch_async( + return await client.get_table_for_patch( server="srv", database="db", table="tbl" ) - if operation == "get_tables_for_post_item": + if operation == "list_tables_for_post_item": return await resolve_generated_result( - client.get_tables_for_post_item_async(server="srv", database="db") + client.list_tables_for_post_item(server="srv", database="db") ) if operation == "get_table": - return await client.get_table_async(server="srv", database="db", table="tbl") + return await client.get_table(server="srv", database="db", table="tbl") if operation == "get_pass_through_native_query_metadata": - return await client.get_pass_through_native_query_metadata_async( + return await client.get_pass_through_native_query_metadata( input=SqlPassThroughNativeQueryBody(query="SELECT 1"), server="srv", database="db", ) if operation == "get_procedure": - return await client.get_procedure_async(procedure="proc") - if operation == "get_procedures": - return await client.get_procedures_async() + return await client.get_procedure(procedure="proc") + if operation == "list_procedures": + return await resolve_generated_result(client.list_procedures()) raise ValueError(f"Unsupported operation '{operation}'.") @@ -133,25 +140,25 @@ async def _invoke_operation(client: SqlClient, operation: str): "execute_pass_through_native_query", "execute_procedure", "get_item", - "get_items", - "get_tables", + "list_items", + "list_tables", "patch_item", "post_item", - "get_servers", - "get_databases", - "get_tables_for_delete_item", - "get_procedures_v2", + "list_servers", + "list_databases", + "list_tables_for_delete_item", + "list_procedures_v2", "get_procedure_v2", - "get_tables_for_get_item", - "get_tables_for_get_on_new_items", - "get_tables_for_get_on_updated_items", - "get_tables_for_patch_item", + "list_tables_for_get_item", + "list_tables_for_get_on_new_items", + "list_tables_for_get_on_updated_items", + "list_tables_for_patch_item", "get_table_for_patch", - "get_tables_for_post_item", + "list_tables_for_post_item", "get_table", "get_pass_through_native_query_metadata", "get_procedure", - "get_procedures", + "list_procedures", ] @@ -188,7 +195,7 @@ def test_init_with_custom_settings(self, mock_credential): client = SqlClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -245,8 +252,8 @@ class TestSqlClientMethods: """Success path tests for representative SQL methods.""" @pytest.mark.asyncio - async def test_get_servers_success(self, mock_credential): - """Test get_servers_async returns parsed JSON and targets /servers.""" + async def test_list_servers_success(self, mock_credential): + """Test list_servers returns parsed items and targets /servers.""" client = SqlClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -255,18 +262,18 @@ async def test_get_servers_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_servers_async() + result = await resolve_generated_result(client.list_servers()) - assert result["value"][0]["name"] == "srv1" + assert result[0]["name"] == "srv1" assert mock_send.call_args[0][1].endswith("/servers") @pytest.mark.asyncio - async def test_get_databases_sends_server_query(self, mock_credential): - """Test get_databases_async appends the server query parameter.""" + async def test_list_databases_sends_server_query(self, mock_credential): + """Test list_databases appends the server query parameter.""" client = SqlClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -275,11 +282,11 @@ async def test_get_databases_sends_server_query(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.get_databases_async(server="srv1") + await resolve_generated_result(client.list_databases(server="srv1")) request_url = mock_send.call_args[0][1] assert "/databases" in request_url @@ -296,11 +303,11 @@ async def test_get_items_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await resolve_generated_result(client.get_items_async( + result = await resolve_generated_result(client.list_items( server="srv", database="db", table="tbl" )) @@ -318,11 +325,11 @@ async def test_get_items_appends_odata_query_params(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await resolve_generated_result(client.get_items_async( + await resolve_generated_result(client.list_items( server="srv", database="db", table="tbl", @@ -345,11 +352,11 @@ async def test_post_item_sends_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.post_item_async( + await client.post_item( input=PostItemInput(additional_properties={"Name": "Contoso"}), server="srv", database="db", @@ -372,11 +379,11 @@ async def test_patch_item_uses_patch_verb(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.patch_item_async( + await client.patch_item( input=body, server="srv", database="db", @@ -399,11 +406,11 @@ async def test_delete_item_uses_delete_verb(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_item_async( + result = await client.delete_item( server="srv", database="db", table="tbl", id="1" ) @@ -422,11 +429,11 @@ async def test_execute_procedure_sends_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.execute_procedure_async( + await client.execute_procedure( input=ExecuteProcedureInput(), server="srv", database="db", @@ -447,11 +454,11 @@ async def test_execute_pass_through_native_query_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.execute_pass_through_native_query_async( + await client.execute_pass_through_native_query( input=SqlPassThroughNativeQueryBody(query="SELECT 1"), server="srv", database="db", @@ -461,8 +468,8 @@ async def test_execute_pass_through_native_query_success(self, mock_credential): assert "/v2/datasets/srv,db/query/sql" in mock_send.call_args[0][1] @pytest.mark.asyncio - async def test_get_procedures_v2_success(self, mock_credential): - """Test get_procedures_v2_async targets the v2 procedures endpoint.""" + async def test_list_procedures_v2_success(self, mock_credential): + """Test list_procedures_v2 targets the v2 procedures endpoint.""" client = SqlClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -471,11 +478,13 @@ async def test_get_procedures_v2_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.get_procedures_v2_async(server="srv", database="db") + await resolve_generated_result( + client.list_procedures_v2(server="srv", database="db") + ) assert "/v2/datasets/srv,db/procedures" in mock_send.call_args[0][1] @@ -490,11 +499,11 @@ async def test_get_table_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.get_table_async(server="srv", database="db", table="tbl") + await client.get_table(server="srv", database="db", table="tbl") assert "/v2/$metadata.json/datasets/srv,db/tables/tbl" in mock_send.call_args[0][1] @@ -508,7 +517,7 @@ async def test_all_operations_success(self, mock_credential, operation): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: @@ -537,7 +546,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -615,53 +624,53 @@ def test_trigger_routes_not_client_methods(self): def test_callable_method_signatures(self): """Test the client exposes exactly the generated callable methods.""" expected_signatures = { - "delete_item_async": ("self", "server", "database", "table", "id"), - "execute_pass_through_native_query_async": ( + "delete_item": ("self", "server", "database", "table", "id"), + "execute_pass_through_native_query": ( "self", "input", "server", "database" ), - "execute_procedure_async": ( + "execute_procedure": ( "self", "input", "server", "database", "procedure" ), - "get_databases_async": ("self", "server"), - "get_item_async": ("self", "server", "database", "table", "id"), - "get_items_async": ( + "list_databases": ("self", "server"), + "get_item": ("self", "server", "database", "table", "id"), + "list_items": ( "self", "server", "database", "table", "apply", "filter", "orderby", "skip", "top", "select", "count", "extract_sensitivity_label", "purview_account_name" ), - "get_pass_through_native_query_metadata_async": ( + "get_pass_through_native_query_metadata": ( "self", "input", "server", "database" ), - "get_procedure_async": ("self", "procedure"), - "get_procedure_v2_async": ( + "get_procedure": ("self", "procedure"), + "get_procedure_v2": ( "self", "server", "database", "procedure" ), - "get_procedures_async": ("self",), - "get_procedures_v2_async": ("self", "server", "database"), - "get_servers_async": ("self",), - "get_table_async": ( + "list_procedures": ("self",), + "list_procedures_v2": ("self", "server", "database"), + "list_servers": ("self",), + "get_table": ( "self", "server", "database", "table", "extract_sensitivity_label", "purview_account_name" ), - "get_table_for_patch_async": ("self", "server", "database", "table"), - "get_tables_async": ( + "get_table_for_patch": ("self", "server", "database", "table"), + "list_tables": ( "self", "server", "database", "extract_sensitivity_label", "purview_account_name" ), - "get_tables_for_delete_item_async": ("self", "server", "database"), - "get_tables_for_get_item_async": ("self", "server", "database"), - "get_tables_for_get_on_new_items_async": ( + "list_tables_for_delete_item": ("self", "server", "database"), + "list_tables_for_get_item": ("self", "server", "database"), + "list_tables_for_get_on_new_items": ( "self", "server", "database" ), - "get_tables_for_get_on_updated_items_async": ( + "list_tables_for_get_on_updated_items": ( "self", "server", "database" ), - "get_tables_for_patch_item_async": ("self", "server", "database"), - "get_tables_for_post_item_async": ("self", "server", "database"), - "patch_item_async": ( + "list_tables_for_patch_item": ("self", "server", "database"), + "list_tables_for_post_item": ("self", "server", "database"), + "patch_item": ( "self", "input", "server", "database", "table", "id" ), - "post_item_async": ("self", "input", "server", "database", "table"), + "post_item": ("self", "input", "server", "database", "table"), } request_control_parameters = ( "timeout", @@ -673,13 +682,10 @@ def test_callable_method_signatures(self): name: parameters + request_control_parameters for name, parameters in expected_signatures.items() } + assert get_generated_operations(SqlClient) == set(expected_signatures) actual_signatures = { - name: tuple(inspect.signature(method).parameters) - for name, method in vars(SqlClient).items() - if ( - inspect.iscoroutinefunction(method) - or inspect.isasyncgenfunction(method) - ) + name: tuple(inspect.signature(getattr(SqlClient, name)).parameters) + for name in expected_signatures } assert actual_signatures == expected_signatures diff --git a/tests/test_starmind.py b/tests/test_starmind.py index 9c8a9c2a..75807321 100644 --- a/tests/test_starmind.py +++ b/tests/test_starmind.py @@ -9,10 +9,10 @@ from azure.core.credentials import AzureKeyCredential import azure.connectors.starmind as starmind_module from azure.connectors.sdk import ConnectorException +from azure.connectors.starmind import StarmindClient from azure.connectors.starmind import ( FindExpertsInput, PostQuestionDraftInput, - StarmindClient, ) from tests.conftest import MockResponse from tests.generated_connector_test_utils import ( @@ -93,7 +93,7 @@ async def test_generated_operation_success_contract( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"ok": true}'), ) as mock_send: @@ -115,11 +115,11 @@ async def test_find_experts_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"experts": []}'), ) as mock_send: - result = await client.find_experts_async( + result = await client.find_experts( input=FindExpertsInput(text_query="distributed systems"), ) @@ -138,11 +138,11 @@ async def test_post_question_draft_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=201, text='{"id": 42}'), ) as mock_send: - await client.post_question_draft_async( + await client.post_question_draft( input=PostQuestionDraftInput( title="How does this work?", description="Looking for an expert explanation.", @@ -167,7 +167,7 @@ async def test_non_success_response_raises_exception( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=400, text="bad request"), ): diff --git a/tests/test_starrezrestv1.py b/tests/test_starrezrestv1.py index 81407e90..81686f09 100644 --- a/tests/test_starrezrestv1.py +++ b/tests/test_starrezrestv1.py @@ -8,39 +8,44 @@ import azure.connectors.starrezrestv1 as starrezrestv1_module from azure.connectors.sdk.serialization import to_wire -from azure.connectors.starrezrestv1 import SelectBookingInput, Starrezrestv1Client +from azure.connectors.starrezrestv1 import Starrezrestv1Client +from azure.connectors.starrezrestv1 import SelectBookingInput from tests.conftest import MockResponse -from tests.generated_connector_test_utils import GeneratedConnectorContractTests +from tests.generated_connector_test_utils import ( + GeneratedConnectorContractTests, + model_instance, + resolve_generated_result, +) OPERATION_CONTRACTS = { - "select_entry": ("POST", True), + "list_select_entry": ("POST", True), "create_entry": ("POST", True), "update_entry": ("POST", True), "delete": ("POST", False), - "select_entry_custom_field": ("POST", True), + "list_select_entry_custom_field": ("POST", True), "update_entry_custom_field": ("POST", True), - "select_term": ("POST", True), - "select_entry_address": ("POST", True), + "list_select_term": ("POST", True), + "list_select_entry_address": ("POST", True), "update_entry_address": ("POST", True), - "select_entry_application": ("POST", True), + "list_select_entry_application": ("POST", True), "create_entry_application": ("POST", True), "update_entry_application": ("POST", True), - "select_term_session": ("POST", True), - "select_entry_detail": ("POST", True), + "list_select_term_session": ("POST", True), + "list_select_entry_detail": ("POST", True), "update_entry_detail": ("POST", True), - "select_entry_enrollment": ("POST", True), + "list_select_entry_enrollment": ("POST", True), "create_entry_enrollment": ("POST", True), "update_entry_enrollment": ("POST", True), - "select_booking": ("POST", True), + "list_select_booking": ("POST", True), "create_booking": ("POST", True), "update_booking": ("POST", True), - "select_room_space": ("POST", True), + "list_select_room_space": ("POST", True), "create_room_space": ("POST", True), - "select_room_location": ("POST", True), - "select_transaction": ("POST", True), + "list_select_room_location": ("POST", True), + "list_select_transaction": ("POST", True), "create_transaction": ("POST", True), - "select_room_space_maintenance": ("POST", True), + "list_select_room_space_maintenance": ("POST", True), "create_room_space_maintenance": ("POST", True), "update_room_space_maintenance": ("POST", True), } @@ -64,18 +69,21 @@ async def test_select_booking_sends_filter_and_deserializes_response( "https://example.azure.com/connections/test", credential=mock_credential, ) - request = SelectBookingInput( + request = model_instance( + SelectBookingInput, return_empty_array_on_no_result=True, page_size=10, ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, - return_value=MockResponse(status=200, text='{"bookings": []}'), + return_value=MockResponse(status=200, text='[{"BookingID": 123}]'), ) as mock_send: - result = await client.select_booking_async(input=request) + result = await resolve_generated_result( + client.list_select_booking(input=request) + ) mock_send.assert_awaited_once_with( "POST", @@ -89,5 +97,6 @@ async def test_select_booking_sends_filter_and_deserializes_response( assert to_wire(request) == { "_returnEmptyArrayOnNoResult": True, "_pageSize": 10, + "_pageIndex": 1, } - assert result == {"bookings": []} + assert result == [{"BookingID": 123}] diff --git a/tests/test_tallyfy.py b/tests/test_tallyfy.py index aa6215ca..83e4a0d1 100644 --- a/tests/test_tallyfy.py +++ b/tests/test_tallyfy.py @@ -9,11 +9,13 @@ from azure.core.credentials import AzureKeyCredential import azure.connectors.tallyfy as tallyfy_module from azure.connectors.sdk import ConnectorException -from azure.connectors.tallyfy import CreateRunInput, CreateTaskInput, TallyfyClient +from azure.connectors.tallyfy import TallyfyClient +from azure.connectors.tallyfy import CreateRunInput, CreateTaskInput from tests.conftest import MockResponse from tests.generated_connector_test_utils import ( get_generated_operations, invoke_generated_operation, + model_instance, ) @@ -46,7 +48,7 @@ "/processes/micro-functions/organizations/value/tasks/value/edit-deadline", True, ), - "get_organization_users": ("GET", "/organizations/value/users", False), + "list_organization_users": ("GET", "/organizations/value/users", False), "get_user_organizations": ("GET", "/me/organizations", False), "get_user_tasks": ( "GET", @@ -140,9 +142,16 @@ async def test_generated_operation_success_contract( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, - return_value=MockResponse(status=200, text='{"ok": true}'), + return_value=MockResponse( + status=200, + text=( + '{"data": [{"ok": true}]}' + if operation == "list_organization_users" + else '{"ok": true}' + ), + ), ) as mock_send: result = await invoke_generated_operation(client, operation, tallyfy_module) @@ -150,7 +159,12 @@ async def test_generated_operation_success_contract( assert method == expected_method assert url.endswith(expected_url_suffix) assert (mock_send.call_args.kwargs["body"] is not None) is expects_body - assert result == {"ok": True} + expected_result = ( + [{"ok": True}] + if operation == "list_organization_users" + else {"ok": True} + ) + assert result == expected_result @pytest.mark.asyncio async def test_create_run_success(self, mock_credential): @@ -162,11 +176,11 @@ async def test_create_run_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=201, text='{"id": "run-1"}'), ) as mock_send: - result = await client.create_run_async( + result = await client.create_run( input=CreateRunInput(name="Quarterly review", checklist_id="checklist-1"), org="organization/one", ) @@ -187,12 +201,16 @@ async def test_create_task_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=201, text='{"id": "task-1"}'), ) as mock_send: - await client.create_task_async( - input=CreateTaskInput(name="Review document", description="Check details"), + await client.create_task( + input=model_instance( + CreateTaskInput, + name="Review document", + description="Check details", + ), org="organization", ) @@ -216,7 +234,7 @@ async def test_non_success_response_raises_exception( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=400, text="bad request"), ): diff --git a/tests/test_teams.py b/tests/test_teams.py index cbb742d2..02c04e8f 100644 --- a/tests/test_teams.py +++ b/tests/test_teams.py @@ -3,9 +3,9 @@ import pytest from unittest.mock import AsyncMock, patch +from azure.connectors.teams import TeamsClient from azure.connectors.teams import ( CallEventWebhookResponseSchema, - TeamsClient, NewMeeting, CreateChannelInput, CreateTagInput, @@ -24,6 +24,7 @@ from azure.connectors.sdk import ConnectorException from azure.connectors.sdk.serialization import to_wire from tests.conftest import MockResponse +from tests.generated_connector_test_utils import model_instance, resolve_generated_result class TestTeamsClientInitialization: @@ -61,7 +62,7 @@ def test_init_with_custom_settings(self, mock_credential): client = TeamsClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) @@ -154,12 +155,12 @@ async def test_create_teams_meeting_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - input_data = NewMeeting() - result = await client.create_teams_meeting_async(input_data, "calendar123") + input_data = model_instance(NewMeeting) + result = await client.create_teams_meeting(input_data, "calendar123") call_args = mock_send.call_args assert call_args[0][0] == "POST" @@ -178,13 +179,13 @@ async def test_create_teams_meeting_error(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - input_data = NewMeeting() + input_data = model_instance(NewMeeting) with pytest.raises(ConnectorException) as exc_info: - await client.create_teams_meeting_async(input_data, "calendar123") + await client.create_teams_meeting(input_data, "calendar123") assert exc_info.value.status_code == 400 @@ -207,14 +208,13 @@ async def test_get_all_teams_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_all_teams_async() + result = await resolve_generated_result(client.list_all_teams()) - assert "value" in result - assert len(result["value"]) == 1 + assert len(result) == 1 @pytest.mark.asyncio async def test_get_all_teams_empty_response(self, mock_credential): @@ -228,13 +228,13 @@ async def test_get_all_teams_empty_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_all_teams_async() + result = await resolve_generated_result(client.list_all_teams()) - assert result is None + assert result == [] @pytest.mark.asyncio async def test_get_all_associated_teams_success(self, mock_credential): @@ -251,13 +251,15 @@ async def test_get_all_associated_teams_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_all_associated_teams_async() + result = await resolve_generated_result( + client.list_all_associated_teams() + ) - assert "value" in result + assert result[0]["teamId"] == "team1" @pytest.mark.asyncio async def test_get_all_teams_error_response(self, mock_credential): @@ -274,12 +276,14 @@ async def test_get_all_teams_error_response(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_all_associated_teams_async() + await resolve_generated_result( + client.list_all_associated_teams() + ) assert exc_info.value.status_code == 401 @@ -302,11 +306,11 @@ async def test_at_mention_user_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.at_mention_user_async("user123") + result = await client.at_mention_user("user123") call_args = mock_send.call_args assert call_args[0][0] == "GET" @@ -325,12 +329,12 @@ async def test_at_mention_user_error(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.at_mention_user_async("nonexistent") + await client.at_mention_user("nonexistent") assert exc_info.value.status_code == 404 @@ -353,12 +357,12 @@ async def test_create_chat_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - input_data = NewChat() - result = await client.create_chat_async(input_data) + input_data = model_instance(NewChat) + result = await client.create_chat(input_data) call_args = mock_send.call_args assert call_args[0][0] == "POST" @@ -377,12 +381,12 @@ async def test_create_chat_error(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_chat_async(NewChat()) + await client.create_chat(model_instance(NewChat)) assert exc_info.value.status_code == 400 @@ -405,7 +409,7 @@ async def test_create_a_team_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: @@ -414,7 +418,7 @@ async def test_create_a_team_success(self, mock_credential): description="A new team", visibility="Private" ) - result = await client.create_a_team_async(input_data) + result = await client.create_a_team(input_data) call_args = mock_send.call_args assert call_args[0][0] == "POST" @@ -433,12 +437,12 @@ async def test_create_a_team_error(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.create_a_team_async(CreateATeamInput()) + await client.create_a_team(model_instance(CreateATeamInput)) assert exc_info.value.status_code == 403 @@ -461,8 +465,8 @@ class TestGeneratedContractSurface: def test_channel_and_chat_operations_are_generated(self): """Test current channel and chat operations are callable.""" - assert hasattr(TeamsClient, "update_channel_properties_async") - assert hasattr(TeamsClient, "remove_member_from_chat_async") + assert hasattr(TeamsClient, "update_channel_properties") + assert hasattr(TeamsClient, "remove_member_from_chat") class TestHttpRequestOperations: @@ -483,12 +487,12 @@ async def test_http_request_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = b'{"method":"GET","uri":"/teams"}' - result = await client.http_request_async(input_data) + result = await client.http_request(input_data) call_args = mock_send.call_args assert call_args[0][0] == "POST" @@ -509,12 +513,12 @@ async def test_http_request_error(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.http_request_async(b'{"method":"GET","uri":"/teams"}') + await client.http_request(b'{"method":"GET","uri":"/teams"}') assert exc_info.value.status_code == 500 @@ -534,12 +538,12 @@ async def test_subscribe_user_message_with_options_success(self, mock_credential with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = DynamicUserMessageWithOptionsSubscriptionRequest() - await client.subscribe_user_message_with_options_async(input_data) + await client.subscribe_user_message_with_options(input_data) call_args = mock_send.call_args assert call_args[0][0] == "POST" @@ -557,12 +561,12 @@ async def test_subscribe_user_message_with_options_error(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.subscribe_user_message_with_options_async( + await client.subscribe_user_message_with_options( DynamicUserMessageWithOptionsSubscriptionRequest() ) @@ -572,7 +576,7 @@ class TestDataClasses: def test_new_meeting_creation(self): """Test NewMeeting data class creation.""" - meeting = NewMeeting() + meeting = model_instance(NewMeeting) assert meeting is not None def test_create_channel_input_creation(self): @@ -586,7 +590,7 @@ def test_create_channel_input_creation(self): def test_create_tag_input_creation(self): """Test CreateTagInput data class creation.""" - tag = CreateTagInput(display_name="Test Tag") + tag = model_instance(CreateTagInput, display_name="Test Tag") assert tag.display_name == "Test Tag" def test_add_member_to_tag_input_creation(self): @@ -667,12 +671,12 @@ async def test_multiple_consecutive_calls(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result1 = await client.get_all_teams_async() - result2 = await client.get_all_teams_async() + result1 = await resolve_generated_result(client.list_all_teams()) + result2 = await resolve_generated_result(client.list_all_teams()) assert result1 is not None assert result2 is not None @@ -689,12 +693,12 @@ async def test_json_parse_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(Exception): - await client.get_all_teams_async() + await resolve_generated_result(client.list_all_teams()) @pytest.mark.asyncio async def test_url_construction_with_multiple_trailing_slashes(self, mock_credential): @@ -729,12 +733,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_all_teams_async() + await resolve_generated_result(client.list_all_teams()) assert exc_info.value.status_code == 500 @@ -750,11 +754,11 @@ async def test_404_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_all_teams_async() + await resolve_generated_result(client.list_all_teams()) assert exc_info.value.status_code == 404 diff --git a/tests/test_textrequest.py b/tests/test_textrequest.py index 1d60ad64..706472b4 100644 --- a/tests/test_textrequest.py +++ b/tests/test_textrequest.py @@ -8,6 +8,7 @@ from azure.core.credentials import AzureKeyCredential import azure.connectors.textrequest as textrequest_module +from azure.connectors.textrequest import TextrequestClient from azure.connectors.textrequest import ( CreateContactInput, CreateDashboardInput, @@ -16,7 +17,6 @@ GetContactByPhoneNumberResponse, SendMessageByPhoneNumberInput, SendMessageByPhoneNumberResponse, - TextrequestClient, UpdateDashboardsNameInput, UpdateGroupInput, TRIGGER_OPERATIONS, @@ -28,6 +28,7 @@ from tests.generated_connector_test_utils import ( get_generated_operations, invoke_generated_operation, + resolve_generated_result, ) @@ -55,33 +56,33 @@ "/dashboards/1/contacts/value", False, ), - "get_contacts": ( + "list_contacts": ( "GET", "/dashboards/1/contacts?page=1&page_size=1", False, ), - "get_conversations": ("GET", "/dashboards/1/conversations", False), - "get_custom_fields": ("GET", "/dashboards/1/fields", False), + "list_conversations": ("GET", "/dashboards/1/conversations", False), + "list_custom_fields": ("GET", "/dashboards/1/fields", False), "get_dashboard": ("GET", "/dashboards/1", False), - "get_dashboards": ("GET", "/dashboards", False), + "list_dashboards": ("GET", "/dashboards", False), "get_group_by_id": ("GET", "/dashboards/1/groups/1", False), - "get_groups": ( + "list_groups": ( "GET", "/dashboards/1/groups?page=1&page_size=1", False, ), - "get_messages_by_contact_phone": ( + "list_messages_by_contact_phone": ( "GET", "/dashboards/1/contacts/value/messages?page=1&page_size=1", False, ), "get_payment": ("GET", "/dashboards/1/payments/1", False), - "get_payments": ( + "list_payments": ( "GET", "/dashboards/1/payments?page=1&page_size=1", False, ), - "get_tags": ( + "list_tags": ( "GET", "/dashboards/1/tags?page=1&page_size=1", False, @@ -110,6 +111,15 @@ "update_group": ("PUT", "/dashboards/1/groups/1", True), } ALL_OPERATIONS = list(SUCCESS_CONTRACTS) +PAGED_OPERATIONS = { + "list_contacts", + "list_conversations", + "list_dashboards", + "list_groups", + "list_messages_by_contact_phone", + "list_payments", + "list_tags", +} class TestTextrequestClientInitialization: @@ -145,7 +155,7 @@ def test_init_with_custom_settings(self, mock_credential): client = TextrequestClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -232,9 +242,21 @@ async def test_generated_operation_success_contract( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, - return_value=MockResponse(status=200, text='{"ok": true}'), + return_value=MockResponse( + status=200, + text=( + '[{"ok": true}]' + if operation in { + "bulk_update_contacts", + "list_custom_fields", + } + else '{"items": [{"ok": true}]}' + if operation in PAGED_OPERATIONS + else '{"ok": true}' + ), + ), ) as mock_send: result = await invoke_generated_operation( client, @@ -246,7 +268,15 @@ async def test_generated_operation_success_contract( assert method == expected_method assert url.endswith(expected_url_suffix) assert (mock_send.call_args.kwargs["body"] is not None) is expects_body - assert result == {"ok": True} + expected_result = ( + [{"ok": True}] + if operation in { + "bulk_update_contacts", + "list_custom_fields", + } | PAGED_OPERATIONS + else {"ok": True} + ) + assert result == expected_result @pytest.mark.asyncio async def test_get_messages_by_contact_phone_success(self, mock_credential): @@ -255,11 +285,16 @@ async def test_get_messages_by_contact_phone_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"items": []}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_messages_by_contact_phone_async( - dashboard_id="7", phone_number="+15551112222", page="1", page_size="20" + result = await resolve_generated_result( + client.list_messages_by_contact_phone( + dashboard_id="7", + phone_number="+15551112222", + page="1", + page_size="20", + ) ) url = mock_send.call_args[0][1] @@ -267,7 +302,7 @@ async def test_get_messages_by_contact_phone_success(self, mock_credential): assert "/dashboards/7/contacts/%2B15551112222/messages" in url assert "page=1" in url assert "page_size=20" in url - assert result == {"items": []} + assert result == [] @pytest.mark.asyncio async def test_send_message_by_phone_number_success(self, mock_credential): @@ -277,10 +312,10 @@ async def test_send_message_by_phone_number_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"message_id": "m1"}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.send_message_by_phone_number_async( + result = await client.send_message_by_phone_number( input=payload, dashboard_id="7", phone_number="+15551112222" ) @@ -296,10 +331,10 @@ async def test_archive_conversation_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"ok": true}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.archive_conversation_async( + result = await client.archive_conversation( dashboard_id="7", phone_number="+15551112222" ) @@ -314,10 +349,10 @@ async def test_unarchive_conversation_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"ok": true}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.unarchive_conversation_async( + result = await client.unarchive_conversation( dashboard_id="7", phone_number="+15551112222" ) @@ -332,10 +367,10 @@ async def test_get_contact_by_phone_number_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"phone_number": "+15551112222"}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_contact_by_phone_number_async( + result = await client.get_contact_by_phone_number( dashboard_id="7", phone_number="+15551112222" ) @@ -350,10 +385,10 @@ async def test_delete_contact_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"ok": true}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_contact_async( + result = await client.delete_contact( dashboard_id="7", phone_number="+15551112222" ) @@ -369,10 +404,10 @@ async def test_create_contact_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"phone_number": "+15551112222"}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_contact_async( + result = await client.create_contact( input=payload, dashboard_id="7", phone_number="+15551112222" ) @@ -388,11 +423,16 @@ async def test_get_contacts_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"items": []}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_contacts_async( - dashboard_id="7", page="1", page_size="20", is_resolved="true" + result = await resolve_generated_result( + client.list_contacts( + dashboard_id="7", + page="1", + page_size="20", + is_resolved="true", + ) ) url = mock_send.call_args[0][1] @@ -400,7 +440,7 @@ async def test_get_contacts_success(self, mock_credential): assert "/dashboards/7/contacts" in url assert "is_resolved=true" in url assert "page=1" in url - assert result == {"items": []} + assert result == [] @pytest.mark.asyncio async def test_get_group_by_id_success(self, mock_credential): @@ -409,10 +449,10 @@ async def test_get_group_by_id_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"id": 3}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_group_by_id_async(dashboard_id="7", group_id="3") + result = await client.get_group_by_id(dashboard_id="7", group_id="3") assert mock_send.call_args[0][0] == "GET" assert "/dashboards/7/groups/3" in mock_send.call_args[0][1] @@ -426,10 +466,10 @@ async def test_update_group_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"id": 3}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.update_group_async( + result = await client.update_group( input=payload, dashboard_id="7", group_id="3" ) @@ -446,10 +486,10 @@ async def test_create_group_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"id": 3}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_group_async(input=payload, dashboard_id="7") + result = await client.create_group(input=payload, dashboard_id="7") assert mock_send.call_args[0][0] == "POST" assert "/dashboards/7/groups" in mock_send.call_args[0][1] @@ -457,20 +497,25 @@ async def test_create_group_success(self, mock_credential): assert result == {"id": 3} @pytest.mark.asyncio - async def test_get_custom_fields_success(self, mock_credential): - """Test get_custom_fields issues a GET to the fields route.""" + async def test_list_custom_fields_success(self, mock_credential): + """Test list_custom_fields issues a GET to the fields route.""" client = self._make_client(mock_credential) - mock_response = MockResponse(status=200, text='[]') + mock_response = MockResponse(status=200, text='[{"id": "field-1"}]') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_custom_fields_async(dashboard_id="7") + result = await invoke_generated_operation( + client, + "list_custom_fields", + textrequest_module, + request_controls={"dashboard_id": "7"}, + ) assert mock_send.call_args[0][0] == "GET" assert "/dashboards/7/fields" in mock_send.call_args[0][1] - assert result == [] + assert result == [{"id": "field-1"}] @pytest.mark.asyncio async def test_mark_payment_paid_success(self, mock_credential): @@ -479,10 +524,10 @@ async def test_mark_payment_paid_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"ok": true}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.mark_payment_paid_async(dashboard_id="7", payment_id="9") + result = await client.mark_payment_paid(dashboard_id="7", payment_id="9") assert mock_send.call_args[0][0] == "POST" assert "/dashboards/7/payments/9/mark_as_paid" in mock_send.call_args[0][1] @@ -496,10 +541,10 @@ async def test_create_payment_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"id": 9}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_payment_async(input=payload, dashboard_id="7") + result = await client.create_payment(input=payload, dashboard_id="7") assert mock_send.call_args[0][0] == "POST" assert "/dashboards/7/payments" in mock_send.call_args[0][1] @@ -513,16 +558,18 @@ async def test_get_dashboards_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"items": []}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_dashboards_async(page="1", page_size="20") + result = await resolve_generated_result( + client.list_dashboards(page="1", page_size="20") + ) url = mock_send.call_args[0][1] assert mock_send.call_args[0][0] == "GET" assert "/dashboards" in url assert "page=1" in url - assert result == {"items": []} + assert result == [] @pytest.mark.asyncio async def test_create_dashboard_success(self, mock_credential): @@ -532,10 +579,10 @@ async def test_create_dashboard_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"id": 1}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_dashboard_async(input=payload) + result = await client.create_dashboard(input=payload) assert mock_send.call_args[0][0] == "POST" assert mock_send.call_args[0][1].endswith("/dashboards") @@ -550,10 +597,10 @@ async def test_update_dashboards_name_success(self, mock_credential): mock_response = MockResponse(status=200, text='{"id": 7}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.update_dashboards_name_async(input=payload, dashboard_id="7") + result = await client.update_dashboards_name(input=payload, dashboard_id="7") assert mock_send.call_args[0][0] == "PUT" assert mock_send.call_args[0][1].endswith("/dashboards/7") @@ -567,12 +614,12 @@ async def test_empty_response_body_returns_none(self, mock_credential): mock_response = MockResponse(status=200, text="") with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.get_dashboards_async() + result = await resolve_generated_result(client.list_dashboards()) - assert result is None + assert result == [] class TestTextrequestClientErrorHandling: @@ -582,33 +629,33 @@ class TestTextrequestClientErrorHandling: @pytest.mark.parametrize( "operation", [ - "get_messages_by_contact_phone", + "list_messages_by_contact_phone", "send_message_by_phone_number", "archive_conversation", "unarchive_conversation", "get_contact_by_phone_number", "delete_contact", "create_contact", - "get_contacts", + "list_contacts", "bulk_update_contacts", "get_group_by_id", "delete_group", "update_group", - "get_groups", + "list_groups", "create_group", - "get_tags", - "get_custom_fields", + "list_tags", + "list_custom_fields", "get_payment", "mark_payment_paid", "send_payment_reminder", "cancel_payment", - "get_payments", + "list_payments", "create_payment", "get_dashboard", "delete_dashboard", "update_dashboards_name", - "get_conversations", - "get_dashboards", + "list_conversations", + "list_dashboards", "create_dashboard", ], ) @@ -621,80 +668,15 @@ async def test_error_response_raises_exception(self, mock_credential, operation) mock_response = MockResponse(status=500, text='{"error":"server failure"}') with patch.object( - client._http_client, "send_async", new_callable=AsyncMock, + client._http_client, "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - if operation == "get_messages_by_contact_phone": - await client.get_messages_by_contact_phone_async( - dashboard_id="7", phone_number="p", page="1", page_size="20" - ) - elif operation == "send_message_by_phone_number": - await client.send_message_by_phone_number_async( - input=SendMessageByPhoneNumberInput(), dashboard_id="7", phone_number="p" - ) - elif operation == "archive_conversation": - await client.archive_conversation_async(dashboard_id="7", phone_number="p") - elif operation == "unarchive_conversation": - await client.unarchive_conversation_async(dashboard_id="7", phone_number="p") - elif operation == "get_contact_by_phone_number": - await client.get_contact_by_phone_number_async( - dashboard_id="7", phone_number="p" - ) - elif operation == "delete_contact": - await client.delete_contact_async(dashboard_id="7", phone_number="p") - elif operation == "create_contact": - await client.create_contact_async( - input=CreateContactInput(), dashboard_id="7", phone_number="p" - ) - elif operation == "get_contacts": - await client.get_contacts_async( - dashboard_id="7", page="1", page_size="20" - ) - elif operation == "bulk_update_contacts": - await client.bulk_update_contacts_async(input=[], dashboard_id="7") - elif operation == "get_group_by_id": - await client.get_group_by_id_async(dashboard_id="7", group_id="3") - elif operation == "delete_group": - await client.delete_group_async(dashboard_id="7", group_id="3") - elif operation == "update_group": - await client.update_group_async( - input=UpdateGroupInput(), dashboard_id="7", group_id="3" - ) - elif operation == "get_groups": - await client.get_groups_async(dashboard_id="7", page="1", page_size="20") - elif operation == "create_group": - await client.create_group_async(input=CreateGroupInput(), dashboard_id="7") - elif operation == "get_tags": - await client.get_tags_async(dashboard_id="7", page="1", page_size="20") - elif operation == "get_custom_fields": - await client.get_custom_fields_async(dashboard_id="7") - elif operation == "get_payment": - await client.get_payment_async(dashboard_id="7", payment_id="9") - elif operation == "mark_payment_paid": - await client.mark_payment_paid_async(dashboard_id="7", payment_id="9") - elif operation == "send_payment_reminder": - await client.send_payment_reminder_async(dashboard_id="7", payment_id="9") - elif operation == "cancel_payment": - await client.cancel_payment_async(dashboard_id="7", payment_id="9") - elif operation == "get_payments": - await client.get_payments_async(dashboard_id="7", page="1", page_size="20") - elif operation == "create_payment": - await client.create_payment_async(input=CreatePaymentInput(), dashboard_id="7") - elif operation == "get_dashboard": - await client.get_dashboard_async(dashboard_id="7") - elif operation == "delete_dashboard": - await client.delete_dashboard_async(dashboard_id="7") - elif operation == "update_dashboards_name": - await client.update_dashboards_name_async( - input=UpdateDashboardsNameInput(), dashboard_id="7" - ) - elif operation == "get_conversations": - await client.get_conversations_async(dashboard_id="7") - elif operation == "get_dashboards": - await client.get_dashboards_async() - else: - await client.create_dashboard_async(input=CreateDashboardInput()) + await invoke_generated_operation( + client, + operation, + textrequest_module, + ) assert exc_info.value.status_code == 500 diff --git a/tests/test_ticketmaster.py b/tests/test_ticketmaster.py index 86acf6ac..22a40757 100644 --- a/tests/test_ticketmaster.py +++ b/tests/test_ticketmaster.py @@ -50,11 +50,11 @@ async def test_attractions_get_serializes_query_and_response( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"items": []}'), ) as mock_send: - result = await client.attractions_get_async( + result = await client.attractions_get( keyword="rock & roll", classification_name=["music", "comedy"], ) diff --git a/tests/test_todo.py b/tests/test_todo.py index 2b187055..40f576bb 100644 --- a/tests/test_todo.py +++ b/tests/test_todo.py @@ -7,11 +7,11 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.todo import TodoClient from azure.connectors.todo import ( CreateToDo, CreateToDoList, TRIGGER_OPERATIONS, - TodoClient, ToDoHtml, UpdateToDo, ) @@ -20,6 +20,7 @@ ) from azure.connectors.sdk.serialization import to_wire from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result class TestTodoClientInitialization: @@ -55,7 +56,7 @@ def test_init_with_custom_settings(self, mock_credential): client = TodoClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -121,8 +122,8 @@ def test_todo_html_preserves_colliding_ids(self): assert payload["@odata.id"] == "odata-id" -class TestGetAllTodoListsAsync: - """Tests for get_all_todo_lists_async method.""" +class TestListAllTodoListsAsync: + """Tests for list_all_todo_lists method.""" @pytest.mark.asyncio async def test_success(self, mock_credential): @@ -131,22 +132,21 @@ async def test_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"value": [{"id": "list-1"}]}') + mock_response = MockResponse(status=200, text='[{"id": "list-1"}]') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_all_todo_lists_async() + result = await resolve_generated_result(client.list_all_todo_lists()) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert path.endswith("/lists") - assert result is not None - assert "value" in result + assert result == [{"id": "list-1"}] @pytest.mark.asyncio async def test_error_response_raises_exception(self, mock_credential): @@ -159,12 +159,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.get_all_todo_lists_async() + await resolve_generated_result(client.list_all_todo_lists()) class TestGetTodoListAsync: @@ -184,11 +184,11 @@ async def test_success_encodes_folder_id(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_to_do_list_async(folder_id="list 1") + result = await client.get_to_do_list(folder_id="list 1") mock_send.assert_called_once_with( "GET", @@ -208,18 +208,18 @@ async def test_error_response_raises_exception(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=404, text='{"error": "Not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.get_to_do_list_async(folder_id="missing-list") + await client.get_to_do_list(folder_id="missing-list") - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestCreateTodoListAsync: @@ -237,11 +237,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_to_do_list_async(input=payload) + result = await client.create_to_do_list(input=payload) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -263,12 +263,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException): - await client.create_to_do_list_async(input=payload) + await client.create_to_do_list(input=payload) class TestUpdateTodoListAsync: @@ -289,11 +289,11 @@ async def test_success_encodes_folder_id_and_sends_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.update_to_do_list_async( + result = await client.update_to_do_list( input=payload, folder_id="list 1", ) @@ -321,12 +321,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.update_to_do_list_async( + await client.update_to_do_list( input=payload, folder_id="missing-list", ) @@ -348,11 +348,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_to_do_list_async(folder_id="list 1") + result = await client.delete_to_do_list(folder_id="list 1") mock_send.assert_called_once_with( "DELETE", @@ -372,18 +372,18 @@ async def test_error_response_raises_exception(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=404, text='{"error": "Not found"}') + mock_response = MockResponse(status=500, text='{"error": "Server error"}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_to_do_list_async(folder_id="missing-list") + await client.delete_to_do_list(folder_id="missing-list") - assert exc_info.value.status_code == 404 + assert exc_info.value.status_code == 500 class TestGetTodoAsync: @@ -403,11 +403,11 @@ async def test_success_encodes_folder_and_todo_ids(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_to_do_async( + result = await client.get_to_do( folder_id="list 1", id="task 1", ) @@ -434,12 +434,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.get_to_do_async( + await client.get_to_do( folder_id="list-1", id="missing-task", ) @@ -462,11 +462,11 @@ async def test_create_to_do_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_to_do_async(input=payload, folder_id="list-1") + result = await client.create_to_do(input=payload, folder_id="list-1") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -489,11 +489,11 @@ async def test_update_to_do_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.update_to_do_async(input=payload, folder_id="list-1", id="task-1") + result = await client.update_to_do(input=payload, folder_id="list-1", id="task-1") mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -518,11 +518,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_to_do_async( + result = await client.delete_to_do( folder_id="list 1", id="task 1", ) @@ -549,12 +549,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: - await client.delete_to_do_async( + await client.delete_to_do( folder_id="list-1", id="task-1", ) @@ -572,22 +572,24 @@ async def test_success_with_top_query(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"value": [{"id": "task-1"}]}') + mock_response = MockResponse(status=200, text='[{"id": "task-1"}]') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_to_dos_by_folder_async(folder_id="list-1", top="10") + result = await resolve_generated_result( + client.list_to_dos_by_folder(folder_id="list-1", top=10) + ) mock_send.assert_called_once() method, path = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert "/lists/list-1/tasks" in path assert "$top=10" in path - assert result is not None + assert result == [{"id": "task-1"}] class TestTodoTriggerOperations: diff --git a/tests/test_trello.py b/tests/test_trello.py index 43a28fa1..5a4bc589 100644 --- a/tests/test_trello.py +++ b/tests/test_trello.py @@ -2,7 +2,6 @@ """Unit tests for TrelloClient.""" -import inspect from unittest.mock import AsyncMock, patch import pytest @@ -11,85 +10,99 @@ from azure.connectors.sdk import ( ConnectorException, ) +from azure.connectors.trello import TrelloClient from azure.connectors.trello import ( Card, CommentPost, CreateBoard, CreateCard, CreateList, - TrelloClient, TRIGGER_OPERATIONS, UpdateBoard, UpdateCard, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import ( + get_generated_operations, + model_instance, + resolve_generated_result, +) async def _invoke_operation(client: TrelloClient, operation: str): """Invoke a Trello operation by name for shared tests.""" if operation == "list_cards": - return await client.list_cards_async(board_id="board") + return await resolve_generated_result(client.list_cards(board_id="board")) if operation == "list_cards_simple": - return await client.list_cards_simple_async(board_id="board") + return await resolve_generated_result(client.list_cards_simple(board_id="board")) if operation == "get_card": - return await client.get_card_async(card_id="card", board_id="board") + return await client.get_card(card_id="card", board_id="board") if operation == "delete_card": - return await client.delete_card_async(card_id="card", board_id="board") + return await client.delete_card(card_id="card", board_id="board") if operation == "list_boards": - return await client.list_boards_async() + return await resolve_generated_result(client.list_boards()) if operation == "list_boards_simple": - return await client.list_boards_simple_async() + return await resolve_generated_result(client.list_boards_simple()) if operation == "get_board": - return await client.get_board_async(board_id="board") + return await client.get_board(board_id="board") if operation == "update_board": - return await client.update_board_async(input=UpdateBoard(), board_id="board") + return await client.update_board(input=UpdateBoard(), board_id="board") if operation == "list_lists": - return await client.list_lists_async(board_id="board") + return await resolve_generated_result(client.list_lists(board_id="board")) if operation == "list_lists_simple": - return await client.list_lists_simple_async(board_id="board") + return await resolve_generated_result(client.list_lists_simple(board_id="board")) if operation == "get_list": - return await client.get_list_async(list_id="list", board_id="board") + return await client.get_list(list_id="list", board_id="board") if operation == "update_list": - return await client.update_list_async(list_id="list", board_id="board") + return await client.update_list(list_id="list", board_id="board") if operation == "get_user_profile": - return await client.get_user_profile_async() + return await client.get_user_profile() if operation == "list_teams": - return await client.list_teams_async() + return await resolve_generated_result(client.list_teams()) if operation == "list_team_members": - return await client.list_team_members_async(team_id="team") + return await resolve_generated_result(client.list_team_members(team_id="team")) if operation == "list_board_members": - return await client.list_board_members_async(board_id="board") + return await resolve_generated_result(client.list_board_members(board_id="board")) if operation == "list_board_labels": - return await client.list_board_labels_async(board_id="board") + return await resolve_generated_result(client.list_board_labels(board_id="board")) if operation == "get_team_for_board": - return await client.get_team_for_board_async(board_id="board") + return await client.get_team_for_board(board_id="board") if operation == "list_card_members": - return await client.list_card_members_async(card_id="card", board_id="board") + return await resolve_generated_result( + client.list_card_members(card_id="card", board_id="board") + ) if operation == "list_card_comments": - return await client.list_card_comments_async(card_id="card", board_id="board") + return await resolve_generated_result( + client.list_card_comments(card_id="card", board_id="board") + ) if operation == "add_comment_to_card": - return await client.add_comment_to_card_async( + return await client.add_comment_to_card( input=CommentPost(), card_id="card", board_id="board", ) if operation == "add_member_to_card": - return await client.add_member_to_card_async( - card_id="card", - board_id="board", - member_id="member", + return await resolve_generated_result( + client.add_member_to_card( + card_id="card", + board_id="board", + member_id="member", + ) ) if operation == "create_board": - return await client.create_board_async(input=CreateBoard()) + return await client.create_board(input=model_instance(CreateBoard)) if operation == "create_list": - return await client.create_list_async(input=CreateList()) + return await client.create_list(input=model_instance(CreateList)) if operation == "close_board": - return await client.close_board_async(board_id="board") + return await client.close_board(board_id="board") if operation == "create_card": - return await client.create_card_async(input=CreateCard(), board_id="board") + return await client.create_card( + input=model_instance(CreateCard), + board_id="board", + ) if operation == "update_card": - return await client.update_card_async( - input=UpdateCard(), + return await client.update_card( + input=model_instance(UpdateCard), card_id="card", board_id="board", ) @@ -161,7 +174,7 @@ def test_init_with_custom_settings(self, mock_credential): client = TrelloClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -219,13 +232,7 @@ class TestTrelloClientOperations: def test_all_generated_operations_are_covered(self): """Test the operation list matches every generated client method.""" - generated_operations = { - name.removesuffix("_async") - for name, method in inspect.getmembers(TrelloClient, inspect.iscoroutinefunction) - if name.endswith("_async") - } - - assert generated_operations == set(ALL_OPERATIONS) + assert get_generated_operations(TrelloClient) == set(ALL_OPERATIONS) @pytest.mark.asyncio async def test_list_cards_serializes_path_and_query(self, mock_credential): @@ -238,14 +245,16 @@ async def test_list_cards_serializes_path_and_query(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_cards_async( - board_id="board/one", - actions="comment card", - limit="10", + result = await resolve_generated_result( + client.list_cards( + board_id="board/one", + actions="comment card", + limit=10, + ) ) assert result == [{"id": "card"}] @@ -266,11 +275,11 @@ async def test_create_card_sends_request_body(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_card_async(input=request, board_id="board") + result = await client.create_card(input=request, board_id="board") assert result == {"id": "card"} assert mock_send.call_args[0][0] == "POST" @@ -288,11 +297,11 @@ async def test_delete_card_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_card_async(card_id="card", board_id="board") + result = await client.delete_card(card_id="card", board_id="board") assert result is None assert mock_send.call_args[0][0] == "DELETE" @@ -314,7 +323,7 @@ async def test_error_response_raises_connector_exception( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -359,7 +368,7 @@ def test_response_dataclasses_initialize_expected_defaults(self): assert Card().checklists is None def test_request_dataclasses_instantiate(self): - """Test representative request dataclasses instantiate without arguments.""" - assert CreateBoard().name is None - assert CreateCard().name is None - assert CreateList().name is None + """Test representative request dataclasses instantiate with required fields.""" + assert model_instance(CreateBoard).name is not None + assert model_instance(CreateCard).name is not None + assert model_instance(CreateList).name is not None diff --git a/tests/test_twitter.py b/tests/test_twitter.py index 7ef7dd53..eef167d6 100644 --- a/tests/test_twitter.py +++ b/tests/test_twitter.py @@ -11,25 +11,27 @@ from azure.connectors.sdk import ( ConnectorException, ) -from azure.connectors.twitter import TRIGGER_OPERATIONS, TwitterClient +from azure.connectors.twitter import TwitterClient +from azure.connectors.twitter import TRIGGER_OPERATIONS from tests.conftest import MockResponse from tests.generated_connector_test_utils import ( get_generated_operations, invoke_generated_operation, + resolve_generated_result, ) SUCCESS_CONTRACTS = { - "followers": ("GET", "/followers?userName=value", False), - "following": ("GET", "/friends?userName=value", False), - "home_timeline": ("GET", "/hometimeline", False), - "my_followers": ("GET", "/myfollowers", False), - "my_following": ("GET", "/myfriends", False), + "list_followers": ("GET", "/followers?userName=value", False), + "list_following": ("GET", "/friends?userName=value", False), + "list_home_timeline": ("GET", "/hometimeline", False), + "list_my_followers": ("GET", "/myfollowers", False), + "list_my_following": ("GET", "/myfriends", False), "retweet": ("POST", "/retweet?tweetId=value", False), - "search_tweet": ("GET", "/searchtweets?searchQuery=value", False), + "list_search_tweet": ("GET", "/searchtweets?searchQuery=value", False), "tweet": ("POST", "/posttweet", True), "user": ("GET", "/user?userName=value", False), - "user_timeline": ("GET", "/usertimeline?userName=value", False), + "list_user_timeline": ("GET", "/usertimeline?userName=value", False), } ALL_OPERATIONS = list(SUCCESS_CONTRACTS) @@ -67,7 +69,7 @@ def test_init_with_custom_settings(self, mock_credential): client = TwitterClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) @@ -140,9 +142,16 @@ async def test_generated_operation_success_contract( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, - return_value=MockResponse(status=200, text='{"ok": true}'), + return_value=MockResponse( + status=200, + text=( + '[{"ok": true}]' + if operation.startswith("list_") + else '{"ok": true}' + ), + ), ) as mock_send: result = await invoke_generated_operation(client, operation, twitter_module) @@ -150,7 +159,12 @@ async def test_generated_operation_success_contract( assert method == expected_method assert url.endswith(expected_url_suffix) assert (mock_send.call_args.kwargs["body"] is not None) is expects_body - assert result == {"ok": True} + expected_result = ( + [{"ok": True}] + if operation.startswith("list_") + else {"ok": True} + ) + assert result == expected_result @pytest.mark.asyncio async def test_user_timeline_success(self, mock_credential): @@ -159,20 +173,22 @@ async def test_user_timeline_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - response = MockResponse(status=200, text='{"value": []}') + response = MockResponse(status=200, text='[{"id": "tweet-1"}]') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=response, ) as mock_send: - result = await client.user_timeline_async(user_name="Ada Lovelace", max_results="5") + result = await resolve_generated_result( + client.list_user_timeline(user_name="Ada Lovelace", max_results=5) + ) method, url = mock_send.call_args.args[:2] assert method == "GET" assert url.endswith("/usertimeline?userName=Ada%20Lovelace&maxResults=5") - assert result == {"value": []} + assert result == [{"id": "tweet-1"}] @pytest.mark.asyncio async def test_tweet_success(self, mock_credential): @@ -185,11 +201,11 @@ async def test_tweet_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=response, ) as mock_send: - result = await client.tweet_async(input=b"payload", tweet_text="Hello") + result = await client.tweet(input=b"payload", tweet_text="Hello") method, url = mock_send.call_args.args[:2] assert method == "POST" @@ -198,8 +214,8 @@ async def test_tweet_success(self, mock_credential): assert result == {"id": "tweet-1"} @pytest.mark.asyncio - async def test_empty_response_returns_none(self, mock_credential): - """Test an empty successful response returns None.""" + async def test_empty_response_returns_empty_page(self, mock_credential): + """Test an empty successful response returns an empty page.""" client = TwitterClient( "https://example.azure.com/connections/test", credential=mock_credential, @@ -207,13 +223,13 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=204, text=""), ): - result = await client.home_timeline_async() + result = await resolve_generated_result(client.list_home_timeline()) - assert result is None + assert result == [] def test_trigger_metadata(self): """Test polling trigger metadata is registered instead of callable.""" @@ -236,7 +252,7 @@ async def test_non_success_response_raises_exception( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=400, text="bad request"), ): diff --git a/tests/test_typeform.py b/tests/test_typeform.py index 78686849..cf34ef7b 100644 --- a/tests/test_typeform.py +++ b/tests/test_typeform.py @@ -3,7 +3,8 @@ """Contract tests for TypeformClient.""" import azure.connectors.typeform as typeform_module -from azure.connectors.typeform import TRIGGER_OPERATIONS, TypeformClient +from azure.connectors.typeform import TypeformClient +from azure.connectors.typeform import TRIGGER_OPERATIONS from tests.generated_connector_test_utils import GeneratedConnectorContractTests diff --git a/tests/test_universalprint.py b/tests/test_universalprint.py index 5549f7fc..a4e0fa3f 100644 --- a/tests/test_universalprint.py +++ b/tests/test_universalprint.py @@ -13,18 +13,19 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import resolve_generated_result async def _invoke_operation(client: UniversalprintClient, operation: str): """Invoke a Universal Print operation by name for shared tests.""" if operation == "print_file": - return await client.print_file_async( + return await client.print_file( input=b"%PDF-1.4 test", printer="printer123", file_name="document.pdf", ) if operation == "list_recent_shares": - return await client.list_recent_shares_async() + return await resolve_generated_result(client.list_recent_shares()) raise ValueError(f"Unsupported operation '{operation}'.") @@ -62,7 +63,7 @@ def test_init_with_custom_settings(self, mock_credential): client = UniversalprintClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -130,11 +131,11 @@ async def test_print_file_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.print_file_async( + result = await client.print_file( input=body, printer="printer123", file_name="document.pdf", @@ -160,11 +161,11 @@ async def test_print_file_includes_query_params(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.print_file_async( + await client.print_file( input=b"%PDF-1.4 test", printer="printer123", file_name="document.pdf", @@ -189,13 +190,13 @@ async def test_list_recent_shares_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.list_recent_shares_async() + result = await resolve_generated_result(client.list_recent_shares()) - assert result["value"][0]["id"] == "share123" + assert result == [{"id": "share123"}] assert mock_send.call_args[0][0] == "GET" assert "/beta/me/print/recentPrinterShares" in mock_send.call_args[0][1] @@ -206,17 +207,17 @@ async def test_list_recent_shares_empty_returns_none(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text="") + mock_response = MockResponse(status=200, text='{"value": []}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.list_recent_shares_async() + result = await resolve_generated_result(client.list_recent_shares()) - assert result is None + assert result == [] class TestUniversalprintClientErrorHandling: @@ -244,7 +245,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -257,21 +258,21 @@ class TestUniversalprintClientSignatures: def test_print_file_required_params_have_no_default(self): """Test printer and file_name are required (no default value).""" - signature = inspect.signature(UniversalprintClient.print_file_async) + signature = inspect.signature(UniversalprintClient.print_file) assert signature.parameters["printer"].default is inspect.Parameter.empty assert signature.parameters["file_name"].default is inspect.Parameter.empty def test_print_file_required_params_annotated_as_str(self): """Test printer and file_name are annotated as str, not Optional.""" - signature = inspect.signature(UniversalprintClient.print_file_async) + signature = inspect.signature(UniversalprintClient.print_file) assert signature.parameters["printer"].annotation == "str" assert signature.parameters["file_name"].annotation == "str" def test_print_file_optional_params_default_to_none(self): """Test optional configuration params default to None.""" - signature = inspect.signature(UniversalprintClient.print_file_async) + signature = inspect.signature(UniversalprintClient.print_file) assert signature.parameters["configuration_copies"].default is None assert signature.parameters["configuration_color_mode"].default is None @@ -285,4 +286,4 @@ async def test_print_file_missing_required_param_raises_type_error(self, mock_cr ) with pytest.raises(TypeError): - await client.print_file_async(input=b"%PDF-1.4 test") + await client.print_file(input=b"%PDF-1.4 test") diff --git a/tests/test_waywedo.py b/tests/test_waywedo.py index 66b26b29..63f50590 100644 --- a/tests/test_waywedo.py +++ b/tests/test_waywedo.py @@ -3,7 +3,8 @@ """Contract tests for WaywedoClient.""" import azure.connectors.waywedo as waywedo_module -from azure.connectors.waywedo import TRIGGER_OPERATIONS, WaywedoClient +from azure.connectors.waywedo import WaywedoClient +from azure.connectors.waywedo import TRIGGER_OPERATIONS from tests.generated_connector_test_utils import GeneratedConnectorContractTests @@ -11,17 +12,17 @@ "comment_add": ("POST", True), "checklist_instances": ("POST", True), "checklist_instances_get": ("GET", False), - "checklist_instances_activity": ("GET", False), - "find_steps": ("GET", False), + "list_checklist_instances_activity": ("GET", False), + "list_find_steps": ("GET", False), "checklist_steps_get": ("GET", False), "checklist_steps_complete": ("POST", True), "collaborators_add": ("POST", True), - "find_checklist": ("GET", False), + "list_find_checklist": ("GET", False), "procedures_get": ("GET", False), - "find_checklist_instances": ("GET", False), - "find_user": ("GET", False), + "list_find_checklist_instances": ("GET", False), + "list_find_user": ("GET", False), "users": ("POST", True), - "get_all_checklist_instances": ("GET", False), + "list_all_checklist_instances": ("GET", False), } diff --git a/tests/test_wdatp.py b/tests/test_wdatp.py index b71dcf19..df82ab09 100644 --- a/tests/test_wdatp.py +++ b/tests/test_wdatp.py @@ -6,8 +6,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.wdatp import WdatpClient from azure.connectors.wdatp import ( - WdatpClient, AdvancedHuntingInput, PatchAlertInput, StartInvestigationInput, @@ -22,7 +22,10 @@ ConnectorException, ) from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import ( + model_instance, + resolve_generated_result, +) class TestWdatpClientInitialization: @@ -58,7 +61,7 @@ def test_init_with_custom_settings(self, mock_credential): client = WdatpClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -128,10 +131,10 @@ async def test_advanced_hunting_success(self, mock_credential): } mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = AdvancedHuntingInput(query="DeviceInfo | take 10") - result = await client.advanced_hunting_async(input=input_data) + result = await client.advanced_hunting(input=input_data) mock_send.assert_called_once() call_args = mock_send.call_args @@ -149,11 +152,11 @@ async def test_advanced_hunting_error(self, mock_credential): mock_response = MockResponse(400, "Invalid query") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): input_data = AdvancedHuntingInput(query="invalid") with pytest.raises(ConnectorException): - await client.advanced_hunting_async(input=input_data) + await client.advanced_hunting(input=input_data) class TestGetAlerts: @@ -176,9 +179,9 @@ async def test_get_alerts_success(self, mock_credential): } mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.get_alerts_async()) + result = await resolve_generated_result(client.list_alerts()) call_args = mock_send.call_args assert call_args[0][0] == "GET" @@ -195,9 +198,9 @@ async def test_get_alerts_with_filter(self, mock_credential): mock_response = MockResponse(200, '{"count": 0, "value": []}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.get_alerts_async(filter="severity eq 'High'")) + await resolve_generated_result(client.list_alerts(filter="severity eq 'High'")) call_args = mock_send.call_args assert "$filter=" in call_args[0][1] @@ -212,9 +215,9 @@ async def test_get_alerts_with_pagination(self, mock_credential): mock_response = MockResponse(200, '{"count": 0, "value": []}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.get_alerts_async(top="10", skip="5")) + await resolve_generated_result(client.list_alerts(top="10", skip="5")) call_args = mock_send.call_args assert "$top=10" in call_args[0][1] @@ -235,9 +238,9 @@ async def test_get_single_alert_success(self, mock_credential): response_data = {"id": "alert-123", "title": "Test Alert", "severity": "High"} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_single_alert_async(alert_id="alert-123") + result = await client.get_single_alert(alert_id="alert-123") call_args = mock_send.call_args assert "api/alerts/alert-123" in call_args[0][1] @@ -253,10 +256,10 @@ async def test_get_single_alert_not_found(self, mock_credential): mock_response = MockResponse(404, "Alert not found") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException): - await client.get_single_alert_async(alert_id="nonexistent") + await client.get_single_alert(alert_id="nonexistent") class TestPatchAlert: @@ -273,10 +276,10 @@ async def test_patch_alert_success(self, mock_credential): response_data = {"id": "alert-123", "status": "Resolved"} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = PatchAlertInput(status="Resolved") - result = await client.patch_alert_async(input=input_data, alert_id="alert-123") + result = await client.patch_alert(input=input_data, alert_id="alert-123") call_args = mock_send.call_args assert call_args[0][0] == "PATCH" @@ -304,9 +307,9 @@ async def test_get_machines_success(self, mock_credential): } mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.get_machines_async()) + result = await resolve_generated_result(client.list_machines()) call_args = mock_send.call_args assert "api/machines" in call_args[0][1] @@ -327,9 +330,9 @@ async def test_get_single_machine_success(self, mock_credential): response_data = {"id": "machine-123", "computerDnsName": "TestPC"} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_single_machine_async(machine_id="machine-123") + result = await client.get_single_machine(machine_id="machine-123") call_args = mock_send.call_args assert "api/machines/machine-123" in call_args[0][1] @@ -350,10 +353,13 @@ async def test_isolate_machine_success(self, mock_credential): response_data = {"id": "action-123", "type": "Isolate", "status": "InProgress"} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - input_data = IsolateMachineInput(comment="Security investigation") - result = await client.isolate_machine_async( + input_data = model_instance( + IsolateMachineInput, + comment="Security investigation", + ) + result = await client.isolate_machine( input=input_data, machine_id="machine-123" ) @@ -378,10 +384,10 @@ async def test_unisolate_machine_success(self, mock_credential): response_data = {"id": "action-124", "type": "Unisolate", "status": "InProgress"} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = UnisolateMachineInput(comment="Investigation complete") - await client.unisolate_machine_async( + await client.unisolate_machine( input=input_data, machine_id="machine-123" ) @@ -404,10 +410,10 @@ async def test_run_antivirus_scan_success(self, mock_credential): response_data = {"id": "action-125", "type": "RunAntiVirusScan", "status": "InProgress"} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = RunAntivirusScanInput(comment="Routine scan", scan_type="Quick") - await client.run_antivirus_scan_async( + await client.run_antivirus_scan( input=input_data, machine_id="machine-123" ) @@ -430,10 +436,10 @@ async def test_collect_investigation_package_success(self, mock_credential): response_data = {"id": "action-126", "type": "CollectInvestigationPackage"} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = CollectInvestigationPackageInput(comment="Forensic analysis") - await client.collect_investigation_package_async( + await client.collect_investigation_package( input=input_data, machine_id="machine-123" ) @@ -459,9 +465,9 @@ async def test_get_machine_actions_success(self, mock_credential): } mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.get_machine_actions_async()) + result = await resolve_generated_result(client.list_machine_actions()) call_args = mock_send.call_args assert "api/machineactions" in call_args[0][1] @@ -485,9 +491,9 @@ async def test_get_investigations_success(self, mock_credential): } mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.get_investigations_async()) + result = await resolve_generated_result(client.list_investigations()) call_args = mock_send.call_args assert "api/investigations" in call_args[0][1] @@ -508,10 +514,10 @@ async def test_start_investigation_success(self, mock_credential): response_data = {"id": "inv-123", "state": "Running"} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = StartInvestigationInput(comment="Suspicious activity") - await client.start_investigation_async( + await client.start_investigation( input=input_data, machine_id="machine-123" ) @@ -534,10 +540,10 @@ async def test_add_machine_tag_success(self, mock_credential): response_data = {"id": "machine-123", "machineTags": ["HighValue"]} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = MachineTagInput(value="HighValue", action="Add") - result = await client.machine_tag_async( + result = await client.machine_tag( input=input_data, machine_id="machine-123" ) @@ -561,9 +567,9 @@ async def test_get_file_stats_success(self, mock_credential): response_data = {"sha1": "abc123", "globallyPrevalence": 100} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_file_stats_async(file_id="abc123") + result = await client.get_file_stats(file_id="abc123") call_args = mock_send.call_args assert "api/files/abc123/stats" in call_args[0][1] @@ -584,9 +590,9 @@ async def test_get_domain_stats_success(self, mock_credential): response_data = {"host": "example.com", "organizationPrevalence": 50} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_domain_stats_async(domain_name="example.com") + result = await client.get_domain_stats(domain_name="example.com") call_args = mock_send.call_args assert "api/domains/example.com/stats" in call_args[0][1] @@ -607,9 +613,9 @@ async def test_get_ip_stats_success(self, mock_credential): response_data = {"ipAddress": "192.168.1.1", "organizationPrevalence": 25} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_ip_stats_async(ip_address="192.168.1.1") + result = await client.get_ip_stats(ip_address="192.168.1.1") call_args = mock_send.call_args assert "api/ips/192.168.1.1/stats" in call_args[0][1] @@ -630,10 +636,10 @@ async def test_restrict_app_execution_success(self, mock_credential): response_data = {"id": "action-127", "type": "RestrictCodeExecution"} mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: input_data = RestrictAppExecutionInput(comment="Containment") - await client.restrict_app_execution_async( + await client.restrict_app_execution( input=input_data, machine_id="machine-123" ) @@ -659,9 +665,9 @@ async def test_get_remediation_activities_success(self, mock_credential): } mock_response = MockResponse(200, json.dumps(response_data)) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock, return_value=mock_response + client._http_client, 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await resolve_generated_result(client.get_remediation_activities_async()) + result = await resolve_generated_result(client.list_remediation_activities()) call_args = mock_send.call_args assert "api/remediationtasks" in call_args[0][1] diff --git a/tests/test_webex.py b/tests/test_webex.py index ef675d16..b3b3fa05 100644 --- a/tests/test_webex.py +++ b/tests/test_webex.py @@ -7,18 +7,22 @@ import pytest from azure.core.credentials import AzureKeyCredential +from azure.connectors.webex import WebexClient from azure.connectors.webex import ( CreateSpaceInput, CreateSpaceMemberInput, CreateTeamMemberInput, SendMessageInput, TRIGGER_OPERATIONS, - WebexClient, ) from azure.connectors.sdk import ( ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import ( + model_instance, + resolve_generated_result, +) class TestWebexClientInitialization: @@ -54,7 +58,7 @@ def test_init_with_custom_settings(self, mock_credential): client = WebexClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -121,12 +125,16 @@ async def test_create_space_member_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_space_member_async( - input=CreateSpaceMemberInput(room_id="R1", person_email="a@b.com"), + result = await client.create_space_member( + input=model_instance( + CreateSpaceMemberInput, + room_id="R1", + person_email="a@b.com", + ), ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -142,21 +150,23 @@ async def test_get_messages_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"items": []}') + mock_response = MockResponse(status=200, text='{"items": [{"id": "msg1"}]}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_messages_async(room_id="R1") + result = await resolve_generated_result( + client.list_messages(room_id="R1") + ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert "/v1/messages" in url assert "roomId=R1" in url - assert result == {"items": []} + assert result == [{"id": "msg1"}] @pytest.mark.asyncio async def test_send_message_success(self, mock_credential): @@ -169,11 +179,11 @@ async def test_send_message_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.send_message_async( + result = await client.send_message( input=SendMessageInput(room_id="R1", text="hello"), ) @@ -194,11 +204,11 @@ async def test_get_message_details_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_message_details_async(message_id="msg1") + result = await client.get_message_details(message_id="msg1") method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -216,17 +226,17 @@ async def test_get_people_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_people_async(email="a@b.com") + result = await resolve_generated_result(client.list_people(email="a@b.com")) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert "/v1/people" in url assert "email=a%40b.com" in url - assert result == {"items": []} + assert result == [] @pytest.mark.asyncio async def test_get_my_own_details_success(self, mock_credential): @@ -239,11 +249,11 @@ async def test_get_my_own_details_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_my_own_details_async() + result = await client.get_my_own_details() method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -257,20 +267,20 @@ async def test_get_spaces_success(self, mock_credential): "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text='{"items": []}') + mock_response = MockResponse(status=200, text='{"items": [{"id": "R1"}]}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_spaces_async() + result = await resolve_generated_result(client.list_spaces()) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" assert url.endswith("/v1/rooms") - assert result == {"items": []} + assert result == [{"id": "R1"}] @pytest.mark.asyncio async def test_create_space_success(self, mock_credential): @@ -283,11 +293,11 @@ async def test_create_space_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_space_async( + result = await client.create_space( input=CreateSpaceInput(title="My Space"), ) @@ -308,11 +318,11 @@ async def test_get_space_detail_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_space_detail_async(room_id="R1") + result = await client.get_space_detail(room_id="R1") method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] assert method == "GET" @@ -330,12 +340,16 @@ async def test_create_team_member_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.create_team_member_async( - input=CreateTeamMemberInput(team_id="T1", person_email="a@b.com"), + result = await client.create_team_member( + input=model_instance( + CreateTeamMemberInput, + team_id="T1", + person_email="a@b.com", + ), ) method, url = mock_send.call_args[0][0], mock_send.call_args[0][1] @@ -345,23 +359,23 @@ async def test_create_team_member_success(self, mock_credential): assert result == {"id": "tm1"} @pytest.mark.asyncio - async def test_empty_response_body_returns_none(self, mock_credential): - """Test a 2xx response with no body returns None.""" + async def test_empty_page_returns_empty_list(self, mock_credential): + """Test an empty items envelope returns an empty list.""" client = WebexClient( "https://example.azure.com/connections/test", credential=mock_credential, ) - mock_response = MockResponse(status=200, text="") + mock_response = MockResponse(status=200, text='{"items": []}') with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.get_spaces_async() + result = await resolve_generated_result(client.list_spaces()) - assert result is None + assert result == [] class TestWebexClientErrorHandling: @@ -372,12 +386,12 @@ class TestWebexClientErrorHandling: "operation", [ "create_space_member", - "get_messages", + "list_messages", "send_message", "get_message_details", - "get_people", + "list_people", "get_my_own_details", - "get_spaces", + "list_spaces", "create_space", "get_space_detail", "create_team_member", @@ -393,31 +407,37 @@ async def test_error_response_raises_exception(self, mock_credential, operation) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): with pytest.raises(ConnectorException) as exc_info: if operation == "create_space_member": - await client.create_space_member_async(input=CreateSpaceMemberInput()) - elif operation == "get_messages": - await client.get_messages_async(room_id="R1") + await client.create_space_member( + input=model_instance(CreateSpaceMemberInput) + ) + elif operation == "list_messages": + await resolve_generated_result( + client.list_messages(room_id="R1") + ) elif operation == "send_message": - await client.send_message_async(input=SendMessageInput()) + await client.send_message(input=SendMessageInput()) elif operation == "get_message_details": - await client.get_message_details_async(message_id="msg1") - elif operation == "get_people": - await client.get_people_async(email="a@b.com") + await client.get_message_details(message_id="msg1") + elif operation == "list_people": + await resolve_generated_result(client.list_people(email="a@b.com")) elif operation == "get_my_own_details": - await client.get_my_own_details_async() - elif operation == "get_spaces": - await client.get_spaces_async() + await client.get_my_own_details() + elif operation == "list_spaces": + await resolve_generated_result(client.list_spaces()) elif operation == "create_space": - await client.create_space_async(input=CreateSpaceInput()) + await client.create_space(input=model_instance(CreateSpaceInput)) elif operation == "get_space_detail": - await client.get_space_detail_async(room_id="R1") + await client.get_space_detail(room_id="R1") else: - await client.create_team_member_async(input=CreateTeamMemberInput()) + await client.create_team_member( + input=model_instance(CreateTeamMemberInput) + ) assert exc_info.value.status_code == 500 @@ -459,7 +479,6 @@ class TestWebexTypeSerialization: def test_dataclass_defaults(self): """Test dataclasses default to None and reserved names are renamed.""" - assert CreateSpaceInput().title is None - assert CreateSpaceInput().team_id is None + assert model_instance(CreateSpaceInput).team_id is None assert SendMessageInput().room_id is None - assert CreateTeamMemberInput().team_id is None + assert model_instance(CreateTeamMemberInput).person_id is None diff --git a/tests/test_wordonlinebusiness.py b/tests/test_wordonlinebusiness.py index bd3720d1..fd672d01 100644 --- a/tests/test_wordonlinebusiness.py +++ b/tests/test_wordonlinebusiness.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.wordonlinebusiness import WordonlinebusinessClient from azure.connectors.wordonlinebusiness import ( - WordonlinebusinessClient, CreateFileItemInput, ContentBody, BlobMetadata, @@ -17,6 +17,10 @@ ConnectorException, ) from tests.conftest import MockResponse +from tests.generated_connector_test_utils import ( + model_instance, + resolve_generated_result, +) class TestWordonlinebusinessClientInitialization: @@ -52,7 +56,7 @@ def test_init_with_custom_settings(self, mock_credential): client = WordonlinebusinessClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -124,14 +128,14 @@ async def test_create_file_item_success(self, mock_credential): ) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response input_data = CreateFileItemInput( additional_properties={"field1": "value1", "field2": "value2"} ) - result = await client.create_file_item_async( + result = await client.create_file_item( input=input_data, source="me", drive="drive-1", @@ -158,12 +162,12 @@ async def test_create_file_item_empty_response(self, mock_credential): mock_response = MockResponse(status=200, text="") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response input_data = CreateFileItemInput() - result = await client.create_file_item_async( + result = await client.create_file_item( input=input_data, source="me", drive="drive-1", @@ -183,13 +187,13 @@ async def test_create_file_item_error_response(self, mock_credential): mock_response = MockResponse(status=400, text="Bad Request") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response input_data = CreateFileItemInput() with pytest.raises(ConnectorException) as exc_info: - await client.create_file_item_async( + await client.create_file_item( input=input_data, source="me", drive="drive-1", @@ -216,12 +220,12 @@ async def test_create_word_file_success(self, mock_credential): ) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response input_data = ContentBody(content="Hello World document content") - result = await client.create_word_file_with_content_async( + result = await client.create_word_file_with_content( input=input_data, file_name="test.docx" ) @@ -247,12 +251,12 @@ async def test_create_word_file_without_filename(self, mock_credential): ) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response input_data = ContentBody(content="Document content") - result = await client.create_word_file_with_content_async(input=input_data) + result = await client.create_word_file_with_content(input=input_data) call_args = mock_send.call_args assert "fileName=" not in call_args[0][1] @@ -269,12 +273,12 @@ async def test_create_word_file_empty_response(self, mock_credential): mock_response = MockResponse(status=200, text="") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response input_data = ContentBody(content="Content") - result = await client.create_word_file_with_content_async(input=input_data) + result = await client.create_word_file_with_content(input=input_data) assert result is None @@ -289,13 +293,13 @@ async def test_create_word_file_error_response(self, mock_credential): mock_response = MockResponse(status=500, text="Internal Server Error") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response input_data = ContentBody(content="Content") with pytest.raises(ConnectorException) as exc_info: - await client.create_word_file_with_content_async(input=input_data) + await client.create_word_file_with_content(input=input_data) assert exc_info.value.status_code == 500 @@ -313,12 +317,12 @@ async def test_create_word_file_with_special_characters_in_name(self, mock_crede ) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response input_data = ContentBody(content="Content") - await client.create_word_file_with_content_async( + await client.create_word_file_with_content( input=input_data, file_name="my document.docx" ) @@ -345,11 +349,11 @@ async def test_convert_to_pdf_success(self, mock_credential): ) with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.get_file_pdf_async( + result = await client.get_file_pdf( source="me", drive="drive-1", file="file-1" @@ -373,11 +377,11 @@ async def test_convert_to_pdf_with_sensitivity_label(self, mock_credential): mock_response = MockResponse(status=200, text="PDF_CONTENT") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.get_file_pdf_async( + await client.get_file_pdf( source="me", drive="drive-1", file="file-1", @@ -400,11 +404,11 @@ async def test_convert_to_pdf_empty_response(self, mock_credential): mock_response = MockResponse(status=200, text="") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - result = await client.get_file_pdf_async( + result = await client.get_file_pdf( source="me", drive="drive-1", file="file-1" @@ -423,12 +427,12 @@ async def test_convert_to_pdf_error_response(self, mock_credential): mock_response = MockResponse(status=404, text="File not found") with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response with pytest.raises(ConnectorException) as exc_info: - await client.get_file_pdf_async( + await client.get_file_pdf( source="me", drive="drive-1", file="file-1" @@ -447,11 +451,11 @@ async def test_get_drives_injects_personal_source(self, mock_credential): mock_response = MockResponse(status=200, text='{"value": []}') with patch.object( - client._http_client, 'send_async', new_callable=AsyncMock + client._http_client, 'send', new_callable=AsyncMock ) as mock_send: mock_send.return_value = mock_response - await client.get_drives_async() + await resolve_generated_result(client.list_drives()) call_args = mock_send.call_args assert "source=me" in call_args[0][1] @@ -473,10 +477,10 @@ def test_create_file_item_input_with_values(self): assert input_data.additional_properties["field1"] == "value1" assert input_data.additional_properties["templateId"] == "abc123" - def test_content_body_defaults(self): - """Test ContentBody default values.""" - body = ContentBody() - assert body.content is None + def test_content_body_required_content(self): + """Test ContentBody requires document content.""" + body = model_instance(ContentBody) + assert body.content == "value" def test_content_body_with_content(self): """Test ContentBody with content.""" diff --git a/tests/test_wordpress.py b/tests/test_wordpress.py index 7fca2788..56c01807 100644 --- a/tests/test_wordpress.py +++ b/tests/test_wordpress.py @@ -9,15 +9,16 @@ from azure.core.credentials import AzureKeyCredential import azure.connectors.wordpress as wordpress_module from azure.connectors.sdk import ConnectorException +from azure.connectors.wordpress import WordpressClient from azure.connectors.wordpress import ( CreatePostModel, TRIGGER_OPERATIONS, - WordpressClient, ) from tests.conftest import MockResponse from tests.generated_connector_test_utils import ( get_generated_operations, invoke_generated_operation, + resolve_generated_result, ) @@ -91,12 +92,17 @@ async def test_generated_operation_success_contract( "https://example.azure.com/connections/test", credential=mock_credential, ) + response_text = ( + '{"sites": [{"ok": true}]}' + if operation == "list_sites" + else '{"ok": true}' + ) with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, - return_value=MockResponse(status=200, text='{"ok": true}'), + return_value=MockResponse(status=200, text=response_text), ) as mock_send: result = await invoke_generated_operation(client, operation, wordpress_module) @@ -104,7 +110,8 @@ async def test_generated_operation_success_contract( assert method == expected_method assert url.endswith(expected_url_suffix) assert (mock_send.call_args.kwargs["body"] is not None) is expects_body - assert result == {"ok": True} + expected_result = [{"ok": True}] if operation == "list_sites" else {"ok": True} + assert result == expected_result @pytest.mark.asyncio async def test_create_post_success(self, mock_credential): @@ -117,11 +124,11 @@ async def test_create_post_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=response, ) as mock_send: - result = await client.create_async( + result = await client.create( input=CreatePostModel(title="Generated SDK", content="Hello"), site_id="site/one", ) @@ -142,16 +149,16 @@ async def test_list_sites_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"sites": []}'), ) as mock_send: - result = await client.list_sites_async() + result = await resolve_generated_result(client.list_sites()) method, url = mock_send.call_args.args[:2] assert method == "GET" assert "/me/sites?fields=" in url - assert result == {"sites": []} + assert result == [] def test_trigger_metadata(self): """Test polling trigger metadata is registered instead of callable.""" @@ -176,7 +183,7 @@ async def test_non_success_response_raises_exception( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=400, text="bad request"), ): diff --git a/tests/test_yammer.py b/tests/test_yammer.py index 83407754..25c949a6 100644 --- a/tests/test_yammer.py +++ b/tests/test_yammer.py @@ -5,8 +5,8 @@ import pytest from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.yammer import YammerClient from azure.connectors.yammer import ( - YammerClient, Network, YammerEntity, User, @@ -22,7 +22,10 @@ ) from azure.connectors.sdk.serialization import to_wire from tests.conftest import MockResponse -from tests.generated_connector_test_utils import resolve_generated_result +from tests.generated_connector_test_utils import ( + model_instance, + resolve_generated_result, +) class TestYammerClientInitialization: @@ -64,7 +67,7 @@ def test_init_with_custom_settings(self, mock_credential): client = YammerClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -143,11 +146,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_networks_async() + result = await resolve_generated_result(client.list_networks()) mock_send.assert_called_once() call_args = mock_send.call_args @@ -168,12 +171,12 @@ async def test_error_response_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.get_networks_async() + await resolve_generated_result(client.list_networks()) assert exc_info.value.status_code == 401 @@ -196,11 +199,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_groups_async() + result = await resolve_generated_result(client.list_groups()) mock_send.assert_called_once() call_args = mock_send.call_args @@ -220,21 +223,21 @@ async def test_with_query_parameters(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_groups_async( + await resolve_generated_result(client.list_groups( network_id="net123", - mine="1", - show_all_company_group="true" - ) + mine=1, + show_all_company_group=1, + )) call_args = mock_send.call_args url = call_args[0][1] assert "network_id=net123" in url assert "mine=1" in url - assert "showAllCompanyGroup=true" in url + assert "showAllCompanyGroup=1" in url class TestGetUserDetailsById: @@ -255,11 +258,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - result = await client.get_user_details_by_id_async(user_id="12345") + result = await client.get_user_details_by_id(user_id="12345") mock_send.assert_called_once() call_args = mock_send.call_args @@ -283,11 +286,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.like_message_async(message_id="msg123") + await client.like_message(message_id="msg123") mock_send.assert_called_once() call_args = mock_send.call_args @@ -314,11 +317,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - _ = await resolve_generated_result(client.get_all_messages_async()) + _ = await resolve_generated_result(client.list_all_messages()) mock_send.assert_called_once() call_args = mock_send.call_args @@ -337,11 +340,11 @@ async def test_with_pagination_params(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await resolve_generated_result(client.get_all_messages_async( + await resolve_generated_result(client.list_all_messages( network_id="net123", older_than="100", newer_than="50", @@ -376,11 +379,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - _ = await resolve_generated_result(client.get_messages_following_async()) + _ = await resolve_generated_result(client.list_messages_following()) mock_send.assert_called_once() call_args = mock_send.call_args @@ -406,11 +409,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - _ = await resolve_generated_result(client.get_messages_in_group_async(group_id="123")) + _ = await resolve_generated_result(client.list_messages_in_group(group_id="123")) mock_send.assert_called_once() call_args = mock_send.call_args @@ -436,11 +439,11 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - _ = await resolve_generated_result(client.get_messages_in_thread_async(thread_id="456")) + _ = await resolve_generated_result(client.list_messages_in_thread(thread_id="456")) mock_send.assert_called_once() call_args = mock_send.call_args @@ -480,9 +483,13 @@ async def test_success(self, mock_credential): mock_response = MockResponse( status=201, - text='{"id": 789, "content_excerpt": "New message"}' + text=( + '{"messages": [{"id": 789, ' + '"content_excerpt": "New message"}]}' + ), ) - message_input = PostOperationRequest( + message_input = model_instance( + PostOperationRequest, group_id=123, body="Hello Yammer!", title="Test Post" @@ -490,11 +497,13 @@ async def test_success(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - _ = await client.post_message_async(input=message_input) + _ = await resolve_generated_result( + client.post_message(input=message_input) + ) mock_send.assert_called_once() call_args = mock_send.call_args @@ -509,19 +518,22 @@ async def test_with_network_id(self, mock_credential): credential=mock_credential ) - mock_response = MockResponse(status=201, text='{"id": 789}') - message_input = PostOperationRequest(body="Hello!") + mock_response = MockResponse( + status=201, + text='{"messages": [{"id": 789}]}', + ) + message_input = model_instance(PostOperationRequest, body="Hello!") with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.post_message_async( + await resolve_generated_result(client.post_message( input=message_input, - network_id="net123" - ) + network_id="net123", + )) call_args = mock_send.call_args url = call_args[0][1] @@ -538,16 +550,18 @@ async def test_error_response_raises_exception(self, mock_credential): mock_response = MockResponse( status=403, text='{"error": "Not authorized to post"}' ) - message_input = PostOperationRequest(body="Test") + message_input = model_instance(PostOperationRequest, body="Test") with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await client.post_message_async(input=message_input) + await resolve_generated_result( + client.post_message(input=message_input) + ) assert exc_info.value.status_code == 403 @@ -643,7 +657,8 @@ def test_liked_by(self): def test_post_operation_request(self): """Test PostOperationRequest dataclass creation.""" - request = PostOperationRequest( + request = model_instance( + PostOperationRequest, group_id=123, body="Hello Yammer!", title="Announcement", @@ -656,7 +671,8 @@ def test_post_operation_request(self): def test_current_post_request_uses_swagger_wire_names(self): """Test the current post request preserves its Swagger keys.""" - request = PostOperationRequest( + request = model_instance( + PostOperationRequest, group_id=123, body="Hello Yammer!", replied_to_id=456, @@ -695,12 +711,12 @@ async def test_empty_response_returns_none(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): - result = await client.get_networks_async() - assert result is None + result = await resolve_generated_result(client.list_networks()) + assert result == [] @pytest.mark.asyncio async def test_multiple_consecutive_calls(self, mock_credential): @@ -714,12 +730,12 @@ async def test_multiple_consecutive_calls(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ) as mock_send: - await client.get_networks_async() - await client.get_groups_async() + await resolve_generated_result(client.list_networks()) + await resolve_generated_result(client.list_groups()) assert mock_send.call_count == 2 @@ -737,11 +753,11 @@ async def test_server_error_raises_exception(self, mock_credential): with patch.object( client._http_client, - 'send_async', + 'send', new_callable=AsyncMock, return_value=mock_response ): with pytest.raises(ConnectorException) as exc_info: - await resolve_generated_result(client.get_all_messages_async()) + await resolve_generated_result(client.list_all_messages()) assert exc_info.value.status_code == 500 diff --git a/tests/test_zendesk.py b/tests/test_zendesk.py index 20ba736f..6606250e 100644 --- a/tests/test_zendesk.py +++ b/tests/test_zendesk.py @@ -8,9 +8,9 @@ from unittest.mock import AsyncMock, patch from azure.core.credentials import AzureKeyCredential +from azure.connectors.zendesk import ZendeskClient from azure.connectors.zendesk import ( Item, - ZendeskClient, TRIGGER_OPERATIONS, ) from azure.connectors.sdk import ( @@ -22,22 +22,24 @@ async def _invoke_operation(client: ZendeskClient, operation: str): """Invoke a Zendesk operation by name for shared tests.""" - if operation == "get_tables": - return await client.get_tables_async() - if operation == "get_items": - return await resolve_generated_result(client.get_items_async(table="tickets")) + if operation == "list_tables": + return await resolve_generated_result(client.list_tables()) + if operation == "list_items": + return await resolve_generated_result(client.list_items(table="tickets")) if operation == "post_item": - return await client.post_item_async(input=Item(), table="tickets") + return await client.post_item(input=Item(), table="tickets") if operation == "get_item": - return await client.get_item_async(table="tickets", id="1") + return await client.get_item(table="tickets", id="1") if operation == "delete_item": - return await client.delete_item_async(table="tickets", id="1") + return await client.delete_item(table="tickets", id="1") if operation == "patch_item": - return await client.patch_item_async(input=Item(), table="tickets", id="1") - if operation == "search_articles": - return await client.search_articles_async(query="password") + return await client.patch_item(input=Item(), table="tickets", id="1") + if operation == "list_search_articles": + return await resolve_generated_result( + client.list_search_articles(query="password") + ) if operation == "get_table": - return await client.get_table_async(table="tickets") + return await client.get_table(table="tickets") raise ValueError(f"Unsupported operation '{operation}'.") @@ -75,7 +77,7 @@ def test_init_with_custom_settings(self, mock_credential): client = ZendeskClient( "https://example.azure.com/connections/test", credential=mock_credential, - timeout_seconds=60.0, + timeout=60.0, max_retry_attempts=5, ) assert client._http_client._timeout_seconds == 60.0 @@ -142,13 +144,13 @@ async def test_get_tables_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_tables_async() + result = await resolve_generated_result(client.list_tables()) - assert result["value"][0]["name"] == "tickets" + assert result == [{"name": "tickets"}] assert mock_send.call_args[0][0] == "GET" assert "/datasets/default/tables" in mock_send.call_args[0][1] @@ -163,11 +165,11 @@ async def test_get_items_includes_query_params(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await resolve_generated_result(client.get_items_async( + await resolve_generated_result(client.list_items( table="tickets", filter="status eq 'open'", top="10", @@ -191,11 +193,11 @@ async def test_post_item_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.post_item_async(input=body, table="tickets") + result = await client.post_item(input=body, table="tickets") assert result["dynamic_properties"]["id"] == 1 assert mock_send.call_args[0][0] == "POST" @@ -213,11 +215,11 @@ async def test_get_item_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_item_async(table="tickets", id="42") + result = await client.get_item(table="tickets", id="42") assert result["dynamic_properties"]["id"] == 42 assert mock_send.call_args[0][0] == "GET" @@ -234,11 +236,11 @@ async def test_delete_item_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.delete_item_async(table="tickets", id="42") + result = await client.delete_item(table="tickets", id="42") assert result is None assert mock_send.call_args[0][0] == "DELETE" @@ -256,11 +258,11 @@ async def test_patch_item_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.patch_item_async(input=body, table="tickets", id="42") + result = await client.patch_item(input=body, table="tickets", id="42") assert result["dynamic_properties"]["id"] == 42 assert mock_send.call_args[0][0] == "PATCH" @@ -278,17 +280,21 @@ async def test_search_articles_includes_query_params(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - await client.search_articles_async(query="password reset", locale="en-us") + result = await resolve_generated_result(client.list_search_articles( + query="password reset", + locale="en-us", + )) request_url = mock_send.call_args[0][1] assert mock_send.call_args[0][0] == "GET" assert "/api/v2/help_center/articles/search" in request_url assert "query=password%20reset" in request_url assert "locale=en-us" in request_url + assert result == [] @pytest.mark.asyncio async def test_get_table_success(self, mock_credential): @@ -301,11 +307,11 @@ async def test_get_table_success(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ) as mock_send: - result = await client.get_table_async(table="tickets") + result = await client.get_table(table="tickets") assert result["name"] == "tickets" assert mock_send.call_args[0][0] == "GET" @@ -322,13 +328,13 @@ async def test_get_tables_empty_returns_none(self, mock_credential): with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): - result = await client.get_tables_async() + result = await resolve_generated_result(client.list_tables()) - assert result is None + assert result == [] class TestZendeskClientErrorHandling: @@ -338,13 +344,13 @@ class TestZendeskClientErrorHandling: @pytest.mark.parametrize( "operation", [ - "get_tables", - "get_items", + "list_tables", + "list_items", "post_item", "get_item", "delete_item", "patch_item", - "search_articles", + "list_search_articles", "get_table", ], ) @@ -362,7 +368,7 @@ async def test_error_response_raises_exception_for_all_operations( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=mock_response, ): @@ -375,14 +381,14 @@ class TestZendeskClientSignatures: def test_search_articles_query_required_and_annotated_str(self): """Test the query parameter is required and annotated as str, not Optional.""" - signature = inspect.signature(ZendeskClient.search_articles_async) + signature = inspect.signature(ZendeskClient.list_search_articles) assert signature.parameters["query"].default is inspect.Parameter.empty assert signature.parameters["query"].annotation == "str" def test_search_articles_optional_params_default_to_none(self): """Test optional search params default to None.""" - signature = inspect.signature(ZendeskClient.search_articles_async) + signature = inspect.signature(ZendeskClient.list_search_articles) assert signature.parameters["locale"].default is None @@ -395,19 +401,19 @@ async def test_search_articles_missing_query_raises_type_error(self, mock_creden ) with pytest.raises(TypeError): - await client.search_articles_async() + await resolve_generated_result(client.list_search_articles()) @pytest.mark.parametrize( "method_name", [ - "get_tables_async", - "get_items_async", - "post_item_async", - "get_item_async", - "delete_item_async", - "patch_item_async", - "search_articles_async", - "get_table_async", + "list_tables", + "list_items", + "post_item", + "get_item", + "delete_item", + "patch_item", + "list_search_articles", + "get_table", ], ) def test_public_methods_have_return_annotation(self, method_name): @@ -416,7 +422,7 @@ def test_public_methods_have_return_annotation(self, method_name): assert signature.return_annotation is not inspect.Signature.empty assert signature.return_annotation in ( - "AsyncIterator[dict[str, Any]]", + "AsyncItemPaged[dict[str, Any]]", "dict[str, Any] | None", "None", ) diff --git a/tests/test_zeptomail.py b/tests/test_zeptomail.py index a8227b17..69a8b8d3 100644 --- a/tests/test_zeptomail.py +++ b/tests/test_zeptomail.py @@ -2,19 +2,22 @@ """Contract tests for ZeptomailClient.""" -from typing import Any, Dict, List, Optional, get_type_hints +from typing import Any, Dict, List, Mapping, Optional, get_type_hints from unittest.mock import AsyncMock, patch import azure.connectors.zeptomail as zeptomail_module import pytest +from azure.connectors.zeptomail import ZeptomailClient from azure.connectors.zeptomail import ( ReplyToAddress, SendMailInput, SendTemplateMailInput, - ZeptomailClient, ) from azure.connectors.sdk.serialization import to_wire -from tests.generated_connector_test_utils import GeneratedConnectorContractTests +from tests.generated_connector_test_utils import ( + GeneratedConnectorContractTests, + model_instance, +) from tests.conftest import MockResponse @@ -42,7 +45,8 @@ async def test_send_template_mail_preserves_mixed_values( ) -> None: """Test the template-mail request serializes mixed merge values unchanged.""" type_hints = get_type_hints(SendTemplateMailInput) - model = SendTemplateMailInput( + model = model_instance( + SendTemplateMailInput, merge_key_detail=[{"key": "customer", "value": "Ada", "rank": 2}] ) client = ZeptomailClient( @@ -52,11 +56,11 @@ async def test_send_template_mail_preserves_mixed_values( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"ok": true}'), ) as mock_send: - result = await client.send_template_mail_async(model) + result = await client.send_template_mail(model) assert type_hints["merge_key_detail"] == Optional[List[Dict[str, Any]]] mock_send.assert_awaited_once_with( @@ -77,7 +81,7 @@ async def test_send_template_mail_preserves_mixed_values( def test_reply_to_uses_corrected_model_in_both_requests() -> None: """Test the corrected public type preserves both reply-to annotations.""" - expected_type = Optional[List[ReplyToAddress]] + expected_type = Optional[List[ReplyToAddress | Mapping[str, Any]]] assert get_type_hints(SendMailInput)["reply_to"] == expected_type assert get_type_hints(SendTemplateMailInput)["reply_to"] == expected_type @@ -105,11 +109,11 @@ async def test_get_processed_emails_uses_exact_encoded_query( with patch.object( client._http_client, - "send_async", + "send", new_callable=AsyncMock, return_value=MockResponse(status=200, text='{"data": []}'), ) as mock_send: - result = await client.get_processed_emails_async( + result = await client.get_processed_emails( mailagent_key="agent+key", subject="Quarterly report", from_="sender+alias@example.com", diff --git a/tests/test_zohosign.py b/tests/test_zohosign.py index 2374094e..e90df0b5 100644 --- a/tests/test_zohosign.py +++ b/tests/test_zohosign.py @@ -5,7 +5,8 @@ from typing import get_type_hints import azure.connectors.zohosign as zohosign_module -from azure.connectors.zohosign import ZohosignClient, TRIGGER_OPERATIONS +from azure.connectors.zohosign import ZohosignClient +from azure.connectors.zohosign import TRIGGER_OPERATIONS from tests.generated_connector_test_utils import GeneratedConnectorContractTests @@ -17,7 +18,7 @@ "get_document": ("GET", False), "get_form_data": ("GET", False), "get_template_details": ("GET", False), - "get_templates": ("GET", False), + "list_templates": ("GET", False), "invoke_api": ("POST", True), "recall_document": ("POST", False), "remind_document_recipients": ("POST", False), @@ -54,17 +55,17 @@ def test_document_identifiers_use_integer_annotations() -> None: ] for operation in integer_request_id_operations: - type_hints = get_type_hints(getattr(ZohosignClient, f"{operation}_async")) + type_hints = get_type_hints(getattr(ZohosignClient, f"{operation}")) assert type_hints["request_id"] is int, operation - download_file_hints = get_type_hints(ZohosignClient.download_file_async) + download_file_hints = get_type_hints(ZohosignClient.download_file) assert download_file_hints["document_id"] is int for operation in ["send_sign_request", "update_document"]: - type_hints = get_type_hints(getattr(ZohosignClient, f"{operation}_async")) + type_hints = get_type_hints(getattr(ZohosignClient, f"{operation}")) assert type_hints["request_id"] is str, operation def test_multipart_create_document_is_not_generated() -> None: """Test the unsupported multipart operation is excluded.""" - assert not hasattr(ZohosignClient, "create_document_async") + assert not hasattr(ZohosignClient, "create_document")