anaplan-sdk 0.4.2__tar.gz → 0.4.3__tar.gz

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.4.2
+Version: 0.4.3
 Summary: Streamlined Python Interface for Anaplan
 Project-URL: Homepage, https://vinzenzklass.github.io/anaplan-sdk/
 Project-URL: Repository, https://github.com/VinzenzKlass/anaplan-sdk

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/anaplan_sdk/models/_bulk.py

@@ -145,10 +145,10 @@ class TaskSummary(AnaplanModel):
 
 
 class TaskResultDetail(AnaplanModel):
-    local_message_text: str = Field(description="Error message text.")
+    local_message_text: str | None = Field(None, description="Error message text.")
     occurrences: int = Field(0, description="The number of occurrences of this error.")
     type: str = Field(description="The type of this error.")
-    values: list[str] = Field([], description="Further error information if available.")
+    values: list[str | None] = Field([], description="Further error information if available.")
 
 
 class TaskResult(AnaplanModel):

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/docs/api/async/async_alm_client.md

@@ -3,3 +3,9 @@
     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/alm.md).
 
 ::: anaplan_sdk._async_clients._AsyncAlmClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/docs/api/async/async_audit_client.md

@@ -3,3 +3,9 @@
     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/audit.md).
 
 ::: anaplan_sdk._async_clients._AsyncAuditClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3/docs/api/async/async_client.md

@@ -0,0 +1,9 @@
+# Bulk API Client (`AsyncClient`)
+
+::: anaplan_sdk.AsyncClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/docs/api/async/async_cw_client.md

@@ -3,3 +3,9 @@
     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
 
 ::: anaplan_sdk._async_clients._AsyncCloudWorksClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/docs/api/async/async_flows_client.md

@@ -3,3 +3,9 @@
     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
 
 ::: anaplan_sdk._async_clients._cw_flow._AsyncFlowClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3/docs/api/async/async_transactional_client.md

@@ -0,0 +1,11 @@
+???+ note
+     This Class is not meant to be instantiated directly, but rather accessed through the `transactional` Property on an
+     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/transactional.md).
+
+::: anaplan_sdk._async_clients._AsyncTransactionalClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3/docs/api/exceptions.md

@@ -0,0 +1,9 @@
+::: anaplan_sdk.exceptions
+    options:
+        show_bases: true
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3/docs/api/models/alm.md

@@ -0,0 +1,7 @@
+::: anaplan_sdk.models._alm
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3/docs/api/models/bulk.md

@@ -0,0 +1,7 @@
+::: anaplan_sdk.models._bulk
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3/docs/api/models/cloud_works.md

@@ -0,0 +1,7 @@
+::: anaplan_sdk.models.cloud_works
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3/docs/api/models/flows.md

@@ -0,0 +1,7 @@
+::: anaplan_sdk.models.flows
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3/docs/api/models/transactional.md

@@ -0,0 +1,7 @@
+::: anaplan_sdk.models._transactional
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/docs/api/sync/sync_alm_client.md

@@ -3,3 +3,9 @@
     instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/alm.md).
 
 ::: anaplan_sdk._clients._AlmClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/docs/api/sync/sync_audit_client.md

@@ -3,3 +3,9 @@
     instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/audit.md).
 
 ::: anaplan_sdk._clients._AuditClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

anaplan_sdk-0.4.3/docs/api/sync/sync_client.md

@@ -0,0 +1,9 @@
+# Bulk API Client (`Client`)
+
+::: anaplan_sdk.Client
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/docs/api/sync/sync_cw_client.md

@@ -3,3 +3,9 @@
     instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
 
 ::: anaplan_sdk._async_clients._AsyncCloudWorksClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/docs/api/sync/sync_flows_client.md

@@ -3,3 +3,9 @@
     instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
 
 ::: anaplan_sdk._async_clients._cw_flow._AsyncFlowClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/docs/api/sync/sync_transactional_client.md

