bellator-si 0.4.0__tar.gz

bellator_si-0.4.0/PKG-INFO

@@ -0,0 +1,534 @@
+Metadata-Version: 2.4
+Name: bellator_si
+Version: 0.4.0
+Summary: Bellator Schedule Intelligence APIs
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: OpenAPI Generator Community <team@openapitools.org>
+Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
+Keywords: OpenAPI,OpenAPI-Generator,Bellator Schedule Intelligence APIs
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+
+# bellator-si-python
+
+    Bellator Schedule Intelligence APIs - Stateless Schedule Health APIs
+
+    ## Features
+
+    * **Schedule Analysis** - Comprehensive schedule health analysis
+    * **Critical Path** - CPM-based critical path calculation
+    * **Validation** - Schedule validation and quality checks
+    * **Future: Resource Management** - Resource allocation and leveling
+    * **Future: Simulation** - Monte Carlo and what-if analysis
+    * **Future: AI Recommendations** - LLM-powered optimization suggestions
+
+    ## Authentication
+
+    API key authentication via `x-api-key` header or OAuth 2.0 Bearer token via `Authorization` header.
+
+    ### API Key Authentication (Legacy)
+    Include API key in `x-api-key` header.
+
+    ### OAuth 2.0 / Azure AD Authentication (Recommended)
+    Include Bearer token in `Authorization` header: `Authorization: Bearer <token>`
+
+    Tiers:
+    - **Free**: 2,000 tasks, 100 req/min, 5MB payload
+    - **Professional**: 5,000 tasks, 500 req/min, 25MB payload
+    - **Enterprise**: 50,000 tasks, 2,000 req/min, 100MB payload
+    - **Government**: 100,000+ tasks, 10,000 req/min, 500MB payload
+
+    ## Usage Metering
+
+    All API requests are metered and tracked for:
+    - Request duration (milliseconds)
+    - Task count processed
+    - Token consumption (for LLM operations)
+    - Estimated cost (USD)
+
+    Metering events are emitted to logs and can be integrated with billing systems.
+
+    ## Security
+
+    * Tier-based task limits (500-100,000 tasks per request)
+    * Tier-based payload limits (5-500 MB)
+    * Input validation and sanitization
+    * Tier-based rate limiting (100-10,000 requests per 60 seconds)
+    
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.4.0
+- Package version: 0.4.0
+- Generator version: 7.18.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.9+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import bellator_si
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import bellator_si
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import bellator_si
+from bellator_si.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.bellatorsi.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = bellator_si.Configuration(
+    host = "https://api.bellatorsi.com"
+)
+
+
+
+# Enter a context with an instance of the API client
+with bellator_si.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = bellator_si.APIKeysApi(api_client)
+
+    try:
+        # Generate Agent Ephemeral Key
+        api_response = api_instance.generate_agent_key_api_v1_keys_ephemeral_generate_agent_post()
+        print("The response of APIKeysApi->generate_agent_key_api_v1_keys_ephemeral_generate_agent_post:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling APIKeysApi->generate_agent_key_api_v1_keys_ephemeral_generate_agent_post: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.bellatorsi.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*APIKeysApi* | [**generate_agent_key_api_v1_keys_ephemeral_generate_agent_post**](docs/APIKeysApi.md#generate_agent_key_api_v1_keys_ephemeral_generate_agent_post) | **POST** /api/v1/keys/ephemeral/generate/agent | Generate Agent Ephemeral Key
+*APIKeysApi* | [**generate_ephemeral_key_api_v1_keys_ephemeral_generate_post**](docs/APIKeysApi.md#generate_ephemeral_key_api_v1_keys_ephemeral_generate_post) | **POST** /api/v1/keys/ephemeral/generate | Generate Ephemeral API Key
+*APIKeysApi* | [**get_key_info_api_v1_keys_ephemeral_info_get**](docs/APIKeysApi.md#get_key_info_api_v1_keys_ephemeral_info_get) | **GET** /api/v1/keys/ephemeral/info | Get Key Usage Info
+*APIKeysApi* | [**revoke_key_api_v1_keys_ephemeral_revoke_delete**](docs/APIKeysApi.md#revoke_key_api_v1_keys_ephemeral_revoke_delete) | **DELETE** /api/v1/keys/ephemeral/revoke | Revoke Ephemeral Key
+*AccountApi* | [**get_account_tier_api_v1_account_tier_get**](docs/AccountApi.md#get_account_tier_api_v1_account_tier_get) | **GET** /api/v1/account/tier | Get current API tier and limits
+*AnalysisApi* | [**analysis_cpm**](docs/AnalysisApi.md#analysis_cpm) | **POST** /api/v1/analysis/cpm | Calculate Critical Path
+*AnalysisApi* | [**analysis_cpm_async**](docs/AnalysisApi.md#analysis_cpm_async) | **POST** /api/v1/analysis/cpm/async | Calculate Critical Path (Async)
+*AnalysisApi* | [**analysis_resources**](docs/AnalysisApi.md#analysis_resources) | **POST** /api/v1/analysis/resources | Resource Analysis
+*AnalysisApi* | [**analysis_resources_async**](docs/AnalysisApi.md#analysis_resources_async) | **POST** /api/v1/analysis/resources/async | Resource Analysis (Async)
+*AnalysisApi* | [**analysis_validate**](docs/AnalysisApi.md#analysis_validate) | **POST** /api/v1/analysis/validate | Validate Schedule
+*AuthenticationApi* | [**create_api_key_api_v1_auth_keys_post**](docs/AuthenticationApi.md#create_api_key_api_v1_auth_keys_post) | **POST** /api/v1/auth/keys | Create Api Key
+*AuthenticationApi* | [**delete_account_api_v1_auth_account_delete**](docs/AuthenticationApi.md#delete_account_api_v1_auth_account_delete) | **DELETE** /api/v1/auth/account | Delete Account
+*AuthenticationApi* | [**get_user_profile_api_v1_auth_profile_get**](docs/AuthenticationApi.md#get_user_profile_api_v1_auth_profile_get) | **GET** /api/v1/auth/profile | Get User Profile
+*AuthenticationApi* | [**list_api_keys_api_v1_auth_keys_get**](docs/AuthenticationApi.md#list_api_keys_api_v1_auth_keys_get) | **GET** /api/v1/auth/keys | List Api Keys
+*AuthenticationApi* | [**oauth_callback_api_v1_auth_callback_get**](docs/AuthenticationApi.md#oauth_callback_api_v1_auth_callback_get) | **GET** /api/v1/auth/callback | Oauth Callback
+*AuthenticationApi* | [**options_delete_account_api_v1_auth_account_options**](docs/AuthenticationApi.md#options_delete_account_api_v1_auth_account_options) | **OPTIONS** /api/v1/auth/account | Options Delete Account
+*AuthenticationApi* | [**options_keys_api_v1_auth_keys_options**](docs/AuthenticationApi.md#options_keys_api_v1_auth_keys_options) | **OPTIONS** /api/v1/auth/keys | Options Keys
+*AuthenticationApi* | [**options_revoke_key_api_v1_auth_keys_key_id_options**](docs/AuthenticationApi.md#options_revoke_key_api_v1_auth_keys_key_id_options) | **OPTIONS** /api/v1/auth/keys/{key_id} | Options Revoke Key
+*AuthenticationApi* | [**revoke_api_key_api_v1_auth_keys_key_id_delete**](docs/AuthenticationApi.md#revoke_api_key_api_v1_auth_keys_key_id_delete) | **DELETE** /api/v1/auth/keys/{key_id} | Revoke Api Key
+*AuthenticationApi* | [**signup_user_api_v1_auth_signup_post**](docs/AuthenticationApi.md#signup_user_api_v1_auth_signup_post) | **POST** /api/v1/auth/signup | Signup User
+*AuthenticationApi* | [**update_api_key_label_api_v1_auth_keys_key_id_label_patch**](docs/AuthenticationApi.md#update_api_key_label_api_v1_auth_keys_key_id_label_patch) | **PATCH** /api/v1/auth/keys/{key_id}/label | Update Api Key Label
+*BillingApi* | [**azure_marketplace_webhook_api_v1_billing_azure_marketplace_webhook_post**](docs/BillingApi.md#azure_marketplace_webhook_api_v1_billing_azure_marketplace_webhook_post) | **POST** /api/v1/billing/azure-marketplace/webhook | Azure Marketplace Webhook
+*BillingApi* | [**azure_marketplace_webhook_api_v1_billing_azure_marketplace_webhook_post_0**](docs/BillingApi.md#azure_marketplace_webhook_api_v1_billing_azure_marketplace_webhook_post_0) | **POST** /api/v1/billing/azure-marketplace/webhook | Azure Marketplace Webhook
+*BillingApi* | [**create_checkout_session_api_v1_billing_checkout_post**](docs/BillingApi.md#create_checkout_session_api_v1_billing_checkout_post) | **POST** /api/v1/billing/checkout | Create Stripe Checkout Session for Starter tier
+*BillingApi* | [**create_portal_session_api_v1_billing_portal_post**](docs/BillingApi.md#create_portal_session_api_v1_billing_portal_post) | **POST** /api/v1/billing/portal | Create Stripe Customer Portal Session
+*BillingApi* | [**export_overage_settlement_api_v1_billing_settlement_overage_export_get**](docs/BillingApi.md#export_overage_settlement_api_v1_billing_settlement_overage_export_get) | **GET** /api/v1/billing/settlement/overage-export | Export Overage Settlement
+*BillingApi* | [**export_overage_settlement_api_v1_billing_settlement_overage_export_get_0**](docs/BillingApi.md#export_overage_settlement_api_v1_billing_settlement_overage_export_get_0) | **GET** /api/v1/billing/settlement/overage-export | Export Overage Settlement
+*BillingApi* | [**reconcile_checkout_session_api_v1_billing_checkout_reconcile_post**](docs/BillingApi.md#reconcile_checkout_session_api_v1_billing_checkout_reconcile_post) | **POST** /api/v1/billing/checkout/reconcile | Reconcile completed Stripe checkout session
+*ContactFormApi* | [**get_email_diagnostics_api_v1_contact_email_diagnostics_get**](docs/ContactFormApi.md#get_email_diagnostics_api_v1_contact_email_diagnostics_get) | **GET** /api/v1/contact/email/diagnostics | Get contact email diagnostics
+*ContactFormApi* | [**get_submission_types_api_v1_contact_submission_types_get**](docs/ContactFormApi.md#get_submission_types_api_v1_contact_submission_types_get) | **GET** /api/v1/contact/submission-types | Get available submission types
+*ContactFormApi* | [**get_waitlist_types_api_v1_contact_waitlist_types_get**](docs/ContactFormApi.md#get_waitlist_types_api_v1_contact_waitlist_types_get) | **GET** /api/v1/contact/waitlist-types | Get available waitlist types
+*ContactFormApi* | [**submit_contact_form_api_v1_contact_submit_post**](docs/ContactFormApi.md#submit_contact_form_api_v1_contact_submit_post) | **POST** /api/v1/contact/submit | Submit contact form
+*FeedbackApi* | [**submit_page_feedback_api_v1_feedback_page_post**](docs/FeedbackApi.md#submit_page_feedback_api_v1_feedback_page_post) | **POST** /api/v1/feedback/page | Submit docs page helpfulness feedback
+*FeedbackApi* | [**submit_playground_feedback_api_v1_feedback_post**](docs/FeedbackApi.md#submit_playground_feedback_api_v1_feedback_post) | **POST** /api/v1/feedback | Submit playground feedback
+*ForensicsApi* | [**as_planned_vs_as_built_api_v1_forensics_as_planned_vs_as_built_post**](docs/ForensicsApi.md#as_planned_vs_as_built_api_v1_forensics_as_planned_vs_as_built_post) | **POST** /api/v1/forensics/as-planned-vs-as-built | As-Planned vs. As-Built Comparison
+*ForensicsApi* | [**as_planned_vs_as_built_async_api_v1_forensics_as_planned_vs_as_built_async_post**](docs/ForensicsApi.md#as_planned_vs_as_built_async_api_v1_forensics_as_planned_vs_as_built_async_post) | **POST** /api/v1/forensics/as-planned-vs-as-built/async | As-Planned vs. As-Built Comparison (Async)
+*ForensicsApi* | [**baseline_compare_api_v1_forensics_baseline_compare_post**](docs/ForensicsApi.md#baseline_compare_api_v1_forensics_baseline_compare_post) | **POST** /api/v1/forensics/baseline-compare | Baseline Variance Analysis
+*ForensicsApi* | [**baseline_compare_async_api_v1_forensics_baseline_compare_async_post**](docs/ForensicsApi.md#baseline_compare_async_api_v1_forensics_baseline_compare_async_post) | **POST** /api/v1/forensics/baseline-compare/async | Baseline Variance Analysis (Async)
+*ForensicsApi* | [**change_tracking_api_v1_forensics_change_tracking_post**](docs/ForensicsApi.md#change_tracking_api_v1_forensics_change_tracking_post) | **POST** /api/v1/forensics/change-tracking | Time-Series Change Detection
+*ForensicsApi* | [**change_tracking_async_api_v1_forensics_change_tracking_async_post**](docs/ForensicsApi.md#change_tracking_async_api_v1_forensics_change_tracking_async_post) | **POST** /api/v1/forensics/change-tracking/async | Time-Series Change Detection (Async)
+*ForensicsApi* | [**delay_analysis_api_v1_forensics_delay_analysis_post**](docs/ForensicsApi.md#delay_analysis_api_v1_forensics_delay_analysis_post) | **POST** /api/v1/forensics/delay-analysis | Delay Attribution Analysis
+*ForensicsApi* | [**delay_analysis_async_api_v1_forensics_delay_analysis_async_post**](docs/ForensicsApi.md#delay_analysis_async_api_v1_forensics_delay_analysis_async_post) | **POST** /api/v1/forensics/delay-analysis/async | Delay Attribution Analysis (Async)
+*HealthApi* | [**health_check_health_get**](docs/HealthApi.md#health_check_health_get) | **GET** /health | Health Check
+*ImportApi* | [**import_mpp_api_v1_import_mpp_post**](docs/ImportApi.md#import_mpp_api_v1_import_mpp_post) | **POST** /api/v1/import/mpp | Import MS Project XML Schedule
+*ImportApi* | [**import_xer_api_v1_import_xer_post**](docs/ImportApi.md#import_xer_api_v1_import_xer_post) | **POST** /api/v1/import/xer | Import Primavera P6 XER Schedule
+*InfrastructureApi* | [**infrastructure_health_api_v1_infrastructure_health_get**](docs/InfrastructureApi.md#infrastructure_health_api_v1_infrastructure_health_get) | **GET** /api/v1/infrastructure/health | Infrastructure Health
+*InfrastructureApi* | [**redis_health_check_api_v1_infrastructure_health_redis_get**](docs/InfrastructureApi.md#redis_health_check_api_v1_infrastructure_health_redis_get) | **GET** /api/v1/infrastructure/health/redis | Redis Health Check
+*JobsApi* | [**cancel_async_job_api_v1_jobs_job_id_cancel_post**](docs/JobsApi.md#cancel_async_job_api_v1_jobs_job_id_cancel_post) | **POST** /api/v1/jobs/{job_id}/cancel | Cancel Job
+*JobsApi* | [**delete_job_api_v1_jobs_job_id_delete**](docs/JobsApi.md#delete_job_api_v1_jobs_job_id_delete) | **DELETE** /api/v1/jobs/{job_id} | Delete Job
+*JobsApi* | [**get_async_job_status_api_v1_jobs_job_id_get**](docs/JobsApi.md#get_async_job_status_api_v1_jobs_job_id_get) | **GET** /api/v1/jobs/{job_id} | Get Job Status
+*MCPApi* | [**invoke_tool_mcp_tools_tool_name_post**](docs/MCPApi.md#invoke_tool_mcp_tools_tool_name_post) | **POST** /mcp/tools/{tool_name} | Invoke Tool
+*MCPApi* | [**list_mcp_tools_mcp_tools_get**](docs/MCPApi.md#list_mcp_tools_mcp_tools_get) | **GET** /mcp/tools | List Mcp Tools
+*MCPApi* | [**mcp_streamable_delete_mcp_delete**](docs/MCPApi.md#mcp_streamable_delete_mcp_delete) | **DELETE** /mcp | Mcp Streamable Delete
+*MCPApi* | [**mcp_streamable_get_mcp_get**](docs/MCPApi.md#mcp_streamable_get_mcp_get) | **GET** /mcp | Mcp Streamable Get
+*MCPApi* | [**mcp_streamable_post_mcp_post**](docs/MCPApi.md#mcp_streamable_post_mcp_post) | **POST** /mcp | Mcp Streamable Post
+*ResourceManagementApi* | [**allocate_resources_api_v1_resources_allocate_post**](docs/ResourceManagementApi.md#allocate_resources_api_v1_resources_allocate_post) | **POST** /api/v1/resources/allocate | Allocate Resources (Placeholder)
+*ResourceManagementApi* | [**level_resources_api_v1_resources_level_post**](docs/ResourceManagementApi.md#level_resources_api_v1_resources_level_post) | **POST** /api/v1/resources/level | Resource Leveling (Placeholder)
+*RootApi* | [**root_get**](docs/RootApi.md#root_get) | **GET** / | Root
+*SandboxApi* | [**list_sandbox_fixtures_api_v1_sandbox_fixtures_get**](docs/SandboxApi.md#list_sandbox_fixtures_api_v1_sandbox_fixtures_get) | **GET** /api/v1/sandbox/fixtures | List Sandbox Fixtures
+*SimulationAnalysisApi* | [**run_monte_carlo_api_v1_simulation_monte_carlo_post**](docs/SimulationAnalysisApi.md#run_monte_carlo_api_v1_simulation_monte_carlo_post) | **POST** /api/v1/simulation/monte-carlo | Monte Carlo Simulation (Placeholder)
+*SimulationAnalysisApi* | [**run_what_if_api_v1_simulation_what_if_post**](docs/SimulationAnalysisApi.md#run_what_if_api_v1_simulation_what_if_post) | **POST** /api/v1/simulation/what-if | What-If Analysis (Placeholder)
+*UsageQuotaApi* | [**export_usage_api_v1_usage_export_get**](docs/UsageQuotaApi.md#export_usage_api_v1_usage_export_get) | **GET** /api/v1/usage/export | Export Usage
+*UsageQuotaApi* | [**get_key_usage_api_v1_usage_keys_key_id_get**](docs/UsageQuotaApi.md#get_key_usage_api_v1_usage_keys_key_id_get) | **GET** /api/v1/usage/keys/{key_id} | Get Key Usage
+*UsageQuotaApi* | [**get_my_usage_api_v1_usage_me_get**](docs/UsageQuotaApi.md#get_my_usage_api_v1_usage_me_get) | **GET** /api/v1/usage/me | Get My Usage
+*ComplianceApi* | [**get_compliance_metadata_api_v1_compliance_metadata_get**](docs/ComplianceApi.md#get_compliance_metadata_api_v1_compliance_metadata_get) | **GET** /api/v1/compliance/metadata | Get Compliance Metadata
+*ComplianceApi* | [**get_function_compliance_metadata_api_v1_compliance_metadata_function_name_get**](docs/ComplianceApi.md#get_function_compliance_metadata_api_v1_compliance_metadata_function_name_get) | **GET** /api/v1/compliance/metadata/{function_name} | Get Function Compliance Metadata
+*HealthApi* | [**calculate_health_score_api_v1_health_score_post**](docs/HealthApi.md#calculate_health_score_api_v1_health_score_post) | **POST** /api/v1/health/score | Calculate Schedule Health Score
+*HealthApi* | [**health_dcma14_point**](docs/HealthApi.md#health_dcma14_point) | **POST** /api/v1/health/dcma-14-point | DCMA 14-Point Assessment
+*HealthApi* | [**health_dcma14_point_async**](docs/HealthApi.md#health_dcma14_point_async) | **POST** /api/v1/health/dcma-14-point/async | DCMA 14-Point Assessment (Async)
+*HealthApi* | [**health_dcma_decm**](docs/HealthApi.md#health_dcma_decm) | **POST** /api/v1/health/dcma-decm | DCMA DECM Assessment
+*HealthApi* | [**health_dcma_decm_async**](docs/HealthApi.md#health_dcma_decm_async) | **POST** /api/v1/health/dcma-decm/async | DCMA DECM Assessment (Async)
+*HealthApi* | [**health_logic_audit**](docs/HealthApi.md#health_logic_audit) | **POST** /api/v1/health/logic-audit | Logic Audit
+*HealthApi* | [**health_logic_audit_async**](docs/HealthApi.md#health_logic_audit_async) | **POST** /api/v1/health/logic-audit/async | Logic Audit (Async)
+*HealthApi* | [**health_planning_horizon**](docs/HealthApi.md#health_planning_horizon) | **POST** /api/v1/health/planning-horizon | Planning Horizon
+*HealthApi* | [**health_planning_horizon_async**](docs/HealthApi.md#health_planning_horizon_async) | **POST** /api/v1/health/planning-horizon/async | Planning Horizon (Async)
+*HealthApi* | [**health_progress_audit**](docs/HealthApi.md#health_progress_audit) | **POST** /api/v1/health/progress-audit | Progress Audit
+*HealthApi* | [**health_progress_audit_async**](docs/HealthApi.md#health_progress_audit_async) | **POST** /api/v1/health/progress-audit/async | Progress Audit (Async)
+*HealthApi* | [**health_schedule_risk_index**](docs/HealthApi.md#health_schedule_risk_index) | **POST** /api/v1/health/schedule-risk-index | Schedule Risk Index
+*HealthApi* | [**health_schedule_risk_index_async**](docs/HealthApi.md#health_schedule_risk_index_async) | **POST** /api/v1/health/schedule-risk-index/async | Schedule Risk Index (Async)
+*HealthApi* | [**submit_async_health_score_api_v1_health_score_async_post**](docs/HealthApi.md#submit_async_health_score_api_v1_health_score_async_post) | **POST** /api/v1/health/score/async | Submit Async Health Score Job
+*WebhooksApi* | [**delete_webhook_registration_api_v1_webhooks_registration_delete**](docs/WebhooksApi.md#delete_webhook_registration_api_v1_webhooks_registration_delete) | **DELETE** /api/v1/webhooks/registration | Delete Webhook Registration
+*WebhooksApi* | [**get_delivery_status_api_v1_webhooks_deliveries_webhook_id_get**](docs/WebhooksApi.md#get_delivery_status_api_v1_webhooks_deliveries_webhook_id_get) | **GET** /api/v1/webhooks/deliveries/{webhook_id} | Get Delivery Status
+*WebhooksApi* | [**get_dlq_api_v1_webhooks_dlq_get**](docs/WebhooksApi.md#get_dlq_api_v1_webhooks_dlq_get) | **GET** /api/v1/webhooks/dlq | Get Dead Letter Queue
+*WebhooksApi* | [**get_job_deliveries_api_v1_webhooks_deliveries_job_job_id_get**](docs/WebhooksApi.md#get_job_deliveries_api_v1_webhooks_deliveries_job_job_id_get) | **GET** /api/v1/webhooks/deliveries/job/{job_id} | Get Job Deliveries
+*WebhooksApi* | [**get_webhook_registration_api_v1_webhooks_registration_get**](docs/WebhooksApi.md#get_webhook_registration_api_v1_webhooks_registration_get) | **GET** /api/v1/webhooks/registration | Get Webhook Registration
+*WebhooksApi* | [**register_webhook_api_v1_webhooks_register_post**](docs/WebhooksApi.md#register_webhook_api_v1_webhooks_register_post) | **POST** /api/v1/webhooks/register | Register Webhook
+
+
+## Documentation For Models
+
+ - [APIKeyListItem](docs/APIKeyListItem.md)
+ - [APIKeyResponse](docs/APIKeyResponse.md)
+ - [APITier](docs/APITier.md)
+ - [AccountTierMetadata](docs/AccountTierMetadata.md)
+ - [AccountTierResponse](docs/AccountTierResponse.md)
+ - [ActualCategoryResult](docs/ActualCategoryResult.md)
+ - [AddedRelationship](docs/AddedRelationship.md)
+ - [AnalysisSummary](docs/AnalysisSummary.md)
+ - [AppApiV1ScheduleAnalysisCpmProcessingMetadata](docs/AppApiV1ScheduleAnalysisCpmProcessingMetadata.md)
+ - [AppModelsSchemasProcessingMetadata](docs/AppModelsSchemasProcessingMetadata.md)
+ - [AppModelsSchemasProgressAnomaly1](docs/AppModelsSchemasProgressAnomaly1.md)
+ - [AppModelsSchemasProgressAnomaly2](docs/AppModelsSchemasProgressAnomaly2.md)
+ - [AppModelsSchemasResourceAvailability1](docs/AppModelsSchemasResourceAvailability1.md)
+ - [AppModelsSchemasResourceAvailability2](docs/AppModelsSchemasResourceAvailability2.md)
+ - [ApprovalDimensionScore](docs/ApprovalDimensionScore.md)
+ - [AsBuiltScheduleInput](docs/AsBuiltScheduleInput.md)
+ - [AsPlannedScheduleInput](docs/AsPlannedScheduleInput.md)
+ - [AsPlannedVsAsBuiltData](docs/AsPlannedVsAsBuiltData.md)
+ - [AsPlannedVsAsBuiltOptions](docs/AsPlannedVsAsBuiltOptions.md)
+ - [AsPlannedVsAsBuiltRequest](docs/AsPlannedVsAsBuiltRequest.md)
+ - [AsPlannedVsAsBuiltSummary](docs/AsPlannedVsAsBuiltSummary.md)
+ - [AutoDetected](docs/AutoDetected.md)
+ - [BaselineCategoryResult](docs/BaselineCategoryResult.md)
+ - [BaselineChartData](docs/BaselineChartData.md)
+ - [BaselineCompareCurrentSchedule](docs/BaselineCompareCurrentSchedule.md)
+ - [BaselineCompareData](docs/BaselineCompareData.md)
+ - [BaselineCompareHistorySnapshot](docs/BaselineCompareHistorySnapshot.md)
+ - [BaselineCompareOptions](docs/BaselineCompareOptions.md)
+ - [BaselineCompareRequest](docs/BaselineCompareRequest.md)
+ - [BaselineCompareSummary](docs/BaselineCompareSummary.md)
+ - [BaselineDriftSubMetric](docs/BaselineDriftSubMetric.md)
+ - [BaselinePerformanceIndicators](docs/BaselinePerformanceIndicators.md)
+ - [BaselineRecommendation](docs/BaselineRecommendation.md)
+ - [BaselineScheduleInput](docs/BaselineScheduleInput.md)
+ - [BellatorResponseAsPlannedVsAsBuiltData](docs/BellatorResponseAsPlannedVsAsBuiltData.md)
+ - [BellatorResponseBaselineCompareData](docs/BellatorResponseBaselineCompareData.md)
+ - [BellatorResponseCPMData](docs/BellatorResponseCPMData.md)
+ - [BellatorResponseChangeTrackingData](docs/BellatorResponseChangeTrackingData.md)
+ - [BellatorResponseDCMA14PointData](docs/BellatorResponseDCMA14PointData.md)
+ - [BellatorResponseDCMADECMData](docs/BellatorResponseDCMADECMData.md)
+ - [BellatorResponseDelayAnalysisData](docs/BellatorResponseDelayAnalysisData.md)
+ - [BellatorResponseHealthScoreData](docs/BellatorResponseHealthScoreData.md)
+ - [BellatorResponseImportData](docs/BellatorResponseImportData.md)
+ - [BellatorResponseLogicAuditData](docs/BellatorResponseLogicAuditData.md)
+ - [BellatorResponsePlanningHorizonData](docs/BellatorResponsePlanningHorizonData.md)
+ - [BellatorResponseProgressAuditData](docs/BellatorResponseProgressAuditData.md)
+ - [BellatorResponseResourceAnalysisData](docs/BellatorResponseResourceAnalysisData.md)
+ - [BellatorResponseScheduleRiskIndexData](docs/BellatorResponseScheduleRiskIndexData.md)
+ - [BellatorResponseValidationData](docs/BellatorResponseValidationData.md)
+ - [CPMData](docs/CPMData.md)
+ - [CPMOptions](docs/CPMOptions.md)
+ - [CPMRequest](docs/CPMRequest.md)
+ - [CPResourceAssignment](docs/CPResourceAssignment.md)
+ - [CalendarInfo](docs/CalendarInfo.md)
+ - [CategorizedDelays](docs/CategorizedDelays.md)
+ - [CausalChain](docs/CausalChain.md)
+ - [ChangeImpactAnalysis](docs/ChangeImpactAnalysis.md)
+ - [ChangeTrackingCurrentSchedule](docs/ChangeTrackingCurrentSchedule.md)
+ - [ChangeTrackingData](docs/ChangeTrackingData.md)
+ - [ChangeTrackingMaterialityThresholds](docs/ChangeTrackingMaterialityThresholds.md)
+ - [ChangeTrackingOptions](docs/ChangeTrackingOptions.md)
+ - [ChangeTrackingRequest](docs/ChangeTrackingRequest.md)
+ - [ChangeTrackingSnapshot](docs/ChangeTrackingSnapshot.md)
+ - [ChangeTrends](docs/ChangeTrends.md)
+ - [ChangesByCategory](docs/ChangesByCategory.md)
+ - [CheckoutReconcileRequest](docs/CheckoutReconcileRequest.md)
+ - [CheckoutReconcileResponse](docs/CheckoutReconcileResponse.md)
+ - [CheckoutSessionResponse](docs/CheckoutSessionResponse.md)
+ - [ComparisonSummary](docs/ComparisonSummary.md)
+ - [ConcurrentOverlap](docs/ConcurrentOverlap.md)
+ - [ContactSubmissionRequest](docs/ContactSubmissionRequest.md)
+ - [ContactSubmissionResponse](docs/ContactSubmissionResponse.md)
+ - [CreateAPIKeyRequest](docs/CreateAPIKeyRequest.md)
+ - [CriticalPathOverlay](docs/CriticalPathOverlay.md)
+ - [CriticalPathResources](docs/CriticalPathResources.md)
+ - [CrossBandInsights](docs/CrossBandInsights.md)
+ - [CumulativeCurveBucket](docs/CumulativeCurveBucket.md)
+ - [DCMA14PointCustomThresholds](docs/DCMA14PointCustomThresholds.md)
+ - [DCMA14PointData](docs/DCMA14PointData.md)
+ - [DCMA14PointOptions](docs/DCMA14PointOptions.md)
+ - [DCMA14PointRequest](docs/DCMA14PointRequest.md)
+ - [DCMA14PointSummary](docs/DCMA14PointSummary.md)
+ - [DCMACheckResult](docs/DCMACheckResult.md)
+ - [DCMADECMCustomThresholds](docs/DCMADECMCustomThresholds.md)
+ - [DCMADECMData](docs/DCMADECMData.md)
+ - [DCMADECMOptions](docs/DCMADECMOptions.md)
+ - [DCMADECMRequest](docs/DCMADECMRequest.md)
+ - [DCMADECMViolationRecord](docs/DCMADECMViolationRecord.md)
+ - [DCMAThresholdMetadata](docs/DCMAThresholdMetadata.md)
+ - [DECMCheckResult](docs/DECMCheckResult.md)
+ - [DECMGuidelineResult](docs/DECMGuidelineResult.md)
+ - [DECMGuidelineSummary](docs/DECMGuidelineSummary.md)
+ - [DECMOverallSummary](docs/DECMOverallSummary.md)
+ - [DECMThresholdMetadata](docs/DECMThresholdMetadata.md)
+ - [DelayAnalysisData](docs/DelayAnalysisData.md)
+ - [DelayAnalysisOptions](docs/DelayAnalysisOptions.md)
+ - [DelayAnalysisRequest](docs/DelayAnalysisRequest.md)
+ - [DelayDriver](docs/DelayDriver.md)
+ - [DelayRecommendation](docs/DelayRecommendation.md)
+ - [DelaySummary](docs/DelaySummary.md)
+ - [DependencyLink](docs/DependencyLink.md)
+ - [DownstreamEffect](docs/DownstreamEffect.md)
+ - [DurationConversion](docs/DurationConversion.md)
+ - [EACHistoryEntry](docs/EACHistoryEntry.md)
+ - [EACStability](docs/EACStability.md)
+ - [EVMSChartData](docs/EVMSChartData.md)
+ - [EVMSPerformanceSummary](docs/EVMSPerformanceSummary.md)
+ - [EVMSPeriod](docs/EVMSPeriod.md)
+ - [EVMSTrends](docs/EVMSTrends.md)
+ - [EphemeralKeyResponse](docs/EphemeralKeyResponse.md)
+ - [Evidence](docs/Evidence.md)
+ - [Finding](docs/Finding.md)
+ - [FindingSeverity](docs/FindingSeverity.md)
+ - [FloatAnalysis](docs/FloatAnalysis.md)
+ - [FloatDimensionScore](docs/FloatDimensionScore.md)
+ - [FloatRiskSubMetric](docs/FloatRiskSubMetric.md)
+ - [ForecastCategoryResult](docs/ForecastCategoryResult.md)
+ - [ForecastChartData](docs/ForecastChartData.md)
+ - [ForecastStabilityScore](docs/ForecastStabilityScore.md)
+ - [ForecastTrends](docs/ForecastTrends.md)
+ - [Grade](docs/Grade.md)
+ - [HTTPValidationError](docs/HTTPValidationError.md)
+ - [HealthScoreData](docs/HealthScoreData.md)
+ - [HistogramBucket](docs/HistogramBucket.md)
+ - [HorizonBandConfig](docs/HorizonBandConfig.md)
+ - [HorizonBandResult](docs/HorizonBandResult.md)
+ - [HorizonRecommendation](docs/HorizonRecommendation.md)
+ - [HorizonTask](docs/HorizonTask.md)
+ - [ImportData](docs/ImportData.md)
+ - [JobPriority](docs/JobPriority.md)
+ - [JobStatus](docs/JobStatus.md)
+ - [JobStatusResponse](docs/JobStatusResponse.md)
+ - [JobSubmissionRequest](docs/JobSubmissionRequest.md)
+ - [JobSubmissionResponse](docs/JobSubmissionResponse.md)
+ - [KeyEndpointUsage](docs/KeyEndpointUsage.md)
+ - [KeyHourlyUsage](docs/KeyHourlyUsage.md)
+ - [KeyUsageInfoResponse](docs/KeyUsageInfoResponse.md)
+ - [KeyUsageSummary](docs/KeyUsageSummary.md)
+ - [LevelingCandidate](docs/LevelingCandidate.md)
+ - [LogicAuditData](docs/LogicAuditData.md)
+ - [LogicAuditOptions](docs/LogicAuditOptions.md)
+ - [LogicAuditRequest](docs/LogicAuditRequest.md)
+ - [LogicAuditSummary](docs/LogicAuditSummary.md)
+ - [LogicCategoryResult](docs/LogicCategoryResult.md)
+ - [LogicChanges](docs/LogicChanges.md)
+ - [LogicChangesSummary](docs/LogicChangesSummary.md)
+ - [LogicDiff](docs/LogicDiff.md)
+ - [LogicDimensionScore](docs/LogicDimensionScore.md)
+ - [LogicFinding](docs/LogicFinding.md)
+ - [LogicRecommendedFix](docs/LogicRecommendedFix.md)
+ - [LogicRelationship](docs/LogicRelationship.md)
+ - [LogicRiskSubMetric](docs/LogicRiskSubMetric.md)
+ - [LogicRuleResult](docs/LogicRuleResult.md)
+ - [MappingStats](docs/MappingStats.md)
+ - [ModifiedRelationship](docs/ModifiedRelationship.md)
+ - [MonteCarloRequest](docs/MonteCarloRequest.md)
+ - [MonteCarloResponse](docs/MonteCarloResponse.md)
+ - [MppImportOptions](docs/MppImportOptions.md)
+ - [MppImportRequest](docs/MppImportRequest.md)
+ - [MspAssignment](docs/MspAssignment.md)
+ - [MspResource](docs/MspResource.md)
+ - [NetworkDetails](docs/NetworkDetails.md)
+ - [NetworkStats](docs/NetworkStats.md)
+ - [NormalizedSchedule](docs/NormalizedSchedule.md)
+ - [OverAllocationPeriod](docs/OverAllocationPeriod.md)
+ - [PageFeedbackRequest](docs/PageFeedbackRequest.md)
+ - [ParseSummary](docs/ParseSummary.md)
+ - [ParseWarning](docs/ParseWarning.md)
+ - [PercentileResult](docs/PercentileResult.md)
+ - [PlanningHorizonData](docs/PlanningHorizonData.md)
+ - [PlanningHorizonOptions](docs/PlanningHorizonOptions.md)
+ - [PlanningHorizonRequest](docs/PlanningHorizonRequest.md)
+ - [PlaygroundFeedbackRequest](docs/PlaygroundFeedbackRequest.md)
+ - [PoPDimension](docs/PoPDimension.md)
+ - [PoPRiskFactor](docs/PoPRiskFactor.md)
+ - [PortalSessionResponse](docs/PortalSessionResponse.md)
+ - [ProbabilityOfPerformance](docs/ProbabilityOfPerformance.md)
+ - [ProgressAuditData](docs/ProgressAuditData.md)
+ - [ProgressAuditOptions](docs/ProgressAuditOptions.md)
+ - [ProgressAuditRecommendation](docs/ProgressAuditRecommendation.md)
+ - [ProgressAuditRequest](docs/ProgressAuditRequest.md)
+ - [ProgressAuditSummary](docs/ProgressAuditSummary.md)
+ - [ProgressCategoryResult](docs/ProgressCategoryResult.md)
+ - [ProgressIntegritySubMetric](docs/ProgressIntegritySubMetric.md)
+ - [ReadinessIssue](docs/ReadinessIssue.md)
+ - [Recommendation](docs/Recommendation.md)
+ - [RelationshipType](docs/RelationshipType.md)
+ - [RelationshipTypeThresholds](docs/RelationshipTypeThresholds.md)
+ - [RemovedRelationship](docs/RemovedRelationship.md)
+ - [ResourceAllocationRequest](docs/ResourceAllocationRequest.md)
+ - [ResourceAllocationResponse](docs/ResourceAllocationResponse.md)
+ - [ResourceAnalysisData](docs/ResourceAnalysisData.md)
+ - [ResourceAnalysisOptions](docs/ResourceAnalysisOptions.md)
+ - [ResourceAnalysisRequest](docs/ResourceAnalysisRequest.md)
+ - [ResourceAnalysisSummary](docs/ResourceAnalysisSummary.md)
+ - [ResourceAvailabilityOutput](docs/ResourceAvailabilityOutput.md)
+ - [ResourceCategoryResult](docs/ResourceCategoryResult.md)
+ - [ResourceDiff](docs/ResourceDiff.md)
+ - [ResourceDimensionScore](docs/ResourceDimensionScore.md)
+ - [ResourceProfile](docs/ResourceProfile.md)
+ - [ResourceRiskComponents](docs/ResourceRiskComponents.md)
+ - [ResourceRiskScore](docs/ResourceRiskScore.md)
+ - [ResourceRiskSubMetric](docs/ResourceRiskSubMetric.md)
+ - [ResponseMetadata](docs/ResponseMetadata.md)
+ - [ResponseRegisterWebhookApiV1WebhooksRegisterPostValue](docs/ResponseRegisterWebhookApiV1WebhooksRegisterPostValue.md)
+ - [ResponseStatus](docs/ResponseStatus.md)
+ - [ResponseUpdateApiKeyLabelApiV1AuthKeysKeyIdLabelPatchValue](docs/ResponseUpdateApiKeyLabelApiV1AuthKeysKeyIdLabelPatchValue.md)
+ - [RetypedRelationship](docs/RetypedRelationship.md)
+ - [RevokeKeyResponse](docs/RevokeKeyResponse.md)
+ - [RiskDriver](docs/RiskDriver.md)
+ - [RiskIndicator](docs/RiskIndicator.md)
+ - [SRIRecommendation](docs/SRIRecommendation.md)
+ - [SRIScore](docs/SRIScore.md)
+ - [SRISubMetrics](docs/SRISubMetrics.md)
+ - [SandboxFixtureCatalog](docs/SandboxFixtureCatalog.md)
+ - [ScheduleHistorySnapshot](docs/ScheduleHistorySnapshot.md)
+ - [ScheduleInput](docs/ScheduleInput.md)
+ - [ScheduleRequest](docs/ScheduleRequest.md)
+ - [ScheduleRiskIndexData](docs/ScheduleRiskIndexData.md)
+ - [ScheduleRiskIndexOptions](docs/ScheduleRiskIndexOptions.md)
+ - [ScheduleRiskIndexRequest](docs/ScheduleRiskIndexRequest.md)
+ - [ScoreComponent](docs/ScoreComponent.md)
+ - [SimulationEnvelope](docs/SimulationEnvelope.md)
+ - [SubMetricWeights](docs/SubMetricWeights.md)
+ - [SubMetrics](docs/SubMetrics.md)
+ - [SubmissionTypeResponse](docs/SubmissionTypeResponse.md)
+ - [SystemicIssue](docs/SystemicIssue.md)
+ - [Task](docs/Task.md)
+ - [TaskComparison](docs/TaskComparison.md)
+ - [TaskPredecessorsInner](docs/TaskPredecessorsInner.md)
+ - [TaskPrerequisites](docs/TaskPrerequisites.md)
+ - [TaskTelemetryValue](docs/TaskTelemetryValue.md)
+ - [TaskTiming](docs/TaskTiming.md)
+ - [TaskVarianceRecord](docs/TaskVarianceRecord.md)
+ - [TierCapabilities](docs/TierCapabilities.md)
+ - [TierLimits](docs/TierLimits.md)
+ - [TopRisk](docs/TopRisk.md)
+ - [TrendIndicators](docs/TrendIndicators.md)
+ - [TrendPattern](docs/TrendPattern.md)
+ - [UnmatchedBuiltTask](docs/UnmatchedBuiltTask.md)
+ - [UnmatchedPlannedTask](docs/UnmatchedPlannedTask.md)
+ - [UnresourcedTask](docs/UnresourcedTask.md)
+ - [UpdateAPIKeyLabelRequest](docs/UpdateAPIKeyLabelRequest.md)
+ - [UsageKeyDetailResponse](docs/UsageKeyDetailResponse.md)
+ - [UsageMeResponse](docs/UsageMeResponse.md)
+ - [UsageMeResponseWarningsInnerValue](docs/UsageMeResponseWarningsInnerValue.md)
+ - [UsagePeriod](docs/UsagePeriod.md)
+ - [UserProfileResponse](docs/UserProfileResponse.md)
+ - [UserSignupRequest](docs/UserSignupRequest.md)
+ - [UserSignupResponse](docs/UserSignupResponse.md)
+ - [ValidationData](docs/ValidationData.md)
+ - [ValidationError](docs/ValidationError.md)
+ - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
+ - [ValidationOptions](docs/ValidationOptions.md)
+ - [VarianceFinding](docs/VarianceFinding.md)
+ - [VariancePattern](docs/VariancePattern.md)
+ - [VarianceTrendPeriod](docs/VarianceTrendPeriod.md)
+ - [VarianceTrends](docs/VarianceTrends.md)
+ - [WaitlistTypeResponse](docs/WaitlistTypeResponse.md)
+ - [WebhookRegistration](docs/WebhookRegistration.md)
+ - [XerImportOptions](docs/XerImportOptions.md)
+ - [XerImportRequest](docs/XerImportRequest.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="ApiKeyAuth"></a>
+### ApiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: x-api-key
+- **Location**: HTTP header
+
+<a id="OAuth2"></a>
+### OAuth2
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize
+- **Scopes**: 
+ - **api.read**: Read access to API
+ - **api.write**: Write access to API
+
+<a id="BearerAuth"></a>
+### BearerAuth
+
+- **Type**: Bearer authentication (JWT)
+
+
+## Author
+
+
+
+