@@ -3,3 +3,9 @@
     instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/transactional.md).
 
 ::: anaplan_sdk._clients._TransactionalClient
+
+<style>
+    [data-md-component="toc"] li:first-of-type{
+        display:  none!important;
+    }
+</style>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/docs/guides/index.md

@@ -16,6 +16,6 @@ respective Guides to get started with each API.
 - [__CloudWorks API__](cloud_works.md) for orchestrating and automating your Anaplan processes
 - [__ALM API__](alm.md) for managing your Anaplan assets and their lifecycle
 - [__Audit API__](audit.md) for tracking changes and maintaining compliance
-- The Auth APIs are used internally by the SDK to automatically manage authentication.
+- [__Auth APIs__](authentication.md) are used internally by the SDK to automatically manage authentication.
 
 </div>

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/docs/quickstart.md

@@ -56,7 +56,7 @@ common practice.
     files, processes = await gather(anaplan.list_files(), anaplan.list_processes())
     ```
 ??? info "Output"
-    Models used in this Example: [File](api/models.md#anaplan_sdk.models.File), [Process](api/models.md#anaplan_sdk.models.Process).
+    Models used in this Example: [File](api/models/bulk.md#anaplan_sdk.models._bulk.File), [Process](api/models/bulk.md#anaplan_sdk.models._bulk.Process).
     ```python
     [
         File(
@@ -90,7 +90,7 @@ With these two, you're ready to run your first import.
     )
     ```
     
-This will upload the file to Anaplan, trigger the process task, wait for the completion of the task and validate the task result. You can see the details of the task by inspecting the [TaskResult](api/models.md#anaplan_sdk.models.TaskResult).
+This will upload the file to Anaplan, trigger the process task, wait for the completion of the task and validate the task result. You can see the details of the task by inspecting the [TaskResult](api/models/bulk.md#anaplan_sdk.models._bulk.TaskResult).
 
 ## Exporting Data
 
@@ -105,7 +105,7 @@ Conversely, for exporting data, we start by listing the available exports.
     exports = await anaplan.list_exports()
     ```
 ??? info "Output"
-    Models used in this Example: [Export](api/models.md#anaplan_sdk.models.Export).
+    Models used in this Example: [Export](api/models/bulk.md#anaplan_sdk.models._bulk.Export).
     ```python
     [
         Export(

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/mkdocs.yml

@@ -1,5 +1,5 @@
 site_name: Anaplan SDK
-site_description: Provides pythonic access to the Anaplan API.
+site_description: Streamlined Python Interface for Anaplan
 site_url: https://vinzenzklass.github.io/anaplan-sdk/
 repo_name: VinzenzKlass/anaplan-sdk
 repo_url: https://github.com/VinzenzKlass/anaplan-sdk
@@ -24,6 +24,7 @@ theme:
     - content.code.copy
     - content.tabs.link
     - search.suggest
+    - navigation.instant
     - navigation.tabs
     - navigation.top
 
@@ -64,7 +65,12 @@ nav:
           - CloudWorks:
               - Client: 'api/sync/sync_cw_client.md'
               - Flows: 'api/sync/sync_flows_client.md'
-      - Models: 'api/models.md'
+      - Models:
+         - ALM: 'api/models/alm.md'
+         - Bulk: 'api/models/bulk.md'
+         - CloudWorks: 'api/models/cloud_works.md'
+         - Flows: 'api/models/flows.md'
+         - Transactional: 'api/models/transactional.md'
       - Exceptions: 'api/exceptions.md'
   - Concepts:
       - Anaplan Basics: 'anaplan_explained.md'

{anaplan_sdk-0.4.2 → anaplan_sdk-0.4.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "anaplan-sdk"
-version = "0.4.2"
+version = "0.4.3"
 description = "Streamlined Python Interface for Anaplan"
 license = "Apache-2.0"
 authors = [{ name = "Vinzenz Klass", email = "vinzenz.klass@valantic.com" }]