# packages

pkgId: f9500a653cc404e86dbe4d4c94743705627c34eca583d90bd65828d6311d45a9
name: python-llamero-help
arch: noarch
version: 0.2.1
epoch: 0
release: 1
summary: Development documents and examples for llamero
url: https://pypi.org/project/llamero/
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llamero-0.2.1-1.src.rpm
location_href: Packages/python-llamero-help-0.2.1-1.noarch.rpm
checksum_type: sha256
description:
  ![llamero logo](assets/llamero-logo.jpg)





  Llamero is a toolkit to facilitate collaborating with LLMs on coding projects. It provides tools for:

  - Generating structured documentation and summaries to provide LLMs with relevant context
  - Maintaining clean, LLM-friendly project organization
  - Automating common documentation tasks
  - Building modular, context-aware codebases
  - Github actions integrations


  - Modular documentation system with Jinja2 templates
  - Automatic project structure documentation
  - Reusable GitHub Actions workflows
  - Centralized configuration management
  - Utility functions for common operations
  - Clean, maintainable architecture optimized for AI agents
  - Git operations handled through utilities




  When developing this project (or using it as a template), keep in mind these guidelines for effective collaboration with Large Language Models:

  1. **Separation of Concerns**
     - Each package should have a single, clear responsibility
     - New features should be separate packages when appropriate
     - Avoid coupling between packages
     - Use consistent patterns across packages, but implement independently
     - Cross-cutting concerns should use shared conventions

  2. **File Length and Modularity**
     - Keep files short and focused on a single responsibility
     - If you find yourself using comments like "... rest remains the same" or "... etc", the file is too long
     - Files should be completely replaceable in a single LLM interaction
     - Long files should be split into logical components

  3. **Dependencies**
     - All dependencies managed in `pyproject.toml`
     - Optional dependencies grouped by feature:
       ```
       [project.optional-dependencies]
       test = ["pytest", ...]
       site = ["markdown2", ...]
       all = ["pytest", "markdown2", ...]  # Everything
       ```
     - Use appropriate groups during development:
       ```bash
       pip install -e ".[test]"  # Just testing
       pip install -e ".[all]"   # Everything
       ```

  4. **Testing Standards**
     - Every new feature needs tests
     - Tests should be clear and focused
     - Use pytest fixtures for common setups
     - All workflows depend on tests passing
     - Test files should follow same modularity principles

  5. **Why This Matters**
     - LLMs work best with clear, focused contexts
     - Complete file contents are better than partial updates with ellipsis
     - Tests provide clear examples of intended behavior
     - Shorter files make it easier for LLMs to:
       - Understand the complete context
       - Suggest accurate modifications
       - Maintain consistency
       - Avoid potential errors from incomplete information

  7. **Best Practices**
     - Aim for files under 200 lines
     - Each file should have a single, clear purpose
     - Use directory structure to organize related components
     - Prefer many small files over few large files
     - Consider splitting when files require partial updates
     - Write tests alongside new features
     - Syntax permitting, files should begin with a comment indicating that file's name and relative path from the project root


  One of the most valuable features `llamero` offers is tooling to automate generation of various kinds of project/directory summaries that can be provided to an LLM for context.

  This system generates both local directory summaries and project-wide summaries to provide focused, relevant context for different tasks.

  The default behavior is to generate summaries and force push them to a dedicated `summaries` branch, keeping the actual project uncluttered so the user can pick and choose
  the specific summaries to share as they need to, when they need to, rather than filling up the LLMs context unnecessarily.

  For a concrete example, poke around [llamero's `summaries` branch](https://github.com/dmarx/llamero/tree/summaries).
  `llamero`'s summaries are currently configured to only be generated on request, through the `on: workflow_dispatch:` directive in the workflow configuration [here](https://github.com/dmarx/llamero/blob/main/.github/workflows/generate_summaries.yaml).



  Each directory in the project contains a `SUMMARY` file that concatenates all text files in that directory, recursively.
  This provides focused, local context when working on directory-specific tasks.


  Special project-wide summaries are maintained in the `SUMMARIES/` directory:

  - `READMEs.md`: Concatenation of all README files in the project
  - `README_SUBs.md`: Same as above but excluding the root README
  - `PYTHON.md`: Structured view of all Python code including:
    - Function and class signatures
    - Type hints
    - Docstrings
    - Clear indication of class membership


  ```bash

  git checkout summaries


  ls SUMMARIES/
  ```


  ```

  ├── .github
  │   └── workflows
  │       ├── build_readme.yml
  │       ├── generate_summaries.yaml
  │       ├── publish.yaml
  │       └── test.yml
  ├── LICENSE
  ├── README.md
  ├── assets
  │   └── llamero-logo.jpg
  ├── build
  │   └── lib
  │       └── llamero
  │           ├── __init__.py
  │           ├── __main__.py
  │           ├── dir2doc.py
  │           ├── summary
  │           │   ├── __init__.py
  │           │   ├── concatenative.py
  │           │   ├── python_files.py
  │           │   ├── python_signatures.py
  │           │   └── readmes.py
  │           ├── tree_generator.py
  │           └── utils.py
  ├── docs
  │   └── readme
  │       ├── base.md.j2
  │       └── sections
  │           ├── config.md.j2
  │           ├── development.md.j2
  │           ├── features.md.j2
  │           ├── introduction.md.j2
  │           ├── structure.md.j2
  │           └── summaries.md.j2
  ├── pyproject.toml
  ├── src
  │   └── llamero
  │       ├── __init__.py
  │       ├── __main__.py
  │       ├── dir2doc.py
  │       ├── summary
  │       │   ├── __init__.py
  │       │   ├── concatenative.py
  │       │   ├── python_files.py
  │       │   ├── python_signatures.py
  │       │   └── readmes.py
  │       ├── tree_generator.py
  │       └── utils.py
  └── tests
      ├── conftest.py
      ├── test_dir2doc.py
      ├── test_summary
      │   ├── test_concatenative.py
      │   ├── test_python_signatures.py
      │   ├── test_size_limits.py
      │   └── test_workflow_mapping.py
      ├── test_tree_generator.py
      └── test_utils.py

  ```

rpm_license:
  MIT License  Copyright (c) 2024 David Marx  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


pkgId: dadf5e9beda67b90f36e3a880c71e120e5aa130fbf6b6089a3bfd63eed1d1bac
name: python-llm-agent-toolkit-help
arch: noarch
version: 0.0.14
epoch: 0
release: 1
summary: Development documents and examples for llm-agent-toolkit
url: https://pypi.org/project/llm-agent-toolkit/
rpm_license: GPLv3
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llm-agent-toolkit-0.0.14-1.src.rpm
location_href: Packages/python-llm-agent-toolkit-help-0.0.14-1.noarch.rpm
checksum_type: sha256
description:
  ![Banner](https://github.com/JonahWhaler/llm-agent-toolkit/blob/main/repo-banner.jpeg)


  LLM Agent Toolkit provides minimal, modular interfaces for core components in LLM-based applications. Simplify workflows with stateless interaction, embedding encoders, memory management, tool integration, and data loaders, designed for compatibility and scalability. It prioritizes simplicity and modularity by proposing minimal wrappers designed to work across common tools, discouraging direct access to underlying technologies. Specific implementations and examples will be documented separately in a Cookbook (planned).

  PyPI: ![PyPI Downloads](https://static.pepy.tech/badge/llm-agent-toolkit)


  Using this toolkit simplifies integration by providing unified and modular interfaces across platforms. Many configurations are intentionally kept at their default settings to prioritize ease of use. However, most of these components are extensible through abstract classes, allowing developers to define their own desired configurations for greater flexibility. While this approach enhances consistency and reduces complexity, advanced customization may require extending the provided abstractions.

  For developers requiring full-range customization or access to the latest features, it is recommended to consider using native libraries like `ollama` and `openai` directly.


  - [LLM Agent Toolkit: Modular Components for AI Workflows](#llm-agent-toolkit-modular-components-for-ai-workflows)
    - [Attention!!!](#attention)
  - [Table of Contents](#table-of-contents)
  - [Installation](#installation)
  - [Fundamental Components](#fundamental-components)
    - [Core:](#core)
    - [Encoder:](#encoder)
    - [Memory:](#memory)
    - [Tool:](#tool)
    - [Loader:](#loader)
    - [Chunkers:](#chunkers)
  - [Planned Feature](#planned-feature)
  - [License](#license)


    `
    pip install llm-agent-toolkit
    `




  A stateless interface to interact with the LLM.

  **Purpose**: Serves as the central execution layer that abstracts interaction with the underlying LLM model.

  **Features**:
  * Supports multiple input-output modalities (e.g., Text-to-Text, Text-to-Image).
  * Enables iterative executions for multi-step workflows.
  * Facilitates tool invocation as part of the workflow.
  * Support models from OpenAI and Ollama


  A standardized wrapper for embedding models.

  **Purpose**: Provides a minimal API to transform text into embeddings, usable with any common embedding model.

  **Features**:
  * Abstracts away model-specific details (e.g., dimensionality, framework differences).
  * Allows flexible integration with downstream components like Memory or retrieval mechanisms.
  * Support OpenAI, Ollama and Transformers


  Offers essential context retention capabilities.

  **Purpose**: Allows efficient context management without hardcoding database or memory solutions.

  **Types**:
  1. *Short-term Memory*:
      * Maintains recent interactions for session-based context.
  2. *Vector Memory*:
      * Combines embedding and storage for retrieval-augmented workflows.
      * Includes optional metadata management for filtering results.
      * Support Faiss and Chroma


  A unified interface for augmenting the LLM's functionality.

  **Purpose**: Provides a lightweight abstraction for tool integration, accommodating both simple and complex tools.

  **Features**:
  * *Simple Tools*: Lazy wrappers for functions or basic utilities.
  * *Complex Tools*: Abstract class for external APIs or multi-step operations.


  Responsible for converting raw data into text.

  **Purpose**: Handles preprocessing and content extraction from diverse formats.

  **Features**:
  * Covering limited type of documents, images, and audio files.


  Utility to split long text into chunks.

  **Features**:
  * **Basic**:
    * *FixedCharacterChunker*: Split text into fixed-size character chunks with optional overlapping.
    * *FixedGroupChunker*: Splits text into K chunks. Supporting two levels, `word` and `character`, default is `character`.
  * **Semantic**:
    * *SemanticChunker*: Split text into semantically coherent chunks.
    * *SimulatedAnnealingSemanticChunker*: Enhanced with Simulated Annealing optimization technique.


  - A Cookbook with detailed implementation examples.


  This project is licensed under the GNU General Public License v3.0 License. See the [LICENSE](LICENSE) file for details.


pkgId: f66c0d6e461b53083659b3dacdb2fc24ed829654f0f032b8de30a09b880e9c55
name: python-llm-anthropic-help
arch: noarch
version: 0.11
epoch: 0
release: 1
summary: Development documents and examples for llm-anthropic
url: https://github.com/simonw/llm-anthropic
rpm_license: Apache-2.0
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llm-anthropic-0.11-1.src.rpm
location_href: Packages/python-llm-anthropic-help-0.11-1.noarch.rpm
checksum_type: sha256
description:
  [![PyPI](https://img.shields.io/pypi/v/llm-anthropic.svg)](https://pypi.org/project/llm-anthropic/)
  [![Changelog](https://img.shields.io/github/v/release/simonw/llm-anthropic?include_prereleases&label=changelog)](https://github.com/simonw/llm-anthropic/releases)
  [![Tests](https://github.com/simonw/llm-anthropic/actions/workflows/test.yml/badge.svg)](https://github.com/simonw/llm-anthropic/actions/workflows/test.yml)
  [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/llm-anthropic/blob/main/LICENSE)

  LLM access to models by Anthropic, including the Claude series



  Install this plugin in the same environment as [LLM](https://llm.datasette.io/).
  ```bash
  llm install llm-anthropic
  ```



  First, set [an API key](https://console.anthropic.com/settings/keys) for Anthropic:
  ```bash
  llm keys set anthropic

  ```

  You can also set the key in the environment variable `ANTHROPIC_API_KEY`

  Run `llm models` to list the models, and `llm models --options` to include a list of their options.

  Run prompts like this:
  ```bash
  llm -m anthropic/claude-3.5-sonnet 'Fun facts about pelicans'
  llm -m anthropic/claude-3.5-haiku 'Fun facts about armadillos'
  llm -m anthropic/claude-3-opus 'Fun facts about squirrels'
  ```
  Images are supported too, for models other than Claude 3.5 Haiku:
  ```bash
  llm -m anthropic/claude-3.5-sonnet 'describe this image' -a https://static.simonwillison.net/static/2024/pelicans.jpg
  llm -m anthropic/claude-3-haiku 'extract text' -a page.png
  ```
  Claude 3.5 Sonnet can handle PDF files:
  ```bash
  llm -m anthropic/claude-3.5-sonnet 'extract text' -a page.pdf
  ```
  The plugin sets up `claude-3.5-sonnet` and similar as aliases, usable like this:
  ```bash
  llm -m claude-3.5-sonnet 'Fun facts about pelicans'
  ```



  To set up this plugin locally, first checkout the code. Then create a new virtual environment:
  ```bash
  cd llm-anthropic
  python3 -m venv venv
  source venv/bin/activate
  ```
  Now install the dependencies and test dependencies:
  ```bash
  llm install -e '.[test]'
  ```
  To run the tests:
  ```bash
  pytest
  ```

  This project uses [pytest-recording](https://github.com/kiwicom/pytest-recording) to record Anthropic API responses for the tests.

  If you add a new test that calls the API you can capture the API response like this:
  ```bash
  PYTEST_ANTHROPIC_API_KEY="$(llm keys get claude)" pytest --record-mode once
  ```
  You will need to have stored a valid Anthropic API key using this command first:
  ```bash
  llm keys set claude

  ```


pkgId: 9edee3483885d35e682f280c8c120ac37d1688cbcb1a2cf0e972af129f75f82e
name: python-llm-app-test-help
arch: noarch
version: 0.2.0b2
epoch: 0
release: 1
summary: Development documents and examples for llm-app-test
url: https://github.com/Shredmetal/llmtest
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llm-app-test-0.2.0b2-1.src.rpm
location_href: Packages/python-llm-app-test-help-0.2.0b2-1.noarch.rpm
checksum_type: sha256
description:
  [![Discord](https://img.shields.io/discord/1307634517766443058?logo=discord&logoColor=white)](https://discord.gg/awy83bZsKf)
  [![PyPI Version](https://img.shields.io/pypi/v/llm-app-test?label=pypi%20package)](https://pypi.org/project/llm-app-test/)
  ![PyPI Downloads](https://img.shields.io/pypi/dm/llm-app-test)
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
  ![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
  [![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://Shredmetal.github.io/llmtest/)
  [![codecov](https://codecov.io/github/Shredmetal/llmtest/graph/badge.svg?token=EVDZIPM2C0)](https://codecov.io/github/Shredmetal/llmtest)

  > TL;DR: A Python library that lets you test LLM applications by describing expected behavior in plain English.



  A behavioral testing framework for applications using large language models (LLMs). It leverages LLMs to validate the behavior of applications containing LLMs against natural language test specifications (reliability validated through 30,000 test executions), providing a powerful tool for unit/integration testing of applications containing an LLM (not for testing LLMs themselves).

  We made this because we were unsatisfied with existing approaches to testing our apps that someone else told us to stick a non-deterministic black box into:

  1. String/regex matching and embeddings are too brittle - this is obvious for the former. Embeddings allow slightly more flexibility, but you still need to roughly guess what your LLM-powered app is going to say, and set things like thresholds while having an understanding of vector spaces.
  2. Academic metrics are of little help to API consumers like us with no ability to change the model. However, we still believe this tool is useful for the software engineering side of things. Please refer to the [Testing Philosophy](#testing-philosophy) section below on when to send things back to the data scientists.
  3. We just wanted to define a behavior and assert on it.

  ⚠️ Note on Reliability: While we cannot guarantee 100% reliability (due to the fundamental nature of LLMs), we validated the library with 30,000 test executions with zero format violations and non-determinism only occurring in one case containing a genuine semantic boundary.

  We stress that  past success doesn't guarantee future determinism - this is an unsolvable problem in LLM testing, but we've implemented extensive mitigations to make it as reliable as possible. We will continue to validate reliability through brute force testing and will report if issues are detected. In this regard, please refer to the reliability testing section of the documentation.

  You can go straight to the [documentation](https://Shredmetal.github.io/llmtest/) if you wish ⚠️ This is where you will find the most up-to-date information about the library.



  ✨ Test your LLM apps in minutes, not hours

  🚀 CI ready out of the box (Tested in GitHub Actions CI - Please let us know if it just works(tm) in other CI systems)

  💰 Cost-effective testing solution

  🔧 No infrastructure needed (Unless if you want to inject a custom LLM, please refer to the configuration page of the documentation for details)



  ```
  pip install llm-app-test
  ```

  Please refer to the [documentation](https://shredmetal.github.io/llmtest/getting-started/installation/) for full instructions.



  When integrating LLMs into your application, treat them as you would any closed-source third-party library:

  1. Write tests for expected behavior
  2. Focus on interface boundaries
  3. Test application-level functionality
  4. Maintain clear separation of concerns



  This library is built by software engineers to give software engineers a tool to validate the behavior of applications that have had an LLM stuffed in them. It is **NOT** a Data Science tool nor a replacement for model metrics used by Data Science teams to validate model suitability.



  - Write tests for expected application behavior
  - Validate inputs and outputs
  - Ensure proper integration
  - Monitor system performance
  - Escalate consistent failures to DS team (as this might indicate a fundamental problem with the model, or perhaps to seek assistance with the `expected_behavior` prompt in the `assert_behavioral_match` function)



  - Handle model-level issues
  - Address consistent test failures
  - Evaluate model suitability
  - Optimise model performance
  - Adjust prompts when needed



  Escalate to your Data Science team when:

  1. Tests consistently fail despite correct implementation
  2. Model responses are consistently inappropriate
  3. Performance degradation is observed
  4. Pattern of failures indicates model-level issues



  This is an ENGINEERING tool, not a data science tool. The difference is crucial:

  Data Science Tools:
  - Test model performance
  - Evaluate model accuracy
  - Measure model metrics

  llm_app_test (Engineering Tool):
  - Tests your APPLICATION code
  - Validates integration points
  - Ensures system behavior
  - Maintains production reliability

  Think of it this way: You don't test Redis itself, you test your application's use of Redis.
  Similarly, llm_app_test helps you test your application's use of LLMs.



  llm-app-test is designed to complement existing approaches. We recommend this testing hierarchy:

  1. **Behavioral Testing (llm-app-test)**
      - Fast, cost-effective first line of testing
      - Validates IF your LLM application is even working as intended
      - Tests core functionality and behavior
      - Must pass before proceeding to benchmarking
      - Failure indicates fundamental problems with the application

  2. **Benchmarking and Performance Evaluation**
      - Much slower and more expensive
      - Only run AFTER behavioral tests pass
      - Measures HOW WELL the application performs (in our view, this blurs the lines into LLM evaluation but it should still be done, just not as the first line of defence against broken apps due to the time and cost required)
      - Tests performance metrics, response quality
      - Used for optimization and model selection

  That said, we are planning on building a benchmarking system to allow you to get some metrics on how well your system is complying with behavioral specifications, planned for 0.3.0b1.



  ![Testing Hierarchy](https://i.imgur.com/TFPJa9M.png "LLM Application Testing Flow")





  Here's a powerful example showing behavioral testing in action:

  ```python
  from langchain_core.messages import SystemMessage, HumanMessage
  from llm_app_test.behavioral_assert.behavioral_assert import BehavioralAssertion
  from your_bot_module import SimpleApiCallBot  # Your LLM wrapper

  def test_ww2_narrative():
      behavioral_assert = BehavioralAssertion()

      
      system_message = SystemMessage(
          """
          You are a historian bot and you will respond to specific requests
          for information about history. Be detailed but do not go beyond
          what was asked for.
          """
      )

      
      
      bot = SimpleApiCallBot(system_message=system_message)

      
      human_message = HumanMessage(
          content="Tell me about the European Theater of World War 2, the major battles, and how the European war ended"
      )

      
      actual_output = bot.generate_ai_response(human_message)

      
      expected_behavior = """
      A narrative about World War 2 and the global nature of the war
      """

      
      behavioral_assert.assert_behavioral_match(actual_output, expected_behavior)
  ```

  Note: Claude is a little too helpful and will say stuff about the other theaters so when calling the generation bot with Claude, we used this:

  ```
  "Tell me about the European Theater of World War 2, the major battles, and how the European war ended. Only mention the European theater and do not mention the other theaters."
  ```

  Actual bot response from one run (GPT-4o):

  ```
  The European Theater of World War II was a significant front in the global conflict that lasted from 1939 to 1945. It involved most of the countries of Europe and was marked by numerous major battles and campaigns. Here is an overview of some of the key events and battles:

  1. **Invasion of Poland (1939):** The war in Europe began with Germany's invasion of Poland on September 1, 1939. This prompted Britain and France to declare war on Germany. The swift German victory was achieved through the use of Blitzkrieg tactics.

  2. **Battle of France (1940):** In May 1940, Germany launched an invasion of France and the Low Countries. The German forces bypassed the heavily fortified Maginot Line and quickly advanced through the Ardennes, leading to the fall of France in June 1940.

  3. **Battle of Britain (1940):** Following the fall of France, Germany attempted to gain air superiority over Britain in preparation for an invasion. The Royal Air Force successfully defended the UK, marking the first major defeat for Hitler's military forces.

  4. **Operation Barbarossa (1941):** On June 22, 1941, Germany launched a massive invasion of the Soviet Union. This campaign opened the Eastern Front, which became the largest and bloodiest theater of war in World War II.

  5. **Battle of Stalingrad (1942-1943):** One of the deadliest battles in history, the Battle of Stalingrad was a turning point on the Eastern Front. The Soviet victory marked the beginning of a major offensive push against German forces.

  6. **North African Campaign (1940-1943):** This series of battles involved the Allies and Axis powers fighting for control of North Africa. The decisive Allied victory at the Second Battle of El Alamein in 1942 marked the beginning of the end for Axis forces in Africa.

  7. **Invasion of Italy (1943):** After the successful North African Campaign, the Allies invaded Sicily in July 1943 and then mainland Italy. This led to the fall of Mussolini's regime and Italy's eventual surrender, although fighting continued in Italy until 1945.

  8. **D-Day and the Battle of Normandy (1944):** On June 6, 1944, Allied forces launched Operation Overlord, the largest amphibious invasion in history, landing on the beaches of Normandy, France. This marked the beginning of the liberation of Western Europe from Nazi occupation.

  9. **Battle of the Bulge (1944-1945):** Germany's last major offensive on the Western Front took place in the Ardennes Forest. Despite initial successes, the Allies eventually repelled the German forces, leading to a rapid advance into Germany.

  10. **Fall of Berlin (1945):** The final major offensive in Europe was the Soviet assault on Berlin in April 1945. The city fell on May 2, 1945, leading to the suicide of Adolf Hitler and the unconditional surrender of German forces.

  The European war officially ended with Germany's unconditional surrender on May 7, 1945, which was ratified on May 8, known as Victory in Europe (VE) Day. This marked the end of World War II in Europe, although the war continued in the Pacific until Japan's surrender in September 1945.

  ```

  Error message thrown by `assert_behavioral_match`:

  ```
  E           llm_app_test.exceptions.test_exceptions.BehavioralAssertionError: Behavioral assertion failed:
  Behavioral Assertion Failed:  - Reason: The actual output focuses primarily on the European Theater of World War II,
  rather than providing a narrative about the global nature of the war.
  ```



  1. Real Application Testing
      - Tests an actual LLM-based application

  2. Behavioral Testing Power
      - The bot provides a detailed, accurate response
      - However, the test fails because it doesn't meet the expected behavior
      - Shows how behavioral testing catches incorrect behavior from your app

  3. Clear Error Messages
      - The error clearly explains why the test failed
      - Points to specific behavioral mismatch
      - Helps developers understand what needs to change



  Full documentation available at: [https://Shredmetal.github.io/llmtest/](https://Shredmetal.github.io/llmtest/)

  - Installation Guide
  - Quick Start Guide
  - API Reference
  - Best Practices
  - CI/CD Integration
  - Configuration Options



  MIT


  If you encounter issues:
  1. Create an issue on our GitHub repository
  2. Include your Python version and environment details
  3. Describe the problem you encountered with version 0.2.0b2


  - Discord: [Join our community](https://discord.gg/awy83bZsKf)
  - Issues: [GitHub Issues](https://github.com/Shredmetal/llmtest/issues)
  - Documentation: [Full Docs](https://shredmetal.github.io/llmtest/)
  - Email: morganj.lee01@gmail.com / Elnathan.erh@gmail.com





  If you experience issues with version 0.2.0b2, you can roll back to the previous stable version (0.2.0b1) using one of these methods:



  ```
  pip uninstall llm-app-test
  pip install llm-app-test==0.2.0b1
  ```


  ```
  pip install --force-reinstall llm-app-test==0.2.0b1
  ```

  After rolling back, verify the installation:
  ```
  import llm_app_test
  print(llm_app_test.version) # Should show 0.2.0b1
  ```





  Tier 1:

  | Model                        | Maximum Requests per minute (RPM) | Maximum Tokens per minute (TPM) | Maximum Tokens per day (TPD) |
  |------------------------------|-----------------------------------|---------------------------------|------------------------------|
  | Claude 3.5 Sonnet 2024-10-22 | 50                                | 40,000                          | 1,000,000                    |
  | Claude 3.5 Sonnet 2024-06-20 | 50                                | 40,000                          | 1,000,000                    |
  | Claude 3 Opus                | 50                                | 20,000                          | 1,000,000                    |


  Tier 2:

  | Model                        | Maximum Requests per minute (RPM) | Maximum Tokens per minute (TPM) | Maximum Tokens per day (TPD) |
  |------------------------------|-----------------------------------|---------------------------------|------------------------------|
  | Claude 3.5 Sonnet 2024-10-22 | 1,000                             | 80,000                          | 2,500,000                    |
  | Claude 3.5 Sonnet 2024-06-20 | 1,000                             | 80,000                          | 2,500,000                    |
  | Claude 3 Opus                | 1,000                             | 40,000                          | 2,500,000                    |



  Tier 1

  | Model                   | RPM | RPD    | TPM     | Batch Queue Limit |
  |-------------------------|-----|--------|---------|-------------------|
  | gpt-4o                  | 500 | -      | 30,000  | 90,000            |
  | gpt-4o-mini             | 500 | 10,000 | 200,000 | 2,000,000         |
  | gpt-4o-realtime-preview | 100 | 100    | 20,000  | -                 |
  | gpt-4-turbo             | 500 | -      | 30,000  | 90,000            |


  Tier 2:

  | Model                   | RPM   | TPM       | Batch Queue Limit |
  |-------------------------|-------|-----------|-------------------|
  | gpt-4o                  | 5,000 | 450,000   | 1,350,000         |
  | gpt-4o-mini             | 5,000 | 2,000,000 | 20,000,000        |
  | gpt-4o-realtime-preview | 200   | 40,000    | -                 |
  | gpt-4-turbo             | 5,000 | 450,000   | 1,350,000         |


pkgId: 1fab185816426a46f48813c4c3e8762031b5b6cf545af01f66a966899ed590d3
name: python-llm-context-help
arch: noarch
version: 0.2.1
epoch: 0
release: 1
summary: Development documents and examples for llm-context
url: https://pypi.org/project/llm-context/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llm-context-0.2.1-1.src.rpm
location_href: Packages/python-llm-context-help-0.2.1-1.noarch.rpm
checksum_type: sha256
description:
  [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
  [![PyPI version](https://img.shields.io/pypi/v/llm-context.svg)](https://pypi.org/project/llm-context/)

  LLM Context is a command-line tool that helps developers quickly inject relevant content from code/text projects into Large Language Model chat interfaces. It leverages `.gitignore` patterns for smart file selection and provides both a streamlined clipboard workflow and direct LLM integration through the Model Context Protocol (MCP).

  > **Note**: This project was developed in collaboration with Claude-3.5-Sonnet, using LLM Context itself to share code during development. All code in the repository is human-curated (by me 😇, @restlessronin).



  For an in-depth exploration of the reasoning behind LLM Context and its approach to AI-assisted development, check out our article: [LLM Context: Harnessing Vanilla AI Chats for Development](https://www.cyberchitta.cc/articles/llm-ctx-why.html)



  - **Direct LLM Integration**: Native integration with Claude Desktop via MCP protocol
  - **Chat Interface Support**: Works with any LLM chat interface via CLI/clipboard
    - Optimized for interfaces with persistent context like Claude Projects and Custom GPTs
    - Works equally well with standard chat interfaces
  - **Project Types**: Suitable for code repositories and collections of text/markdown/html documents
  - **Project Size**: Optimized for projects that fit within an LLM's context window. Large project support is in development



  Install LLM Context using [uv](https://github.com/astral-sh/uv):

  ```bash
  uv tool install llm-context
  ```

  > **Warning**: LLM Context is under active development. Updates may overwrite configuration files prefixed with `lc-`. We recommend backing up any customized files before updating.





  Add to 'claude_desktop_config.json':

  ```jsonc
  {
    "mcpServers": {
      "CyberChitta": {
        "command": "uvx",
        "args": ["--from", "llm-context", "lc-mcp"]
      }
    }
  }
  ```



  1. Navigate to your project's root directory
  2. Initialize repository: `lc-init` (only needed once)
  3. (Optional) Edit `.llm-context/config.toml` to customize ignore patterns
  4. Select files: `lc-sel-files`
  5. (Optional) Review selected files in `.llm-context/curr_ctx.toml`
  6. Generate context: `lc-context`
  7. Use with your preferred interface:

  - Project Knowledge (Claude Pro): Paste into knowledge section
  - GPT Knowledge (Custom GPTs): Paste into knowledge section
  - Regular chats: Use `lc-set-profile code-prompt` first to include instructions

  8. When the LLM requests additional files:
     - Copy the file list from the LLM
     - Run `lc-read-cliplist`
     - Paste the contents back to the LLM



  - `lc-init`: Initialize project configuration
  - `lc-set-profile <name>`: Switch profiles
  - `lc-sel-files`: Select files for inclusion
  - `lc-context`: Generate and copy context
  - `lc-read-cliplist`: Process LLM file requests



  LLM Context provides advanced features for customizing how project content is captured and presented:

  - Smart file selection using `.gitignore` patterns
  - Multiple profiles for different use cases
  - Code outline generation for supported languages
  - Customizable templates and prompts

  See our [User Guide](docs/user-guide.md) for detailed documentation of these features.



  Check out our [comprehensive list of alternatives](https://www.cyberchitta.cc/articles/lc-alternatives.html) - the sheer number of tools tackling this problem demonstrates its importance to the developer community.



  LLM Context evolves from a lineage of AI-assisted development tools:

  - This project succeeds [LLM Code Highlighter](https://github.com/restlessronin/llm-code-highlighter), a TypeScript library I developed for IDE integration.
  - The concept originated from my work on [RubberDuck](https://github.com/rubberduck-ai/rubberduck-vscode) and continued with later contributions to [Continue](https://github.com/continuedev/continuedev).
  - LLM Code Highlighter was heavily inspired by [Aider Chat](https://github.com/paul-gauthier/aider). I worked with GPT-4 to translate several Aider Chat Python modules into TypeScript, maintaining functionality while restructuring the code.
  - This project uses tree-sitter [tag query files](src/llm_context/highlighter/tag-qry/) from Aider Chat.
  - LLM Context exemplifies the power of AI-assisted development, transitioning from Python to TypeScript and back to Python with the help of GPT-4 and Claude-3.5-Sonnet.

  I am grateful for the open-source community's innovations and the AI assistance that have shaped this project's evolution.

  I am grateful for the help of Claude-3.5-Sonnet in the development of this project.



  This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.


pkgId: a14610176480533c12623e803e73f3dffd5b9d0d455c9842555e7aa62211649d
name: python-llm-dialog-manager-help
arch: noarch
version: 0.3.4
epoch: 0
release: 1
summary: Development documents and examples for llm-dialog-manager
url: https://pypi.org/project/llm-dialog-manager/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llm-dialog-manager-0.3.4-1.src.rpm
location_href: Packages/python-llm-dialog-manager-help-0.3.4-1.noarch.rpm
checksum_type: sha256
description:
  A Python package for managing AI chat conversation history with support for multiple LLM providers (OpenAI, Anthropic, Google, X.AI) and convenient conversation management features.



  - Support for multiple AI providers:
    - OpenAI (GPT-3.5, GPT-4)
    - Anthropic (Claude)
    - Google (Gemini)
    - X.AI (Grok)
  - Intelligent message role management (system, user, assistant)
  - Conversation history tracking and validation
  - Load balancing across multiple API keys
  - Error handling and retry mechanisms
  - Conversation saving and loading
  - Memory management options
  - Conversation search and indexing
  - Rich conversation display options



  ```bash
  pip install llm-dialog-manager
  ```






  Create a `.env` file in your project root:

  ```bash

  OPENAI_API_KEY_1=your-key-1
  OPENAI_API_BASE_1=https://api.openai.com/v1


  ANTHROPIC_API_KEY_1=your-anthropic-key
  ANTHROPIC_API_BASE_1=https://api.anthropic.com


  GEMINI_API_KEY=your-gemini-key


  XAI_API_KEY=your-x-key
  ```




  ```python
  from llm_dialog_manager import Agent


  agent = Agent("claude-2.1", memory_enabled=True)


  agent.add_message("system", "You are a helpful assistant")
  agent.add_message("user", "What is the capital of France?")
  response = agent.generate_response()


  agent.save_conversation()
  ```



  ```bash
  python app.py

  ```
  https://github.com/user-attachments/assets/5f640029-24e6-44ea-a3a3-02eb3de0d4df







  ```bash
  pytest tests/
  ```



  1. Fork the repository
  2. Create your feature branch (`git checkout -b feature/amazing-feature`)
  3. Commit your changes (`git commit -m 'Add amazing feature'`)
  4. Push to the branch (`git push origin feature/amazing-feature`)
  5. Open a Pull Request



  This project is licensed under the MIT License - see the LICENSE file for details.



  For support, please open an issue in the GitHub repository or contact the maintainers.


pkgId: ae9e9d2dfd0372b6bc47d2cc8c4f873f9f2bdee7cea3c03cdbf815a354ff1098
name: python-llm-extractinator-help
arch: noarch
version: 0.1.1
epoch: 0
release: 1
summary: Development documents and examples for llm-extractinator
url: https://pypi.org/project/llm-extractinator/
rpm_license: Apache License 2.0
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llm-extractinator-0.1.1-1.src.rpm
location_href: Packages/python-llm-extractinator-help-0.1.1-1.noarch.rpm
checksum_type: sha256
description:
  This project enables the efficient extraction of structured data from unstructured text using large language models (LLMs). It provides a flexible configuration system and supports a variety of tasks.


pkgId: 7873aacf7835ad499343d76a8ecfbfa652480443a3376dc3c230e8b53af26e58
name: python-llm-gemini-help
arch: noarch
version: 0.8
epoch: 0
release: 1
summary: Development documents and examples for llm-gemini
url: https://github.com/simonw/llm-gemini
rpm_license: Apache-2.0
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llm-gemini-0.8-1.src.rpm
location_href: Packages/python-llm-gemini-help-0.8-1.noarch.rpm
checksum_type: sha256
description:
  [![PyPI](https://img.shields.io/pypi/v/llm-gemini.svg)](https://pypi.org/project/llm-gemini/)
  [![Changelog](https://img.shields.io/github/v/release/simonw/llm-gemini?include_prereleases&label=changelog)](https://github.com/simonw/llm-gemini/releases)
  [![Tests](https://github.com/simonw/llm-gemini/workflows/Test/badge.svg)](https://github.com/simonw/llm-gemini/actions?query=workflow%3ATest)
  [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/llm-gemini/blob/main/LICENSE)

  API access to Google's Gemini models



  Install this plugin in the same environment as [LLM](https://llm.datasette.io/).
  ```bash
  llm install llm-gemini
  ```


  Configure the model by setting a key called "gemini" to your [API key](https://aistudio.google.com/app/apikey):
  ```bash
  llm keys set gemini
  ```
  ```
  <paste key here>
  ```
  You can also set the API key by assigning it to the environment variable `LLM_GEMINI_KEY`.

  Now run the model using `-m gemini-1.5-pro-latest`, for example:

  ```bash
  llm -m gemini-1.5-pro-latest "A joke about a pelican and a walrus"
  ```

  > A pelican walks into a seafood restaurant with a huge fish hanging out of its beak.  The walrus, sitting at the bar, eyes it enviously.
  >
  > "Hey," the walrus says, "That looks delicious! What kind of fish is that?"
  >
  > The pelican taps its beak thoughtfully. "I believe," it says, "it's a billfish."

  Other models are:

  - `gemini-1.5-flash-latest`
  - `gemini-1.5-flash-8b-latest` - the least expensive
  - `gemini-exp-1114` - recent experimental #1
  - `gemini-exp-1121` - recent experimental #2
  - `gemini-exp-1206` - recent experimental #3
  - `gemini-2.0-flash-exp` - [Gemini 2.0 Flash](https://blog.google/technology/google-deepmind/google-gemini-ai-update-december-2024/#gemini-2-0-flash)



  Gemini models are multi-modal. You can provide images, audio or video files as input like this:

  ```bash
  llm -m gemini-1.5-flash-latest 'extract text' -a image.jpg
  ```
  Or with a URL:
  ```bash
  llm -m gemini-1.5-flash-8b-latest 'describe image' \
    -a https://static.simonwillison.net/static/2024/pelicans.jpg
  ```
  Audio works too:

  ```bash
  llm -m gemini-1.5-pro-latest 'transcribe audio' -a audio.mp3
  ```

  And video:

  ```bash
  llm -m gemini-1.5-pro-latest 'describe what happens' -a video.mp4
  ```
  The Gemini prompting guide includes [extensive advice](https://ai.google.dev/gemini-api/docs/file-prompting-strategies) on multi-modal prompting.



  Use `-o json_object 1` to force the output to be JSON:

  ```bash
  llm -m gemini-1.5-flash-latest -o json_object 1 \
    '3 largest cities in California, list of {"name": "..."}'
  ```
  Outputs:
  ```json
  {"cities": [{"name": "Los Angeles"}, {"name": "San Diego"}, {"name": "San Jose"}]}
  ```



  Gemini models can [write and execute code](https://ai.google.dev/gemini-api/docs/code-execution) - they can decide to write Python code, execute it in a secure sandbox and use the result as part of their response.

  To enable this feature, use `-o code_execution 1`:

  ```bash
  llm -m gemini-1.5-pro-latest -o code_execution 1 \
  'use python to calculate (factorial of 13) * 3'
  ```



  To chat interactively with the model, run `llm chat`:

  ```bash
  llm chat -m gemini-1.5-pro-latest
  ```



  The plugin also adds support for the `text-embedding-004` embedding model.

  Run that against a single string like this:
  ```bash
  llm embed -m text-embedding-004 -c 'hello world'
  ```
  This returns a JSON array of 768 numbers.

  This command will embed every `README.md` file in child directories of the current directory and store the results in a SQLite database called `embed.db` in a collection called `readmes`:

  ```bash
  llm embed-multi readmes --files . '*/README.md' -d embed.db -m text-embedding-004
  ```
  You can then run similarity searches against that collection like this:
  ```bash
  llm similar readmes -c 'upload csvs to stuff' -d embed.db
  ```

  See the [LLM embeddings documentation](https://llm.datasette.io/en/stable/embeddings/cli.html) for further details.



  To set up this plugin locally, first checkout the code. Then create a new virtual environment:
  ```bash
  cd llm-gemini
  python3 -m venv venv
  source venv/bin/activate
  ```
  Now install the dependencies and test dependencies:
  ```bash
  llm install -e '.[test]'
  ```
  To run the tests:
  ```bash
  pytest
  ```

  This project uses [pytest-recording](https://github.com/kiwicom/pytest-recording) to record Gemini API responses for the tests.

  If you add a new test that calls the API you can capture the API response like this:
  ```bash
  PYTEST_GEMINI_API_KEY="$(llm keys get gemini)" pytest --record-mode once
  ```
  You will need to have stored a valid Gemini API key using this command first:
  ```bash
  llm keys set gemini

  ```


pkgId: e3a72c77e6dd85cd8ac950db6616022d0ffd344f5f312c10bc450de8ca5b410e
name: python-llm-groq-help
arch: noarch
version: 0.6
epoch: 0
release: 1
summary: Development documents and examples for llm-groq
url: https://github.com/angerman/llm-groq
rpm_license: Apache-2.0
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llm-groq-0.6-1.src.rpm
location_href: Packages/python-llm-groq-help-0.6-1.noarch.rpm
checksum_type: sha256
description:
  [LLM](https://llm.datasette.io/) plugin providing access to [Groqcloud](http://console.groq.com) models.



  Install this plugin in the same environment as LLM:
  ```bash
  llm install llm-groq
  ```



  First, obtain an API key for [Groqcloud](https://console.groq.com/).

  Configure the key using the `llm keys set groq` command:
  ```bash
  llm keys set groq
  ```
  ```
  <paste key here>
  ```
  You can now access the three Mistral hosted models: `groq-llama2` and `groq-mixtral`.

  To run a prompt through `groq-mixtral`:

  ```bash
  llm -m groq-mixtral 'A sassy name for a pet sasquatch'
  ```
  To start an interactive chat session with `groq-mixtral`:
  ```bash
  llm chat -m groq-mixtral
  ```
  ```
  llm chat -m groq-mixtral
  Chatting with groq-mixtral
  Type 'exit' or 'quit' to exit
  Type '!multi' to enter multiple lines, then '!end' to finish
  > three proud names for a pet walrus
  Here are three whimsical and proud-sounding names for a pet walrus:

  1. Regalus Maximus
  2. Glacierus Royalty
  3. Arctican Aristocat

  These names evoke a sense of majesty and grandeur, fitting for a noble and intelligent creature like a walrus. I hope you find these names fitting and amusing! If you have any other requests or need assistance with something else, please don't hesitate to ask.
  ```
  To use a system prompt with `groq-mixtral` to explain some code:
  ```bash
  cat example.py | llm -m groq-mixtral -s 'explain this code'
  ```



  TBD



  To set up this plugin locally, first checkout the code. Then create a new virtual environment:
  ```bash
  cd llm-groq
  python3 -m venv venv
  source venv/bin/activate
  ```


pkgId: c8f205c7734299a40f3d0544d506d2c083d8845336718a3222a137b752adf5e0
name: python-llm-install-pack-help
arch: noarch
version: 0.1.0
epoch: 0
release: 1
summary: Development documents and examples for llm-install-pack
url: https://pypi.org/project/llm-install-pack/
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llm-install-pack-0.1.0-1.src.rpm
location_href: Packages/python-llm-install-pack-help-0.1.0-1.noarch.rpm
checksum_type: sha256
description:
  A Python Library to download all the required LLM Python packages for building an LLM-based chatbot

  Please remember, you should already have Python (>3.8) installed on your device.



  ```bash
  pip install .

rpm_license:
  MIT License  Copyright (c) 2024 5ivatej  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


pkgId: 0f2ec81e4ea044b233cbb6f22270e1e36c9d5200574a832594196227bbd7323c
name: python-llm-perplexity-help
arch: noarch
version: 2024.12.0
epoch: 0
release: 1
summary: Development documents and examples for llm-perplexity
url: https://github.com/hex/llm-perplexity
rpm_license: Apache-2.0
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llm-perplexity-2024.12.0-1.src.rpm
location_href: Packages/python-llm-perplexity-help-2024.12.0-1.noarch.rpm
checksum_type: sha256
description:
  [![PyPI](https://img.shields.io/pypi/v/llm-perplexity.svg)](https://pypi.org/project/llm-perplexity/)
  [![Changelog](https://img.shields.io/github/v/release/hex/llm-perplexity?include_prereleases&label=changelog)](https://github.com/hex/llm-perplexity/releases)
  [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/hex/llm-perplexity/blob/main/LICENSE)

  LLM access to pplx-api 3 by Perplexity Labs



  Install this plugin in the same environment as [LLM](https://llm.datasette.io/).

  ```bash
  llm install llm-perplexity
  ```



  First, set an [API key](https://www.perplexity.ai/settings/api) for Perplexity AI:

  ```bash
  llm keys set perplexity

  ```

  Run `llm models` to list the models, and `llm models --options` to include a list of their options.

  Run prompts like this:

  ```bash
  llm -m sonar-small 'Fun facts about pelicans'
  llm -m sonar-large 'Fun facts about walruses'
  llm -m sonar-huge 'Fun facts about whales'
  llm -m sonar-small-chat 'Fun facts about wolves'
  llm -m sonar-large-chat 'Fun facts about foxes'
  llm -m llama-3.1-8b-instruct 'Fun facts about lemurs'
  llm -m llama-3.1-70b-instruct 'Fun facts about coyotes'
  ```



  To set up this plugin locally, first checkout the code. Then create a new virtual environment:

  ```bash
  cd llm-perplexity
  python3 -m venv venv
  source venv/bin/activate
  ```

  Now install the dependencies and test dependencies:

  ```bash
  llm install -e '.[test]'
  ```

  This plugin was made after the [llm-claude-3](https://github.com/simonw/llm-claude-3) plugin by Simon Willison.


pkgId: 4dba71395220907376c4c38dcd619cf6b4c89d4ce9c0df1895fb788b758d94b0
name: python-llm-webdesign-help
arch: noarch
version: 0.0.1
epoch: 0
release: 1
summary: Development documents and examples for llm-webdesign
url: https://github.com/lucasrcezimbra/llm-webdesign
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llm-webdesign-0.0.1-1.src.rpm
location_href: Packages/python-llm-webdesign-help-0.0.1-1.noarch.rpm
checksum_type: sha256
description:
  [![PyPI](https://img.shields.io/pypi/v/llm-webdesign.svg)](https://pypi.org/project/llm-webdesign/)
  [![Changelog](https://img.shields.io/github/v/release/lucasrcezimbra/llm-webdesign?include_prereleases&label=changelog)](https://github.com/lucasrcezimbra/llm-webdesign/releases)
  [![Tests](https://github.com/lucasrcezimbra/llm-webdesign/workflows/Test/badge.svg)](https://github.com/lucasrcezimbra/llm-webdesign/actions?query=workflow%3ATest)
  [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/lucasrcezimbra/llm-webdesign/blob/main/LICENSE)


  Install this plugin in the same environment as [LLM](https://llm.datasette.io/).
  ```bash
  pipx install llm
  llm install llm-webdesign
  ```


  TODO


pkgId: 893cd24c0ef5aec93be4187b221e58091ff316137667bc9eb0874aa2e5c499d6
name: python-llmeter-help
arch: noarch
version: 0.1.4
epoch: 0
release: 1
summary: Development documents and examples for llmeter
url: https://github.com/awslabs/llmeter
rpm_license: Apache-2.0
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-llmeter-0.1.4-1.src.rpm
location_href: Packages/python-llmeter-help-0.1.4-1.noarch.rpm
checksum_type: sha256
description:
  <div align="center">
  <img alt="LLMeter (Logo)" src="https://github.com/awslabs/llmeter/blob/main/docs/llmeter-logotype-192px.png?raw=true" height="96px" width="396px"/>

  **Measuring large language models latency and throughput**

  [![Latest Version](https://img.shields.io/pypi/v/llmeter.svg)](https://pypi.python.org/pypi/llmeter)
  [![Supported Python Versions](https://img.shields.io/pypi/pyversions/llmeter)](https://pypi.python.org/pypi/llmeter)
  [![Code Style: Ruff](https://img.shields.io/badge/code_style-ruff-000000.svg)](https://github.com/astral-sh/ruff)

  </div>

  LLMeter is a pure-python library for simple latency and throughput testing of large language models (LLMs). It's designed to be lightweight to install; straightforward to run standard tests; and versatile to integrate - whether in notebooks, CI/CD, or other workflows.



  LLMeter requires `python>=3.10`, please make sure your current version of python is compatible.

  To install the basic metering functionalities, you can install the minimum package using pip install:

  ```terminal
  pip install llmeter
  ```

  LLMeter also offers extra features that require additional dependencies. Currently these extras include:

  - **plotting**: Add methods to generate charts and heatmaps to summarize the results
  - **openai**: Enable testing endpoints offered by OpenAI
  - **litellm**: Enable testing a range of different models through [LiteLLM](https://github.com/BerriAI/litellm)
  - **mlflow**: Enable logging LLMeter experiments to [MLFlow](https://mlflow.org/)

  You can install one or more of these extra options using pip:

  ```terminal
  pip install 'llmeter[plotting,openai,litellm,mlflow]'
  ```



  At a high level, you'll start by configuring an LLMeter "Endpoint" for whatever type of LLM you're connecting to:

  ```python

  from llmeter.endpoints import BedrockConverse
  endpoint = BedrockConverse(model_id="...")


  from llmeter.endpoints import OpenAIEndpoint
  endpoint = OpenAIEndpoint(model_id="...", api_key="...")


  from llmeter.endpoints import LiteLLM
  endpoint = LiteLLM("{provider}/{model_id}")


  ```

  You can then run the high-level "experiments" offered by LLMeter:

  ```python

  from llmeter.experiments import LatencyHeatmap
  latency_heatmap = LatencyHeatmap(
      endpoint=endpoint,
      clients=10,
      source_file="examples/MaryShelleyFrankenstein.txt",
      ...
  )
  heatmap_results = await latency_heatmap.run()
  latency_heatmap.plot_heatmap()


  from llmeter.experiments import LoadTest
  sweep_test = LoadTest(
      endpoint=endpoint,
      payload={...},
      sequence_of_clients=[1, 5, 20, 50, 100, 500],
  )
  sweep_results = await sweep_test.run()
  sweep_test.plot_sweep_results()
  ```

  Alternatively, you can use the low-level `llmeter.runner.Runner` class to run and analyze request
  batches - and build your own custom experiments.

  Additional functionality like cost modelling and MLFlow experiment tracking is enabled through `llmeter.callbacks`, and you can write your own callbacks to hook other custom logic into LLMeter test runs.

  For more details, check out our selection of end-to-end code examples in the [examples](https://github.com/awslabs/llmeter/tree/main/examples) folder!



  See [CONTRIBUTING](https://github.com/awslabs/llmeter/tree/main/CONTRIBUTING.md#security-issue-notifications) for more information.



  This project is licensed under the Apache-2.0 License.


pkgId: 868b4454c6353765dab5494179ec1ba0334d101822bd1a666a0cbf75f76151a2
name: python-lmcv-tools-help
arch: noarch
version: 0.0.27
epoch: 0
release: 1
summary: Development documents and examples for lmcv-tools
url: https://pypi.org/project/lmcv-tools/
rpm_license: GPL-3.0
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lmcv-tools-0.0.27-1.src.rpm
location_href: Packages/python-lmcv-tools-help-0.0.27-1.noarch.rpm
checksum_type: sha256
description:
  Considering that the routine activities for which LMCV Tools was developed are quite varied, specific commands were developed for each one of them. These commands are:
  - translate (in implementation)
  - extract (in implementation)
  - generate (in implementation)
  - reorder
  - change (in implementation)

  The command **translate**, in short, aims to convert different types of files used in LMCV.
  Its usage is quite simple:
  ```text
  $ lmcv_tools translate [path/to/file] to [extension]
  ```

  Abaqus is a suite for Finite Element Analysis (FEA) developed by "Dassault Systèmes", while FAST is a console based FEA tool developed by "Laboratório de Mecânica Computacional e Visualização" of "Universidade Federal do Ceará" (UFC). Both of these softwares can simulate complex problems, but FAST has a clear disadvantage: differently of Abaqus, it hasn't a native GUI to generate its meshes. With that in mind, this command specifically seeks to translate meshes generated in Abaqus and exported in .inp format into meshes in .dat format to be used in FAST simulations.
  Example:
  ```text
  $ lmcv_tools translate Job-1.inp to .dat
  ```

  Articles for scientific publications in the LMCV study field generally require images of the used meshes. Generating bitmat images in PNG format is a valid possibility, but for very discretized meshes this approach results in loss of details. Thinking about it, this command translates .dat files of **plate and shell** meshes to the SVG (Scalable Vector Graphics) image format, which does not lose quality with zoom (perfect for meshes with many elements).
  Example:
  ```text
  $ lmcv_tools translate Plate.dat to .svg
  ```
  In addition, this command has some flags:
  | Flags              | Description                                                      |
  | ---                | ---                                                              |
  | -p or --projection | Type of projection: parallel or perspective (default: parallel). |
  | -x                 | X-coordinate of the projection center (perspective projection).  |
  | -y                 | Y-coordinate of the projection center (perspective projection).  |
  | -z                 | Z-coordinate of the projection center (perspective projection).  |
  | --Rx               | A rotaion in x-axis.                                             |
  | --Ry               | A rotaion in y-axis.                                             |
  | --Rz               | A rotaion in z-axis.                                             |
  Examples:
  ```text
  $ lmcv_tools translate Plate.dat to .svg --projection=parallel
  $ lmcv_tools translate Plate.dat to .svg -p=perspective -x=0 -y=0 -=30
  $ lmcv_tools translate Plate.dat to .svg --Rx=45.0 --Ry=30.0
  $ lmcv_tools translate Plate.dat to .svg -p=perspective -x=0 -y=20 -=40.0 --Rx=45.0 --Ry=30.0 --Rx=34
  ```
  The use of these flags must consider the following points:
  - The projection plane will always be the **x-y plane**.
  - The -x, -y and -z flags are only necessary if the projection type is “perspective”.
  - The coordinates provided in the -x, -y and -z flags are relative to the **mesh centroid**.
  - The flags --Rx, --Ry and --Rz can be written in any order and **can even be repeated**.
  - The rotations described by --Rx, --Ry, and --Rz will be executed in the order they were written.

  The command **extract**, in short, aims to extract data from .pos (or .dat) files generated by FAST and save this data in CSV format.
  Files with extension ".pos" are the standard output from FAST simulations. They can store data about nodal displacements, element stresses, gauss points stresses and other informations, all distributed over a series of steps. In some contexts, it is necessary to obtain specific data from these files, but the manual search can take a lot of time and still fail. Alternatively, this command allows to extract entire set of related atributes by a simple expression.
  An extraction expression can be broken down into terms:
  - Keywords
  - Attributes
  - Condition
  **Keywords** are a set of words that define the commmand syntax. In this command, the keywords are "from", "where" and "to" (the last two are optional). Examples of valid syntaxes are:
  ```text
  $ lmcv_tools extract [atributes] from [path/to/.pos]
  $ lmcv_tools extract [atributes] from [path/to/.pos] to [path/to/.csv]
  $ lmcv_tools extract [atributes] from [path/to/.pos] where [condition]
  $ lmcv_tools extract [atributes] from [path/to/.pos] where [condition] to [path/to/.csv]
  ```
  **Attributes** are names that represent a piece of data from a .pos file. The supported attributes are:
  | Attribute                      | Type  | Sub-Type | Related Attributes                |
  | ---                            | ---   | ---      | ---                               |
  | step.id                        | int   | -        | -                                 |
  | step.factor                    | float | -        | step.id                           |
  | node.id                        | int   | -        | -                                 |
  | node.coord                     | list  | float    | node.id                           |
  | step.node.displacement         | list  | float    | step.id, node.id                  |
  | step.gauss.scalar              | list  | str      | step.id                           |
  | step.nodal.scalar              | list  | str      | step.id                           |
  | element.id                     | int   | -        | -                                 |
  | element.info                   | list  | int      | element.id                        |
  | step.element.gauss.scalar.data | list  | float    | step.id, element.id               |
  | step.element.nodal.scalar.data | list  | float    | step.id, element.id               |
  | buckling.id                    | int   | -        | -                                 |
  | buckling.factor                | float | -        | buckling.id                       |
  | buckling.node.displacement     | list  | float    | buckling.id, node.id              |
  | vibration.id                   | int   | -        | -                                 |
  | vibration.factor               | float | -        | vibration.id                      |
  | vibration.node.displacement    | list  | float    | vibration.id, node.id             |
  | material.id                    | int   | -        | -                                 |
  | material.isotropic.E           | float | -        | material.id                       |
  | material.isotropic.poisson     | float | -        | material.id, material.isotropic.E |
  | section.id                     | int   | -        | -                                 |
  | section.bar.circle.radius      | float | -        | section.id                        |
  Attributes that share any related attributed can be related in order which they were typed. Example:
  ```text
  $ lmcv_tools extract step.id step.factor step.node.displacement[0] from Example.pos
  ```
  **Condition** is a series of attribute constraints. They can be written intuitively using attributes, operators and test values after "from" keyword. The supported operators are:
  | Operator | Meaning                              |
  | ---      | ---                                  |
  | and      | Logical and.                         |
  | or       | Logical or.                          |
  | =        | Relational equal to.                 |
  | >        | Relational gerater than.             |
  | <        | Relational less than.                |
  | >=       | Relational gerater than or equal to. |
  | <=       | Relational less than or equal to.    |
  | !=       | Relational different from.           |
  | in       | Relational membership.               |
  Remembering that the symbols ">" and "<" must be encapsulated by quotes. Otherwise, they will be interpreted by the shell as ***redirection operators***.
  Examples:
  ```text
  $ lmcv_tools extract step.factor from Example.pos where step.id ">" 2
  ```
  ```text
  $ lmcv_tools extract step.factor from Example.pos where step.id != 3 and step.factor ">" 3
  ```

  The command **generate**, in short, aims to create special artifacts.
  Artifact is a broad term for anything that can be useful for LMCV simulations. They can be file templates, dynamically generated file parts or anything else that needs a shortcut to create.
  Possible Syntaxes:
  ```text
  $ lmcv_tools generate [artifact name]
  $ lmcv_tools generate [artifact name] [args] [path/to/artifact]
  ```
  Implemented artifacts are listed below:
  - virtual_laminas
  - cuboid

  Virtual Laminas (virtual_laminas) are a model that approximates the behavior of a Functionally Graded Material. The idea is to represent these materials as a stack of isotropic homogeneous laminas. The more laminas used, the more accurate the simulation results. However, tools like Abaqus or FAST do not have a fast and automated way to generate these laminas, so this artifact was developed as a solution.
  This syntax below will start a graphical interface to facilitate the process of passing arguments:
  ```text
  $ lmcv_tools generate virtual_laminas
  ```
  Other syntax possible is based in a long and exaustive list of required arguments:
  ```text
  $ lmcv_tools generate virtual_laminas [params] [path/to/virtual_laminas]
  ```
  | Parameters            | Type  | Description                                          |
  | ---                   |---    | ---                                                  |
  | Laminas Count         | int   | Total number of laminas.                             |
  | Laminas Thickness     | float | Thinkcness of laminas.                               |
  | Power Law Exponent    | float | Exponent of Power Law.                               |
  | Micromechanical Model | str   | Model to calculate effective properties.             |
  | Element Type          | str   | Supported: Solid, Shell.                             |
  | E1                    | float | Elastic Modulus of Material 1.                       |
  | E2                    | float | Elastic Modulus of Material 2.                       |
  | nu1                   | float | Poisson's Coefficient of Material 1.                 |
  | nu2                   | float | Poisson's Coefficient of Material 2.                 |
  | pho1                  | float | Density of Material 1.                               |
  | pho2                  | float | Density of Material 2.                               |
  | Smart Laminas         | bool  | If True, a new smart generation method will be used. |
  **Supported Micromechanical Models:**
  - voigt
  - mori_tanaka
  - hashin_shtrikman_lower_bound
  - hashin_shtrikman_upper_bound

  Rectangles are geometric shapes frequently used in simulation tests. Therefore, this artifact was created to allow the generation of finite element meshes of rectangles in .dat format.
  Proper Syntax:
  ```text
  $ lmcv_tools generate rectangles [params] [path/to/cuboid]
  ```
  | Parameters   | Type  | Description                   |
  | ---          |---    | ---                           |
  | Element Type | str   | Supported: Q8.                |
  | Width        | float | Cuboid Width (x).             |
  | Height       | float | Cuboid Height (y).            |
  | Nx           | int   | Number of Elements in Width.  |
  | Ny           | int   | Number of Elements in Height. |

  Cuboids are geometric shapes frequently used in simulation tests. Therefore, this artifact was created to allow the generation of finite element meshes of cuboids in .dat format.
  Proper Syntax:
  ```text
  $ lmcv_tools generate cuboid [params] [path/to/cuboid]
  ```
  | Parameters   | Type  | Description                   |
  | ---          |---    | ---                           |
  | Element Type | str   | Supported: BRICK20.           |
  | Width        | float | Cuboid Width (x).             |
  | Height       | float | Cuboid Height (y).            |
  | Deep         | float | Cuboid Deep (z).              |
  | Nx           | int   | Number of Elements in Width.  |
  | Ny           | int   | Number of Elements in Height. |
  | Nz           | int   | Number of Elements in Deep.   |

  NURBS Rectangles are geometric shapes frequently used in simulation tests. Therefore, this artifact was created to allow the generation of NURBS meshes of Rectangles in .dat format.
  Proper Syntax:
  ```text
  $ lmcv_tools generate cuboid [params] [path/to/nurbs_rectangle]
  ```
  | Parameters   | Type  | Description                   |
  | ---          |---    | ---                           |
  | Dx           | int   | Degree in Width.              |
  | Dy           | int   | Degree in Height.             |
  | Width        | float | Cuboid Width (x).             |
  | Height       | float | Cuboid Height (y).            |
  | Nx           | int   | Number of Elements in Width.  |
  | Ny           | int   | Number of Elements in Height. |

  NURBS Cuboids are geometric shapes frequently used in simulation tests. Therefore, this artifact was created to allow the generation of NURBS meshes of Cuboids in .dat format.
  Proper Syntax:
  ```text
  $ lmcv_tools generate cuboid [params] [path/to/nurbs_cuboid]
  ```
  | Parameters   | Type  | Description                   |
  | ---          |---    | ---                           |
  | Dx           | int   | Degree in Width.              |
  | Dy           | int   | Degree in Height.             |
  | Dz           | int   | Degree in Deep.               |
  | Width        | float | Cuboid Width (x).             |
  | Height       | float | Cuboid Height (y).            |
  | Deep         | float | Cuboid Deep (z).              |
  | Nx           | int   | Number of Elements in Width.  |
  | Ny           | int   | Number of Elements in Height. |
  | Nz           | int   | Number of Elements in Deep.   |

  Cylindrical panels are geometric shapes frequently used in simulation tests. Therefore, this artifact was created to allow the generation of finite element meshes of cylindrical panels in .dat format.
  Proper Syntax:
  ```text
  $ lmcv_tools generate cyl_panels [params] [path/to/cuboid]
  ```
  | Parameters   | Type  | Description                     |
  | ---          |---    | ---                             |
  | Element Type | str   | Supported: Q8.                  |
  | Height       | float | Cuboid Height (y).              |
  | Nx           | int   | Number of Elements in Width.    |
  | Ny           | int   | Number of Elements in Height.   |
  | Radius       | float | Panel Raius.                    |
  | Start Angle  | float | Angle to start panel (Degrees). |
  | Stop Angle   | float | Angle to stop panel (Degrees).  |

  The command **reorder**, in short, aims to add a node solver order in .dat files to reduce the stiffiness matrix bandwidth and, consequently, the time spent to execute the simulation.
  Considering that computational simulations based on the finite element method involve the solution of a system of linear equations, it is possible to reduce the execution time of these simulations by also reducing the bandwidth of the stiffness matrix that represents the linear system. A valid approach for this is the reordering of the nodes that make up the simulation mesh. Thus, this command allows generating a reordering of nodes (a new node solver order) from different methods.
  Possible Syntax:
  ```text
  $ lmcv_tools reorder [method] [path/to/.dat]
  ```
  Example:
  ```text
  $ lmcv_tools reorder rcm simulation.dat
  ```
  **Possible Flags:**
  | Flag         | Function                                               |
  | ---          | ---                                                    |
  | -i or --info | Show info about bandwidth reduction and execution time |
  **Supported Reordering Methods**:
  | Keyword     | Method                                                              |
  | ---         | ---                                                                 |
  | rcm         | [[1]](#3---references) Reverse Cuthill-McKee                        |
  | sloan       | [[2]](#3---references) Sloan                                        |
  | boost_rcm   | Boost C++ Library Implementation of Reverse Cuthill-McKee Algorithm |
  | boost_sloan | Boost C++ Library Implementation of Sloan Algorithm                 |

  The command **change**, in short, aims to change certain values from .dat (or .pos) files generated by FAST.
  Files with extension ".dat" are the standard input from FAST simulations. They can store data about nodal coordinates, material properties, section details and other informations. In some contexts, it is necessary to change specific data from these files, but the manual process can take a lot of time and still fail. Alternatively, this command allows to precisely change specific atributes by a simple expression.
  In a similar way to the command extract, a change expression can be broken down into terms:
  - Keywords
  - Attributes
  - Condition
  **Keywords** are a set of words that define the command syntax. In this command, the keywords are "to", "in" and "where" (the last is optional). Examples of valid syntaxes are:
  ```text
  $ lmcv_tools change [atribute] to [value] in [path/to/.dat]
  $ lmcv_tools change [atribute] to [value] in [path/to/.pos] where [condition]
  ```
  **Attributes** are names that represent a piece of data from a .dat (or .pos) file. They are the same as those used in the extract command. Example:
  ```text
  $ lmcv_tools change material.isotropic.poisson to 0.3 in Example.dat
  ```
  **Condition** is a series of attribute constraints. They can be written intuitively using attributes, operators and test values after "from" keyword, just like the command extract. However, in this specific case, only attributes related to the attribute that will be changed can be used in condition expressions. Example:
  ```text
  $ lmcv_tools change material.isotropic.poisson to 0.3 in Example. where material.id = 2
  ```

  - [1] CUTHILL, E.; MCKEE, J.. Reducing the bandwidth of sparse symmetric matrices. Proceedings of The 1969 24th National Conference, Washington, p. 157-172, 26 ago. 1969. ACM Press. http://dx.doi.org/10.1145/800195.805928.
  - [2] SLOAN, S. W.. An algorithm for profile and wavefront reduction of sparse matrices. International Journal for Numerical Methods in Engineering, Newcastle, v. 23, n. 2, p. 239-251, fev. 1986. Wiley. http://dx.doi.org/10.1002/nme.1620230208.


pkgId: 11bd00d11f852239724a8a74843a478ef6d38ede0fc52ede3af4561329786a2f
name: python-lmfitxps-help
arch: noarch
version: 4.0.0
epoch: 0
release: 1
summary: Development documents and examples for lmfitxps
url: https://pypi.org/project/lmfitxps/
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lmfitxps-4.0.0-1.src.rpm
location_href: Packages/python-lmfitxps-help-4.0.0-1.noarch.rpm
checksum_type: sha256
description:
  <p align="center">
    <img src="src/logos/logo_large.png" alt="lmfitxps">
  </p>

  <p align="center">
    <a href="https://doi.org/10.5281/zenodo.8181379"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.8181379.svg" alt="DOI"></a>
    <a href="https://lmfitxps.readthedocs.io/en/latest/?badge=latest"><img src="https://readthedocs.org/projects/lmfitxps/badge/?version=latest" alt="Documentation Status"></a>
    <a href="https://badge.fury.io/py/lmfitxps"><img src="https://badge.fury.io/py/lmfitxps.svg" alt="PyPI version" height="18"></a>
    <a href="https://static.pepy.tech/badge/lmfitxps"><img src="https://static.pepy.tech/badge/lmfitxps" alt="Downloads"></a>
    <a href="https://opensource.org/licenses/"><img src="https://img.shields.io/badge/license-MIT-blue" alt="License: MIT"></a>
    <a href="https://en.wikipedia.org/wiki/Free_and_open-source_software"><img src="https://img.shields.io/badge/FOSS-100%25-green.svg?style=flat" alt="FOSS: 100%"></a>
  </p>




  Welcome to lmfitxps, a small Python package designed as an extension for the popular lmfit package , specifically tailored for X-ray Photoelectron Spectroscopy (XPS) data analysis.

  While lmfit provides simple tools to build complex fitting models for non-linear least-squares problems and applies these models to real data, as well as introduces several built-in models, lmfitxps acts as an extension to lmfit designed for XPS data analysis. lmfitxps provides a comprehensive set of functions and models that facilitate the fitting of XPS spectra. In particular, lmfitxps provides several models, which use the convolution of a gaussian with model functions of the lmfit-package.

  In addition to models for fittig signals in XPS data, lmfitxps introduces several background models which can be included in the fit model for fitting the data rather then substracting a precalculated background. This is the so-called active approach as suggested by A. Herrera-Gomez and generally leads to better fit results.
  For further details, please refer to the documentation of [lmfitxps](https://lmfitxps.readthedocs.io/en/latest/index.html) and [lmfit](https://lmfit.github.io/lmfit-py/index.html)!


  To install lmfitxps, simply use pip:

   `pip install lmfitxps`

   
   [![DOI](https://zenodo.org/badge/642726930.svg)](https://zenodo.org/badge/latestdoi/642726930)




  - A. Kononov, [Fullerene and bismuth clusters on nanostructured oxide films](http://dx.doi.org/10.17877/DE290R-24509), Dissertation (2024)
  - K. Teenakul et al. [Treatment of carbon electrodes with Ti3C2Tx MXene coating and thermal method for vanadium redox flow batteries: a comparative study](https://doi.org/10.1039/D4RA01380H) RSC Adv., **14**, 12807-12816 (2024).
  - P. Weinert et al. [Structural, chemical, and magnetic investigation of a graphene/cobalt/platinum multilayer system on silicon carbide](http://dx.doi.org/10.1088/1361-6528/ad1d7b) Nanotechnology, **35** 165702 (2024).
  - P. Lamichhane et al. [Investigating the synergy of rapidly synthesized iron oxide predecessor and plasma-gaseous species for dye-removal to reuse water in irrigation](https://doi.org/10.1016/j.chemosphere.2024.143040) Chemosphere, **24** 143040 (2024).
  - P. Weinert [Structural, chemical, and magnetic investigation of a graphene/cobalt/platinum multilayer system on silicon carbide : About the formation of magnetic structures in 2D cobalt layers](https://d-nb.info/1328839591) Dissertation (2024).
  - P. Schöngrundner [Search for crystalline SiO2 on the wet chemically treated 6H-SiC(0001) surface](https://doi.org/10.34726/HSS.2024.124590) TU Wien, Thesis (2024)

  Publications that use [LG4X-V2](https://github.com/Julian-Hochhaus/LG4X-V2), a graphical user interface (GUI) for XPS/XAS analysis that heavily utilizes `lmfit` and `lmfitxps`, are also included.

rpm_license:
  MIT License  Copyright (c) 2023 Julian-Hochhaus  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.    Some code has been taken from the lmfit library whose licence is below.  BSD-3  Copyright 2022 Matthew Newville, The University of Chicago Renee Otten, Brandeis University Till Stensitzki, Freie Universitat Berlin A. R. J. Nelson, Australian Nuclear Science and Technology Organisation Antonino Ingargiola, University of California, Los Angeles Daniel B. Allen, Johns Hopkins University Michal Rawlik, Eidgenossische Technische Hochschule, Zurich  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


pkgId: 140c5a990cd679bf56ee89f5ae74b37df409fe446c10ca08da53296c128096fe
name: python-lmnr-flow-help
arch: noarch
version: 0.1.5
epoch: 0
release: 1
summary: Development documents and examples for lmnr-flow
url: https://github.com/lmnr-ai/flow
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lmnr-flow-0.1.5-1.src.rpm
location_href: Packages/python-lmnr-flow-help-0.1.5-1.noarch.rpm
checksum_type: sha256
description:
  A lightweight task engine for building AI agents that prioritizes simplicity and flexibility.



  Unlike traditional node and edge-based workflows, Flow uses a dynamic task queue system built on three simple principles:

  1. **Concurrent Execution** - Tasks run in parallel automatically
  2. **Dynamic Scheduling** - Tasks can schedule new tasks at runtime
  3. **Smart Dependencies** - Tasks can await results from previous operations

  Results of all tasks are stored in a thread-safe `Context`.

  This task-based architecture makes complex workflows surprisingly simple:

  - [x] Parallel task execution without explicit threading code
  - [x] Self-modifying dynamic workflows and cycles
  - [x] Conditional branching and control flow
  - [x] Streaming of tasks execution
  - [x] State management, load previous state and save current state
  - [x] Start execution from a specific task
  - [x] Dynamically push next tasks with specific inputs
  - [x] Map Reduce, running the same task in parallel on multiple inputs and collecting results

  By removing the need to predefine edges between nodes, and opting for a dynamic task scheduling architecture, Flow helps you write better and cleaner code by making it easier to reason about control flow and dependencies.

  Flow is lightweight, bloat-free, and has no external dependencies for the engine. It is designed to be simple, flexible and very powerful, and is maintained by the [Laminar](https://github.com/lmnr-ai/lmnr) team.


  Flow comes with auto-instrumentation for tracing using [Laminar](https://github.com/lmnr-ai/lmnr). To enable OpenTelemetry-based tracing, initialize the Laminar SDK before using Flow.

  ```python
  from lmnr import Laminar
  Laminar.initialize(project_api_key="...")
  ```

  > Tracing is extremely useful for debugging and state reconstruction. When tracing is enabled, Flow will automatically capture the state at each step. During debugging, you can load the captured state and inspect the context. To learn more about tracing, see the [Laminar docs](https://docs.lmnr.ai).



  ```bash
  pip install lmnr-flow
  ```




  ```python
  from concurrent.futures import ThreadPoolExecutor
  from lmnr_flow import Flow, TaskOutput, NextTask, Context, StreamChunk


  flow = Flow(thread_pool_executor=ThreadPoolExecutor(max_workers=4))


  def my_task(context: Context) -> TaskOutput:
      return TaskOutput(output="Hello World!")

  flow.add_task("greet", my_task)
  result = flow.run("greet")  # Returns {"greet": "Hello World!"}
  ```


  ```python

  def task1(context: Context) -> TaskOutput:
      return TaskOutput(output="result1", [NextTask("task2")])

  def task2(context: Context) -> TaskOutput:
      
      t1_result = context.get("task1")  # waits for task1 to complete
      return TaskOutput(output="result2")

  flow.add_task("task1", task1)
  flow.add_task("task2", task2)
  flow.run("task1")  # Returns {"task2": "result2"}
  ```


  ```python
  def starter(context: Context) -> TaskOutput:
      
      return TaskOutput(output="started", [NextTask("slow_task1"), NextTask("slow_task2")])

  def slow_task1(context: Context) -> TaskOutput:
      time.sleep(1)
      return TaskOutput(output="result1")

  def slow_task2(context: Context) -> TaskOutput:
      time.sleep(1)
      return TaskOutput(output="result2")


  flow.add_task("starter", starter)
  flow.add_task("slow_task1", slow_task1)
  flow.add_task("slow_task2", slow_task2)
  flow.run("starter")
  ```


  ```python
  def streaming_task(context: Context) -> TaskOutput:
      
      stream = context.get_stream()
      for i in range(3):
          
          stream.put(StreamChunk("streaming_task", f"interim_{i}"))
      return TaskOutput(output="final")

  flow.add_task("streaming_task", streaming_task)


  for task_id, output in flow.stream("streaming_task"):
      print(f"{task_id}: {output}")
      
      
      
      
      
  ```


  ```python
  def conditional_task(context: Context) -> TaskOutput:
      count = context.get("count", 0)

      if count >= 3:
          return TaskOutput(output="done")

      context.set("count", count + 1)
      return TaskOutput(output=f"iteration_{count}", [NextTask("conditional_task")])


  flow.add_task("conditional_task", conditional_task)
  flow.add_task("finish", lambda ctx: TaskOutput("completed", None))
  flow.run("conditional_task")
  ```


  ```python
  def parameterized_task(context: Context) -> TaskOutput:
      name = context.get("user_name")
      return TaskOutput(output=f"Hello {name}!")

  flow.add_task("greet", parameterized_task)
  result = flow.run("greet", inputs={"user_name": "Alice"})

  ```


  ```python
  def task1(ctx):
      return TaskOutput("result1", [NextTask("task2", inputs={"input1": "value1"})])


  def task2(ctx, inputs):
      assert inputs == {"input1": "value1"}
      return TaskOutput("result2")

  flow.add_task("task1", task1)
  flow.add_task("task2", task2)
  result = flow.run("task1")

  ```


  ```python
  def router(context: Context) -> TaskOutput:
      task_type = context.get("type")
      routes = {
          "process": [NextTask("process_task")],
          "analyze": [NextTask("analyze_task")],
          "report": [NextTask("report_task")]
      }
      return TaskOutput(output=f"routing to {task_type}", routes.get(task_type, []))

  def process_task(context: Context) -> TaskOutput:
      return TaskOutput(output="processed data")

  flow.add_task("router", router)
  flow.add_task("process_task", process_task)
  result = flow.run("router", inputs={"type": "process"})

  ```



  ```python
  context = Context()
  context.from_dict({"task1": "result1"})

  flow = Flow(context=context)
  flow.add_task("task2", lambda ctx: TaskOutput("result2"))
  flow.run("task2")

  assert flow.context.get("task1") == "result1" # True, because it was set in the context
  assert flow.context.get("task2") == "result2"



  flow.get_context().to_dict()

  ```


  ```python
  def task1(ctx):
      ctx.set("collector", [])

      return TaskOutput("result1", [
          NextTask("task2", spawn_another=True),
          NextTask("task2", spawn_another=True),
          NextTask("task2", spawn_another=True)
      ])

  def task2(ctx):
      collector = ctx.get("collector")
      collector.append("result2")
      ctx.set("collector", collector)

      return TaskOutput("", [NextTask("task3")])

  def task3(ctx):
      collector = ctx.get("collector")
      return TaskOutput(collector)

  flow.add_task("task1", task1)
  flow.add_task("task2", task2)
  flow.add_task("task3", task3)

  result = flow.run("task1")
  assert result == {"task3": ["result2", "result2", "result2"]}
  ```



  ```python
  from typing import List
  import json

  def llm_agent(context: Context) -> TaskOutput:
      
      prompt = context.get("user_input")
      llm_response = {
          "reasoning": "Need to search database and format results",
          "tools": ["search_db", "format_results"]
      }

      
      next_tasks: List[NextTask] = []
      for tool in llm_response["tools"]:
          next_tasks.append(NextTask(tool))

      return TaskOutput(output=llm_response["reasoning"], next_tasks)

  def search_db(context: Context) -> TaskOutput:
      
      results = ["result1", "result2"]
      return TaskOutput(output=results)

  def format_results(context: Context) -> TaskOutput:
      
      search_results = context.get("search_db")
      formatted = json.dumps(search_results, indent=2)
      return TaskOutput(output=formatted)


  flow = Flow()
  flow.add_task("llm_agent", llm_agent)
  flow.add_tool("search_db", search_db)
  flow.add_tool("format_results", format_results)


  result = flow.run("llm_agent", inputs={"user_input": "Find and format data"})

  ```



  - **Context Sharing**: All tasks share the same context, allowing for complex data flows
  - **Error Handling**: Exceptions in tasks are properly propagated
  - **Thread Safety**: All operations are thread-safe
  - **Minimal Dependencies**: Core engine has zero external dependencies


  - [ ] Add async support
  - [ ] Serverless deployment

rpm_license:
[cell repeats an earlier one in this file: 10254 characters]


pkgId: 75c908a822d18f697b7694f97810ff066a0b8dab9866fdc9fd640d45e8443c46
name: python-lmnr-help
arch: noarch
version: 0.4.49
epoch: 0
release: 1
summary: Development documents and examples for lmnr
url: https://pypi.org/project/lmnr/
rpm_license: Apache-2.0
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lmnr-0.4.49-1.src.rpm
location_href: Packages/python-lmnr-help-0.4.49-1.noarch.rpm
checksum_type: sha256
description:
  Python SDK for [Laminar](https://www.lmnr.ai).

  [Laminar](https://www.lmnr.ai) is an open-source platform for engineering LLM products. Trace, evaluate, annotate, and analyze LLM data. Bring LLM applications to production with confidence.

  Check our [open-source repo](https://github.com/lmnr-ai/lmnr) and don't forget to star it ⭐

   <a href="https://pypi.org/project/lmnr/"> ![PyPI - Version](https://img.shields.io/pypi/v/lmnr?label=lmnr&logo=pypi&logoColor=3775A9) </a>
  ![PyPI - Downloads](https://img.shields.io/pypi/dm/lmnr)
  ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lmnr)




  First, install the package, specifying the instrumentations you want to use.

  For example, to install the package with OpenAI and Anthropic instrumentations:

  ```sh
  pip install 'lmnr[anthropic,openai]'
  ```

  To install all possible instrumentations, use the following command:

  ```sh
  pip install 'lmnr[all]'
  ```

  Initialize Laminar in your code:

  ```python
  from lmnr import Laminar

  Laminar.initialize(project_api_key="<PROJECT_API_KEY>")
  ```

  Note that you need to only initialize Laminar once in your application.





  To instrument any function in your code, we provide a simple `@observe()` decorator.
  This can be useful if you want to trace a request handler or a function which combines multiple LLM calls.

  ```python
  import os
  from openai import OpenAI
  from lmnr import Laminar

  Laminar.initialize(project_api_key=os.environ["LMNR_PROJECT_API_KEY"])

  client = OpenAI(api_key=os.environ["OPENAI_API_KEY"])

  def poem_writer(topic: str):
      prompt = f"write a poem about {topic}"
      messages = [
          {"role": "system", "content": "You are a helpful assistant."},
          {"role": "user", "content": prompt},
      ]

      
      response = client.chat.completions.create(
          model="gpt-4o",
          messages=messages,
      )
      poem = response.choices[0].message.content

      return poem

  @observe()
  def generate_poems():
      poem1 = poem_writer(topic="laminar flow")
      poem2 = poem_writer(topic="turbulence")
      poems = f"{poem1}\n\n---\n\n{poem2}"
      return poems
  ```

  Also, you can use `Laminar.start_as_current_span` if you want to record a chunk of your code using `with` statement.

  ```python
  def handle_user_request(topic: str):
      with Laminar.start_as_current_span(name="poem_writer", input=topic):
          poem = poem_writer(topic=topic)
          
          Laminar.set_span_output(poem)
  ```



  Laminar allows you to automatically instrument majority of the most popular LLM, Vector DB, database, requests, and other libraries.

  If you want to automatically instrument a default set of libraries, then simply do NOT pass `instruments` argument to `.initialize()`.
  See the full list of available instrumentations in the [enum](https://github.com/lmnr-ai/lmnr-python/blob/main/src/lmnr/openllmetry_sdk/instruments.py).

  If you want to automatically instrument only specific LLM, Vector DB, or other
  calls with OpenTelemetry-compatible instrumentation, then pass the appropriate instruments to `.initialize()`.
  For example, if you want to only instrument OpenAI and Anthropic, then do the following:

  ```python
  from lmnr import Laminar, Instruments

  Laminar.initialize(project_api_key=os.environ["LMNR_PROJECT_API_KEY"], instruments={Instruments.OPENAI, Instruments.ANTHROPIC})
  ```

  If you want to fully disable any kind of autoinstrumentation, pass an empty set as `instruments=set()` to `.initialize()`.

  Autoinstrumentations are provided by Traceloop's [OpenLLMetry](https://github.com/traceloop/openllmetry).





  Install the package:

  ```sh
  pip install lmnr
  ```

  Create a file named `my_first_eval.py` with the following code:

  ```python
  from lmnr import evaluate

  def write_poem(data):
      return f"This is a good poem about {data['topic']}"

  def contains_poem(output, target):
      return 1 if output in target['poem'] else 0


  data = [
      {"data": {"topic": "flowers"}, "target": {"poem": "This is a good poem about flowers"}},
      {"data": {"topic": "cars"}, "target": {"poem": "I like cars"}},
  ]

  evaluate(
      data=data,
      executor=write_poem,
      evaluators={
          "containsPoem": contains_poem
      },
      group_id="my_first_feature"
  )
  ```

  Run the following commands:

  ```sh
  export LMNR_PROJECT_API_KEY=<YOUR_PROJECT_API_KEY>  # get from Laminar project settings
  lmnr eval my_first_eval.py  # run in the virtual environment where lmnr is installed
  ```

  Visit the URL printed in the console to see the results.



  Bring rigor to the development of your LLM applications with evaluations.

  You can run evaluations locally by providing executor (part of the logic used in your application) and evaluators (numeric scoring functions) to `evaluate` function.

  `evaluate` takes in the following parameters:
  - `data` – an array of `EvaluationDatapoint` objects, where each `EvaluationDatapoint` has two keys: `target` and `data`, each containing a key-value object. Alternatively, you can pass in dictionaries, and we will instantiate `EvaluationDatapoint`s with pydantic if possible
  - `executor` – the logic you want to evaluate. This function must take `data` as the first argument, and produce any output. It can be both a function or an `async` function.
  - `evaluators` – Dictionary which maps evaluator names to evaluators. Functions that take output of executor as the first argument, `target` as the second argument and produce a numeric scores. Each function can produce either a single number or `dict[str, int|float]` of scores. Each evaluator can be both a function or an `async` function.
  - `name` – optional name for the evaluation. Automatically generated if not provided.
  - `group_id` – optional group name for the evaluation. Evaluations within the same group can be compared visually side-by-side

  \* If you already have the outputs of executors you want to evaluate, you can specify the executor as an identity function, that takes in `data` and returns only needed value(s) from it.

  Read the [docs](https://docs.lmnr.ai/evaluations/introduction) to learn more about evaluations.



  You can create Laminar pipelines in the UI and manage chains of LLM calls there.

  After you are ready to use your pipeline in your code, deploy it in Laminar by selecting the target version for the pipeline.

  Once your pipeline target is set, you can call it from Python in just a few lines.

  Example use:

  ```python
  from lmnr import Laminar

  Laminar.initialize('<YOUR_PROJECT_API_KEY>', instruments=set())

  result = Laminar.run(
      pipeline = 'my_pipeline_name',
      inputs = {'input_node_name': 'some_value'},
      
      env = {'OPENAI_API_KEY': 'sk-some-key'},
  )
  ```

  Resulting in:

  ```python
  >>> result
  PipelineRunResponse(
      outputs={'output': {'value': [ChatMessage(role='user', content='hello')]}},
      
      run_id='53b012d5-5759-48a6-a9c5-0011610e3669'
  )
  ```



  You can perform a semantic search on a dataset in Laminar by calling `Laminar.semantic_search`.

  ```python
  response = Laminar.semantic_search(
      query="Greatest Chinese architectural wonders",
      dataset_id=uuid.UUID("413f8404-724c-4aa4-af16-714d84fd7958"),
  )
  ```

  [Read more](https://docs.lmnr.ai/datasets/indexing) about indexing and semantic search.


pkgId: d16749803b3ca6414008e260f54304393dbdfea9118cbc774c5d470426c9eab0
name: python-lnbits-help
arch: noarch
version: 0.12.12
epoch: 0
release: 1
summary: Development documents and examples for lnbits
url: https://lnbits.com
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lnbits-0.12.12-1.src.rpm
location_href: Packages/python-lnbits-help-0.12.12-1.noarch.rpm
checksum_type: sha256
description:
  <picture >
    <source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/QE6SIrs.png"  style="width:300px">
    <img src="https://i.imgur.com/fyKPgVT.png" style="width:300px">
  </picture>

  ![phase: beta](https://img.shields.io/badge/phase-beta-C41E3A) [![license-badge]](LICENSE) [![docs-badge]][docs] ![PRs: welcome](https://img.shields.io/badge/PRs-Welcome-08A04B) [<img src="https://img.shields.io/badge/community_chat-Telegram-24A1DE">](https://t.me/lnbits) [<img src="https://img.shields.io/badge/supported_by-%3E__OpenSats-f97316">](https://opensats.org)
  ![Lightning network wallet](https://i.imgur.com/DeIiO0y.png)





  LNbits is beta, for responsible disclosure of any concerns please contact an admin in the community chat.

  LNbits is a Python server that sits on top of any funding source. It can be used as:

  - Accounts system to mitigate the risk of exposing applications to your full balance via unique API keys for each wallet
  - Extendable platform for exploring Lightning network functionality via the LNbits extension framework
  - Part of a development stack via LNbits API
  - Fallback wallet for the LNURL scheme
  - Instant wallet for LN demonstrations

  LNbits can run on top of almost all Lightning funding sources.

  See [LNbits manual](https://docs.lnbits.org/guide/wallets.html) for more detailed documentation about each funding source.

  Checkout the LNbits [YouTube](https://www.youtube.com/playlist?list=PLPj3KCksGbSYG0ciIQUWJru1dWstPHshe) video series.

  LNbits is inspired by all the great work of [opennode.com](https://www.opennode.com/), and in particular [lnpay.co](https://lnpay.co/). Both work as funding sources for LNbits.



  Test on our demo server [demo.lnbits.com](https://demo.lnbits.com), or on [lnbits.com](https://lnbits.com) software as a service, where you can spin up an LNbits instance for 21sats per hr.

  See the [install guide](https://github.com/lnbits/lnbits/blob/main/docs/guide/installation.md) for details on installation and setup.



  LNbits is packaged with tools to help manage funds, such as a table of transactions, line chart of spending, export to csv. Each wallet also comes with its own API keys, to help partition the exposure of your funding source.

  <img src="https://i.imgur.com/w8jdGpF.png" style="width:800px">



  Extend YOUR LNbits to meet YOUR needs.

  All non-core features are installed as extensions, reducing your code base and making your LNbits unique to you. Extend your LNbits install in any direction, and even create and share your own extensions.

  <img src="https://i.imgur.com/aEBpwJF.png" style="width:800px">



  LNbits has a powerful API, many projects use LNbits to do the heavy lifting for their bitcoin/lightning services.

  <img src="https://i.imgur.com/V742sb9.png" style="width:800px">



  LNbits comes packaged with a light node management UI, to make running your node that much easier.

  <img src="https://i.imgur.com/TYqIK60.png" style="width:800px">



  As well as working great in a browser, LNbits has native IoS and Android apps as well as a chrome extension. So you can enjoy the same UI across ALL your devices.

  <img src="https://i.imgur.com/J96EbRf.png" style="width:800px">



  If you like this project [send some tip love](https://demo.lnbits.com/lnurlp/link/fH59GD)!

  [docs]: https://github.com/lnbits/lnbits/wiki
  [docs-badge]: https://img.shields.io/badge/docs-lnbits.org-673ab7.svg
  [github-mypy]: https://github.com/lnbits/lnbits/actions?query=workflow%3Amypy
  [github-mypy-badge]: https://github.com/lnbits/lnbits/workflows/mypy/badge.svg
  [github-tests]: https://github.com/lnbits/lnbits/actions?query=workflow%3Atests
  [github-tests-badge]: https://github.com/lnbits/lnbits/workflows/tests/badge.svg
  [codecov]: https://codecov.io/gh/lnbits/lnbits
  [codecov-badge]: https://codecov.io/gh/lnbits/lnbits/branch/master/graph/badge.svg
  [license-badge]: https://img.shields.io/badge/license-MIT-blue.svg


pkgId: 6b68924c485427a0754b953dd1ab20da682586193e541ffae534c8bb03b7d16b
name: python-load-atoms-help
arch: noarch
version: 0.3.9
epoch: 0
release: 1
summary: Development documents and examples for load-atoms
url: https://github.com/jla-gardner/load-atoms
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-load-atoms-0.3.9-1.src.rpm
location_href: Packages/python-load-atoms-help-0.3.9-1.noarch.rpm
checksum_type: sha256
description:
  > [!WARNING]
  > This project is under active development. Until version 1.0.0 is released, breaking changes to the API may occur with no notice.
  >
  <div align="center">
      <a href="https://jla-gardner.github.io/load-atoms/">
          <img src="https://raw.githubusercontent.com/jla-gardner/load-atoms/main/docs/source/logo.svg" width="50%"/>
      </a>
  </div>

  </br>

  <div align="center">

  [![PyPI](https://img.shields.io/pypi/v/load-atoms)](https://pypi.org/project/load-atoms/)
  [![GitHub](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
  [![](https://github.com/jla-gardner/load-atoms/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/jla-gardner/load-atoms/actions/workflows/tests.yaml)
  [![codecov](https://codecov.io/gh/jla-gardner/load-atoms/branch/main/graph/badge.svg)](https://codecov.io/gh/jla-gardner/load-atoms)
  [![Documentation Status](https://img.shields.io/badge/documentation-live-green.svg)](https://jla-gardner.github.io/load-atoms/)
  [![GitHub last commit](https://img.shields.io/github/last-commit/jla-gardner/load-atoms)]()

  </div>

  </br>

  **`load-atoms`** is a Python package for **L**oading **O**pen **A**ccess **D**atasets for **Ato**mistic **M**aterials **S**cience (LOAD-AtoMS).
  See the [documentation](https://jla-gardner.github.io/load-atoms/) for more information.

  **`load-atoms`** is maintained by me, John Gardner ([GitHub](https://github.com/jla-gardner) - [website](https://jla-gardner.github.io)), as part of my PhD research activities within the [Deringer Group](https://www.chem.ox.ac.uk/people/volker-deringer/).



  `pip install load-atoms`




  ```pycon
  >>> from load_atoms import load_dataset
  >>> dataset = load_dataset("C-GAP-17")

  ╭─────────────────────────── C-GAP-17 ────────────────────────────╮
  │                                                                 │
  │  ✓  Downloading C-GAP-17.extxyz ━━━━━━━━━━━━━━━━━━━━ 100% 00:00 │
  │  ✓  Reading C-GAP-17.extxyz     ━━━━━━━━━━━━━━━━━━━━ 100% 00:01 │
  │  ✓  Caching to disk             ━━━━━━━━━━━━━━━━━━━━ 100% 00:00 │
  │                                                                 │
  │ The C-GAP-17 dataset is covered by the CC BY-NC-SA 4.0 license. │
  │  Please cite the C-GAP-17 dataset if you use it in your work.   │
  │     For more information about the C-GAP-17 dataset, visit      │
  │                       load-atoms/C-GAP-17                       │
  ╰─────────────────────────────────────────────────────────────────╯
  ```

  ```
  >>> print(dataset)

  C-GAP-17:
      structures: 4,530
      atoms: 284,965
      species:
          C: 100.00%
      properties:
          per atom: (force)
          per structure: (config_type, detailed_ct, energy, split)
  ```




  Please see the [contributing guidelines](https://jla-gardner.github.io/load-atoms/dev/developer-guide.html) for information on how to contribute to the project.

rpm_license:
  MIT License  Copyright (c) 2023 John Gardner  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


pkgId: 9c7973134c666653798fd5fd0f048eda6d6092da4ac92fac7c3b494fa993e668
name: python-locache-help
arch: noarch
version: 4.0.2
epoch: 0
release: 1
summary: Development documents and examples for locache
url: https://github.com/jla-gardner/locache
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-locache-4.0.2-1.src.rpm
location_href: Packages/python-locache-help-4.0.2-1.noarch.rpm
checksum_type: sha256
description:
  <div align="center">

  [![PyPI](https://img.shields.io/pypi/v/locache)](https://pypi.org/project/locache/)
  [![PyPI - Downloads](https://img.shields.io/pypi/dm/locache?color=green&label=Downloads&logo=Python&logoColor=white)](https://pypistats.org/packages/locache)
  [![GitHub](https://img.shields.io/github/license/jla-gardner/local-cache)](LICENCE.md)
  [![](https://github.com/jla-gardner/load-atoms/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/jla-gardner/load-atoms/actions/workflows/tests.yaml)
  [![codecov](https://codecov.io/gh/jla-gardner/locache/branch/master/graph/badge.svg?token=VGSFM0GWF1)](https://codecov.io/gh/jla-gardner/locache)
  </div>


  `locache` is a single-file, 0-dependency utility package for caching the results of deterministic and pure function calls to disk, exposed via the [`@persist`](#persist) decorator.

  These caches are:
  - **persistent across separate Python sessions**: run the function once to cache the result to disk, and then hit the cache again and again in different runs/notebooks/scripts/sessions
  - **aware of the function's source code**: if the function's source code changes, new values will be cached. If you change the source code back, the old values will still be in the cache (useful for using different versions of a function on e.g. different branches)
  - **configurable with `max_entries` and `max_age` parameters**: control how many entries to store, and how long to keep them in the cache for.



  Have you ever written something like this?

  ```python

  result = np.load("cached_result.npy")
  ```

  This is somewhat dangerous: what if you have changed `expensive_function` and forgotten to update the cache? Or accidentally deleted your cache file? Or you have `result = np.load("cached_result-v3-final.npy")`?

  `locache.persist` is an easy way to avoid these issues:
  1. wrap `expensive_function` with `@persist`
  2. call `expensive_function` as usual
  3. `locache` automatically caches the result of `expensive_function` to disk. If the function's source code changes, new values will be cached.




  `locache` is simple enough that you could have written it yourself. To use it in your project, either:
  - copy the [`locache.py`](locache.py) file into your project
  - install it with
  `pip install locache`



  `locache` provides 3 importable functions:
  - the `@persist` decorator
  - `reset`
  - `verbose`



  Wrap a pure function with `@persist` in order to cache its results to disk. The only stipulation is that the function's arguments and return value must be pickle-able.

  ```python
  >>> from locache import persist

  >>> @persist
  ... def my_func(x, num=3):
  ...     print("Hi from foo!")
  ...     return x * num

  >>> my_func(1) # function behaviour is unchanged
  Hi from foo!
  3
  >>> my_func(2, num=2)
  Hi from foo!
  4
  >>> my_func(1)  # cached results are returned
  3
  ```

  By default, `@persist` will store up to unlimited entries. Each of these will be removed 365 days after they are last accessed. These parameters can be changed by passing `max_entries` and `max_age` to `@persist`.



  Reset the cache for a given function.

  ```python
  >>> from locache import reset

  >>> @persist
  ... def squared(x):
  ...     print(f"Squaring {x}")
  ...     return x * x

  >>> squared(2)  # cache miss
  Squaring 2
  4
  >>> squared(2)  # cache hit
  4
  >>> reset(squared)
  >>> squared(2)  # cache miss
  Squaring 2
  4
  ```




  Turn on verbose, debug logging.


pkgId: 3bd6ee653212125737b6902014bbdbdd46df0c2806c3c73918f8507a8837c839
name: python-localcosmos-app-kit-help
arch: noarch
version: 0.3.12
epoch: 0
release: 1
summary: Development documents and examples for localcosmos-app-kit
url: https://github.com/localcosmos/app-kit
rpm_license: The MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-localcosmos-app-kit-0.3.12-1.src.rpm
location_href: Packages/python-localcosmos-app-kit-help-0.3.12-1.noarch.rpm
checksum_type: sha256
description:
  Build apps for web, Android and iOS. Supports identification keys, observation forms, maps, taxonomy and more


pkgId: 6b6a42f19bda3e46340a137e28d1e3b4a4171eb57441968df4aa732536b06368
name: python-locale-customise-help
arch: noarch
version: 1.0.0
epoch: 0
release: 1
summary: Development documents and examples for locale-customise
url: https://pypi.org/project/locale-customise/
rpm_license: GPL-3
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-locale-customise-1.0.0-1.src.rpm
location_href: Packages/python-locale-customise-help-1.0.0-1.noarch.rpm
checksum_type: sha256
description:
  [![PyPI version](https://badge.fury.io/py/locale-customise.svg)](https://badge.fury.io/py/locale-customise)

  `locale-customise` is a Python package that allows developers to easily customize and manage locale-specific settings, including date, time, currency, and number formatting. It provides a simple API to tailor locale settings for different regions, making it ideal for internationalization (i18n) projects.



  - **Flexible Locale Configuration**: Easily configure locale formats for dates, numbers, and currencies.
  - **Multi-Region Support**: Supports multiple locales for global applications.
  - **Customizable Options**: Override default locale settings with custom formats.
  - **Lightweight**: Minimal dependencies and fast performance.



  Install `locale-customise` using pip:

  ```bash
  pip install locale-customise
  ```



  Here's a basic example to get started:

  ```python
  from locale_customise import LocaleCustomiser


  customiser = LocaleCustomiser("en_US")


  formatted_number = customiser.format_number(1234567.89)
  print(formatted_number)  # Outputs: 1,234,567.89


  formatted_date = customiser.format_date("2024-08-01")
  print(formatted_date)  # Outputs: Aug 1, 2024


  customiser.set_locale("fr_FR")
  formatted_number = customiser.format_number(1234567.89)
  print(formatted_number)  # Outputs: 1 234 567,89
  ```



  Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature: `git checkout -b feature-name`.
  3. Commit your changes: `git commit -m 'Add some feature'`.
  4. Push to the branch: `git push origin feature-name`.
  5. Open a pull request.



  This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.



  If you have any questions or feedback, feel free to reach out to [Your Email or GitHub Profile].


pkgId: 2e55aef9991c43ff40821efca7fee768b21731e3bc93a1f3a57f66156a845c72
name: python-localscope-help
arch: noarch
version: 0.2.3
epoch: 0
release: 1
summary: Development documents and examples for localscope
url: https://pypi.org/project/localscope/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-localscope-0.2.3-1.src.rpm
location_href: Packages/python-localscope-help-0.2.3-1.noarch.rpm
checksum_type: sha256
description:
  Restrict the scope of functions for reproducible code execution and peace of mind. See the [documentation](https://localscope.readthedocs.io) for details.


pkgId: 8bcdd9bda849dff223c859b484e5ec856d7c9d89260584d8b3515c85ce622186
name: python-locobuzz-python-orm-help
arch: noarch
version: 1.1.3
epoch: 0
release: 1
summary: Development documents and examples for locobuzz-python-orm
url: https://github.com/LocoBuzz-Solutions-Pvt-Ltd/locobuzz_database_orm
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-locobuzz-python-orm-1.1.3-1.src.rpm
location_href: Packages/python-locobuzz-python-orm-help-1.1.3-1.noarch.rpm
checksum_type: sha256
description:
  ```markdown


  A Python package for managing database connections in both synchronous and asynchronous contexts using SQLAlchemy. The package provides two main classes: `SyncDatabase` for synchronous operations and `AsyncDatabase` for asynchronous operations with PostgreSQL.



  - Singleton pattern to ensure a single instance of the database connection.
  - Support for multiple databases with connection pooling.
  - Asynchronous support for improved performance in `AsyncDatabase`.
  - Easy switching between different databases.
  - Metadata initialization for table management.



  To install the package, you can use pip:

  ```bash
  pip install locobuzz_python_orm  # Replace with the actual package name
  ```





  To use the `SyncDatabase`, follow these steps:

  ```python
  from database_helper.database.sync_db import SyncDatabase


  sync_db = SyncDatabase(connection_string='postgresql://user:password@localhost/dbname')


  with sync_db:
      
      results = sync_db.execute_query("SELECT * FROM your_table;")
      print(results)
  ```



  For the `AsyncDatabase`, you'll use `async` and `await` keywords:

  ```python
  import asyncio
  from database_helper.database.async_db import AsyncDatabase

  async def main():
      
      async_db = AsyncDatabase(connection_string='postgresql://user:password@localhost/dbname')

      async with async_db:
          
          results = await async_db.execute_query("SELECT * FROM your_table;")
          print(results)


  asyncio.run(main())
  ```



  Both classes support switching databases on the fly:

  ```python

  sync_db.switch_database('new_dbname')


  await async_db.switch_database('new_dbname')
  ```



  You can initialize tables metadata using:

  ```python

  sync_db.initialize_tables(['your_table1', 'your_table2'])


  await async_db.initialize_tables(['your_table1', 'your_table2'])
  ```



  Both classes include basic error handling. If an error occurs during database operations, exceptions will be raised. You can implement additional logging as needed.



  - SQLAlchemy
  - Database connectors such as `pyodbc`, `pymysql`, `psycopg2`, `aioodbc`, `aiomysql`, `asyncpg`



  Atharva Udavant

  [GitHub Profile](https://github.com/Atharva17062002)
  [Email](mailto:17.atharva@gmail.com)


pkgId: fbb43795194fb1c26f3c51dc56423ed16bb4280879fb9c1c87a84f4c3d0a9408
name: python-locopy-help
arch: noarch
version: 0.6.3
epoch: 0
release: 1
summary: Development documents and examples for locopy
url: https://github.com/capitalone/locopy
rpm_license: Apache Software License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-locopy-0.6.3-1.src.rpm
location_href: Packages/python-locopy-help-0.6.3-1.noarch.rpm
checksum_type: sha256
description:
  A Python library to assist with ETL processing for:
  - Amazon Redshift (``COPY``, ``UNLOAD``)
  - Snowflake (``COPY INTO <table>``, ``COPY INTO <location>``)
  In addition:
  - The library supports Python 3.9 to 3.11
  - DB Driver (Adapter) agnostic. Use your favourite driver that complies with
    `DB-API 2.0 <https://www.python.org/dev/peps/pep-0249/>`_
  - It provides functionality to download and upload data to S3 buckets, and internal stages (Snowflake)


pkgId: 4120edf3bd8660bcf4bd5a5ce701b4aed3e81c210ae9660b18205f3fe138b761
name: python-locust-help
arch: noarch
version: 2.32.4
epoch: 0
release: 1
summary: Development documents and examples for locust
url: https://locust.io/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-locust-2.32.4-1.src.rpm
location_href: Packages/python-locust-help-2.32.4-1.noarch.rpm
checksum_type: sha256
description:
  [![PyPI](https://img.shields.io/pypi/v/locust.svg)](https://pypi.org/project/locust/)<!--![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Flocustio%2Flocust%2Fmaster%2Fpyproject.toml)-->[![Downloads](https://pepy.tech/badge/locust/week)](https://pepy.tech/project/locust)
  [![Build Status](https://github.com/locustio/locust/workflows/Tests/badge.svg)](https://github.com/locustio/locust/actions?query=workflow%3ATests)
  [![GitHub contributors](https://img.shields.io/github/contributors/locustio/locust.svg)](https://github.com/locustio/locust/graphs/contributors)
  [![Support Ukraine Badge](https://bit.ly/support-ukraine-now)](https://github.com/support-ukraine/support-ukraine)

  Locust is an open source performance/load testing tool for HTTP and other protocols. Its developer-friendly approach lets you define your tests in regular Python code.

  Locust tests can be run from command line or using its web-based UI. Throughput, response times and errors can be viewed in real time and/or exported for later analysis.

  You can import regular Python libraries into your tests, and with Locust's pluggable architecture it is infinitely expandable. Unlike when using most other tools, your test design will never be limited by a GUI or domain-specific language.

  To get started right away, head over to the [documentation](http://docs.locust.io/en/stable/installation.html).





  If you want your users to loop, perform some conditional behaviour or do some calculations, you just use the regular programming constructs provided by Python. Locust runs every user inside its own greenlet (a lightweight process/coroutine). This enables you to write your tests like normal (blocking) Python code instead of having to use callbacks or some other mechanism. Because your scenarios are “just python” you can use your regular IDE, and version control your tests as regular code (as opposed to some other tools that use XML or binary formats)

  ```python
  from locust import HttpUser, task, between

  class QuickstartUser(HttpUser):
      wait_time = between(1, 2)

      def on_start(self):
          self.client.post("/login", json={"username":"foo", "password":"bar"})

      @task
      def hello_world(self):
          self.client.get("/hello")
          self.client.get("/world")

      @task(3)
      def view_item(self):
          for item_id in range(10):
              self.client.get(f"/item?id={item_id}", name="/item")
  ```



  Locust makes it easy to run load tests distributed over multiple machines. It is event-based (using [gevent](http://www.gevent.org/)), which makes it possible for a single process to handle many thousands concurrent users. While there may be other tools that are capable of doing more requests per second on a given hardware, the low overhead of each Locust user makes it very suitable for testing highly concurrent workloads.



  Locust has a user friendly web interface that shows the progress of your test in real-time. You can even change the load while the test is running. It can also be run without the UI, making it easy to use for CI/CD testing.

  <picture>
  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/bottlenecked-server-light.png" alt="Locust UI charts" height="100" width="200"/>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/bottlenecked-server-dark.png" alt="Locust UI charts" height="100" width="200"/>
  <img src="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/bottlenecked-server-light.png" alt="Locust UI charts" height="100" width="200"/>
  </picture>
  <picture>
  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/webui-running-statistics-light.png" alt="Locust UI stats" height="100" width="200"/>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/webui-running-statistics-dark.png" alt="Locust UI stats" height="100" width="200"/>
  <img src="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/webui-running-statistics-light.png" alt="Locust UI stats" height="100" width="200"/>
  </picture>
  <picture>
  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/locust-workers-light.png" alt="Locust UI workers" height="100" width="200"/>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/locust-workers-dark.png" alt="Locust UI workers" height="100" width="200"/>
  <img src="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/locust-workers-light.png" alt="Locust UI workers" height="100" width="200"/>
  </picture>
  <picture>
  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/webui-splash-light.png" alt="Locust UI start test" height="100" width="200"/>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/webui-splash-dark.png" alt="Locust UI start test" height="100" width="200"/>
  <img src="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/webui-splash-light.png" alt="Locust UI start test" height="100" width="200"/>
  </picture>



  Even though Locust primarily works with web sites/services, it can be used to test almost any system or protocol. Just [write a client](https://docs.locust.io/en/latest/testing-other-systems.html#testing-other-systems) for what you want to test, or [explore some created by the community](https://github.com/SvenskaSpel/locust-plugins#users).



  Locust's code base is intentionally kept small and doesn't solve everything out of the box. Instead, we try to make it easy to adapt to any situation you may come across, using regular Python code. There is nothing stopping you from:

  * [Send real time reporting data to TimescaleDB and visualize it in Grafana](https://github.com/SvenskaSpel/locust-plugins/blob/master/locust_plugins/dashboards/README.md)
  * [Wrap calls to handle the peculiarities of your REST API](https://github.com/SvenskaSpel/locust-plugins/blob/8af21862d8129a5c3b17559677fe92192e312d8f/examples/rest_ex.py#L87)
  * [Use a totally custom load shape/profile](https://docs.locust.io/en/latest/custom-load-shape.html#custom-load-shape)
  * [...](https://github.com/locustio/locust/wiki/Extensions)



  * Documentation: [docs.locust.io](https://docs.locust.io)
  * Support/Questions: [StackOverflow](https://stackoverflow.com/questions/tagged/locust)
  * Github Discussions: [Github Discussions](https://github.com/orgs/locustio/discussions)
  * Chat/discussion: [Slack](https://locustio.slack.com) [(signup)](https://communityinviter.com/apps/locustio/locust)



  * Maintainer: [Lars Holmberg](https://github.com/cyberw)
  * UI: [Andrew Baldwin](https://github.com/andrewbaldwin44)
  * Original creator: [Jonatan Heyman](https://github.com/heyman)
  * Massive thanks to [all of our contributors](https://github.com/locustio/locust/graphs/contributors)



  Open source licensed under the MIT license (see _LICENSE_ file for details).


pkgId: 0489c6def511324fc066fea49cafa4eea2cf5187536ee9d29a478e2fc2f8a298
name: python-lofar-calculator-help
arch: noarch
version: 0.1.1
epoch: 0
release: 1
summary: Development documents and examples for lofar-calculator
url: https://git.astron.nl/ao/sdco/LOFAR-calculator
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lofar-calculator-0.1.1-1.src.rpm
location_href: Packages/python-lofar-calculator-help-0.1.1-1.noarch.rpm
checksum_type: sha256
description:
  The LOFAR Unified Calculator for Imaging, or LUCI, is a unified web interface that allows users to compute several parameters relevant for planning an interferometric observation with LOFAR.

  The web interface can be accessed at <https://support.astron.nl/luci>.

  LUCI is developed and maintained by the SDC Operations group (SDCO) at ASTRON. For comments and/or feature requests, please contact the SDCO group using the [JIRA Helpdesk](https://support.astron.nl/rohelpdesk).

  For a given observation and pipeline setup, the web interface allows users to:

  * Compute the raw and pre-processed data size,

  * Compute theoretical and effective image sensitivity,

  * Estimate the pipeline processing time,

  * Plot the visibility profiles of the sky sources on any given date,

  * Plan multi-beam observations, and

  * Export the observation and pipeline setup in a PDF format.



  The Observational setup section in LUCI allows users to specify an interferometric observing run with LOFAR. The various fields under this section are:

  * **Observation time (in seconds)** – Duration of an observing run (default: 28800 seconds). LUCI throws an error if a negative value is provided as input.

  * **No. of core stations (0 - 24)** – (default: 24)

  * **No. of remote stations (0 - 14)** – (default: 14)

  * **No. of international stations (0 - 14)** – (default: 14)

  * **Number of channels per subband** – Frequency resolution of an observing run. Allowed values are 64, 128, and 256 channels per subband (default: 64)

  * **Number of subbands** – Number of subbands to record as part of the observing run (default: 488). LUCI thows an error if the number of subbands is greater than 488.

  * **Integration time (in seconds)** – Correlator integration time. This input field determines the time resolution of the observing run (default: 1 second). LUCI thows an error if correlator time is smaller than 0.16 seconds.

  * **Antenna set** – specifies the mode in which the stations are operated. Allowed values are LBA Outer, LBA Sparse, HBA Dual, and HBA Dual Inner. (default: HBA Dual Inner).

  Upon clicking the button *Calculate*, LUCI computes the *theoretical image sensitivity*, *effective image sensitivity*, *mean elevation* of input target and the *raw data size*. The results of this computation is displayed to the user under the Results section. Note that before doing the calculations, LUCI validates the input specified by the user. If an invalid input is detected, LUCI displays an error.

  If the pipeline set-up is also selected, then the Results section will get an additional population of the *processed data size* and *pipeline processing time*.


  Besides calculating the data sizes and processing times, LUCI also allows users to check if their target of interest is visible to LOFAR on a specific date. The target of interest can be specified in the Target field under the Target setup section. If the specified source is valid, the Resolve button can be used to obtain the coordinates of that source. Note that LUCI can resolve valid LoTSS pointing names as well (like P17 or P205\+67). If however, the user wishes to *manually* input the coordinates, a *target name* **must** also be specified.

  In addition to plotting the target, users can also plot the elevations of standard LOFAR calibrators and A-team sources by selecting them using the Calibrators and the A-team sources dropdown boxes (these will not be used for data size or processing time calculations).

  Upon clicking the *Calculate* button, LUCI produces three plots:

  * **Target visibility plot** shows the elevation of a target as seen by LOFAR on the specified date as an interactive plot. If the field No. of international stations (0-14) is set to 0 (i.e.) observing with only the Dutch array, the target elevation is calculated with respect to the LOFAR core. On the other hand, if the user specifies the full array, LUCI plots the minimum apparent elevation of the target as seen by all LOFAR stations. In addition to the user-specified target, LUCI also plots the elevations of the Sun, the Moon, and Jupiter by default. The two blue regions indicate the sunrise and sunset times. A thicker line on top of the input target elevation plot is also shown to highlight the observation time around transit for each target.

  * **Beam Layout** plots the tile and station beams for the specified observation.

  * **Angular distance** between specified target and other bright sources are presented in a plotly table.



  Users can export their “observational setup” to a PDF file using the *Generate PDF* button. Upon clicking the *Generate PDF* button, LUCI exposes the *Download* file link below the two buttons which can be used to download the generated PDF file.

  **Note** that if you click on the *Generate PDF* button before using the *Calculate* button, LUCI will throw an error.


  To run the calculator on your local machine, install the dependencies with:
  ```
  pip install -r requirements.txt
  ```

  To launch the calculator, run the following command:
  ```bash
  python -m lofar_calculator.calculator
  ```
  and point your browser at `http://0.0.0.0:8051/luci/`

rpm_license:
[cell repeats an earlier one in this file: 10254 characters]


pkgId: ef2886079acfe74d40d922e68e050624825376c94ee7cc5e816d932e143c251b
name: python-log-candy-help
arch: noarch
version: 0.1.2
epoch: 0
release: 1
summary: Development documents and examples for log-candy
url: https://github.com/SabeeenoGH/log-candy
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-log-candy-0.1.2-1.src.rpm
location_href: Packages/python-log-candy-help-0.1.2-1.noarch.rpm
checksum_type: sha256
description:
  Log Candy is a simple and colorful logging utility designed to make your debug messages more delightful and informative. It provides easy-to-use functions for logging messages with different levels of importance, using vibrant colors for better distinction.



  - 🌈 **Color-Coded Logs**: Debug, Info, Warning, Error, and Result messages are each represented with a unique color for easy identification.

  - 📝 **Readable Formatting**: Automatically formats multiline messages for improved readability.

  - 🛠️ **Customizable Use**: Straightforward integration to be used anywhere in your Python projects.



  You can install `Log Candy` via `pip`:

  ```bash
  pip install log-candy
  ```



  - Python 3 version or higher is required.



  The package also carries the following dependencies (`requirements.txt`) for better use:

  ```bash
  tqdm==4.66.4
  ```



  Import `Log Candy` and start logging colorful messages in your project:

  ```python
  from log_candy import log_debug, log_info, log_warning, log_error, log_result


  log_debug("This is a debug message.")
  log_info("This is an info message.")
  log_warning("This is a warning message.")
  log_error("This is an error message.")
  log_result("This is a result message.")


  log_debug("This is a debug message.\nThis is a multiline debug message.")
  log_info("This is an info message.\nThis is a multiline info message.")
  log_warning("This is a warning message.\nThis is a multiline warning message.")
  log_error("This is an error message.\nThis is a multiline error message.")
  log_result("This is a result message.\nThis is a multiline result message.")
  ```



  - 🛠 **Ease of Use**: No setup required, just import and start logging.

  - 🌟 **Improved Clarity**: Quickly identify different types of logs by their color-coded format.

  - 💡 **Multiline Support**: Automatically indents subsequent lines to keep your logs neat.



  Contributions are welcome! If you have suggestions for improvements, please feel free to open an issue or create a pull request.



  1. Fork the repository.

  2. Create a new branch (`git checkout -b feature/amazing-feature`).

  3. Commit your changes (`git commit -m 'Add amazing feature'`).

  4. Push to the branch (`git push origin feature/amazing-feature`).

  5. Open a Pull Request.



  Special thanks to anyone who finds this project useful and helps make it better!

  Enjoy logging with Log Candy 🍭!


pkgId: 40f66dfd0753fb42d7091d40cad59dc8b88993c2af1d9847bf5890f861b97d78
name: python-logdelta-help
arch: noarch
version: 1.0.0.post1
epoch: 0
release: 1
summary: Development documents and examples for logdelta
url: https://pypi.org/project/logdelta/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-logdelta-1.0.0.post1-1.src.rpm
location_href: Packages/python-logdelta-help-1.0.0.post1-1.noarch.rpm
checksum_type: sha256
description:
  LogDelta - Go Beyond Grepping with NLP-based Log Analysis!

  See [YouTube](https://www.youtube.com/playlist?list=PLTUjKYPvVhe6JhHBlkJN_yPhVDR5w2ej2) demonstrating the tool in action.


  We recommend using a virtual environment to ensure smooth operations.
  ```bash
  conda create -n logdelta python=3.11
  conda activate logdelta
  ```
  Install logdelta.
  ```bash
  pip install logdelta
  ```
  Download source code, and navigate to demo folder
  ```bash
  git clone https://github.com/EvoTestOps/LogDelta.git
  cd LogDelta/demo
  ```
  Get data
  ```bash
  wget -O Hadoop.zip https://zenodo.org/records/8196385/files/Hadoop.zip?download=1
  unzip Hadoop.zip -d Hadoop
  ```
  Run analysis
  ```bash
  python -m logdelta.config_runner -c config.yml`
  ```
  Observer results in `LogDelta/demo/Output`. For more examples see `LogDelta/demo/label_investigation` and `LogDelta/demo/full`


  LogDelta assumes your folders represent a collection of software logs of interest. LogDelta performs a comparison between two or more folders using matching file names.  A **target run** represents a software run we are interested in analyzing. LogDelta uses **comparison runs** as a baseline. For example, the "My_passing_logs1", "My_passing_logs2", "My_passing_logs3" folders can be comparison runs, while "My_failing_logs" would be your target run that you want to analyze with respect to comparison runs.



  In LogDelta, three types of analysis are available:

  1. **Visualize**
     - Multiple logs files or runs with UMAP based on two dimensional scaling of the log contents.
     - Individual log files with log anomaly scoring (see step 3 for details anomaly detection supported)

  2. **Measure the distance between two logs or sets of logs** using:
     - Jaccard distance
     - Cosine distance
     - Containment distance
     - Compression distance

  3. **Build an anomaly detection model** from a set of logs and use it to score anomalies (higher scores more anomalous) in a log file using :
     - KMeans (kmeans)
     - IsolationForest (IF)
     - RarityModel (RM)
     - Out-of-Vocabulary Detector (OOVD)




  Analysis can be done at four different levels:

  1. **Run (folder) level**, investigating the names of files without looking at their contents.
  2. **Run (folder) level**, investigating run contents (this is slower than what is done in 1).
  3. **File level**, investigating file contents (matched with the same names between runs).
  4. **Line level**, investigating line contents (matched with the same names between runs).


  LogDelta is build on top of LogLead[^1]. https://pypi.org/project/LogLead/

  Log line level anomaly detection visualized. Which one is anomaly?
  ![8 different log files](images/8_log_files.png)


  [^1]: Mäntylä MV, Wang Y, Nyyssölä J. Loglead-fast and integrated log loader, enhancer, and anomaly detector. In2024 IEEE International Conference on Software Analysis, Evolution and Reengineering (SANER) 2024 Mar 12 (pp. 395-399). IEEE.


pkgId: 8d25cdbd9038d41a7ca9ac31d1584dfb68cf290b2cdf2cd82cc0c389cf1088a6
name: python-logfire-api-help
arch: noarch
version: 2.7.1
epoch: 0
release: 1
summary: Development documents and examples for logfire-api
url: https://pypi.org/project/logfire-api/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-logfire-api-2.7.1-1.src.rpm
location_href: Packages/python-logfire-api-help-2.7.1-1.noarch.rpm
checksum_type: sha256
description:
  Shim for the logfire SDK Python API which does nothing unless logfire is installed.

  This package is designed to be used by packages that want to provide opt-in integration with [Logfire](https://github.com/pydantic/logfire).

  The package provides a clone of the Python API exposed by the `logfire` package which does nothing if the `logfire` package is not installed, but makes real calls when it is.


pkgId: eeb725a3af12f971fb39740abd77f10cfc45fb8b031ae3796d9563b501b27709
name: python-logging-with-context-help
arch: noarch
version: 0.1.0
epoch: 0
release: 1
summary: Development documents and examples for logging-with-context
url: https://pypi.org/project/logging-with-context/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-logging-with-context-0.1.0-1.src.rpm
location_href: Packages/python-logging-with-context-help-0.1.0-1.noarch.rpm
checksum_type: sha256
description:
  This library provides utilities to easily add context to logging messages and to show them.



  When adding logging messages it's common to show some contextual information on it not directly related to the message, for example `The user <user-id> tried to authenticate with an invalid access token`.

  Orchestrate a monitorization platform that extracts information from the logs with these kind of messages is really hard:

  - Sometimes it's impossible to match a single message with a regular expression due to reuse the same format over and over again (e.g. `The user <user-id> ...`).
  - The programmers don't always follow the same format (e.g. `The user <user-id>`, `User: <user-id>`, `user=<user-id>`, etc).

  This problem can be fixed by using a well-defined format where the log message and the context values of the message are served separately.

  The Python logging module in the standard library already provides a way for doing this: instead of adding placeholders to the message, you can use the `extra` keyword to provide the contextual values of the message, then it's up to the configured formatter to format the values.

  This library provides utilities and logging abstractions to ease the use of this practice.




  Python 3.9 or greater




  Install the package [logging-with-context](pypi.org/project/logging-with-context).

  > [!NOTE]
  > The package is named logging-with-context because contextual-logging was rejected by Pypi due to being too similar to an existing project.




  The expected workflow is:

  * set up your logging system.
  * initialize the global context.
  * add global context values before writing messages or calling methods or functions that may write messages.
  * shutdown the global context before shutting down the application (optional, but recommended).




  After configuring your application's logging, initialize the global context:

  ```python
  import logging

  from logging_with_context.global_context import global_context_initialized


  def main():
      logging.basicConfig(level=logging.INFO)  # Or any other way to setup logging.
      with global_context_initialized():
          
  ```

  Once you've initialized it you can add global context to all the loggers using the context manager `add_global_context`.

  It accepts a dictionary with the values you want to include in all the logging messages, which will get removed from the loggers once the context manager finishes:

  ```python
  import logging

  from logging_with_context.global_context import add_global_context




  logger = logging.getLogger(__name__)


  with add_global_context({"user_id": user_id, "request_id": request_id}):
      
      logger.info("The user tried to authenticate with an invalid access token")
  ```




  In case you can't use the context manager, you can use the manual initialization and shutdown API:

  ```python
  import logging

  from logging_with_context.global_context import init_global_context, shutdown_global_context


  def main():
      logging.basicConfig(level=logging.INFO)  # Or any other way to setup logging.
      init_global_context()



  logger = logging.getLogger(__name__)


  with add_global_context({"user_id": user_id, "request_id": request_id}):
      
      logger.info("The user tried to authenticate with an invalid access token")



  def app_shutdown():
      
      shutdown_global_context()
  ```

  However in complex setups where you need to use specific loggers you'll need to send the same loggers to `init_global_context` and `shutdown_global_context`; see [Caveats](#caveats) section.




  To show the context you need a `Formatter` that somehow uses the context in the log messages produced.

  For example, the logging handler in Python applications running at AWS Lambda handles this automatically by adding the context provided in `extra` as labels to the log struct, separated from the message.

  If you're logging to a `StreamHandler` you can use `logging_with_context.formatters.ExtraTextFormatter`, which accepts the same options as the standard library `Formatter`.

  You can use it instead of the default `Formatter` in your logging setup:

  ```yaml
  version: 1

  formatters:
      contextual:
          class: logging_with_context.formatters.ExtraTextFormatter
          format: 's s'

  handlers:
      console:
          class: logging.StreamHandler
          level: DEBUG
          formatter: contextual
          stream: ext://sys.stdout

  root:
      level: DEBUG
      handlers: [console]
  ```

  If you're modifying the logging setup made by other part of an application, you can attach the `ExtraTextFormatter` and keep using your defined formatting options by passing it the existing `Formatter` as a parent:
  ```python
  import logging

  from logging_with_context.formatters import ExtraTextFormatter

  def main():
      logging.basicConfig(level=logging.INFO)
      for handler in logging.getLogger().handlers:
          handler.setFormatter(ExtraTextFormatter(parent=handler.formatter))
  ```

  `ExtraTextFormatter` uses the format `<message> |context_var_1|value|context_var_2|value|`, which is expected to be machine-processing friendly.

  It delegates on the `repr` method of most values to produce the value output; this behavior can be extended to handle custom types.




  The global context implementation works by attaching a `Filter` object which reads the context and add it to each message.

  This works in simple cases (e.g. CLI applications) but can fall short in application with more complex logging setups which attach handlers to specific loggers other than the root logger.

  The API accepts a list of loggers where the `Filter` will be attached in these cases:

  ```python
  import logging

  from logging_with_context.global_context import global_context_initialized


  def app_entrypoint():
      
      with global_context_initialized(logging.getLogger(), logging.getLogger("app")):
          ...
  ```



  Use the source, Luke (at least until I've generated proper docs from them).




  MIT


pkgId: 4c61e955a72560eadc9076018dd6dd3aa8d995161e41633975706a28e62e9fe8
name: python-logicbank-help
arch: noarch
version: 1.20.10
epoch: 0
release: 1
summary: Development documents and examples for logicbank
url: https://github.com/valhuber/logicbank
rpm_license: BSD
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-logicbank-1.20.10-1.src.rpm
location_href: Packages/python-logicbank-help-1.20.10-1.noarch.rpm
checksum_type: sha256
description:
  Logic Bank governs SQLAlchemy
  update transaction logic - multi-table derivations, constraints,
  and actions such as sending mail or messages. Logic consists of both:

  * **Rules - 40X** more concise
  using a spreadsheet-like paradigm, and

  * **Python - control and extensibility,**
  using standard tools and techniques

  > The example described below is a _typical_ example of multi-table logic.
  >
  > You may find it helpful to begin with [this Tutorial, using a basic example](../../wiki/Tutorial).
  >
  >
  > **Update - Jan 26, 2021:** You can use LogicBank for your own _existing_ projects.  For _new_ projects, the recommended approach is [**ApiLogicServer**](https://github.com/valhuber/ApiLogicServer#readme) - create a complete logic-enabled JSON:API for your database, and a admin app, with 1 command.

  This readme contains:

  1. [Background](#background)
      * [Why](#why---simple-cocktail-napkin-spec-explodes-into-massive-legacy-code) - problems addressed
      * [What](#what---declare-spreadsheet-like-rules---40x-more-concise) - what are spreadsheet-like rules
      * [How](#how---usage-and-operation-overview) - usage / operation overview
      * [Logic Execution](#logic-execution-add-order---watch-react-chain) - sample transaction execution, reuse and scalability
      * [Instant Web App](#an-agile-perspective) - built using [Flask App Builder Quickstart](https://github.com/valhuber/fab-quick-start/wiki)
  1. [Install Instructions](#installation) - of Python and Logic Bank, with verify and run instructions
  1. [Project Information](#project-information)






  If you've coded backend database logic - multi-table derivations and constraints -
  you know how much work it is, and how tedious.  Whether you code it in
  triggers and stored procedures, in ORM events, or UI controllers, it's a lot:
  typically nearly half the effort for a database project.

  It's also incredibly repetitive - you often get the feeling you're doing the same thing over and over.

  And you're right.  It's because backend logic follows patterns of "what" is supposed to happen.
  And your code is the "how".  Suddenly, a simple cocktail napkin specification explodes into a massive amount of legacy code:

  <figure><img src="https://github.com/valhuber/LogicBank/blob/main/images/overview/rules-vs-code.png?raw=true"></figure>

  Logic Bank was designed to make the cocktail napkin spec _executable_.


  Logic Bank introduces rules that are 40X more concise than legacy code.
  The 5 rules below (lines 40-49) express the same logic as 200 lines of code [**(see them here)**](examples/nw/logic/legacy).  That's because rules are all about "what"
  -- spreadsheet-like expressions that automate the tedious "how":

  <figure><img src="https://github.com/valhuber/LogicBank/blob/main/images/overview/cocktail-logic-bank.png?raw=true"></figure>


  Logic Bank is fully integrated with Python:
  * **Declare** rules in Python as shown above (more details in How, below)
  * **Extend** rules with Python (rule on line 51 invokes the Python function on line 32)
  * **Manage** logic using your existing IDE (PyCharm, VSCode etc for code completion, debugging, etc),
  and source control tools and procedures


  40X is... _large_ - do these results hold in practice?
  See [here](../../wiki#technology-evaluation) for
  additional background, and real world experience.



  <figure><img src="https://github.com/valhuber/LogicBank/blob/main/images/architecture.png?raw=true"></figure>
  Logic Bank operates as shown above:

   1. **Declare and Activate** (see example above):

      a. Create a ```declare_logic``` function (above, line 12),
      and declare your rules using ```Rule.``` (e.g., with IDE code completion)

      b. After opening your database, call ```activate```
      to register your rules, and establish Logic Bank as
      a listener for SQLAlchemy ```before_flush``` events


   2. Your application operates as usual: makes calls on `SQLAlchemy` for inserts, updates and deletes
      and issues `session.commit()`

      - By bundling transaction logic into SQLAlchemy data access, your logic
    is automatically shared, whether for hand-written code (Flask apps, APIs)


   3. The **Logic Bank** engine handles SQLAlchemy `before_flush` events on
  `Mapped Tables`, so executes when you issue ```session.commit()```


   4. The logic engine operates much like a spreadsheet:
      - **watch** for changes at the attribute level
      - **react** by running rules that referenced changed attributes, which can
      - **chain** to still other attributes that refer to
  _those_ changes.  Note these might be in different tables,
  providing automation for _multi-table logic_

  Logic does not apply to updates outside SQLAlchemy,
  nor to SQLAlchemy batch updates or unmapped sql updates.

  Let's see how logic operates on a typical, multi-table transaction.



  <figure><img src="https://github.com/valhuber/LogicBank/blob/main/images/check-credit.png?raw=true"></figure>


  The `add_order` example illustrates how
  __Watch / React / Chain__ operates to
  check the Credit Limit as each OrderDetail is inserted:

  1.  The `OrderDetail.UnitPrice` (copy, line 49) references Product, so inserts cause it to be copied

  2.  `Amount` (formula, line 48) watches `UnitPrice`, so its new value recomputes `Amount`

  3.  `AmountTotal` (sum, line 46) watches `Amount`, so `AmountTotal` is adjusted (more on adjustment, below)

  4.  `Balance` (sum, line 43) watches `AmountTotal`, so it is adjusted

  5.  And the Credit Limit constraint (line 40) is checked (exceptions are raised if constraints are violated, and the transaction is rolled back)

  All of the dependency management to see which attributes have changed,
  logic ordering, the SQL commands to read and adjust rows, and the chaining
  are fully automated by the engine, based solely on the rules above.


  Just as a spreadsheet reacts
  to inserts, updates and deletes to a summed column,
  rules automate _adding_, _deleting_ and _updating_ orders.
  This is how 5 rules represent the same logic as 200 lines of code.

  Check out more examples:
  * [**Ship Order**](../../wiki/Ship-Order) illustrates *cascade*, another form of multi-table logic
  * [**Banking**](../../wiki/Sample-Project---Banking) is a complex transaction using the command pattern


  Scalability requires more than clustering - SQLs must be pruned
  and optimized.  For example, the balance rule:
  * is **pruned** if only a non-referenced column is altered (e.g., Shipping Address)
  * is **optimized** into a 1-row _adjustment_ update instead of an
  expensive SQL aggregate

  For more on how logic automates and optimizes multi-table transactions,
  [click here](../../wiki#scalability-automatic-pruning-and-optimization).



  The core tenant of agile is

      Working software, driving collaboration, for rapid iterations

  Here's how rules can help.


  The examples above illustrate how just a few rules can replace
  [pages of code](examples/nw/logic/legacy).



  Rules are _self-ordering_ - they recognize their interdependencies,
  and order their execution and database access (pruning, adjustments etc)
  accordingly.  This means:

  * order is independent - you can state the rules in any order
  and get the same result

  * maintenance is simple - just make changes, additions and deletions,
  the engine will reorganize execution order and database access, automatically



  First, follow the instructions to verify / install Python, then install Logic Bank.



  The first section below verifies whether your Python environment is current.
  The following section explains how to install a current Python environment.


  Ensure you have these pre-reqs:
  ```
  python --version


  pip --version


  pyenv --version

  ```

  If you are missing any, install them as described here.  Skip this step if your pre-reqs are fine.

  To install Python:

  * Python3.8

     * Run the windows installer
        * Be sure to specify "add Python to Path"
     * On mac/Unix, consider [using homebrew](https://brew.sh/), as described
  [here](https://opensource.com/article/19/5/python-3-default-mac#what-to-do)

  * virtualenv - see [here](https://www.google.com/url?q=https%3A%2F%2Fpackaging.python.org%2Fguides%2Finstalling-using-pip-and-virtual-environments%2F%23creating-a-virtual-environment&sa=D&sntz=1&usg=AFQjCNEu-ZbYfqRMjNQ0D0DqU1mhFpDYmw)  (e.g.,  `pip install virtualenv`)
     * on PC, see [these instructions](https://pypi.org/project/pyenv-win/)

  * An IDE - optional - any will do (I've used [PyCharm](https://www.jetbrains.com/pycharm/download) and [VSCode](https://code.visualstudio.com), install notes [here](https://github.com/valhuber/fab-quick-start/wiki/IDE-Setup)), though different install / generate / run instructions apply for running programs.

  Issues?  [Try here](https://github.com/valhuber/fab-quick-start/wiki/Mac-Python-Install-Issues).



  This procedure installs the Logic Bank source code, including
  examples you can explore.

  > To use Logic Bank in your own project: `pip install LogicBank`

  In your IDE or Command Line:

  ```

  git clone https://github.com/valhuber/LogicBank.git
  cd LogicBank

  virtualenv venv

  source venv/bin/activate
  pip install -r requirements.txt
  ```
  > **Warning -** if you just download the zip, *be sure* to remove the hyphen from the name.

  > **Warning -** if you use an IDE, be sure to activate the virtual environment, and verify you are running a proper version of Python.




  Run the `nw/tests` programs under your IDE or the
  command line; start with `test_add_order` and `test_upd_order_shipped,`
  and see the [walk-throughs here](../../wiki/home#logic-execution-watch-react-chain).
  The tests use ```unittest``` - you can run them as follows:

  ```
  cd examples/nw/tests
  python -m unittest test_add_order.py
  python test_add_order.py  # or, run it like this

  python -m unittest discover -p "test*.py"  # run all tests
  ```

  > Note: the console **log** depicts logic execution
  >
  > Log lines are long - consider copying them to a text
  > editor to view with / without word wrap
  >
  > Or, run in an IDE - they look [like this](../../wiki/home#debugging-standard-debugger-logic-logging).





  First, run the [**10 minute Tutorial**](../../wiki/Tutorial).
  You will see how to create, run and debug a rule in a simple, running example.



  Then, check out the [**Examples**](../../wiki/Examples) - note the **navigation bar** on the right.  Key samples:
  * [**Ship Order**](../../wiki/Ship-Order) illustrates *cascade*, another form of multi-table logic
  * [**Allocation**](../../wiki/Sample-Project---Allocation) illustrates *extensibility*,
  providing a reusable pattern for a *provider* to allocate
  to a set of *recipients*
  * [**Banking**](../../wiki/Sample-Project---Banking) is a complex transaction using the command pattern
  * [**Referential Integrity**](../../wiki/Referential-Integrity) illustrates referential integrity support


  A good way to proceed is to
  * Clear the log
  * Run the test
  * Review the log, and the rules that drove the processing



  There a few articles that provide some orientation to Logic Bank:
  * [Extensible Rules](https://dzone.com/articles/logic-bank-now-extensible-drive-95-automation-even) - defining new rule types, using Python
  * [Declarative](https://dzone.com/articles/agile-design-automation-how-are-rules-different-fr) - exploring _multi-statement_ declarative technology
  * [Automate Business Logic With Logic Bank](https://dzone.com/articles/automate-business-logic-with-logic-bank) - general introduction, discussions of extensibility, manageability and scalability
  * [Agile Design Automation With Logic Bank](https://dzone.com/articles/logical-data-indendence) - focuses on automation, design flexibility and agile iterations



  The `Logic Bank Examples` [(setup instructions here)](../../wiki/Sample-Project---Setup)
  contains the same examples, but _not_ the `logic_bank` engine source code.
  It uses the logic engine via `pip install`, as you would for your own projects:

  ```
  pip install logicbank
  ```
  > This is **not required here**, and requires the same
  > pre-reqs noted above







  [Revisions](https://github.com/valhuber/LogicBank/wiki/Summary,-Update-History) are described here.



  <figure><img src="https://github.com/valhuber/LogicBank/blob/main/images/logic-bank-project.png?raw=true"></figure>

  Logic Bank consists of:

  * Several test database systems - `nw,`  `banking`,
    `referential_integrity` and `payment_allocation`;
  these contain

      * [Databases](examples/nw/db) sqlite (no install required) and models

      * [Test folders](examples/nw/tests) that run key transactions - just run the scripts
  (note the logs)

      * [Logic](examples/nw/logic) - rules (and for `nw`,
      the manual `legacy` code for contrast to rules)

  * The `nw` sample illustrates comparisons of Business logic, both
  [by code](examples/nw/logic/legacy) and by rules (shown above).

  * The `logic_bank` engine source code




  To explore:

  * Click [here](../../wiki/Explore-Logic-Bank)
      for install / operations procedures

  * Click [here](../../wiki/Logic-Walkthrough) for a
      short overview of internal logic execution


  There are many to thank:
  * Tyler Band, for testing and the Banking example
  * Max Tardiveau, for testing
  * Nishanth Shyamsundar, for PC testing
  * Michael Holleran, for collaboration
  * Mike Bayer, for suggestions on leveraging Python typing and remarkable responsiveness
  * Achim Götz, for reporting an issue in FAB Quick Start use of Logic Base
  * Gloria, for many reviews... and golden patience


pkgId: 4d9be235136af9e591cd53efa9d3ce8669caf1bce307b779348755fc089a895f
name: python-logits-processor-zoo-help
arch: noarch
version: 0.1.1
epoch: 0
release: 1
summary: Development documents and examples for logits-processor-zoo
url: https://pypi.org/project/logits-processor-zoo/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-logits-processor-zoo-0.1.1-1.src.rpm
location_href: Packages/python-logits-processor-zoo-help-0.1.1-1.noarch.rpm
checksum_type: sha256
description:
  [![PyPI version](https://badge.fury.io/py/logits-processor-zoo.svg)](https://badge.fury.io/py/logits-processor-zoo)
  [![License: MIT](https://img.shields.io/badge/License-Apache2.0-yellow.svg)](https://opensource.org/licenses/Apache2.0)

  <p align="center">
      <img src="docs/logo.jpg" width="50%">
  </p>



  Struggling to get LLMs to follow your instructions? LogitsProcessorZoo offers a zoo of tools to use LLMs for specific tasks, beyond just grammar enforcement!



  ```bash
  pip install logits-processor-zoo
  ```


  * transformers
  * vLLM
  * TensorRT-LLM



  ```python
  import vllm
  from logits_processor_zoo.vllm import GenLengthLogitsProcessor, CiteFromPromptLogitsProcessor, ForceLastPhraseLogitsProcessor

  model = vllm.LLM(
              model_name,
              trust_remote_code=True,
              dtype="half",
              enforce_eager=True
          )
  tokenizer = model.get_tokenizer()

  logits_processors = [
      CiteFromPromptLogitsProcessor(tokenizer, boost_factor=2.0),
      GenLengthLogitsProcessor(tokenizer, boost_factor=-0.2, p=1),
      ForceLastPhraseLogitsProcessor("\n\nReferences:\n", tokenizer)
  ]


  gen_output = model.generate(
              prompts,
              vllm.SamplingParams(
                  n=1,
                  temperature=0,
                  seed=0,
                  skip_special_tokens=True,
                  max_tokens=64,
                  logits_processors=logits_processors
              ),
              use_tqdm=False
          )
  ```


  For the detailed examples in each framework, please have a look at **example_notebook** directory.




  A logits processor that adjusts the likelihood of the end-of-sequence (EOS) token based on the length of the generated sequence, encouraging or discouraging shorter answers.


  A logits processor which boosts or diminishes the likelihood of tokens present in the prompt (and optionally EOS token) to encourage the model to generate tokens similar to those seen in the prompt or vice versa.


  A logits processor which forces LLMs to use the given phrase before they finalize their answers. Most common use cases can be providing references, thanking user with context etc.


  A logits processor to answer multiple choice questions with one of the choices. A multiple choice question is like:
  ```
  I am getting a lot of calls during the day. What is more important for me to consider when I buy a new phone?
  0. Camera
  1. Screen resolution
  2. Operating System
  3. Battery
  ```
  The goal is to make LLM generate "3" as an answer.


pkgId: 92c4f9f77635760803a1ef33fad39e76ed740286ea6ef0683fa66c9cf9ebed17
name: python-lognflow-help
arch: noarch
version: 0.13.9
epoch: 0
release: 1
summary: Development documents and examples for lognflow
url: https://github.com/arsadri/lognflow
rpm_license: GNU General Public License v3
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lognflow-0.13.9-1.src.rpm
location_href: Packages/python-lognflow-help-0.13.9-1.noarch.rpm
checksum_type: sha256
description:
  Log and Flow tracking made easy with Python. You can install it by::
  	pip install lognflow
  A simple program to use it would be similar to the following, if the root for all logs is "c:\all_logs\\"::
  	from lognflow import lognflow
  	import numpy as np
  	data = np.random.rand(100)
  	logger = lognflow(r'c:\all_logs\\')
  	logger('This is a test for lognflow and save')
  	logger.save('data', data)
  	data = logger.load('data*.npy')
  	logger.plot('data', data)
  Apart form lots of easy logging and loading functionalities, lognflow provides a very nice progress bar that does not make a mess in terminals that do not support \r::
  	from lognflow import printprogress
  	N = 100
  	pbar = printprogress(N)
  	for _ in range(N):
  		
  		pbar()
  There is also a conviniant way to use multiprocessing in Python. You wish to
  provide a function name, iterable inputs and shared inputs. Then ask
  to run the function over the iterable inputs using multiprcessing. Then
  The multiprocessor is for you. The following is a cross-correlation of two
  masked verctors using a given ststistical function::
  	from lognflow import multiprocessor
  	def masked_cross_correlation(inputs_to_iter_sliced, inputs_to_share):
  		""" Calculate the correlation of two masked vectors, then use a given
  			statsitcal function to get the stat of the correlation.
  		"""
  	    vec1, vec2 = inputs_to_iter_sliced
  	    mask, statistics_func = inputs_to_share
  	    vec1 = vec1[mask==1]
  	    vec2 = vec2[mask==1]
  	    vec1 -= vec1.mean()
  	    vec1_std = vec1.std()
  	    if vec1_std > 0:
  	        vec1 /= vec1_std
  	    vec2 -= vec2.mean()
  	    vec2_std = vec2.std()
  	    if vec2_std > 0:
  	        vec2 /= vec2_std
  	    correlation = vec1 * vec2
  	    to_return = statistics_func(correlation)
  	    return(to_return)
  	if __name__ == '__main__':
  	    data_shape = (1000, 2000)
  	    data1 = np.random.randn(*data_shape)
  	    data2 = 2 + 5 * np.random.randn(*data_shape)
  	    mask = (2*np.random.rand(data_shape[1])).astype('int')
  	    statistics_func = np.median
  	    inputs_to_iter = (data1, data2)
  	    inputs_to_share = (mask, statistics_func)
  	    ccorr = multiprocessor(masked_cross_correlation,
  	    					   inputs_to_iter,
  	    					   inputs_to_share)
  	    print(f'ccorr: {ccorr}')
  In this package we use a folder on the HDD to generate files and folders in typical
  formats such as numpy npy and npz, png, ... to log. A log viewer is also availble
  to turn an already logged flow into variables. Obviously, it will read the folders
  and map them for you, which is something you could spend hours to do by yourself.
  Also there is the nicest progress bar, that you can easily understand
  and use or implement yourself when you have the time.
  Looking at most logging packages online, you see that you need to spend a lot of time
  learning how to use them and realizing how they work. Especially when you have to deal
  with http servers and ... which will be a huge pain when working for companies
  who have their own HPC.
  This is why lognflow is handy and straight forward.
  Many tests are avialable in the tests directory.
  * Free software: GNU General Public License v3
  * Documentation: https://lognflow.readthedocs.io.


pkgId: 85293a69ee002f0f6d94d83f99bf569dceb2dc39a4be689bd66f1aa71fcb7473
name: python-logs-py
arch: noarch
version: 3.0.0
epoch: 0
release: 1
summary: A python interface for the LOGS public API
url: https://docs.logs-python.com
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-logs-py-3.0.0-1.src.rpm
location_href: Packages/python-logs-py-3.0.0-1.noarch.rpm
checksum_type: sha256
description:
  LOGS is a scientific data management system (SDMS) software allowing for automated data collection, visualization, and organization. Within its internal organizational concepts it allows you to enrich you experimental data with metadata. LOGS allows you to adapt many of its organization structures which enables your data management to follow your internal workflows.

  **LOGS-Py is a Python package** interacting with the LOGS web API to enable you to extract and push data to LOGS and generally operateinteract with the LOGS backend in a programatic way. The main motivation behind in the desing of library is to keep this interaction as pythonic as possible. The communication with the API remains mainly in the background while the user of the library handles native Python objects whereby theuser is still able to interact with nearly are LOGS functionalities and entities.

  Thus _this library_ firstly _targets lab and data scientist_ allowing them to freely interact with experimental data and its meta-data without any pre-knowledge of Web technologies and communication. Secondly, it _facilitates power-users_ to implement highly specific workflows automations and 3rd-party software intergrations with LOGS and other lab software.



  The **LOGS-Py** package can be easily installed by using `pip`.

  For this open the `terminal` and do:

  ```bash
  pip install logs-py
  ```


pkgId: ed0833cf7c68a8a468cf5fd4aa4df05acb54841f4bf1dc5f1bf56d36e2288509
name: python-logyca-ai-help
arch: noarch
version: 0.2.8
epoch: 0
release: 1
summary: Development documents and examples for logyca-ai
url: https://github.com/logyca/python-libraries/tree/main/logyca-ai
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-logyca-ai-0.2.8-1.src.rpm
location_href: Packages/python-logyca-ai-help-0.2.8-1.noarch.rpm
checksum_type: sha256
description:
  * <a href="http://logyca.com" target="_blank">LOGYCA Company</a>
  * <a href="https://www.youtube.com/channel/UCzcJtxfScoAtwFbxaLNnEtA" target="_blank">LOGYCA Youtube Channel</a>
  * <a href="https://www.linkedin.com/company/logyca" target="_blank"><img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" alt="Linkedin"></a>
  * <a href="https://twitter.com/LOGYCA_Org" target="_blank"><img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" alt="Twitter"></a>


pkgId: 232e5f0657ec920c4a7a5505ae7f10b900d1a3c703074fe98489b4c3d87f1750
name: python-lonelypsp-help
arch: noarch
version: 0.0.11
epoch: 0
release: 1
summary: Development documents and examples for lonelypsp
url: https://pypi.org/project/lonelypsp/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lonelypsp-0.0.11-1.src.rpm
location_href: Packages/python-lonelypsp-help-0.0.11-1.noarch.rpm
checksum_type: sha256
description:
  Lonely Pub-Sub Protocol (lonely being the opposite of connected!)



  This project is in the development stage 2 - pre-alpha. This means the core functionality is
  available, but completely untested, and more functionality is expected to be added before it
  reaches the alpha stage.



  This is the Python specification for the protocol used by the canonical implementation
  [lonelypss](https://github.com/Tjstretchalot/lonelypss). It serves both
  as a reference for the protocol and as a helper library for the Python server and client.

  The types here are intended to facilitate alternate server and client
  implementations in a variety of languages, such as Ruby, TypeScript, and Rust.

  This library is fully mypy checked and has a flat class heirarchy (no
  subclasses); as soon as you check e.g. the type field, mypy and pylance will be
  able to deduce specific and accurate information about the remaining fields.

  This library is designed intentionally so you can pick and choose any part of the
  implementation to use relatively painlessly.

  Although the message packets are named for the initial transport layer (websockets),
  they will work in any reliable protocol where every message below a known size > 1024 bytes is
  not fragmented and the total length of the message is known. Thus, it can used directly
  on TCP with a bit of buffering and framing the message length for a significant
  performance boost compared to websockets (mostly due to not having to mask the data).



  Parsing:

  ```python
  import io

  from lonelypsp.stateful.parser import S2B_AnyMessageParser
  from lonelypsp.stateful.parser_helpers import parse_s2b_message_prefix


  message_body: io.BytesIO = ...
  prefix = parse_s2b_message_prefix(message_body)
  message = S2B_AnyMessageParser.parse(prefix.flags, prefix.type, message_body)

  if message.type == SubscriberToBroadcasterStatefulMessageType.SUBSCRIBE_EXACT:
      print(message.topic)
  ```

  Serialization:

  ```python
  from lonelypsp.stateful.constants import SubscriberToBroadcasterStatefulMessageType
  from lonelypsp.stateful.messages.subscribe import S2B_SubscribeExact, serialize_s2b_subscribe_exact

  message = serialize_s2b_subscribe_exact(
      S2B_SubscribeExact(
          type=SubscriberToBroadcasterStatefulMessageType.SUBSCRIBE_EXACT,
          authorization=None,
          topic=b"foo/bar",
      ),
      minimal_headers=True
  )

  ```


pkgId: ea10ef40ffda21dbc73dc938bc5b884507d35083f18368ff73582c9f222a4288
name: python-lookout-cli-help
arch: noarch
version: 1.14.0
epoch: 0
release: 1
summary: Development documents and examples for lookout-cli
url: https://github.com/Greenroom-Robotics/lookout
rpm_license: Copyright (C) 2023, Greenroom Robotics
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lookout-cli-1.14.0-1.src.rpm
location_href: Packages/python-lookout-cli-help-1.14.0-1.noarch.rpm
checksum_type: sha256
description:
  Publicly available on [PyPi](https://pypi.org/project/lookout-cli/) for convenience but if you don't work at Greenroom Robotics, you probably don't want to use this.



  * For development:
    * `pip install -e ./packages/lookout_config`
    * `pip install -e ./tools/lookout_cli`
  * For production: `pip install lookout-cli`
  * You may also need to `export PATH=$PATH:~/.local/bin` if you don't have `~/.local/bin` in your path
  * Install autocomplete:
    * bash: `echo 'eval "$(_lookout_COMPLETE=bash_source lookout)"' >> ~/.bashrc`
    * zsh: `echo 'eval "$(_lookout_COMPLETE=zsh_source lookout)"' >> ~/.zshrc` (this is much nicer)



  * `lookout --help` to get help with the CLI


pkgId: 160feac0404eba59fa7d8a1e85d08558c56c7b8ace9bc60ee5c5446edabb6e74
name: python-lookout-config-help
arch: noarch
version: 1.14.0
epoch: 0
release: 1
summary: Development documents and examples for lookout-config
url: https://github.com/Greenroom-Robotics/lookout
rpm_license: Copyright (C) 2023, Greenroom Robotics
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lookout-config-1.14.0-1.src.rpm
location_href: Packages/python-lookout-config-help-1.14.0-1.noarch.rpm
checksum_type: sha256
description:
  Lookout Config is used to load config stored inside the `~/.config/greenroom` folder.



  * `pip install -e ./packages/lookout_config`
  * or...
  * `pip install lookout_config` (Public on [PyPi](https://pypi.org/project/lookout-config/))





  ```python
  from lookout_config import read

  config = read()
  ```



  ```python
  from lookout_config import write, LookoutConfig

  config = LookoutConfig()

  write(config)

  ```



  After changing the dataclasses, you can generate the schemas with:

  ```bash
  python3 -m lookout_config.generate_schemas
  ```


pkgId: 64e9a40ab0f90b06b32ecf0d51aca412c300c93ef508c3138c5a99c66105efa5
name: python-loop-rate-limiters-help
arch: noarch
version: 1.1.0
epoch: 0
release: 1
summary: Development documents and examples for loop-rate-limiters
url: https://github.com/stephane-caron/loop-rate-limiters
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-loop-rate-limiters-1.1.0-1.src.rpm
location_href: Packages/python-loop-rate-limiters-help-1.1.0-1.noarch.rpm
checksum_type: sha256
description:
  [![Build](https://img.shields.io/github/actions/workflow/status/stephane-caron/loop-rate-limiters/main.yml?branch=main)](https://github.com/stephane-caron/loop-rate-limiters/actions)
  [![Documentation](https://img.shields.io/github/actions/workflow/status/stephane-caron/loop-rate-limiters/docs.yml?branch=main&label=docs)](https://upkie.github.io/loop-rate-limiters/)
  [![Coverage](https://coveralls.io/repos/github/stephane-caron/loop-rate-limiters/badge.svg?branch=main)](https://coveralls.io/github/stephane-caron/loop-rate-limiters?branch=main)
  [![Conda version](https://img.shields.io/conda/vn/conda-forge/loop-rate-limiters.svg)](https://anaconda.org/conda-forge/loop-rate-limiters)
  [![PyPI version](https://img.shields.io/pypi/v/loop-rate-limiters)](https://pypi.org/project/loop-rate-limiters/)

  Simple loop frequency regulators in Python with an API similar to ``rospy.Rate``:

  ```python
  from loop_rate_limiters import RateLimiter
  from time import perf_counter

  rate = RateLimiter(frequency=400.0)
  while True:
      print(f"Hello from loop at {perf_counter():.3f} s")
      rate.sleep()
  ```

  A similar ``AsyncRateLimiter`` class is available for [asynchronous code](https://github.com/stephane-caron/loop-rate-limiters#asynchronous-io).





  ```console
  conda install -c conda-forge loop-rate-limiters
  ```



  ```console
  pip install loop-rate-limiters
  ```



  The ``AsyncRateLimiter`` class provides a loop frequency limiter for [asyncio](https://docs.python.org/3/library/asyncio.html):

  ```python
  import asyncio
  from loop_rate_limiters import AsyncRateLimiter

  async def main():
      rate = AsyncRateLimiter(frequency=400.0)
      while True:
          loop_time = asyncio.get_event_loop().time()
          print(f"Hello from loop at {loop_time:.3f} s")
          await rate.sleep()

  asyncio.run(main())
  ```

  This can be used if, for instance, there are several tasks executed in parallel at different frequencies.



  - [ischedule](https://github.com/aleksve/ischedule): single-thread interval scheduler in Python


pkgId: abf9120bdac0d8a28a660a9a31a32618c584562ca17324290a141b89be51bde9
name: python-loopstructuralvisualisation-help
arch: noarch
version: 0.1.12
epoch: 0
release: 1
summary: Development documents and examples for loopstructuralvisualisation
url: https://pypi.org/project/loopstructuralvisualisation/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-loopstructuralvisualisation-0.1.12-1.src.rpm
location_href: Packages/python-loopstructuralvisualisation-help-0.1.12-1.noarch.rpm
checksum_type: sha256
description:
  A LoopStructural interface for pyvista's Plotter class.


  To install `pip install loopstructuralvisualisation` or for a jupyter notebook environment (including the pyvista[jupyuter] dependencies) `pip install loopstructuralvisualisation[jupyter]`


pkgId: 2d89695588abb53d7294d8715e8e8036988a13836d57e02e1d0ee97b21015cc8
name: python-losant-rest-help
arch: noarch
version: 1.21.1
epoch: 0
release: 1
summary: Development documents and examples for losant-rest
url: https://github.com/Losant/losant-rest-python
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-losant-rest-1.21.1-1.src.rpm
location_href: Packages/python-losant-rest-help-1.21.1-1.noarch.rpm
checksum_type: sha256
description:
  ![Build Status](https://github.com/Losant/losant-rest-python/actions/workflows/test.yml/badge.svg?branch=master) [![PyPI version](https://badge.fury.io/py/losant-rest.svg)](https://badge.fury.io/py/losant-rest)

  The [Losant](https://www.losant.com) REST API client provides a simple way to use the comprehensive Losant API. You can authenticate either as a Losant device or with your user account, and have access to all the functionality of the Losant platform.

  This client works with both Python 2.7 and 3. It uses [Requests](https://github.com/kennethreitz/requests/) under the covers for the actual HTTP communication.

  <br/>



  The latest stable version is available in the Python Package Index (PyPi) and can be installed using

  ```bash
  pip install losant-rest
  ```

  <br/>



  Below is a high-level example of using the Losant Python REST API client to authenticate against the Losant Platform and report state for a device.

  ```python
  from platformrest import Client
  from analog import AnalogSensor

  client = Client()
  creds = {
      'deviceId': 'my-device-id',
      'key': 'my-app-access-key',
      'secret': 'my-app-access-secret'
  }
  response = client.auth.authenticate_device(credentials=creds)

  client.auth_token = response['token']
  app_id = response['applicationId']

  state = {'data': {'temperature': AnalogSensor.read()}}
  response = client.device.send_state(deviceId='my-device-id',
      applicationId=app_id, deviceState=state)

  print(response)
  """ {'success': True} """
  ```

  <br/>





  A client is a single api instance. By default, it is unauthenticated, but can be given an access token to perform authenticated requests.



  ```python
  Client(auth_token=None, url="https://api.losant.com")
  ```

  The ``Client()`` constructor takes the following arguments:

  * auth_token
    The access token to be used for authentication - by default there is no access token. An access token can be acquired through any of the [Auth](docs/auth.md) methods, or can be created for a particular application through [application_api_tokens](docs/applicationApiTokens.md).

  * url
    The url of the Losant API - by default <https://api.losant.com>.



  * auth_token
    The access token can be accessed or changed after Client creation through this property.

  * url
    The api base url can be accessed or changed after Client creation through this property.



  Each of the following is a property on the client object, and returns a wrapper for the actions against that particular resource. See each resource documentation file for more information.

  * [application](docs/application.md)
    Contains all of the actions that can be performed against a single [Application](https://docs.losant.com/applications/overview/), which include things like getting info on an application or modifying an application.

  * [application_api_token](docs/applicationApiToken.md)
    Contains all the actions that can be performed against a single [Api Token](https://docs.losant.com/applications/application-tokens/) belonging to an application - for instance, getting info on a single token or revoking a token.

  * [application_api_tokens](docs/applicationApiTokens.md)
    Contains all of the actions that can be performed against the collection of [Api Tokens](https://docs.losant.com/applications/application-tokens/) belonging to an Application - such as listing all tokens or creating a new token.

  * [application_certificate](docs/applicationCertificate.md)
    Contains all the actions that can be performed against a single Application Certificate belonging to an application - for instance, getting info on a single certificate or disabling a certificate.

  * [application_certificate_authorities](docs/applicationCertificateAuthorities.md)
    Contains all the actions that can be performed against a single Application Certificate Authority belonging to an application - for instance, getting info on an authority or disabling an authority.

  * [application_certificate_authority](docs/applicationCertificateAuthority.md)
    Contains all of the actions that can be performed against the collection of Application Certificate Authorities belonging to an Application - such as listing all authorities or creating a new authority.

  * [application_certificates](docs/applicationCertificates.md)
    Contains all of the actions that can be performed against the collection of Application Certificates belonging to an Application - such as listing all certificates or creating a new certificate.

  * [application_cashboard](docs/applicationDashboard.md)
    Contains all the actions that can be performed against a single [Application Dashboard](https://docs.losant.com/dashboards/overview/) - for instance, things like getting info on a dashboard or modifying a dashboard.

  * [application_dashboards](docs/applicationDashboards.md)
    Contains all of the actions that can be performed against the collection of [Application Dashboards](https://docs.losant.com/dashboards/overview/) belonging to an Application - such as listing all dashboards or creating a new dashboard.

  * [application_key](docs/applicationKey.md)
    Contains all the actions that can be performed against a single [Application Key](https://docs.losant.com/applications/access-keys/) - for instance, getting info on a single key or revoking a key.

  * [application_keys](docs/applicationKeys.md)
    Contains all of the actions that can be performed against the collection of [Application Keys](https://docs.losant.com/applications/access-keys/) belonging to an Application - such as listing all keys or creating a new key.

  * [applications](docs/applications.md)
    Contains all of the actions that can be performed against the set of [Applications](https://docs.losant.com/applications/overview/) that the currently authenticated user has access to - such as listing the applications or creating a new application.

  * [application_template](docs/applicationTemplate.md)
    Contains all the actions that can be performed against a single [Application Template](https://docs.losant.com/templates/overview/) - for instance, getting info on a single template.

  * [application_templates](docs/applicationTemplates.md)
    Contains all of the actions that can be performed against the collection of [Application Templates](https://docs.losant.com/templates/overview/) - such as listing all templates or categories.

  * [audit_log](docs/auditLog.md)
    Contains all of the actions that can be performed against a single [Audit Log](https://docs.losant.com/organizations/audit-logs/) that belongs to an organization - such as viewing a log.

  * [audit_logs](docs/auditLogs.md)
    Contains all of the actions that can be performed against the set of [Audit Logs](https://docs.losant.com/organizations/audit-logs/) that belong to an organization - such as listing the logs.

  * [auth](docs/auth.md)
    Contains the actions used for authenticating against the api, either as a user or as a device. The result of authentication calls contain the auth_token needed for authenticated calls - see the examples for more details.

  * [credential](docs/credential.md)
    Contains all the actions that can be performed against a single [Service Credential](https://docs.losant.com/applications/credentials/), such as updating a credential or removing a credential.

  * [credentials](docs/credentials.md)
    Contains all of the actions that can be performed against the set of [Service Credentials](https://docs.losant.com/applications/credentials/) that the currently authenticated user has access to - such as listing the credentials or creating a new credential.

  * [dashboard](docs/dashboard.md)
    Contains all of the actions that can be performed against a single [Dashboard](https://docs.losant.com/dashboards/overview/), which include things like getting info on a dashboard or modifying a dashboard.

  * [dashboards](docs/dashboards.md)
    Contains all of the actions that can be performed against the set of [Dashboards](https://docs.losant.com/dashboards/overview/) that the currently authenticated user has access to - such as listing the dashboards or creating a new dashboard.

  * [data](docs/data.md)
    Contains the actions for querying against historical Device data across an Application.

  * [data_table](docs/dataTable.md)
    Contains all the actions that can be performed against a single [Data Table](https://docs.losant.com/data-tables/overview/) - for instance, getting info on a single data table or modifying the columns of a data table.

  * [data_table_row](docs/dataTableRow.md)
    Contains all the actions that can be performed against a single row inside of a [Data Table](https://docs.losant.com/data-tables/overview/) - for instance, getting the contents of a row, or modifying a row.

  * [data_table_rows](docs/dataTableRows.md)
    Contains all of the actions that can be performed against the collection of rows that make up a [Data Table](https://docs.losant.com/data-tables/overview/) - such as querying for rows in that table, or adding a new row to the table.

  * [data_tables](docs/dataTables.md)
    Contains all of the actions that can be performed against the collection of [Data Tables](https://docs.losant.com/data-tables/overview/) belonging to an Application - such as listing all data tables or creating a new data table.

  * [device](docs/device.md)
    Contains all the actions that can be performed against a single [Device](https://docs.losant.com/devices/overview/) - for instance, getting info on a single device or reporting the current state of a device.

  * [device_recipe](docs/deviceRecipe.md)
    Contains all the actions that can be performed against a single [Device Recipe](https://docs.losant.com/devices/device-recipes/), which include things like removing a device recipe or creating a device from a device recipe.

  * [device_recipes](docs/deviceRecipes.md)
    Contains all the actions that can be performed against the collection of [Device Recipes](https://docs.losant.com/devices/device-recipes/) belonging to an Application - such as listing recipes or creating a new recipe.

  * [devices](docs/devices.md)
    Contains all of the actions that can be performed against the collection of [Devices](https://docs.losant.com/devices/overview/) belonging to an Application - such as listing all devices or sending a command to a set of devices.

  * [edge_deployment](docs/edgeDeployment.md)
    Contains all the actions that can be performed against a single [Edge Deployment](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as retrieving information on a single deployment.

  * [edge_deployments](docs/edgeDeployments.md)
    Contains all the actions that can be performed against the collection of [Edge Deployments](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as listing deployments or creating a new deployment.

  * [embedded_deployment](docs/embeddedDeployment.md)
    Contains all the actions that can be performed against a single [Embedded Deployment](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as retrieving information on a single deployment.

  * [embedded_deployments](docs/embeddedDeployments.md)
    Contains all the actions that can be performed against the collection of [Embedded Deployments](https://docs.losant.com/edge-compute/deployments/) belonging to an Application - such as listing deployments or creating a new deployment.

  * [event](docs/event.md)
    Contains all the actions that can be performed against a single [Event](https://docs.losant.com/events/overview/), such as commenting on or changing the state of an event.

  * [events](docs/events.md)
    Contains all the actions that can be performed against the collection of [Events](https://docs.losant.com/events/overview/) belonging to an Application - such as listing open events or creating a new event.

  * [experience](docs/experience.md)
    Contains all the actions that can be performed against an application [Experience](https://docs.losant.com/experiences/), such as bootstrapping or clearing resources.

  * [experience_domain](docs/experienceDomain.md)
    Contains all the actions that can be performed against a single [Experience Domain](https://docs.losant.com/experiences/domains/), such as updating SSL certificate information.

  * [experience_domains](docs/experienceDomains.md)
    Contains all the actions that can be performed against the collection of [Experience Domains](https://docs.losant.com/experiences/domains/) belonging to an Application - such as listing domains or creating a new domain.

  * [experience_endpoint](docs/experienceEndpoint.md)
    Contains all the actions that can be performed against a single [Experience Endpoint](https://docs.losant.com/experiences/endpoints/), such as updating route information.

  * [experience_endpoints](docs/experienceEndpoints.md)
    Contains all the actions that can be performed against the collection of [Experience Endpoints](https://docs.losant.com/experiences/endpoints/) belonging to an Application - such as listing endpoints or creating a new endpoint.

  * [experience_group](docs/experienceGroup.md)
    Contains all the actions that can be performed against a single [Experience Group](https://docs.losant.com/experiences/groups/), such as updating member information.

  * [experience_groups](docs/experienceGroups.md)
    Contains all the actions that can be performed against the collection of [Experience Groups](https://docs.losant.com/experiences/groups/) belonging to an Application - such as listing groups or creating a new group.

  * [experience_slug](docs/experienceSlug.md)
    Contains all the actions that can be performed against a single [Experience Slug](https://docs.losant.com/experiences/domains/), such as changing the associated version.

  * [experience_slugs](docs/experienceSlugs.md)
    Contains all the actions that can be performed against the collection of [Experience Slugs](https://docs.losant.com/experiences/domains/) belonging to an Application - such as listing slugs or creating a new slug.

  * [experience_user](docs/experienceUser.md)
    Contains all the actions that can be performed against a single [Experience User](https://docs.losant.com/experiences/users/), such as changing their email or password.

  * [experience_users](docs/experienceUsers.md)
    Contains all the actions that can be performed against the collection of [Experience Users](https://docs.losant.com/experiences/users/) belonging to an Application - such as listing users or creating a new user.

  * [experience_version](docs/experienceVersion.md)
    Contains all the actions that can be performed against a single [Experience Version](https://docs.losant.com/experiences/), such as modifying the description.

  * [experience_versions](docs/experienceVersions.md)
    Contains all the actions that can be performed against the collection of [Experience Versions](https://docs.losant.com/experiences/) belonging to an Application - such as listing versions or creating a new versions.

  * [experience_view](docs/experienceView.md)
    Contains all the actions that can be performed against a single [Experience View](https://docs.losant.com/experiences/views/), such as modifying the body template.

  * [experience_views](docs/experienceViews.md)
    Contains all the actions that can be performed against the collection of [Experience Views](https://docs.losant.com/experiences/views/) belonging to an Application - such as listing views or creating a new view.

  * [file](docs/file.md)
    Contains all the actions that can be performed against a single [File](https://docs.losant.com/applications/files/), such as moving, renaming, or deleting.

  * [files](docs/files.md)
    Contains all the actions that can be performed against the collection of [Files](https://docs.losant.com/applications/files/) belonging to an Application - such as listing files or uploading a new file.

  * [flow](docs/flow.md)
    Contains all the actions that can be performed against a single [Workflow](https://docs.losant.com/workflows/overview/), such as enabling or disabling a workflow, or triggering a virtual button in the workflow.

  * [flows](docs/flows.md)
    Contains all the actions that can be performed against the collection of [Workflows](https://docs.losant.com/workflows/overview/) belonging to an Application - such as listing the workflows or creating a new workflow.

  * [flow_version](docs/flowVersion.md)
    Contains all the actions that can be performed against a single [Workflow Version](https://docs.losant.com/workflows/versioning/), such as enabling or disabling a workflow version, or updating the version notes.

  * [flow_versions](docs/flowVersions.md)
    Contains all the actions that can be performed against the collection of [Workflow Versions](https://docs.losant.com/workflows/versioning/) belonging to a Workflow - such as listing the versions or creating a new version.

  * [instance](docs/instance.md)
    Contains all the actions that can be performed against a single [Instance](https://docs.losant.com/instance-manager/overview/), which include things such as updating report configuration or defaults.

  * [instance_api_token](docs/instanceApiToken.md)
    Contains all the actions that can be performed against a single [Instance API Token](https://docs.losant.com/instance-manager/instance-tokens/) - for instance, getting info on a single token or revoking a token.

  * [instance_api_tokens](docs/instanceApiTokens.md)
    Contains all the actions that can be performed against the collection of [Instance API Tokens](https://docs.losant.com/instance-manager/instance-tokens/) belonging to an Instance - such as listing tokens or creating a new token.

  * [instance_audit_log](docs/instanceAuditLog.md)
    Contains all of the actions that can be performed against a single [Audit Log](https://docs.losant.com/instance-manager/audit-logs/) belonging to an Instance - such as viewing a log.

  * [instance_audit_logs](docs/instanceAuditLogs.md)
    Contains all of the actions that can be performed against the set of [Audit Logs](https://docs.losant.com/instance-manager/audit-logs/) belonging to an Instance - such as listing the logs.

  * [instance_custom_node](docs/instanceCustomNode.md)
    Contains all the actions that can be performed against a single [Instance Custom Node](https://docs.losant.com/instance-manager/instance-custom-nodes/) - for instance, getting info on a single custom node or modifying a custom node.

  * [instance_custom_nodes](docs/instanceCustomNodes.md)
    Contains all the actions that can be performed against the collection of [Instance Custom Nodes](https://docs.losant.com/instance-manager/instance-custom-nodes/) belonging to an Instance - such as listing custom nodes or creating a new custom node.

  * [instance_member](docs/instanceMember.md)
    Contains all the actions that can be performed against a single [Instance Member](https://docs.losant.com/instance-manager/overview/#managing-membership), which include things such as updating the role or removing the member.

  * [instance_members](docs/instanceMembers.md)
    Contains all the actions that can be performed against the collection of [Instance Members](https://docs.losant.com/instance-manager/overview/#managing-membership) belonging to an Instance - such as listing members or adding a new member.

  * [instance_notification_rule](docs/instanceNotificationRule.md)
    Contains all the actions that can be performed against a single [Instance Notification Rule](https://docs.losant.com/instance-manager/overview/#notifications), which include things such as updating the threshold or the targets.

  * [instance_notification_rules](docs/instanceNotificationRules.md)
    Contains all the actions that can be performed against the collection of [Instance Notification Rules](https://docs.losant.com/instance-manager/overview/#notifications) belonging to an Instance - such as listing rules or adding a new rule.

  * [instance_org_invite](docs/instanceOrgInvite.md)
    Contains all the actions that can be performed against a single [Instance Organization Invite](https://docs.losant.com/instance-manager/managing-organizations/#renewing-and-revoking-invitations), which include things such as revoking the invite.

  * [instance_org_invites](docs/instanceOrgInvites.md)
    Contains all the actions that can be performed against the collection of [Instance Organization Invites](https://docs.losant.com/instance-manager/managing-organizations/#renewing-and-revoking-invitations) belonging to an Organization in an Instance - such as listing invites or sending a new invitation.

  * [instance_org_member](docs/instanceOrgMember.md)
    Contains all the actions that can be performed against a single [Instance Organization Member](https://docs.losant.com/instance-manager/managing-organizations/#organization-membership), which include things such as changing the role or removing the membership.

  * [instance_org_members](docs/instanceOrgMembers.md)
    Contains all the actions that can be performed against the collection of [Instance Organization Members](https://docs.losant.com/instance-manager/managing-organizations/#organization-membership) belonging to an Organization in an Instance - such as listing members or adding new members.

  * [instance_org](docs/instanceOrganization.md)
    Contains all the actions that can be performed against a single [Instance Organization](https://docs.losant.com/instance-manager/managing-organizations/), which include things such as modifying limits.

  * [instance_orgs](docs/instanceOrgs.md)
    Contains all the actions that can be performed against the collection of [Instance Organizations](https://docs.losant.com/instance-manager/managing-organizations/) belonging to an Instance - such as listing organizations or adding a new organization.

  * [instance_sandbox](docs/instanceSandbox.md)
    Contains all the actions that can be performed against a single [Instance Sandbox](https://docs.losant.com/instance-manager/managing-sandbox-users/) - for instance, getting info on a single sandbox or deleting the sandbox.

  * [instance_sandboxes](docs/instanceSandboxes.md)
    Contains all the actions that can be performed against the collection of [Instance Sandboxes](https://docs.losant.com/instance-manager/managing-sandbox-users/) belonging to an Instance - such as listing sandboxes.

  * [instances](docs/instances.md)
    Contains all the actions that can be performed against the collection of [Instances](https://docs.losant.com/instance-manager/overview/) that the currently authenticated user has access to - such as listing instances.

  * [integration](docs/integration.md)
    Contains all the actions that can be performed against a single [Integration](https://docs.losant.com/applications/integrations/), which include things like removing an integration or updating integration configuration.

  * [integrations](docs/integrations.md)
    Contains all the actions that can be performed against the collection of [Integrations](https://docs.losant.com/applications/integrations/) belonging to an Application - such as listing integrations or creating a new integration.

  * [me](docs/me.md)
    Contains the actions for operating against the currently authenticated [User](https://docs.losant.com/user-accounts/overview/) such as changing the password or linking against external services.

  * [notebook](docs/notebook.md)
    Contains all the actions that can be performed against a single [Notebook](https://docs.losant.com/notebooks/overview/), which include things like removing a notebook or executing a notebook.

  * [notebooks](docs/notebooks.md)
    Contains all the actions that can be performed against the collection of [Notebooks](https://docs.losant.com/notebooks/overview/) belonging to an Application - such as listing notebooks or creating a new notebook.

  * [org_invites](docs/orgInvites.md)
    Contains all of the actions that can be performed against a invitation to an organization, such as accepting the invitation.

  * [org](docs/org.md)
    Contains all the actions that can be performed against a single [Organization](https://docs.losant.com/organizations/overview/), things like inviting a user to the organization, or modifying the organization.

  * [orgs](docs/orgs.md)
    Contains all of the actions that can be performed against the set of [Organizations](https://docs.losant.com/organizations/overview/) that the currently authenticated user has access to - such as listing the organizations or creating a new organization.

  * [resource_job](docs/resourceJob.md)
    Contains all the actions that can be performed against a single [Resource Job](https://docs.losant.com/applications/resource-jobs/), such as executing the job.

  * [resource_jobs](docs/resourceJobs.md)
    Contains all the actions that can be performed against the collection of [Resource Jobs](https://docs.losant.com/applications/resource-jobs/) belonging to an Application - such as listing resource jobs or creating a new resource job.

  * [user_api_token](docs/userApiToken.md)
    Contains all the actions that can be performed against a single [User API Token](https://docs.losant.com/user-accounts/user-tokens/), such as revoking the token.

  * [user_api_tokens](docs/userApiTokens.md)
    Contains all the actions that can be performed against the collection of [User API Tokens](https://docs.losant.com/user-accounts/user-tokens/) belonging to the currently authenticated user - such as listing tokens or creating a new token.

  * [webhook](docs/webhook.md)
    Contains all the actions that can be performed against a single [Webhook](https://docs.losant.com/applications/webhooks/), for instance modifying the verification settings or removing the webhook.

  * [webhooks](docs/webhooks.md)
    Contains all the actions that can be performed against the collection of [Webhooks](https://docs.losant.com/applications/webhooks/) belonging to an Application - such as listing the webhooks or creating a new webhook.

  <br/>

  *****

  Copyright (c) 2024 Losant IoT, Inc

  <https://www.losant.com>


pkgId: 445c108bdba4b3ee636720bdb411f1cd6fae2eaa8fea9ab4d959fbf0fec30a33
name: python-lotion-help
arch: noarch
version: 0.0.1
epoch: 0
release: 1
summary: Development documents and examples for lotion
url: https://pypi.org/project/lotion/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lotion-0.0.1-1.src.rpm
location_href: Packages/python-lotion-help-0.0.1-1.noarch.rpm
checksum_type: sha256
description:
  Lotion is a wrapper of `notion-client`.

  refs: [ramnes/notion-sdk-py: The official Notion API client library, but rewritten in Python! (sync + async)](https://github.com/ramnes/notion-sdk-py)

  You can use Notion API easily using Lotion.





  ```python
  from notion_client import Client

  client = Client(auth='NOTION_SECRET')
  client.pages.create(
      parent={
        'type': 'database_id',
        'database_id': 'abcd1234-4e63-4a46-9ffe-36adeb59ab30'
      },
      properties={
        'Name': {
          'title': [
            {
              'type': 'text',
              'text': {
                'content': 'テスト'
              }
            }
          ]
        }
      },
  )
  ```



  ```python
  from lotion import Lotion

  lotion = Lotion.get_instance()
  created_page = lotion.create_page_in_database(
      database_id='abcd1234-4e63-4a46-9ffe-36adeb59ab30',
      properties=[
        Title.from_plain_text(name='Name', text='テスト')
      ]
  )
  ```


pkgId: 334bb187b5d7f943dc1e1f94a4440a93eef23238eff8ada08d51a19ef0ce3b57
name: python-lovekit-help
arch: noarch
version: 0.1.19
epoch: 0
release: 1
summary: Development documents and examples for lovekit
url: https://pypi.org/project/lovekit/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lovekit-0.1.19-1.src.rpm
location_href: Packages/python-lovekit-help-0.1.19-1.noarch.rpm
checksum_type: sha256
description:
  [![codecov](https://codecov.io/gh/jhnnsrs/akuire/branch/master/graph/badge.svg?token=UGXEA2THBV)](https://codecov.io/gh/jhnnsrs/akuire)
  [![PyPI version](https://badge.fury.io/py/akuire.svg)](https://pypi.org/project/akuire/)
  [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://pypi.org/project/akuire/)
  ![Maintainer](https://img.shields.io/badge/maintainer-jhnnsrs-blue)
  [![PyPI pyversions](https://img.shields.io/pypi/pyversions/akuire.svg)](https://pypi.python.org/pypi/akuire/)
  [![PyPI status](https://img.shields.io/pypi/status/akuire.svg)](https://pypi.python.org/pypi/akuire/)

  Lovekit is the arkitekt version of livekit and allows you to create WebRTC based streams and rooms.
  This is highly experimental and not recommended for production use.


pkgId: efd115c68f3fdf89eace617b1775693786f72e9e0311b66e3e36f77514e45ae9
name: python-lpjsmin-help
arch: noarch
version: 0.7
epoch: 0
release: 1
summary: Development documents and examples for lpjsmin
url: https://launchpad.net/lpjsmin
rpm_license: BSD
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lpjsmin-0.7-1.src.rpm
location_href: Packages/python-lpjsmin-help-0.7-1.noarch.rpm
checksum_type: sha256
description:
  We need to handle several minification goals within the Launchpad codebase.
  This helps to create a single lib to help handle all of the cases and allow it
  to be flexibly used in more projects.


pkgId: 000f5603b18371a20c4824c1de42cf0047b52fbe3d37f71031d9ed8e518820fc
name: python-lsfm-fuse-help
arch: noarch
version: 0.1.2
epoch: 0
release: 1
summary: Development documents and examples for lsfm-fuse
url: https://github.com/peng-lab/lsfm_fuse
rpm_license: MIT license
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lsfm-fuse-0.1.2-1.src.rpm
location_href: Packages/python-lsfm-fuse-help-0.1.2-1.noarch.rpm
checksum_type: sha256
description:
  (1) Provide two filenames
  suppose we have two to-be-processed volumes "A.tif" and "B.tif" saved in folder `sample_name` under the path `data_path`.
  Meanwhile fusion result, together with the intermediate results, will be saved in folder `save_folder` under the path `save_path`.
  if "A.tif" and "B.tif" are illuminated from top and bottom respectively (in the image space):
  ```python
  from lsfm_fuse import FUSE_illu
  exe = FUSE_illu()   ###to run with default parameters for training
  out = exe.train(data_path = data_path,
                  sample_name = sample_name,
                  top_illu_data = "A.tif",
                  bottom_illu_data = "B.tif",
                  save_path = save_path,
                  save_folder = save_folder,
                  save_separate_results = True,
                  sparse_sample = False,
                  cam_pos = "front",
                  )
  ```
  where `save_separate_results` means whether to save the separated results before stitching (by default False), `sparse_sample` means whether the specimen is sparse (by default False), and `cam_pos` means whether the detection device is in the front or back in the image space (by default "front"). Two folders, named The fusion result, named "A" ad "B" will be created under `save_folder` to keep intermediate results, whereas the fusion result, named "illuFusionResult.tif" will be saved in foldedr "A", i.e., named after the volume illuminated from the top. Fusion result will also be returned as `out`.
  otherwise,  "A.tif" and "B.tif" can be illuminated from left and right respectively:
  ```python
  out = exe.train(data_path = data_path,
                  sample_name = sample_name,
                  left_illu_data = "A.tif",
                  right_illu_data = "B.tif",
                  save_path = save_path,
                  save_folder = save_folder,
                  )
  ```
  Alternatively, FUSE_illu can be initialized with user-defined training parameters, a full list of input arguments in `__init__` is here:
  ```
  require_precropping: bool = True,
  precropping_params: list[int, int, int, int] = [],
  resample_ratio: int = 2,
  window_size: list[int, int] = [5, 59],
  poly_order: list[int, int] = [2, 2],
  n_epochs: int = 50,
  require_segmentation: bool = True,
  skip_illuFusion: bool = True,
  destripe_preceded: bool = False,
  destripe_params: Dict = None,
  device: str = "cuda",
  ```
  (2) Provide two arrays, i.e., the stacks to be processed, and necessary parameters (suitable for use in napari)
  suppose we have two to-be-processed volumes `img_arr1` (illuminated from the top) and `img_arr2` (illuminated from the bottom) that have been read in as a np.ndarray or dask.array.core.Array
  ```python
  from lsfm_fuse import FUSE_illu
  exe = FUSE_illu()   ###to run with default parameters for training
  out = exe.train(data_path = data_path,
                  sample_name = sample_name,
                  top_illu_data = img_arr1,
                  bottom_illu_data = img_arr2,
                  save_path = save_path,
                  save_folder = save_folder,
                  save_separate_results = True,
                  sparse_sample = False,
                  cam_pos = "front",
                  )
  ```
  to save results, two folders "top_illu" and "bottom_illu" will be created under `save_folder`, and the fusion result "illuFusionResult.tif" will be kept in folder "top_illu".
  same for left-right illumination orientations, simply use arguments `left_illu_data` and `right_illu_data`, instead of `top_illu_data` and `bottom_illu_data`.

  suppose we have two to-be-processed volumes saved in /path/to/my/sample_name/image1.tiff (from the top) and /path/to/my/sample_name/image2.tiff (from the bottom), and we'd like to save the result in /save_path/save_folder:
  ```bash
  fuse_illu --data_path /path/to/my \
            --sample_name sample_name \
            --top_illu_data image1.tiff \
            --bottom_illu_data image2.tiff \
            --save_path /save_path \
            --save_folder save_folder
  ```
  in addition, all the training parameters can be changed in command line:
  ```bash
  fuse_illu --data_path /path/to/my \
            --sample_name sample_name \
            --top_illu_data image1.tiff \
            --bottom_illu_data image2.tiff \
            --save_path /save_path \
            --save_folder save_folder\
            --window_size 5,59 \
            --poly_order 2,2
  ```
  a full list of changeable args:
  ```
  usage: run_fuse_illu --data_path
                       --sample_name
                       --save_path
                       --save_folder
                       [--require_precropping "True"]
                       [--precropping_params []]
                       [--resample_ratio 2]
                       [--window_size [5, 59]]
                       [--poly_order [2, 2]]
                       [--n_epochs 50]
                       [--require_segmentation "True"]
                       [--device "cpu"]
                       [--top_illu_data None]
                       [--bottom_illu_data None]
                       [--left_illu_data None]
                       [--right_illu_data None]
                       [--camera_position ""]
                       [--cam_pos "front"]
                       [--sparse_sample "False"]
                       [--save_separate_results "False"]
  ```


  (1) Provide two filenames
  suppose we have four to-be-processed volumes "A.tif", "B.tif", "C.tif" and "D.tif" saved in folder `sample_name` under the path `data_path`.
  Meanwhile fusion result, together with the intermediate results, will be saved in folder `save_folder` under the path `save_path`.
  if "A.tif", "B.tif", "C.tif" and "D.tif" are top illuminated+ventral detected, bottom illuminated+ventral detected, top illuminated+dorsal detected, bottom illuminated+dorsal detected (in the image space), respectively:
  ```python
  from lsfm_fuse import FUSE_det
  exe = FUSE_det()   ###to run with default parameters for training
  out = exe.train(data_path = data_path,
                  sample_name = sample_name,
                  require_registration = require_registration,
                  require_flipping_along_illu_for_dorsaldet = require_flipping_along_illu_for_dorsaldet,
                  require_flipping_along_det_for_dorsaldet = require_flipping_along_det_for_dorsaldet,
                  top_illu_ventral_det_data = "A.tif",
                  bottom_illu_ventral_det_data = "B.tif",
                  top_illu_dorsal_det_data = "C.tif",
                  bottom_illu_dorsal_det_data =  "D.tif",
                  save_path = save_path,
                  save_folder = save_folder,
                  save_separate_results = False,
                  sparse_sample = False,
                  z_spacing = z_spacing,
                  xy_spacing = xy_spacing,
                  )
  ```
  where `require_registration` means whether registration for the two detection devices is needed. By default, we assume datasets with different illumination sources but the same detection device are well registered in advance. `require_flipping_along_illu_for_dorsaldet` and `require_flipping_along_det_for_dorsaldet` mean in order to put inputs in a common space, whether flipping along illumination and detection are needed, respectively. Flipping only applies to datasets with detection device at the back. `save_separate_results` and `sparse_sample` are same as in FUSE_illu. If `require_registration` is True, `z_spacing` and  `z_spacing`, axial resolution and lateral resolution, respectively, are mandatory for registration. Otherwise, they are optional.
  Four folders "A", "B", "C" and "D" will be created under `save_foldedr` to keep intermediate results, and the fusion result, "quadrupleFusionResult.tif" will be saved under folder "A".
  otherwise,  illmination can be of hotizontal orientations (in image space):
  ```python
  out = exe.train(data_path = data_path,
                  sample_name = sample_name,
                  require_registration = require_registration,
                  require_flipping_along_illu_for_dorsaldet = require_flipping_along_illu_for_dorsaldet,
                  require_flipping_along_det_for_dorsaldet = require_flipping_along_det_for_dorsaldet,
                  left_illu_ventral_det_data = "A.tif",
                  right_illu_ventral_det_data = "B.tif",
                  left_illu_dorsal_det_data = "C.tif",
                  right_illu_dorsal_det_data =  "D.tif",
                  save_path = save_path,
                  save_folder = save_folder,
                  )
  ```
  Alternatively, FUSE-det can be initialized with user-defined training parameters, a full list of input arguments in `__init__` is here:
  ```
  require_precropping: bool = True,
  precropping_params: list[int, int, int, int] = [],
  resample_ratio: int = 2,
  window_size: list[int, int] = [5, 59],
  poly_order: list[int, int] = [2, 2],
  n_epochs: int = 50,
  require_segmentation: bool = True,
  device: str = "cpu",
  ```
  (2) Provide four arrays, i.e., the stacks to be processed, and necessary parameters (suitable for use in napari)
  suppose we have four to-be-processed volumes `img_arr1` (top illuminated+ventral detected) and `img_arr2` (bottom illuminated+ventral detected), `img_arr3` (top illuminated+dorsal detected) and `img_arr4` (bottom illuminated+dorsal detected). All of them have been read in as a np.ndarray or dask.array.core.Array:
  ```python
  from lsfm_fuse import FUSE_det
  exe = FUSE_det()   ###to run with default parameters for training
  out = exe.train(data_path = data_path,
                  sample_name = sample_name,
                  require_registration = require_registration,
                  require_flipping_along_illu_for_dorsaldet = require_flipping_along_illu_for_dorsaldet,
                  require_flipping_along_det_for_dorsaldet = require_flipping_along_det_for_dorsaldet,
                  left_illu_ventral_det_data = img_arr1,
                  right_illu_ventral_det_data = img_arr2,
                  left_illu_dorsal_det_data = img_arr3,
                  right_illu_dorsal_det_data = img_arr4,
                  save_path = save_path,
                  save_folder = save_folder,
                  )
  ```
  to save results, four folders "top_illu+ventral_det", "bottom_illu+ventral_det", "top_illu+dorsal_det", and "bottom_illu+dorsal_det" will be created under `save_folder`, and the fusion result "quadrupleFusionResult.tif" will be kept in folder "top_illu+ventral_det".
  same for left-right illumination orientations, simply use arguments `left_illu_ventral_det_data`, `right_illu_ventral_det_data`, `left_illu_dorsal_det_data` and `right_illu_dorsal_det_data`.

  suppose we have four to-be-processed volumes saved in /path/to/my/sample_name/image1.tiff (top illuminated+ventral detected), /path/to/my/sample_name/image2.tiff (bottom illuminated+ventral detected), /path/to/my/sample_name/image3.tiff (top illuminated+dorsal detected), and /path/to/my/sample_name/image4.tiff (bottom illuminated+dorsal detected). We'd like to save the result in /save_path/save_folder:
  ```bash
  bigfuse_det --data_path /path/to/my \
              --sample_name sample_name \
              --require_registration False\
              --require_flipping_along_illu_for_dorsaldet True \
              --require_flipping_along_det_for_dorsaldet False \
              --top_illu_ventral_det_data image1.tiff \
              --bottom_illu_ventral_det_data image2.tiff \
              --top_illu_dorsal_det_data image3.tiff \
              --bottom_illu_dorsal_det_data image4.tiff \
              --save_path /save_path \
              --save_folder save_folder
  ```
  in addition, all the training parameters can be changed in command line. A full list of changeable args:
  ```
  usage: run_fuse_det --data_path
                      --sample_name
                      --save_path
                      --save_folder
                      --require_registration
                      --require_flipping_along_illu_for_dorsaldet
                      --require_flipping_along_det_for_dorsaldet
                      [--require_precropping "True"]
                      [--precropping_params []]
                      [--resample_ratio 2]
                      [--window_size [5, 59]]
                      [--poly_order [2, 2]]
                      [--n_epochs 50]
                      [--require_segmentation "True"]
                      [--skip_illuFusion "False"]
                      [--destripe_preceded  "False"]
                      [--destripe_params None]
                      [--device "cpu"]
                      [--sparse_sample "False"]
                      [--top_illu_ventral_det_data None]
                      [--bottom_illu_ventral_det_data None]
                      [--top_illu_dorsal_det_data None]
                      [--bottom_illu_dorsal_det_data None]
                      [--left_illu_ventral_det_data None]
                      [--right_illu_ventral_det_data None]
                      [--left_illu_dorsal_det_data None]
                      [--right_illu_dorsal_det_data None]
                      [--save_separate_results "False"]
                      [--z_spacing None]
                      [--xy_spacing None]
  ```

  **Stable Release:** `pip install lsfm_fuse`<br>
  **Development Head:** `pip install git+https://github.com/peng-lab/lsfm_fuse.git`

  See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code.
  **MIT license**


pkgId: 1157cd68d40d0519bf8c193d032d5f92233824762d2d1ae82c54b17429ff2f9a
name: python-lsfm-fusion-napari-help
arch: noarch
version: 0.1.1
epoch: 0
release: 1
summary: Development documents and examples for lsfm-fusion-napari
url: https://pypi.org/project/lsfm-fusion-napari/
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lsfm-fusion-napari-0.1.1-1.src.rpm
location_href: Packages/python-lsfm-fusion-napari-help-0.1.1-1.noarch.rpm
checksum_type: sha256
description:
  This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.
  <!--
  Don't miss the full getting started guide to set up your new package:
  https://github.com/napari/cookiecutter-napari-plugin#getting-started
  and review the napari docs for plugin developers:
  https://napari.org/stable/plugins/index.html
  -->

  You can install `lsfm_fusion_napari` via [pip]:
      pip install lsfm_fusion_napari
  To install latest development version :
      pip install git+https://github.com/peng-lab/lsfm_fusion_napari.git

  Contributions are very welcome. Tests can be run with [tox], please ensure
  the coverage at least stays the same before you submit a pull request.

  Distributed under the terms of the [BSD-3] license,
  "lsfm_fusion_napari" is free and open source software

  If you encounter any problems, please [file an issue] along with a detailed description.
  [napari]: https://github.com/napari/napari
  [Cookiecutter]: https://github.com/audreyr/cookiecutter
  [@napari]: https://github.com/napari
  [MIT]: http://opensource.org/licenses/MIT
  [BSD-3]: http://opensource.org/licenses/BSD-3-Clause
  [GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
  [GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
  [Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0
  [Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
  [cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin
  [file an issue]: https://github.com/peng-lab/lsfm_fusion_napari/issues
  [napari]: https://github.com/napari/napari
  [tox]: https://tox.readthedocs.io/en/latest/
  [pip]: https://pypi.org/project/pip/
  [PyPI]: https://pypi.org/

rpm_license:
  Copyright (c) 2024, lennart kowitz All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  * Neither the name of copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


pkgId: 1ef730356037aa3e29ba6d1f342cb6d6255d3333c4cca56aec4f173670f2b32a
name: python-lufah-help
arch: noarch
version: 0.8.2
epoch: 0
release: 1
summary: Development documents and examples for lufah
url: https://github.com/kbernhagen/lufah
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lufah-0.8.2-1.src.rpm
location_href: Packages/python-lufah-help-0.8.2-1.noarch.rpm
checksum_type: sha256
rpm_license:
  MIT License  Copyright (c) 2024 Kevin Bernhagen  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


pkgId: b708c3047d485971c57a2d8e59d52f9a58368d3847209020eff871012c5952ba
name: python-lumaai-help
arch: noarch
version: 1.2.2
epoch: 0
release: 1
summary: Development documents and examples for lumaai
url: https://github.com/lumalabs/lumaai-python
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lumaai-1.2.2-1.src.rpm
location_href: Packages/python-lumaai-help-1.2.2-1.noarch.rpm
checksum_type: sha256
description:
  [![PyPI version](https://img.shields.io/pypi/v/lumaai.svg)](https://pypi.org/project/lumaai/)

  The LumaAI Python library provides convenient access to the LumaAI REST API from any Python 3.8+
  application. The library includes type definitions for all request params and response fields,
  and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).



  The REST API documentation can be found on [lumalabs.ai](https://lumalabs.ai). The full API of this library can be found in [api.md](https://github.com/lumalabs/lumaai-python/tree/main/api.md).



  ```sh

  pip install lumaai
  ```



  The full API of this library can be found in [api.md](https://github.com/lumalabs/lumaai-python/tree/main/api.md).

  ```python
  import os
  from lumaai import LumaAI

  client = LumaAI(
      auth_token=os.environ.get("LUMAAI_API_KEY"),  # This is the default and can be omitted
  )

  generation = client.generations.create(
      aspect_ratio="16:9",
      loop=False,
      prompt="A teddy bear in sunglasses playing electric guitar, dancing and headbanging in the jungle in front of a large beautiful waterfall",
  )
  print(generation.id)
  ```

  While you can provide a `auth_token` keyword argument,
  we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
  to add `LUMAAI_API_KEY="My Auth Token"` to your `.env` file
  so that your Auth Token is not stored in source control.



  Simply import `AsyncLumaAI` instead of `LumaAI` and use `await` with each API call:

  ```python
  import os
  import asyncio
  from lumaai import AsyncLumaAI

  client = AsyncLumaAI(
      auth_token=os.environ.get("LUMAAI_API_KEY"),  # This is the default and can be omitted
  )


  async def main() -> None:
      generation = await client.generations.create(
          aspect_ratio="16:9",
          loop=False,
          prompt="A teddy bear in sunglasses playing electric guitar, dancing and headbanging in the jungle in front of a large beautiful waterfall",
      )
      print(generation.id)


  asyncio.run(main())
  ```

  Functionality between the synchronous and asynchronous clients is otherwise identical.



  Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:

  - Serializing back into JSON, `model.to_json()`
  - Converting to a dictionary, `model.to_dict()`

  Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.



  When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `lumaai.APIConnectionError` is raised.

  When the API returns a non-success status code (that is, 4xx or 5xx
  response), a subclass of `lumaai.APIStatusError` is raised, containing `status_code` and `response` properties.

  All errors inherit from `lumaai.APIError`.

  ```python
  import lumaai
  from lumaai import LumaAI

  client = LumaAI()

  try:
      client.generations.create(
          aspect_ratio="16:9",
          loop=False,
          prompt="A teddy bear in sunglasses playing electric guitar, dancing and headbanging in the jungle in front of a large beautiful waterfall",
      )
  except lumaai.APIConnectionError as e:
      print("The server could not be reached")
      print(e.__cause__)  # an underlying Exception, likely raised within httpx.
  except lumaai.RateLimitError as e:
      print("A 429 status code was received; we should back off a bit.")
  except lumaai.APIStatusError as e:
      print("Another non-200-range status code was received")
      print(e.status_code)
      print(e.response)
  ```

  Error codes are as followed:

  | Status Code | Error Type                 |
  | ----------- | -------------------------- |
  | 400         | `BadRequestError`          |
  | 401         | `AuthenticationError`      |
  | 403         | `PermissionDeniedError`    |
  | 404         | `NotFoundError`            |
  | 422         | `UnprocessableEntityError` |
  | 429         | `RateLimitError`           |
  | >=500       | `InternalServerError`      |
  | N/A         | `APIConnectionError`       |



  Certain errors are automatically retried 2 times by default, with a short exponential backoff.
  Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
  429 Rate Limit, and >=500 Internal errors are all retried by default.

  You can use the `max_retries` option to configure or disable retry settings:

  ```python
  from lumaai import LumaAI


  client = LumaAI(
      
      max_retries=0,
  )


  client.with_options(max_retries=5).generations.create(
      aspect_ratio="16:9",
      loop=False,
      prompt="A teddy bear in sunglasses playing electric guitar, dancing and headbanging in the jungle in front of a large beautiful waterfall",
  )
  ```



  By default requests time out after 1 minute. You can configure this with a `timeout` option,
  which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:

  ```python
  from lumaai import LumaAI


  client = LumaAI(
      
      timeout=20.0,
  )


  client = LumaAI(
      timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
  )


  client.with_options(timeout=5.0).generations.create(
      aspect_ratio="16:9",
      loop=False,
      prompt="A teddy bear in sunglasses playing electric guitar, dancing and headbanging in the jungle in front of a large beautiful waterfall",
  )
  ```

  On timeout, an `APITimeoutError` is thrown.

  Note that requests that time out are [retried twice by default](https://github.com/lumalabs/lumaai-python/tree/main/#retries).





  We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.

  You can enable logging by setting the environment variable `LUMAAI_LOG` to `info`.

  ```shell
  $ export LUMAAI_LOG=info
  ```

  Or to `debug` for more verbose logging.



  In an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:

  ```py
  if response.my_field is None:
    if 'my_field' not in response.model_fields_set:
      print('Got json like {}, without a "my_field" key present at all.')
    else:
      print('Got json like {"my_field": null}.')
  ```



  The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,

  ```py
  from lumaai import LumaAI

  client = LumaAI()
  response = client.generations.with_raw_response.create(
      aspect_ratio="16:9",
      loop=False,
      prompt="A teddy bear in sunglasses playing electric guitar, dancing and headbanging in the jungle in front of a large beautiful waterfall",
  )
  print(response.headers.get('X-My-Header'))

  generation = response.parse()  # get the object that `generations.create()` would have returned
  print(generation.id)
  ```

  These methods return an [`APIResponse`](https://github.com/lumalabs/lumaai-python/tree/main/src/lumaai/_response.py) object.

  The async client returns an [`AsyncAPIResponse`](https://github.com/lumalabs/lumaai-python/tree/main/src/lumaai/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.



  The above interface eagerly reads the full response body when you make the request, which may not always be what you want.

  To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.

  ```python
  with client.generations.with_streaming_response.create(
      aspect_ratio="16:9",
      loop=False,
      prompt="A teddy bear in sunglasses playing electric guitar, dancing and headbanging in the jungle in front of a large beautiful waterfall",
  ) as response:
      print(response.headers.get("X-My-Header"))

      for line in response.iter_lines():
          print(line)
  ```

  The context manager is required so that the response will reliably be closed.



  This library is typed for convenient access to the documented API.

  If you need to access undocumented endpoints, params, or response properties, the library can still be used.



  To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
  http verbs. Options on the client will be respected (such as retries) will be respected when making this
  request.

  ```py
  import httpx

  response = client.post(
      "/foo",
      cast_to=httpx.Response,
      body={"my_param": True},
  )

  print(response.headers.get("x-foo"))
  ```



  If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
  options.



  To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
  can also get all the extra fields on the Pydantic model as a dict with
  [`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).



  You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:

  - Support for [proxies](https://www.python-httpx.org/advanced/proxies/)
  - Custom [transports](https://www.python-httpx.org/advanced/transports/)
  - Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality

  ```python
  import httpx
  from lumaai import LumaAI, DefaultHttpxClient

  client = LumaAI(
      
      base_url="http://my.test.server.example.com:8083",
      http_client=DefaultHttpxClient(
          proxy="http://my.test.proxy.example.com",
          transport=httpx.HTTPTransport(local_address="0.0.0.0"),
      ),
  )
  ```

  You can also customize the client on a per-request basis by using `with_options()`:

  ```python
  client.with_options(http_client=DefaultHttpxClient(...))
  ```



  By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.

  ```py
  from lumaai import LumaAI

  with LumaAI() as client:
    
    ...


  ```



  This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes that only affect static types, without breaking runtime behavior.
  2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
  3. Changes that we do not expect to impact the vast majority of users in practice.

  We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

  We are keen for your feedback; please open an [issue](https://www.github.com/lumalabs/lumaai-python/issues) with questions, bugs, or suggestions.



  If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.

  You can determine the version that is being used at runtime with:

  ```py
  import lumaai
  print(lumaai.__version__)
  ```



  Python 3.8 or higher.



  See [the contributing documentation](https://github.com/lumalabs/lumaai-python/tree/main/./CONTRIBUTING.md).


pkgId: 845aa71506668073411b6881fa5c99e70e56dbcf737a1b4895717bd75bcaf967
name: python-lumibot-help
arch: noarch
version: 3.8.21
epoch: 0
release: 1
summary: Development documents and examples for lumibot
url: https://github.com/Lumiwealth/lumibot
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lumibot-3.8.21-1.src.rpm
location_href: Packages/python-lumibot-help-3.8.21-1.noarch.rpm
checksum_type: sha256
description:
  Lumibot is a backtesting and trading library for stocks, options, crypto, futures and more. It is made so that the same code you use for backtesting can be used for live trading, making it easy to transition from backtesting to live trading. Lumibot is a highly flexible library that allows you to create your own strategies and indicators, and backtest them on historical data. It is also highly optimized for speed, so you can backtest your strategies quickly and efficiently.

  **IMPORTANT: This library requires data for backtesting. The recommended data source is [Polygon.io](https://polygon.io/?utm_source=affiliate&utm_campaign=lumi10) (a free tier is available too). Please click the link to give us credit for the sale, it helps support this project. You can use the coupon code 'LUMI10' for 10% off.**



  To get started with Lumibot, you can check out our documentation below.

  **Check out the documentation for the project here: 👉 <http://lumibot.lumiwealth.com/> 👈**



  Our blog has lots of example strategies and shows you how to run a bot using LumiBot. Check the blog out here:

  **https://lumiwealth.com/blog/**



  To run a backtest, you can use the following code snippet:

  ```bash
  python -m lumibot.example_strategies.stock_buy_and_hold
  ```



  We made a small example strategy to show you how to use Lumibot in this GitHub repository: [Example Algorithm GitHub](https://github.com/Lumiwealth-Strategies/stock_example_algo)

  To run this example strategy, click on the `Deploy to Render` button below to deploy the strategy to Render (our recommendation). You can also run the strategy on Repl.it by clicking on the `Run on Repl.it` button below.

  [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/Lumiwealth-Strategies/stock_example_algo)

  [![Run on Repl.it](https://replit.com/badge/github/Lumiwealth-Strategies/stock_example_algo)](https://replit.com/new/github/Lumiwealth-Strategies/stock_example_algo)

  **For more information on this example strategy, you can check out the README in the example strategy repository here: [Example Algorithm](https://github.com/Lumiwealth-Strategies/stock_example_algo)**



  If you want to contribute to Lumibot, you can check how to get started below. We are always looking for contributors to help us out!

  Here's a video to help you get started with contributing to Lumibot: [Watch The Video](https://youtu.be/Huz6VxqafZs)

  **Steps to contribute:**

  0. Watch the video: [Watch The Video](https://youtu.be/Huz6VxqafZs)
  1. Clone the repository to your local machine
  2. Create a new branch for your feature
  3. Run `pip install -r requirements_dev.txt` to install the developer dependencies
  4. Install all the requirements from setup.py: `pip install -e .`
  5. Make your changes
  6. Run `pytest` to make sure all the tests pass
  7. Create a pull request to merge your branch into master



  We use pytest for our testing framework. Some tests require API keys to be in a `.env` file in the root directory. To run the tests, you can run the following command:

  ```bash
  pytest
  ```

  To run an individual test file, you can run the following command:

  ```bash
  pytest tests/test_asset.py
  ```



  To show code coverage, you can run the following command:

  ```bash
  coverage run; coverage report; coverage html
  ```



  This will show you the code coverage in the terminal and also create a folder called "htmlcov" which will have a file called "index.html". You can open this file in your browser to see the code coverage in a more readable format.

  If you don't want to keep typing out the command, you can add it as an alias in bash. To do this, you can run the following command:

  ```bash
  alias cover='coverage run; coverage report; coverage html'
  ```

  This will now allow you to run the command by just typing "cover" in the terminal.

  ```bash
  cover
  ```

  If you want to also add it to your .bashrc file. You can do this by running the following command:

  ```bash
  echo "alias cover='coverage run; coverage report; coverage html'" >> ~/.bashrc
  ```



  If you are on Windows, you can add an alias by running the following command:

  Add to your PowerShell Profile: (profile.ps1)

  ```powershell
  function cover {
   coverage run
   coverage report
   coverage html
  }
  ```



  To set up in VS Code for debugging, you can add the following to your launch.json file under "configurations". This will allow you to go into "Run and Debug" and run the tests from there, with breakpoints and everything.

  NOTE: You may need to change args to the path of your tests folder.

  ```json
  {
      "name": "Python: Pytest",
      "type": "python",
      "request": "launch",
      "module": "pytest",
      "args": [
          "lumibot/tests"
      ],
      "console": "integratedTerminal",
  }
  ```

  Here's an example of an actual launch.json file:

  ```json
  {
      "version": "0.2.0",
      "configurations": [
          {
              "name": "Python: Pytest",
              "type": "python",
              "request": "launch",
              "module": "pytest",
              "args": [
                  "lumibot/tests"
              ],
              "console": "integratedTerminal",
          }
      ]
  }
  ```



  This table points out some of the differences between the data sources we use in Lumibot. These refer to the data
  returned in a Bars entity that is returned from calls to get_historical_prices.

  | data_source | type  | OHLCV | split adjusted | dividends | returns | dividend adjusted returns |
  |-------------|-------|-------|----------------|-----------|---------|---------------------------|
  | yahoo       | stock | Yes   | Yes            | Yes       | Yes     | Yes                       |
  | alpaca      | stock | Yes   | Yes            | No        | Yes     | No                        |
  | polygon     | stock | Yes   | Yes            | No        | Yes     | No                        |
  | Tradier     | stock | Yes   | Yes            | No        | Yes     | No                        |
  | Pandas*     | stock | Yes   | Yes            | Yes       | Yes     | Yes                       |

  *Pandas is not a data source per se, but it can load csv files in the same format as Yahoo dataframes,
  which can contain dividends.



  Making a new branch and pulling from main:
  ```shell
  git checkout -b my-feature
  git fetch origin
  git merge origin/dev
  ```
  Committing work to you feature branch:
  ```shell
  git add .
  git commit -m "my changes"
  git push -u origin my-feature
  ```

  If work on main progressed while you were in another branch, this is how you rebase it into your branch. Note that
  since you've rebased your local branch, you'll need to force push your changes to update the remote branch.
  The --force-with-lease option is a safer alternative to --force as it will abort the push if there are any new
  commits on the remote that you haven't incorporated into your local branch
  ```shell
  git checkout dev
  git fetch origin
  git merge origin/dev
  git checkout my-feature
  git rebase dev
  git checkout my-feature
  git push --force-with-lease origin my-feature
  ```

  When ready to merge the branch into main, go into github, create a pull request, and await review. When your PR is approved it will automatically be merged into the dev branch remotely. Now, you can delete your local branch and the remote branch.
  ```shell
  git checkout dev
  git fetch origin
  git merge origin/dev
  git branch -D my-feature
  git push origin --delete my-feature
  ```




  If you want to learn more about Lumibot or Algorithmic Trading then you will love out communities! You can join us on Discord.

  **Join us on Discord: <https://discord.gg/TmMsJCKY3T>**



  If you need extra help building your algorithm, we have courses to help you out.

  **For our Algorithmic Trading course: <https://lumiwealth.com/algorithmic-trading-landing-page>**

  **For our Machine Learning for Trading course: <https://www.lumiwealth.com/product-category/machine-learning-purchase/>**

  **For our Options Trading course: <https://www.lumiwealth.com/product-category/options-trading-purchase/>**



  This library is covered by the MIT license for open sourced software which can be found here: <https://github.com/Lumiwealth/lumibot/blob/master/LICENSE>


pkgId: 3ce939ebdb9db704f2e04ffc677e78e50c5438e7b5dabb126228cfe04a2d9de0
name: python-lumigator-schemas-help
arch: noarch
version: 0.0.2
epoch: 0
release: 1
summary: Development documents and examples for lumigator-schemas
url: https://pypi.org/project/lumigator-schemas/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lumigator-schemas-0.0.2-1.src.rpm
location_href: Packages/python-lumigator-schemas-help-0.0.2-1.noarch.rpm
checksum_type: sha256
description:
  The lumigator REST API uses `json` objects to communicate with the lumigator server. Their schemas are defined as `pydantic` models within this package. It is a requirement both for the `backend`and the `lumigator_sdk` packages.


pkgId: ed8244c98a00572132e79a06237781b7eb2d59b7c9bf4c98dcd44a7c1820cab3
name: python-lumigator-sdk-help
arch: noarch
version: 0.0.2
epoch: 0
release: 1
summary: Development documents and examples for lumigator-sdk
url: https://pypi.org/project/lumigator-sdk/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lumigator-sdk-0.0.2-1.src.rpm
location_href: Packages/python-lumigator-sdk-help-0.0.2-1.noarch.rpm
checksum_type: sha256
description:
  The SDK provides the communication and validation primitives needed to contact the Lumigator itself,
  either locally or remotely.

  You can install the lumigator SDK  via `pip` directly or via `uv` from the cloned repository:

  ```bash
  pip install -e lumigator/python/mzai/sdk
  ```

  or

  ```bash
  uv pip install -e lumigator/python/mzai/sdk
  ```

  Now that you have the SDK installed, you can use it to communicate with Lumigator. You can run the
  [example notebook](/notebooks/walkthrough.ipynb) for a platform API walkthrough, or follow the
  [quickstart guide](https://mozilla-ai.github.io/lumigator/get-started/quickstart.html) in the
  documentation.

  The SDK uses the `lumigator-schemas` package models, but with stricter validations, so properties not explicitly defined in the schemas will be handled as errors.



  The SDK includes both unit tests (requiring no additional containers) and integration tests (requiring a live Lumigator backend). By default only unit tests are run.

  To run unit tests, please use:

  ```bash
  uv run pytest
  ```

  To run integration tests, please use:

  ```bash
  pushd ../../../../ # go back to the project root
  make start-lumigator-build # wait until all containers are up and running
  popd
  uv run pytest -o python_files="int_test_*.py" # wait until all tests have passed; update and repeat...
  pushd ../../../../ # go back to the project root
  make local-down # wait until all containers are removed
  popd
  ```

  The tests include a unit test suite and an integration test suite. There are make targets available at the root folder, as follows:

  * `sdk-test`: runs `sdk-unit-test` and `sdk-int-test`
    * `sdk-unit-test`: runs tests in `backend/tests/unit/*/test_*.py` (any depth of subfolders)
    * `sdk-int-test`: runs tests in `backend/tests/int/*/test_*.py` (any depth of subfolders)

  A live Lumigator backend is started for integration tests.


pkgId: b2bbb8e6d501011abe64b2dda33d13ecee6f77910565255c902b7a4392ff7dbb
name: python-luminesce-sdk-help
arch: noarch
version: 2.1.173
epoch: 0
release: 1
summary: Development documents and examples for luminesce-sdk
url: https://github.com/finbourne/luminesce-sdk-python
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-luminesce-sdk-2.1.173-1.src.rpm
location_href: Packages/python-luminesce-sdk-help-2.1.173-1.noarch.rpm
checksum_type: sha256
description:
  *ApplicationMetadataApi* | [**get_services_as_access_controlled_resources**](docs/ApplicationMetadataApi.md#get_services_as_access_controlled_resources) | **GET** /api/metadata/access/resources | GetServicesAsAccessControlledResources: Get resources available for access control
  *BinaryDownloadingApi* | [**download_binary**](docs/BinaryDownloadingApi.md#download_binary) | **GET** /api/Download/download | [EXPERIMENTAL] DownloadBinary: Download a Luminesce Binary you may run on-site
  *BinaryDownloadingApi* | [**get_binary_versions**](docs/BinaryDownloadingApi.md#get_binary_versions) | **GET** /api/Download/versions | [EXPERIMENTAL] GetBinaryVersions: List available versions of binaries
  *CertificateManagementApi* | [**download_certificate**](docs/CertificateManagementApi.md#download_certificate) | **GET** /api/Certificate/certificate | [EXPERIMENTAL] DownloadCertificate: Download domain or your personal certificates
  *CertificateManagementApi* | [**list_certificates**](docs/CertificateManagementApi.md#list_certificates) | **GET** /api/Certificate/certificates | [EXPERIMENTAL] ListCertificates: List previously minted certificates
  *CertificateManagementApi* | [**manage_certificate**](docs/CertificateManagementApi.md#manage_certificate) | **PUT** /api/Certificate/manage | [EXPERIMENTAL] ManageCertificate: Create / Renew / Revoke a certificate
  *CurrentTableFieldCatalogApi* | [**get_catalog**](docs/CurrentTableFieldCatalogApi.md#get_catalog) | **GET** /api/Catalog | GetCatalog: Get a Flattened Table/Field Catalog
  *CurrentTableFieldCatalogApi* | [**get_fields**](docs/CurrentTableFieldCatalogApi.md#get_fields) | **GET** /api/Catalog/fields | GetFields: List field and parameters for providers
  *CurrentTableFieldCatalogApi* | [**get_providers**](docs/CurrentTableFieldCatalogApi.md#get_providers) | **GET** /api/Catalog/providers | GetProviders: List available providers
  *HealthCheckingEndpointApi* | [**fake_node_reclaim**](docs/HealthCheckingEndpointApi.md#fake_node_reclaim) | **GET** /fakeNodeReclaim | [INTERNAL] FakeNodeReclaim: Helps testing of AWS node reclaim behaviour
  *HistoricallyExecutedQueriesApi* | [**cancel_history**](docs/HistoricallyExecutedQueriesApi.md#cancel_history) | **DELETE** /api/History/{executionId} | CancelHistory: Cancel / Clear data from a history search
  *HistoricallyExecutedQueriesApi* | [**fetch_history_result_histogram**](docs/HistoricallyExecutedQueriesApi.md#fetch_history_result_histogram) | **GET** /api/History/{executionId}/histogram | FetchHistoryResultHistogram: Make a histogram of results of a history search
  *HistoricallyExecutedQueriesApi* | [**fetch_history_result_json**](docs/HistoricallyExecutedQueriesApi.md#fetch_history_result_json) | **GET** /api/History/{executionId}/json | FetchHistoryResultJson: Fetch JSON results from a query history search
  *HistoricallyExecutedQueriesApi* | [**get_history**](docs/HistoricallyExecutedQueriesApi.md#get_history) | **GET** /api/History | GetHistory: Start a background history search
  *HistoricallyExecutedQueriesApi* | [**get_progress_of_history**](docs/HistoricallyExecutedQueriesApi.md#get_progress_of_history) | **GET** /api/History/{executionId} | GetProgressOfHistory: View progress of a history search
  *MultiQueryExecutionApi* | [**cancel_multi_query**](docs/MultiQueryExecutionApi.md#cancel_multi_query) | **DELETE** /api/MultiQueryBackground/{executionId} | CancelMultiQuery: Cancel / Clear a previously started query-set
  *MultiQueryExecutionApi* | [**get_progress_of_multi_query**](docs/MultiQueryExecutionApi.md#get_progress_of_multi_query) | **GET** /api/MultiQueryBackground/{executionId} | GetProgressOfMultiQuery: View progress of the entire query-set load
  *MultiQueryExecutionApi* | [**start_queries**](docs/MultiQueryExecutionApi.md#start_queries) | **PUT** /api/MultiQueryBackground | StartQueries: Run a given set of Sql queries in the background
  *SqlBackgroundExecutionApi* | [**cancel_query**](docs/SqlBackgroundExecutionApi.md#cancel_query) | **DELETE** /api/SqlBackground/{executionId} | CancelQuery: Cancel / Clear data from a previously run query
  *SqlBackgroundExecutionApi* | [**fetch_query_result_csv**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_csv) | **GET** /api/SqlBackground/{executionId}/csv | FetchQueryResultCsv: Fetch the result of a query as CSV
  *SqlBackgroundExecutionApi* | [**fetch_query_result_excel**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_excel) | **GET** /api/SqlBackground/{executionId}/excel | FetchQueryResultExcel: Fetch the result of a query as an Excel file
  *SqlBackgroundExecutionApi* | [**fetch_query_result_histogram**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_histogram) | **GET** /api/SqlBackground/{executionId}/histogram | FetchQueryResultHistogram: Construct a histogram of the result of a query
  *SqlBackgroundExecutionApi* | [**fetch_query_result_json**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_json) | **GET** /api/SqlBackground/{executionId}/json | FetchQueryResultJson: Fetch the result of a query as a JSON string
  *SqlBackgroundExecutionApi* | [**fetch_query_result_json_proper**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_json_proper) | **GET** /api/SqlBackground/{executionId}/jsonProper | FetchQueryResultJsonProper: Fetch the result of a query as JSON
  *SqlBackgroundExecutionApi* | [**fetch_query_result_parquet**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_parquet) | **GET** /api/SqlBackground/{executionId}/parquet | FetchQueryResultParquet: Fetch the result of a query as Parquet
  *SqlBackgroundExecutionApi* | [**fetch_query_result_pipe**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_pipe) | **GET** /api/SqlBackground/{executionId}/pipe | FetchQueryResultPipe: Fetch the result of a query as pipe-delimited
  *SqlBackgroundExecutionApi* | [**fetch_query_result_sqlite**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_sqlite) | **GET** /api/SqlBackground/{executionId}/sqlite | FetchQueryResultSqlite: Fetch the result of a query as SqLite
  *SqlBackgroundExecutionApi* | [**fetch_query_result_xml**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_xml) | **GET** /api/SqlBackground/{executionId}/xml | FetchQueryResultXml: Fetch the result of a query as XML
  *SqlBackgroundExecutionApi* | [**get_progress_of**](docs/SqlBackgroundExecutionApi.md#get_progress_of) | **GET** /api/SqlBackground/{executionId} | GetProgressOf: View query progress up to this point
  *SqlBackgroundExecutionApi* | [**start_query**](docs/SqlBackgroundExecutionApi.md#start_query) | **PUT** /api/SqlBackground | StartQuery: Start to Execute Sql in the background
  *SqlDesignApi* | [**get_provider_template_for_export**](docs/SqlDesignApi.md#get_provider_template_for_export) | **GET** /api/Sql/providertemplateforexport | GetProviderTemplateForExport: Makes a fields template for file importing via a writer
  *SqlDesignApi* | [**put_case_statement_design_sql_to_design**](docs/SqlDesignApi.md#put_case_statement_design_sql_to_design) | **PUT** /api/Sql/tocasestatementdesign | [EXPERIMENTAL] PutCaseStatementDesignSqlToDesign: Convert SQL to a case statement design object
  *SqlDesignApi* | [**put_case_statement_design_to_sql**](docs/SqlDesignApi.md#put_case_statement_design_to_sql) | **PUT** /api/Sql/fromcasestatementdesign | [EXPERIMENTAL] PutCaseStatementDesignToSql: Convert a case statement design object to SQL
  *SqlDesignApi* | [**put_file_read_design_to_sql**](docs/SqlDesignApi.md#put_file_read_design_to_sql) | **PUT** /api/Sql/fromfilereaddesign | [EXPERIMENTAL] PutFileReadDesignToSql: Make file read SQL from a design object
  *SqlDesignApi* | [**put_inlined_properties_design_sql_to_design**](docs/SqlDesignApi.md#put_inlined_properties_design_sql_to_design) | **PUT** /api/Sql/toinlinedpropertiesdesign | [EXPERIMENTAL] PutInlinedPropertiesDesignSqlToDesign: Make an inlined properties design from SQL
  *SqlDesignApi* | [**put_inlined_properties_design_to_sql**](docs/SqlDesignApi.md#put_inlined_properties_design_to_sql) | **PUT** /api/Sql/frominlinedpropertiesdesign | [EXPERIMENTAL] PutInlinedPropertiesDesignToSql: Make inlined properties SQL from a design object
  *SqlDesignApi* | [**put_intellisense**](docs/SqlDesignApi.md#put_intellisense) | **PUT** /api/Sql/intellisense | PutIntellisense: Make intellisense prompts given an SQL snip-it
  *SqlDesignApi* | [**put_intellisense_error**](docs/SqlDesignApi.md#put_intellisense_error) | **PUT** /api/Sql/intellisenseError | PutIntellisenseError: Get error ranges from SQL
  *SqlDesignApi* | [**put_query_design_to_sql**](docs/SqlDesignApi.md#put_query_design_to_sql) | **PUT** /api/Sql/fromdesign | [EXPERIMENTAL] PutQueryDesignToSql: Make SQL from a structured query design
  *SqlDesignApi* | [**put_query_to_format**](docs/SqlDesignApi.md#put_query_to_format) | **PUT** /api/Sql/pretty | PutQueryToFormat: Format SQL into a more readable form
  *SqlDesignApi* | [**put_sql_to_extract_scalar_parameters**](docs/SqlDesignApi.md#put_sql_to_extract_scalar_parameters) | **PUT** /api/Sql/extractscalarparameters | [EXPERIMENTAL] PutSqlToExtractScalarParameters: Extract scalar parameter information from SQL
  *SqlDesignApi* | [**put_sql_to_file_read_design**](docs/SqlDesignApi.md#put_sql_to_file_read_design) | **PUT** /api/Sql/tofilereaddesign | [EXPERIMENTAL] PutSqlToFileReadDesign: Make a design object from file-read SQL
  *SqlDesignApi* | [**put_sql_to_query_design**](docs/SqlDesignApi.md#put_sql_to_query_design) | **PUT** /api/Sql/todesign | [EXPERIMENTAL] PutSqlToQueryDesign: Make a SQL-design object from SQL if possible
  *SqlDesignApi* | [**put_sql_to_view_design**](docs/SqlDesignApi.md#put_sql_to_view_design) | **PUT** /api/Sql/toviewdesign | [EXPERIMENTAL] PutSqlToViewDesign: Make a view-design from view creation SQL
  *SqlDesignApi* | [**put_sql_to_writer_design**](docs/SqlDesignApi.md#put_sql_to_writer_design) | **PUT** /api/Sql/towriterdesign | [EXPERIMENTAL] PutSqlToWriterDesign: Make a SQL-writer-design object from SQL
  *SqlDesignApi* | [**put_view_design_to_sql**](docs/SqlDesignApi.md#put_view_design_to_sql) | **PUT** /api/Sql/fromviewdesign | [EXPERIMENTAL] PutViewDesignToSql: Make view creation sql from a view-design
  *SqlDesignApi* | [**put_writer_design_to_sql**](docs/SqlDesignApi.md#put_writer_design_to_sql) | **PUT** /api/Sql/fromwriterdesign | [EXPERIMENTAL] PutWriterDesignToSql: Make writer SQL from a writer-design object
  *SqlExecutionApi* | [**get_by_query_csv**](docs/SqlExecutionApi.md#get_by_query_csv) | **GET** /api/Sql/csv/{query} | GetByQueryCsv: Execute Sql from the url returning CSV
  *SqlExecutionApi* | [**get_by_query_excel**](docs/SqlExecutionApi.md#get_by_query_excel) | **GET** /api/Sql/excel/{query} | GetByQueryExcel: Execute Sql from the url returning an Excel file
  *SqlExecutionApi* | [**get_by_query_json**](docs/SqlExecutionApi.md#get_by_query_json) | **GET** /api/Sql/json/{query} | GetByQueryJson: Execute Sql from the url returning JSON
  *SqlExecutionApi* | [**get_by_query_parquet**](docs/SqlExecutionApi.md#get_by_query_parquet) | **GET** /api/Sql/parquet/{query} | GetByQueryParquet: Execute Sql from the url returning a Parquet file
  *SqlExecutionApi* | [**get_by_query_pipe**](docs/SqlExecutionApi.md#get_by_query_pipe) | **GET** /api/Sql/pipe/{query} | GetByQueryPipe: Execute Sql from the url returning pipe-delimited
  *SqlExecutionApi* | [**get_by_query_sqlite**](docs/SqlExecutionApi.md#get_by_query_sqlite) | **GET** /api/Sql/sqlite/{query} | GetByQuerySqlite: Execute Sql from the url returning SqLite DB
  *SqlExecutionApi* | [**get_by_query_xml**](docs/SqlExecutionApi.md#get_by_query_xml) | **GET** /api/Sql/xml/{query} | GetByQueryXml: Execute Sql from the url returning XML
  *SqlExecutionApi* | [**put_by_query_csv**](docs/SqlExecutionApi.md#put_by_query_csv) | **PUT** /api/Sql/csv | PutByQueryCsv: Execute Sql from the body returning CSV
  *SqlExecutionApi* | [**put_by_query_excel**](docs/SqlExecutionApi.md#put_by_query_excel) | **PUT** /api/Sql/excel | PutByQueryExcel: Execute Sql from the body making an Excel file
  *SqlExecutionApi* | [**put_by_query_json**](docs/SqlExecutionApi.md#put_by_query_json) | **PUT** /api/Sql/json | PutByQueryJson: Execute Sql from the body returning JSON
  *SqlExecutionApi* | [**put_by_query_parquet**](docs/SqlExecutionApi.md#put_by_query_parquet) | **PUT** /api/Sql/parquet | PutByQueryParquet: Execute Sql from the body making a Parquet file
  *SqlExecutionApi* | [**put_by_query_pipe**](docs/SqlExecutionApi.md#put_by_query_pipe) | **PUT** /api/Sql/pipe | PutByQueryPipe: Execute Sql from the body making pipe-delimited
  *SqlExecutionApi* | [**put_by_query_sqlite**](docs/SqlExecutionApi.md#put_by_query_sqlite) | **PUT** /api/Sql/sqlite | PutByQuerySqlite: Execute Sql from the body returning SqLite DB
  *SqlExecutionApi* | [**put_by_query_xml**](docs/SqlExecutionApi.md#put_by_query_xml) | **PUT** /api/Sql/xml | PutByQueryXml: Execute Sql from the body returning XML
  <a id="documentation-for-models"></a>

   - [AccessControlledAction](docs/AccessControlledAction.md)
   - [AccessControlledResource](docs/AccessControlledResource.md)
   - [AccessControlledResourceIdentifierPartSchemaAttribute](docs/AccessControlledResourceIdentifierPartSchemaAttribute.md)
   - [ActionId](docs/ActionId.md)
   - [AggregateFunction](docs/AggregateFunction.md)
   - [Aggregation](docs/Aggregation.md)
   - [AutoDetectType](docs/AutoDetectType.md)
   - [AvailableField](docs/AvailableField.md)
   - [AvailableParameter](docs/AvailableParameter.md)
   - [BackgroundMultiQueryProgressResponse](docs/BackgroundMultiQueryProgressResponse.md)
   - [BackgroundMultiQueryResponse](docs/BackgroundMultiQueryResponse.md)
   - [BackgroundQueryCancelResponse](docs/BackgroundQueryCancelResponse.md)
   - [BackgroundQueryProgressResponse](docs/BackgroundQueryProgressResponse.md)
   - [BackgroundQueryResponse](docs/BackgroundQueryResponse.md)
   - [BackgroundQueryState](docs/BackgroundQueryState.md)
   - [CaseStatementDesign](docs/CaseStatementDesign.md)
   - [CaseStatementItem](docs/CaseStatementItem.md)
   - [CertificateAction](docs/CertificateAction.md)
   - [CertificateFileType](docs/CertificateFileType.md)
   - [CertificateState](docs/CertificateState.md)
   - [CertificateStatus](docs/CertificateStatus.md)
   - [CertificateType](docs/CertificateType.md)
   - [Column](docs/Column.md)
   - [ColumnInfo](docs/ColumnInfo.md)
   - [ConditionAttributes](docs/ConditionAttributes.md)
   - [ConvertToViewData](docs/ConvertToViewData.md)
   - [CursorPosition](docs/CursorPosition.md)
   - [DataType](docs/DataType.md)
   - [ErrorHighlightItem](docs/ErrorHighlightItem.md)
   - [ErrorHighlightRequest](docs/ErrorHighlightRequest.md)
   - [ErrorHighlightResponse](docs/ErrorHighlightResponse.md)
   - [ExpressionWithAlias](docs/ExpressionWithAlias.md)
   - [FeedbackEventArgs](docs/FeedbackEventArgs.md)
   - [FeedbackLevel](docs/FeedbackLevel.md)
   - [FieldDesign](docs/FieldDesign.md)
   - [FieldType](docs/FieldType.md)
   - [FileReaderBuilderDef](docs/FileReaderBuilderDef.md)
   - [FileReaderBuilderResponse](docs/FileReaderBuilderResponse.md)
   - [FilterTermDesign](docs/FilterTermDesign.md)
   - [IdSelectorDefinition](docs/IdSelectorDefinition.md)
   - [InlinedPropertyDesign](docs/InlinedPropertyDesign.md)
   - [InlinedPropertyItem](docs/InlinedPropertyItem.md)
   - [IntellisenseItem](docs/IntellisenseItem.md)
   - [IntellisenseRequest](docs/IntellisenseRequest.md)
   - [IntellisenseResponse](docs/IntellisenseResponse.md)
   - [IntellisenseType](docs/IntellisenseType.md)
   - [Link](docs/Link.md)
   - [LuminesceBinaryType](docs/LuminesceBinaryType.md)
   - [LusidProblemDetails](docs/LusidProblemDetails.md)
   - [MappableField](docs/MappableField.md)
   - [MappingFlags](docs/MappingFlags.md)
   - [MultiQueryDefinitionType](docs/MultiQueryDefinitionType.md)
   - [OptionsCsv](docs/OptionsCsv.md)
   - [OptionsExcel](docs/OptionsExcel.md)
   - [OptionsParquet](docs/OptionsParquet.md)
   - [OptionsSqLite](docs/OptionsSqLite.md)
   - [OptionsXml](docs/OptionsXml.md)
   - [OrderByDirection](docs/OrderByDirection.md)
   - [OrderByTermDesign](docs/OrderByTermDesign.md)
   - [QueryDesign](docs/QueryDesign.md)
   - [QueryDesignerBinaryOperator](docs/QueryDesignerBinaryOperator.md)
   - [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)
   - [ScalarParameter](docs/ScalarParameter.md)
   - [Source](docs/Source.md)
   - [SourceType](docs/SourceType.md)
   - [TaskStatus](docs/TaskStatus.md)
   - [ViewParameter](docs/ViewParameter.md)
   - [WriterDesign](docs/WriterDesign.md)


pkgId: a7c66058aa11dc4268cd20474b3f16cb637875c771e98419c3bf575e35b49a01
name: python-luna-soc-help
arch: noarch
version: 0.2.2
epoch: 0
release: 1
summary: Development documents and examples for luna-soc
url: https://pypi.org/project/luna-soc/
rpm_license: BSD
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-luna-soc-0.2.2-1.src.rpm
location_href: Packages/python-luna-soc-help-0.2.2-1.noarch.rpm
checksum_type: sha256
description:
  LUNA-SOC is a toolkit for building custom SoC (System on Chip) designs incorporating [LUNA](https://github.com/greatscottgadgets/luna) USB peripherals.

  Some things you can use LUNA-SOC for, currently:

  * Implement SoC designs using a [Minerva](https://github.com/minerva-cpu/minerva) or [VexRiscv](https://github.com/SpinalHDL/VexRiscv) RISC-V CPU.
  * Add a variety of Wishbone and CSR peripherals to your SoC design such as: SRAM, GPIO, UART and USB.
  * Implement firmware for your designs using Rust or C.

  > __NOTE__
  > There are no official packages for Minerva at the time of writing but you can install it directly from the repository using:
  >
  > `pip install git+https://github.com/minerva-cpu/minerva`



  This project is broken down into several directories:

  * [`luna_soc/`](luna_soc/) -- the primary LUNA-SOC library; generates gateware and provides peripherals.
  * [`examples/`](examples/) -- some simple LUNA-SOC examples demonstrating gateware design and firmware implementation.
  * [`docs/`](docs/) -- sources for the LUNA-SOC Sphinx documentation.




  LUNA-SOC's documentation is captured on [Read the Docs](https://luna-soc.readthedocs.io/en/latest/). Raw documentation sources are in the docs folder.


pkgId: 864e7c29f476dcdd0f56636bc3b6ecc597f11008d779b4212b65ea686456a1b4
name: python-lusid-configuration-sdk-help
arch: noarch
version: 2.1.48
epoch: 0
release: 1
summary: Development documents and examples for lusid-configuration-sdk
url: https://github.com/finbourne/configuration-sdk-python
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lusid-configuration-sdk-2.1.48-1.src.rpm
location_href: Packages/python-lusid-configuration-sdk-help-2.1.48-1.noarch.rpm
checksum_type: sha256
description:
  *ApplicationMetadataApi* | [**list_access_controlled_resources**](docs/ApplicationMetadataApi.md#list_access_controlled_resources) | **GET** /api/metadata/access/resources | [EARLY ACCESS] ListAccessControlledResources: Get resources available for access control
  *ConfigurationSetsApi* | [**add_configuration_to_set**](docs/ConfigurationSetsApi.md#add_configuration_to_set) | **POST** /api/sets/{type}/{scope}/{code}/items | [EARLY ACCESS] AddConfigurationToSet: Add a configuration item to an existing set
  *ConfigurationSetsApi* | [**check_access_token_exists**](docs/ConfigurationSetsApi.md#check_access_token_exists) | **HEAD** /api/sets/personal/me | [DEPRECATED] CheckAccessTokenExists: Check the Personal Access Token exists for the current user
  *ConfigurationSetsApi* | [**create_configuration_set**](docs/ConfigurationSetsApi.md#create_configuration_set) | **POST** /api/sets | [EARLY ACCESS] CreateConfigurationSet: Create a configuration set
  *ConfigurationSetsApi* | [**delete_access_token**](docs/ConfigurationSetsApi.md#delete_access_token) | **DELETE** /api/sets/personal/me | [DEPRECATED] DeleteAccessToken: Delete any stored Personal Access Token for the current user
  *ConfigurationSetsApi* | [**delete_configuration_item**](docs/ConfigurationSetsApi.md#delete_configuration_item) | **DELETE** /api/sets/{type}/{scope}/{code}/items/{key} | [EARLY ACCESS] DeleteConfigurationItem: Remove the specified configuration item from the specified configuration set
  *ConfigurationSetsApi* | [**delete_configuration_set**](docs/ConfigurationSetsApi.md#delete_configuration_set) | **DELETE** /api/sets/{type}/{scope}/{code} | [EARLY ACCESS] DeleteConfigurationSet: Deletes a configuration set along with all their configuration items
  *ConfigurationSetsApi* | [**generate_access_token**](docs/ConfigurationSetsApi.md#generate_access_token) | **PUT** /api/sets/personal/me | [DEPRECATED] GenerateAccessToken: Generate a Personal Access Token for the current user and stores it in the me token
  *ConfigurationSetsApi* | [**get_configuration_item**](docs/ConfigurationSetsApi.md#get_configuration_item) | **GET** /api/sets/{type}/{scope}/{code}/items/{key} | GetConfigurationItem: Get the specific configuration item within an existing set
  *ConfigurationSetsApi* | [**get_configuration_set**](docs/ConfigurationSetsApi.md#get_configuration_set) | **GET** /api/sets/{type}/{scope}/{code} | GetConfigurationSet: Get a configuration set, including all the associated metadata. By default secrets will not be revealed
  *ConfigurationSetsApi* | [**get_system_configuration_items**](docs/ConfigurationSetsApi.md#get_system_configuration_items) | **GET** /api/sets/system/{code}/items/{key} | [EARLY ACCESS] GetSystemConfigurationItems: Get the specific system configuration items within a system set  All users have access to this endpoint
  *ConfigurationSetsApi* | [**get_system_configuration_sets**](docs/ConfigurationSetsApi.md#get_system_configuration_sets) | **GET** /api/sets/system/{code} | GetSystemConfigurationSets: Get the specified system configuration sets, including all their associated metadata. By default secrets will not be revealed  All users have access to this endpoint
  *ConfigurationSetsApi* | [**list_configuration_sets**](docs/ConfigurationSetsApi.md#list_configuration_sets) | **GET** /api/sets | [EARLY ACCESS] ListConfigurationSets: List all configuration sets summaries (I.e. list of scope/code combinations available)
  *ConfigurationSetsApi* | [**update_configuration_item**](docs/ConfigurationSetsApi.md#update_configuration_item) | **PUT** /api/sets/{type}/{scope}/{code}/items/{key} | [EARLY ACCESS] UpdateConfigurationItem: Update a configuration item's value and/or description
  *ConfigurationSetsApi* | [**update_configuration_set**](docs/ConfigurationSetsApi.md#update_configuration_set) | **PUT** /api/sets/{type}/{scope}/{code} | [EARLY ACCESS] UpdateConfigurationSet: Update the description of a configuration set
  <a id="documentation-for-models"></a>

   - [AccessControlledAction](docs/AccessControlledAction.md)
   - [AccessControlledResource](docs/AccessControlledResource.md)
   - [ActionId](docs/ActionId.md)
   - [ConfigurationItem](docs/ConfigurationItem.md)
   - [ConfigurationItemSummary](docs/ConfigurationItemSummary.md)
   - [ConfigurationSet](docs/ConfigurationSet.md)
   - [ConfigurationSetSummary](docs/ConfigurationSetSummary.md)
   - [CreateConfigurationItem](docs/CreateConfigurationItem.md)
   - [CreateConfigurationSet](docs/CreateConfigurationSet.md)
   - [IdSelectorDefinition](docs/IdSelectorDefinition.md)
   - [IdentifierPartSchema](docs/IdentifierPartSchema.md)
   - [Link](docs/Link.md)
   - [LusidProblemDetails](docs/LusidProblemDetails.md)
   - [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)
   - [PersonalAccessToken](docs/PersonalAccessToken.md)
   - [ResourceId](docs/ResourceId.md)
   - [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)
   - [ResourceListOfConfigurationItem](docs/ResourceListOfConfigurationItem.md)
   - [ResourceListOfConfigurationSet](docs/ResourceListOfConfigurationSet.md)
   - [ResourceListOfConfigurationSetSummary](docs/ResourceListOfConfigurationSetSummary.md)
   - [UpdateConfigurationItem](docs/UpdateConfigurationItem.md)
   - [UpdateConfigurationSet](docs/UpdateConfigurationSet.md)


pkgId: 886023684ff0581525c531bd33f31d94ce34bde5a2460e863fa634f820f9b6db
name: python-lusid-drive-sdk-help
arch: noarch
version: 2.1.43
epoch: 0
release: 1
summary: Development documents and examples for lusid-drive-sdk
url: https://github.com/finbourne/drive-sdk-python
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lusid-drive-sdk-2.1.43-1.src.rpm
location_href: Packages/python-lusid-drive-sdk-help-2.1.43-1.noarch.rpm
checksum_type: sha256
description:
  *ApplicationMetadataApi* | [**list_access_controlled_resources**](docs/ApplicationMetadataApi.md#list_access_controlled_resources) | **GET** /api/metadata/access/resources | [EARLY ACCESS] ListAccessControlledResources: Get resources available for access control
  *FilesApi* | [**create_file**](docs/FilesApi.md#create_file) | **POST** /api/files | CreateFile: Uploads a file to Lusid Drive. If using an SDK, consider using the UploadAsStreamAsync function for larger files instead.
  *FilesApi* | [**delete_file**](docs/FilesApi.md#delete_file) | **DELETE** /api/files/{id} | [EARLY ACCESS] DeleteFile: Deletes a file from Drive.
  *FilesApi* | [**download_file**](docs/FilesApi.md#download_file) | **GET** /api/files/{id}/contents | DownloadFile: Download the file from Drive.
  *FilesApi* | [**get_file**](docs/FilesApi.md#get_file) | **GET** /api/files/{id} | [EARLY ACCESS] GetFile: Get a file stored in Drive.
  *FilesApi* | [**update_file_contents**](docs/FilesApi.md#update_file_contents) | **PUT** /api/files/{id}/contents | [EARLY ACCESS] UpdateFileContents: Updates contents of a file in Drive.
  *FilesApi* | [**update_file_metadata**](docs/FilesApi.md#update_file_metadata) | **PUT** /api/files/{id} | [EARLY ACCESS] UpdateFileMetadata: Updates metadata for a file in Drive.
  *FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /api/folders | [EARLY ACCESS] CreateFolder: Create a new folder in LUSID Drive
  *FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /api/folders/{id} | [EARLY ACCESS] DeleteFolder: Delete a specified folder and all subfolders
  *FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /api/folders/{id} | [EARLY ACCESS] GetFolder: Get metadata of folder
  *FoldersApi* | [**get_folder_contents**](docs/FoldersApi.md#get_folder_contents) | **GET** /api/folders/{id}/contents | GetFolderContents: List contents of a folder
  *FoldersApi* | [**get_root_folder**](docs/FoldersApi.md#get_root_folder) | **GET** /api/folders | GetRootFolder: List contents of root folder
  *FoldersApi* | [**move_folder**](docs/FoldersApi.md#move_folder) | **POST** /api/folders/{id} | [EARLY ACCESS] MoveFolder: Move files to specified folder
  *FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /api/folders/{id} | [EARLY ACCESS] UpdateFolder: Update an existing folder's name, path
  *SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /api/search | [EARLY ACCESS] Search: Search for a file or folder with a given name and path
  <a id="documentation-for-models"></a>

   - [AccessControlledAction](docs/AccessControlledAction.md)
   - [AccessControlledResource](docs/AccessControlledResource.md)
   - [ActionId](docs/ActionId.md)
   - [CreateFolder](docs/CreateFolder.md)
   - [IdSelectorDefinition](docs/IdSelectorDefinition.md)
   - [IdentifierPartSchema](docs/IdentifierPartSchema.md)
   - [Link](docs/Link.md)
   - [LusidProblemDetails](docs/LusidProblemDetails.md)
   - [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)
   - [PagedResourceListOfStorageObject](docs/PagedResourceListOfStorageObject.md)
   - [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)
   - [SearchBody](docs/SearchBody.md)
   - [StorageObject](docs/StorageObject.md)
   - [UpdateFile](docs/UpdateFile.md)
   - [UpdateFolder](docs/UpdateFolder.md)


pkgId: 3f670f3c7a7b3aee74e4366c21f6932b64eee5597b7952e6fa3df55fdd98c318
name: python-lusid-notifications-sdk-help
arch: noarch
version: 2.1.59
epoch: 0
release: 1
summary: Development documents and examples for lusid-notifications-sdk
url: https://github.com/finbourne/notifications-sdk-python
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lusid-notifications-sdk-2.1.59-1.src.rpm
location_href: Packages/python-lusid-notifications-sdk-help-2.1.59-1.noarch.rpm
checksum_type: sha256
description:
  *ApplicationMetadataApi* | [**list_access_controlled_resources**](docs/ApplicationMetadataApi.md#list_access_controlled_resources) | **GET** /api/metadata/access/resources | ListAccessControlledResources: Get resources available for access control
  *DeliveriesApi* | [**list_deliveries**](docs/DeliveriesApi.md#list_deliveries) | **GET** /api/deliveries | ListDeliveries: List Deliveries
  *EventTypesApi* | [**get_event_type**](docs/EventTypesApi.md#get_event_type) | **GET** /api/eventtypes/{eventType} | GetEventType: Gets the specified event type schema.
  *EventTypesApi* | [**list_event_types**](docs/EventTypesApi.md#list_event_types) | **GET** /api/eventtypes | ListEventTypes: Lists all of the available event types.
  *ManualEventApi* | [**trigger_manual_event**](docs/ManualEventApi.md#trigger_manual_event) | **POST** /api/manualevent | TriggerManualEvent: Trigger a manual event.
  *NotificationsApi* | [**create_notification**](docs/NotificationsApi.md#create_notification) | **POST** /api/subscriptions/{scope}/{code}/notifications | CreateNotification: Add a Notification to a Subscription.
  *NotificationsApi* | [**delete_notification**](docs/NotificationsApi.md#delete_notification) | **DELETE** /api/subscriptions/{scope}/{code}/notifications/{id} | DeleteNotification: Delete a notification for a given subscription.
  *NotificationsApi* | [**get_notification**](docs/NotificationsApi.md#get_notification) | **GET** /api/subscriptions/{scope}/{code}/notifications/{id} | GetNotification: Get a notification on a subscription.
  *NotificationsApi* | [**list_notifications**](docs/NotificationsApi.md#list_notifications) | **GET** /api/subscriptions/{scope}/{code}/notifications | ListNotifications: List all notifications on a subscription.
  *NotificationsApi* | [**update_notification**](docs/NotificationsApi.md#update_notification) | **PUT** /api/subscriptions/{scope}/{code}/notifications/{id} | UpdateNotification: Update a Notification for a Subscription
  *SubscriptionsApi* | [**create_subscription**](docs/SubscriptionsApi.md#create_subscription) | **POST** /api/subscriptions | CreateSubscription: Create a new subscription.
  *SubscriptionsApi* | [**delete_subscription**](docs/SubscriptionsApi.md#delete_subscription) | **DELETE** /api/subscriptions/{scope}/{code} | DeleteSubscription: Delete a subscription.
  *SubscriptionsApi* | [**get_subscription**](docs/SubscriptionsApi.md#get_subscription) | **GET** /api/subscriptions/{scope}/{code} | GetSubscription: Get a subscription.
  *SubscriptionsApi* | [**list_subscriptions**](docs/SubscriptionsApi.md#list_subscriptions) | **GET** /api/subscriptions | ListSubscriptions: List subscriptions.
  *SubscriptionsApi* | [**update_subscription**](docs/SubscriptionsApi.md#update_subscription) | **PUT** /api/subscriptions/{scope}/{code} | UpdateSubscription: Update an existing subscription.
  <a id="documentation-for-models"></a>

   - [AccessControlledAction](docs/AccessControlledAction.md)
   - [AccessControlledResource](docs/AccessControlledResource.md)
   - [ActionId](docs/ActionId.md)
   - [AmazonSqsNotificationType](docs/AmazonSqsNotificationType.md)
   - [AmazonSqsNotificationTypeResponse](docs/AmazonSqsNotificationTypeResponse.md)
   - [AmazonSqsPrincipalAuthNotificationType](docs/AmazonSqsPrincipalAuthNotificationType.md)
   - [AmazonSqsPrincipalAuthNotificationTypeResponse](docs/AmazonSqsPrincipalAuthNotificationTypeResponse.md)
   - [Attempt](docs/Attempt.md)
   - [AttemptStatus](docs/AttemptStatus.md)
   - [AzureServiceBusNotificationType](docs/AzureServiceBusNotificationType.md)
   - [AzureServiceBusTypeResponse](docs/AzureServiceBusTypeResponse.md)
   - [CreateNotificationRequest](docs/CreateNotificationRequest.md)
   - [CreateSubscription](docs/CreateSubscription.md)
   - [Delivery](docs/Delivery.md)
   - [EmailNotificationType](docs/EmailNotificationType.md)
   - [EmailNotificationTypeResponse](docs/EmailNotificationTypeResponse.md)
   - [EventFieldDefinition](docs/EventFieldDefinition.md)
   - [EventTypeSchema](docs/EventTypeSchema.md)
   - [IdSelectorDefinition](docs/IdSelectorDefinition.md)
   - [IdentifierPartSchema](docs/IdentifierPartSchema.md)
   - [Link](docs/Link.md)
   - [LusidProblemDetails](docs/LusidProblemDetails.md)
   - [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)
   - [ManualEvent](docs/ManualEvent.md)
   - [ManualEventBody](docs/ManualEventBody.md)
   - [ManualEventHeader](docs/ManualEventHeader.md)
   - [ManualEventRequest](docs/ManualEventRequest.md)
   - [MatchingPattern](docs/MatchingPattern.md)
   - [Notification](docs/Notification.md)
   - [NotificationStatus](docs/NotificationStatus.md)
   - [NotificationType](docs/NotificationType.md)
   - [NotificationTypeResponse](docs/NotificationTypeResponse.md)
   - [ResourceId](docs/ResourceId.md)
   - [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)
   - [ResourceListOfDelivery](docs/ResourceListOfDelivery.md)
   - [ResourceListOfEventTypeSchema](docs/ResourceListOfEventTypeSchema.md)
   - [ResourceListOfNotification](docs/ResourceListOfNotification.md)
   - [ResourceListOfSubscription](docs/ResourceListOfSubscription.md)
   - [SmsNotificationType](docs/SmsNotificationType.md)
   - [SmsNotificationTypeResponse](docs/SmsNotificationTypeResponse.md)
   - [Subscription](docs/Subscription.md)
   - [UpdateNotificationRequest](docs/UpdateNotificationRequest.md)
   - [UpdateSubscription](docs/UpdateSubscription.md)
   - [WebhookNotificationType](docs/WebhookNotificationType.md)
   - [WebhookNotificationTypeResponse](docs/WebhookNotificationTypeResponse.md)


pkgId: a4bef4e34f939079e622f4b5f0ada2b088b46da57ab212a4314ee33f96f42d59
name: python-lusid-scheduler-sdk-help
arch: noarch
version: 2.1.71
epoch: 0
release: 1
summary: Development documents and examples for lusid-scheduler-sdk
url: https://github.com/finbourne/scheduler-sdk-python
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lusid-scheduler-sdk-2.1.71-1.src.rpm
location_href: Packages/python-lusid-scheduler-sdk-help-2.1.71-1.noarch.rpm
checksum_type: sha256
description:
  *ApplicationMetadataApi* | [**list_access_controlled_resources**](docs/ApplicationMetadataApi.md#list_access_controlled_resources) | **GET** /api/metadata/access/resources | [EXPERIMENTAL] ListAccessControlledResources: Get resources available for access control
  *ImagesApi* | [**delete_image**](docs/ImagesApi.md#delete_image) | **DELETE** /api/images/{name} | [EXPERIMENTAL] DeleteImage: Delete a Docker Image
  *ImagesApi* | [**download_image**](docs/ImagesApi.md#download_image) | **GET** /api/images/{name}/contents | [EXPERIMENTAL] DownloadImage: Download Docker Image
  *ImagesApi* | [**get_image**](docs/ImagesApi.md#get_image) | **GET** /api/images/{name} | [EXPERIMENTAL] GetImage: Get metadata of a Docker Image
  *ImagesApi* | [**list_images**](docs/ImagesApi.md#list_images) | **GET** /api/images/repository/{name} | [EXPERIMENTAL] ListImages: List all images under same image repository
  *ImagesApi* | [**list_repositories**](docs/ImagesApi.md#list_repositories) | **GET** /api/images/repository | [EXPERIMENTAL] ListRepositories: List all Docker image repositories
  *ImagesApi* | [**upload_image**](docs/ImagesApi.md#upload_image) | **POST** /api/images | [EXPERIMENTAL] UploadImage: Upload a Docker Image used for Scheduler jobs
  *JobsApi* | [**create_job**](docs/JobsApi.md#create_job) | **POST** /api/jobs | [EXPERIMENTAL] CreateJob: Create a new job
  *JobsApi* | [**delete_job**](docs/JobsApi.md#delete_job) | **DELETE** /api/jobs/{scope}/{code} | [EXPERIMENTAL] DeleteJob: Delete a job
  *JobsApi* | [**get_history**](docs/JobsApi.md#get_history) | **GET** /api/jobs/history | [EXPERIMENTAL] GetHistory: Get the history of job runs
  *JobsApi* | [**get_job_console_output**](docs/JobsApi.md#get_job_console_output) | **GET** /api/jobs/history/{runId}/console | [EXPERIMENTAL] GetJobConsoleOutput: Gets the console output of a specific job run
  *JobsApi* | [**get_run_history**](docs/JobsApi.md#get_run_history) | **GET** /api/jobs/history/{runId} | [EXPERIMENTAL] GetRunHistory: Get the history for a single job run
  *JobsApi* | [**get_schedules_for_a_job**](docs/JobsApi.md#get_schedules_for_a_job) | **GET** /api/jobs/{scope}/{code}/schedules | [EXPERIMENTAL] GetSchedulesForAJob: Get all the schedules for a single job
  *JobsApi* | [**list_jobs**](docs/JobsApi.md#list_jobs) | **GET** /api/jobs | [EXPERIMENTAL] ListJobs: List the available jobs
  *JobsApi* | [**run_job**](docs/JobsApi.md#run_job) | **POST** /api/jobs/{scope}/{code}/$run | RunJob: Run a job immediately
  *JobsApi* | [**update_job**](docs/JobsApi.md#update_job) | **PUT** /api/jobs/{scope}/{code} | [EXPERIMENTAL] UpdateJob: Update a JobDefinition
  *SchedulesApi* | [**create_schedule**](docs/SchedulesApi.md#create_schedule) | **POST** /api/schedules | [EXPERIMENTAL] CreateSchedule: Create a Schedule for a job
  *SchedulesApi* | [**delete_schedule**](docs/SchedulesApi.md#delete_schedule) | **DELETE** /api/schedules/{scope}/{code} | [EXPERIMENTAL] DeleteSchedule: Delete a schedule
  *SchedulesApi* | [**enabled_schedule**](docs/SchedulesApi.md#enabled_schedule) | **PUT** /api/schedules/{scope}/{code}/enabled | [EXPERIMENTAL] EnabledSchedule: Enable/disable a schedule
  *SchedulesApi* | [**get_schedule**](docs/SchedulesApi.md#get_schedule) | **GET** /api/schedules/{scope}/{code} | [EXPERIMENTAL] GetSchedule: Get a single Schedule
  *SchedulesApi* | [**list_schedules**](docs/SchedulesApi.md#list_schedules) | **GET** /api/schedules | [EXPERIMENTAL] ListSchedules: List the available Schedules
  *SchedulesApi* | [**run_schedule**](docs/SchedulesApi.md#run_schedule) | **POST** /api/schedules/{scope}/{code}/$run | [EXPERIMENTAL] RunSchedule: Run a schedule immediately
  *SchedulesApi* | [**update_schedule**](docs/SchedulesApi.md#update_schedule) | **PUT** /api/schedules/{scope}/{code} | [EXPERIMENTAL] UpdateSchedule: Update a schedule.
  <a id="documentation-for-models"></a>

   - [AccessControlledAction](docs/AccessControlledAction.md)
   - [AccessControlledResource](docs/AccessControlledResource.md)
   - [ActionId](docs/ActionId.md)
   - [ArgumentDefinition](docs/ArgumentDefinition.md)
   - [CreateJobRequest](docs/CreateJobRequest.md)
   - [CreateScheduleRequest](docs/CreateScheduleRequest.md)
   - [IdSelectorDefinition](docs/IdSelectorDefinition.md)
   - [IdentifierPartSchema](docs/IdentifierPartSchema.md)
   - [Image](docs/Image.md)
   - [ImageSummary](docs/ImageSummary.md)
   - [JobDefinition](docs/JobDefinition.md)
   - [JobHistory](docs/JobHistory.md)
   - [JobRunResult](docs/JobRunResult.md)
   - [Link](docs/Link.md)
   - [LusidProblemDetails](docs/LusidProblemDetails.md)
   - [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)
   - [Notification](docs/Notification.md)
   - [Repository](docs/Repository.md)
   - [RequiredResources](docs/RequiredResources.md)
   - [ResourceId](docs/ResourceId.md)
   - [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)
   - [ResourceListOfImageSummary](docs/ResourceListOfImageSummary.md)
   - [ResourceListOfJobDefinition](docs/ResourceListOfJobDefinition.md)
   - [ResourceListOfJobHistory](docs/ResourceListOfJobHistory.md)
   - [ResourceListOfRepository](docs/ResourceListOfRepository.md)
   - [ResourceListOfScheduleDefinition](docs/ResourceListOfScheduleDefinition.md)
   - [ScanReport](docs/ScanReport.md)
   - [ScanSummary](docs/ScanSummary.md)
   - [ScheduleDefinition](docs/ScheduleDefinition.md)
   - [StartJobRequest](docs/StartJobRequest.md)
   - [StartJobResponse](docs/StartJobResponse.md)
   - [StartScheduleResponse](docs/StartScheduleResponse.md)
   - [Tag](docs/Tag.md)
   - [TimeTrigger](docs/TimeTrigger.md)
   - [Trigger](docs/Trigger.md)
   - [UpdateJobRequest](docs/UpdateJobRequest.md)
   - [UpdateScheduleRequest](docs/UpdateScheduleRequest.md)
   - [UploadImageInstructions](docs/UploadImageInstructions.md)
   - [UploadImageRequest](docs/UploadImageRequest.md)
   - [Vulnerability](docs/Vulnerability.md)


pkgId: f76713d44e56130e116f0de025729931e0aa08a0fb204cf5f1fba96a0eb7cbf2
name: python-lusid-sdk-help
arch: noarch
version: 2.1.633
epoch: 0
release: 1
summary: Development documents and examples for lusid-sdk
url: https://github.com/finbourne/lusid-sdk-python
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-lusid-sdk-2.1.633-1.src.rpm
location_href: Packages/python-lusid-sdk-help-2.1.633-1.noarch.rpm
checksum_type: sha256
description:
  *AborApi* | [**add_diary_entry**](docs/AborApi.md#add_diary_entry) | **POST** /api/abor/{scope}/{code}/accountingdiary | [EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor.
  *AborApi* | [**close_period**](docs/AborApi.md#close_period) | **POST** /api/abor/{scope}/{code}/accountingdiary/$closeperiod | [EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor.
  *AborApi* | [**create_abor**](docs/AborApi.md#create_abor) | **POST** /api/abor/{scope} | [EXPERIMENTAL] CreateAbor: Create an Abor.
  *AborApi* | [**delete_abor**](docs/AborApi.md#delete_abor) | **DELETE** /api/abor/{scope}/{code} | [EXPERIMENTAL] DeleteAbor: Delete an Abor.
  *AborApi* | [**get_abor**](docs/AborApi.md#get_abor) | **GET** /api/abor/{scope}/{code} | [EXPERIMENTAL] GetAbor: Get Abor.
  *AborApi* | [**get_journal_entry_lines**](docs/AborApi.md#get_journal_entry_lines) | **POST** /api/abor/{scope}/{code}/journalentrylines/$query | [EXPERIMENTAL] GetJournalEntryLines: Get the Journal Entry lines for the given Abor.
  *AborApi* | [**get_trial_balance**](docs/AborApi.md#get_trial_balance) | **POST** /api/abor/{scope}/{code}/trialbalance/$query | [EXPERIMENTAL] GetTrialBalance: Get the Trial Balance for the given Abor.
  *AborApi* | [**list_abors**](docs/AborApi.md#list_abors) | **GET** /api/abor | [EXPERIMENTAL] ListAbors: List Abors.
  *AborApi* | [**list_diary_entries**](docs/AborApi.md#list_diary_entries) | **GET** /api/abor/{scope}/{code}/accountingdiary | [EXPERIMENTAL] ListDiaryEntries: List diary entries.
  *AborApi* | [**lock_period**](docs/AborApi.md#lock_period) | **POST** /api/abor/{scope}/{code}/accountingdiary/$lockperiod | [EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period.
  *AborApi* | [**patch_abor**](docs/AborApi.md#patch_abor) | **PATCH** /api/abor/{scope}/{code} | [EXPERIMENTAL] PatchAbor: Patch Abor.
  *AborApi* | [**re_open_periods**](docs/AborApi.md#re_open_periods) | **POST** /api/abor/{scope}/{code}/accountingdiary/$reopenperiods | [EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor.
  *AborApi* | [**upsert_abor_properties**](docs/AborApi.md#upsert_abor_properties) | **POST** /api/abor/{scope}/{code}/properties/$upsert | [EXPERIMENTAL] UpsertAborProperties: Upsert Abor properties
  *AborConfigurationApi* | [**create_abor_configuration**](docs/AborConfigurationApi.md#create_abor_configuration) | **POST** /api/aborconfiguration/{scope} | [EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration.
  *AborConfigurationApi* | [**delete_abor_configuration**](docs/AborConfigurationApi.md#delete_abor_configuration) | **DELETE** /api/aborconfiguration/{scope}/{code} | [EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration.
  *AborConfigurationApi* | [**get_abor_configuration**](docs/AborConfigurationApi.md#get_abor_configuration) | **GET** /api/aborconfiguration/{scope}/{code} | [EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration.
  *AborConfigurationApi* | [**list_abor_configurations**](docs/AborConfigurationApi.md#list_abor_configurations) | **GET** /api/aborconfiguration | [EXPERIMENTAL] ListAborConfigurations: List AborConfiguration.
  *AborConfigurationApi* | [**upsert_abor_configuration_properties**](docs/AborConfigurationApi.md#upsert_abor_configuration_properties) | **POST** /api/aborconfiguration/{scope}/{code}/properties/$upsert | [EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties
  *AddressKeyDefinitionApi* | [**create_address_key_definition**](docs/AddressKeyDefinitionApi.md#create_address_key_definition) | **POST** /api/addresskeydefinitions | [EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition.
  *AddressKeyDefinitionApi* | [**get_address_key_definition**](docs/AddressKeyDefinitionApi.md#get_address_key_definition) | **GET** /api/addresskeydefinitions/{key} | [EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition.
  *AddressKeyDefinitionApi* | [**list_address_key_definitions**](docs/AddressKeyDefinitionApi.md#list_address_key_definitions) | **GET** /api/addresskeydefinitions | [EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions.
  *AggregationApi* | [**generate_configuration_recipe**](docs/AggregationApi.md#generate_configuration_recipe) | **POST** /api/aggregation/{scope}/{code}/$generateconfigurationrecipe | [EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio.
  *AggregationApi* | [**get_queryable_keys**](docs/AggregationApi.md#get_queryable_keys) | **GET** /api/results/queryable/keys | GetQueryableKeys: Query the set of supported \"addresses\" that can be queried from the aggregation endpoint.
  *AggregationApi* | [**get_valuation**](docs/AggregationApi.md#get_valuation) | **POST** /api/aggregation/$valuation | GetValuation: Perform valuation for a list of portfolios and/or portfolio groups
  *AggregationApi* | [**get_valuation_of_weighted_instruments**](docs/AggregationApi.md#get_valuation_of_weighted_instruments) | **POST** /api/aggregation/$valuationinlined | GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio
  *AllocationsApi* | [**delete_allocation**](docs/AllocationsApi.md#delete_allocation) | **DELETE** /api/allocations/{scope}/{code} | [EARLY ACCESS] DeleteAllocation: Delete allocation
  *AllocationsApi* | [**get_allocation**](docs/AllocationsApi.md#get_allocation) | **GET** /api/allocations/{scope}/{code} | [EARLY ACCESS] GetAllocation: Get Allocation
  *AllocationsApi* | [**list_allocations**](docs/AllocationsApi.md#list_allocations) | **GET** /api/allocations | ListAllocations: List Allocations
  *AllocationsApi* | [**upsert_allocations**](docs/AllocationsApi.md#upsert_allocations) | **POST** /api/allocations | UpsertAllocations: Upsert Allocations
  *AmortisationRuleSetsApi* | [**create_amortisation_rule_set**](docs/AmortisationRuleSetsApi.md#create_amortisation_rule_set) | **POST** /api/amortisation/rulesets/{scope} | [EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set.
  *AmortisationRuleSetsApi* | [**delete_amortisation_ruleset**](docs/AmortisationRuleSetsApi.md#delete_amortisation_ruleset) | **DELETE** /api/amortisation/rulesets/{scope}/{code} | [EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set.
  *AmortisationRuleSetsApi* | [**get_amortisation_rule_set**](docs/AmortisationRuleSetsApi.md#get_amortisation_rule_set) | **GET** /api/amortisation/rulesets/{scope}/{code} | [EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set
  *AmortisationRuleSetsApi* | [**list_amortisation_rule_sets**](docs/AmortisationRuleSetsApi.md#list_amortisation_rule_sets) | **GET** /api/amortisation/rulesets | [EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets.
  *AmortisationRuleSetsApi* | [**set_amortisation_rules**](docs/AmortisationRuleSetsApi.md#set_amortisation_rules) | **PUT** /api/amortisation/rulesets/{scope}/{code}/rules | [EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set.
  *AmortisationRuleSetsApi* | [**update_amortisation_rule_set_details**](docs/AmortisationRuleSetsApi.md#update_amortisation_rule_set_details) | **PUT** /api/amortisation/rulesets/{scope}/{code}/details | [EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set.
  *ApplicationMetadataApi* | [**get_excel_addin**](docs/ApplicationMetadataApi.md#get_excel_addin) | **GET** /api/metadata/downloads/exceladdin | GetExcelAddin: Download Excel Addin
  *ApplicationMetadataApi* | [**get_lusid_versions**](docs/ApplicationMetadataApi.md#get_lusid_versions) | **GET** /api/metadata/versions | GetLusidVersions: Get LUSID versions
  *ApplicationMetadataApi* | [**list_access_controlled_resources**](docs/ApplicationMetadataApi.md#list_access_controlled_resources) | **GET** /api/metadata/access/resources | ListAccessControlledResources: Get resources available for access control
  *BlocksApi* | [**delete_block**](docs/BlocksApi.md#delete_block) | **DELETE** /api/blocks/{scope}/{code} | [EARLY ACCESS] DeleteBlock: Delete block
  *BlocksApi* | [**get_block**](docs/BlocksApi.md#get_block) | **GET** /api/blocks/{scope}/{code} | [EARLY ACCESS] GetBlock: Get Block
  *BlocksApi* | [**list_blocks**](docs/BlocksApi.md#list_blocks) | **GET** /api/blocks | [EARLY ACCESS] ListBlocks: List Blocks
  *BlocksApi* | [**upsert_blocks**](docs/BlocksApi.md#upsert_blocks) | **POST** /api/blocks | [EARLY ACCESS] UpsertBlocks: Upsert Block
  *CalendarsApi* | [**add_business_days_to_date**](docs/CalendarsApi.md#add_business_days_to_date) | **POST** /api/calendars/businessday/{scope}/add | [EARLY ACCESS] AddBusinessDaysToDate: Adds the requested number of Business Days to the provided date.
  *CalendarsApi* | [**add_date_to_calendar**](docs/CalendarsApi.md#add_date_to_calendar) | **PUT** /api/calendars/generic/{scope}/{code}/dates | AddDateToCalendar: Add a date to a calendar
  *CalendarsApi* | [**batch_upsert_dates_for_calendar**](docs/CalendarsApi.md#batch_upsert_dates_for_calendar) | **POST** /api/calendars/generic/{scope}/{code}/dates/$batchUpsert | BatchUpsertDatesForCalendar: Batch upsert dates to a calendar
  *CalendarsApi* | [**create_calendar**](docs/CalendarsApi.md#create_calendar) | **POST** /api/calendars/generic | [EARLY ACCESS] CreateCalendar: Create a calendar in its generic form
  *CalendarsApi* | [**delete_calendar**](docs/CalendarsApi.md#delete_calendar) | **DELETE** /api/calendars/generic/{scope}/{code} | [EARLY ACCESS] DeleteCalendar: Delete a calendar
  *CalendarsApi* | [**delete_date_from_calendar**](docs/CalendarsApi.md#delete_date_from_calendar) | **DELETE** /api/calendars/generic/{scope}/{code}/dates/{dateId} | DeleteDateFromCalendar: Remove a date from a calendar
  *CalendarsApi* | [**delete_dates_from_calendar**](docs/CalendarsApi.md#delete_dates_from_calendar) | **POST** /api/calendars/generic/{scope}/{code}/dates/$delete | DeleteDatesFromCalendar: Delete dates from a calendar
  *CalendarsApi* | [**generate_schedule**](docs/CalendarsApi.md#generate_schedule) | **POST** /api/calendars/schedule/{scope} | [EARLY ACCESS] GenerateSchedule: Generate an ordered schedule of dates.
  *CalendarsApi* | [**get_calendar**](docs/CalendarsApi.md#get_calendar) | **GET** /api/calendars/generic/{scope}/{code} | GetCalendar: Get a calendar in its generic form
  *CalendarsApi* | [**get_dates**](docs/CalendarsApi.md#get_dates) | **GET** /api/calendars/generic/{scope}/{code}/dates | [EARLY ACCESS] GetDates: Get dates for a specific calendar
  *CalendarsApi* | [**is_business_date_time**](docs/CalendarsApi.md#is_business_date_time) | **GET** /api/calendars/businessday/{scope}/{code} | [EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a \"Business DateTime\"
  *CalendarsApi* | [**list_calendars**](docs/CalendarsApi.md#list_calendars) | **GET** /api/calendars/generic | [EARLY ACCESS] ListCalendars: List Calendars
  *CalendarsApi* | [**list_calendars_in_scope**](docs/CalendarsApi.md#list_calendars_in_scope) | **GET** /api/calendars/generic/{scope} | ListCalendarsInScope: List all calenders in a specified scope
  *CalendarsApi* | [**update_calendar**](docs/CalendarsApi.md#update_calendar) | **POST** /api/calendars/generic/{scope}/{code} | [EARLY ACCESS] UpdateCalendar: Update a calendar
  *ChartOfAccountsApi* | [**create_chart_of_accounts**](docs/ChartOfAccountsApi.md#create_chart_of_accounts) | **POST** /api/chartofaccounts/{scope} | [EXPERIMENTAL] CreateChartOfAccounts: Create a Chart of Accounts
  *ChartOfAccountsApi* | [**create_cleardown_module**](docs/ChartOfAccountsApi.md#create_cleardown_module) | **POST** /api/chartofaccounts/{scope}/{code}/cleardownmodules | [EXPERIMENTAL] CreateCleardownModule: Create a Cleardown Module
  *ChartOfAccountsApi* | [**create_general_ledger_profile**](docs/ChartOfAccountsApi.md#create_general_ledger_profile) | **POST** /api/chartofaccounts/{scope}/{code}/generalledgerprofile | [EXPERIMENTAL] CreateGeneralLedgerProfile: Create a General Ledger Profile.
  *ChartOfAccountsApi* | [**create_posting_module**](docs/ChartOfAccountsApi.md#create_posting_module) | **POST** /api/chartofaccounts/{scope}/{code}/postingmodules | [EXPERIMENTAL] CreatePostingModule: Create a Posting Module
  *ChartOfAccountsApi* | [**delete_accounts**](docs/ChartOfAccountsApi.md#delete_accounts) | **POST** /api/chartofaccounts/{scope}/{code}/accounts/$delete | [EXPERIMENTAL] DeleteAccounts: Soft or hard delete multiple accounts
  *ChartOfAccountsApi* | [**delete_chart_of_accounts**](docs/ChartOfAccountsApi.md#delete_chart_of_accounts) | **DELETE** /api/chartofaccounts/{scope}/{code} | [EXPERIMENTAL] DeleteChartOfAccounts: Delete a Chart of Accounts
  *ChartOfAccountsApi* | [**delete_cleardown_module**](docs/ChartOfAccountsApi.md#delete_cleardown_module) | **DELETE** /api/chartofaccounts/{scope}/{code}/cleardownmodules/{cleardownModuleCode} | [EXPERIMENTAL] DeleteCleardownModule: Delete a Cleardown Module.
  *ChartOfAccountsApi* | [**delete_general_ledger_profile**](docs/ChartOfAccountsApi.md#delete_general_ledger_profile) | **DELETE** /api/chartofaccounts/{scope}/{code}/generalledgerprofile/{generalLedgerProfileCode} | [EXPERIMENTAL] DeleteGeneralLedgerProfile: Delete a General Ledger Profile.
  *ChartOfAccountsApi* | [**delete_posting_module**](docs/ChartOfAccountsApi.md#delete_posting_module) | **DELETE** /api/chartofaccounts/{scope}/{code}/postingmodules/{postingModuleCode} | [EXPERIMENTAL] DeletePostingModule: Delete a Posting Module.
  *ChartOfAccountsApi* | [**get_account**](docs/ChartOfAccountsApi.md#get_account) | **GET** /api/chartofaccounts/{scope}/{code}/accounts/{accountCode} | [EXPERIMENTAL] GetAccount: Get Account
  *ChartOfAccountsApi* | [**get_chart_of_accounts**](docs/ChartOfAccountsApi.md#get_chart_of_accounts) | **GET** /api/chartofaccounts/{scope}/{code} | [EXPERIMENTAL] GetChartOfAccounts: Get ChartOfAccounts
  *ChartOfAccountsApi* | [**get_cleardown_module**](docs/ChartOfAccountsApi.md#get_cleardown_module) | **GET** /api/chartofaccounts/{scope}/{code}/cleardownmodules/{cleardownModuleCode} | [EXPERIMENTAL] GetCleardownModule: Get a Cleardown Module
  *ChartOfAccountsApi* | [**get_general_ledger_profile**](docs/ChartOfAccountsApi.md#get_general_ledger_profile) | **GET** /api/chartofaccounts/{scope}/{code}/generalledgerprofile/{generalLedgerProfileCode} | [EXPERIMENTAL] GetGeneralLedgerProfile: Get a General Ledger Profile.
  *ChartOfAccountsApi* | [**get_posting_module**](docs/ChartOfAccountsApi.md#get_posting_module) | **GET** /api/chartofaccounts/{scope}/{code}/postingmodules/{postingModuleCode} | [EXPERIMENTAL] GetPostingModule: Get a Posting Module
  *ChartOfAccountsApi* | [**list_accounts**](docs/ChartOfAccountsApi.md#list_accounts) | **GET** /api/chartofaccounts/{scope}/{code}/accounts | [EXPERIMENTAL] ListAccounts: List Accounts
  *ChartOfAccountsApi* | [**list_charts_of_accounts**](docs/ChartOfAccountsApi.md#list_charts_of_accounts) | **GET** /api/chartofaccounts | [EXPERIMENTAL] ListChartsOfAccounts: List Charts of Accounts
  *ChartOfAccountsApi* | [**list_cleardown_module_rules**](docs/ChartOfAccountsApi.md#list_cleardown_module_rules) | **GET** /api/chartofaccounts/{scope}/{code}/cleardownmodules/{cleardownModuleCode}/cleardownrules | [EXPERIMENTAL] ListCleardownModuleRules: List Cleardown Module Rules
  *ChartOfAccountsApi* | [**list_cleardown_modules**](docs/ChartOfAccountsApi.md#list_cleardown_modules) | **GET** /api/chartofaccounts/{scope}/{code}/cleardownmodules | [EXPERIMENTAL] ListCleardownModules: List Cleardown Modules
  *ChartOfAccountsApi* | [**list_general_ledger_profiles**](docs/ChartOfAccountsApi.md#list_general_ledger_profiles) | **GET** /api/chartofaccounts/{scope}/{code}/generalledgerprofile | [EXPERIMENTAL] ListGeneralLedgerProfiles: List General Ledger Profiles.
  *ChartOfAccountsApi* | [**list_posting_module_rules**](docs/ChartOfAccountsApi.md#list_posting_module_rules) | **GET** /api/chartofaccounts/{scope}/{code}/postingmodules/{postingModuleCode}/postingrules | [EXPERIMENTAL] ListPostingModuleRules: List Posting Module Rules
  *ChartOfAccountsApi* | [**list_posting_modules**](docs/ChartOfAccountsApi.md#list_posting_modules) | **GET** /api/chartofaccounts/{scope}/{code}/postingmodules | [EXPERIMENTAL] ListPostingModules: List Posting Modules
  *ChartOfAccountsApi* | [**patch_chart_of_accounts**](docs/ChartOfAccountsApi.md#patch_chart_of_accounts) | **PATCH** /api/chartofaccounts/{scope}/{code} | [EXPERIMENTAL] PatchChartOfAccounts: Patch a Chart of Accounts.
  *ChartOfAccountsApi* | [**patch_cleardown_module**](docs/ChartOfAccountsApi.md#patch_cleardown_module) | **PATCH** /api/chartofaccounts/{scope}/{code}/cleardownmodules/{cleardownModuleCode} | [EXPERIMENTAL] PatchCleardownModule: Patch a Cleardown Module
  *ChartOfAccountsApi* | [**patch_posting_module**](docs/ChartOfAccountsApi.md#patch_posting_module) | **PATCH** /api/chartofaccounts/{scope}/{code}/postingmodules/{postingModuleCode} | [EXPERIMENTAL] PatchPostingModule: Patch a Posting Module
  *ChartOfAccountsApi* | [**set_cleardown_module_details**](docs/ChartOfAccountsApi.md#set_cleardown_module_details) | **PUT** /api/chartofaccounts/{scope}/{code}/cleardownmodules/{cleardownModuleCode} | [EXPERIMENTAL] SetCleardownModuleDetails: Set the details of a Cleardown Module
  *ChartOfAccountsApi* | [**set_cleardown_module_rules**](docs/ChartOfAccountsApi.md#set_cleardown_module_rules) | **PUT** /api/chartofaccounts/{scope}/{code}/cleardownmodules/{cleardownModuleCode}/cleardownrules | [EXPERIMENTAL] SetCleardownModuleRules: Set the rules of a Cleardown Module
  *ChartOfAccountsApi* | [**set_general_ledger_profile_mappings**](docs/ChartOfAccountsApi.md#set_general_ledger_profile_mappings) | **PUT** /api/chartofaccounts/{scope}/{code}/generalledgerprofile/{generalLedgerProfileCode}/mappings | [EXPERIMENTAL] SetGeneralLedgerProfileMappings: Sets the General Ledger Profile Mappings.
  *ChartOfAccountsApi* | [**set_posting_module_details**](docs/ChartOfAccountsApi.md#set_posting_module_details) | **PUT** /api/chartofaccounts/{scope}/{code}/postingmodules/{postingModuleCode} | [EXPERIMENTAL] SetPostingModuleDetails: Set the details of a Posting Module
  *ChartOfAccountsApi* | [**set_posting_module_rules**](docs/ChartOfAccountsApi.md#set_posting_module_rules) | **PUT** /api/chartofaccounts/{scope}/{code}/postingmodules/{postingModuleCode}/postingrules | [EXPERIMENTAL] SetPostingModuleRules: Set the rules of a Posting Module
  *ChartOfAccountsApi* | [**upsert_account_properties**](docs/ChartOfAccountsApi.md#upsert_account_properties) | **POST** /api/chartofaccounts/{scope}/{code}/accounts/{accountCode}/properties/$upsert | [EXPERIMENTAL] UpsertAccountProperties: Upsert account properties
  *ChartOfAccountsApi* | [**upsert_accounts**](docs/ChartOfAccountsApi.md#upsert_accounts) | **POST** /api/chartofaccounts/{scope}/{code}/accounts | [EXPERIMENTAL] UpsertAccounts: Upsert Accounts
  *ChartOfAccountsApi* | [**upsert_chart_of_accounts_properties**](docs/ChartOfAccountsApi.md#upsert_chart_of_accounts_properties) | **POST** /api/chartofaccounts/{scope}/{code}/properties/$upsert | [EXPERIMENTAL] UpsertChartOfAccountsProperties: Upsert Chart of Accounts properties
  *ComplexMarketDataApi* | [**delete_complex_market_data**](docs/ComplexMarketDataApi.md#delete_complex_market_data) | **POST** /api/complexmarketdata/{scope}/$delete | [EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present.
  *ComplexMarketDataApi* | [**get_complex_market_data**](docs/ComplexMarketDataApi.md#get_complex_market_data) | **POST** /api/complexmarketdata/{scope}/$get | [EARLY ACCESS] GetComplexMarketData: Get complex market data
  *ComplexMarketDataApi* | [**list_complex_market_data**](docs/ComplexMarketDataApi.md#list_complex_market_data) | **GET** /api/complexmarketdata | [EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData
  *ComplexMarketDataApi* | [**upsert_complex_market_data**](docs/ComplexMarketDataApi.md#upsert_complex_market_data) | **POST** /api/complexmarketdata/{scope} | UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid.
  *ComplianceApi* | [**create_compliance_template**](docs/ComplianceApi.md#create_compliance_template) | **POST** /api/compliance/templates/{scope} | [EARLY ACCESS] CreateComplianceTemplate: Create a Compliance Rule Template
  *ComplianceApi* | [**delete_compliance_rule**](docs/ComplianceApi.md#delete_compliance_rule) | **DELETE** /api/compliance/rules/{scope}/{code} | [EARLY ACCESS] DeleteComplianceRule: Delete compliance rule.
  *ComplianceApi* | [**delete_compliance_template**](docs/ComplianceApi.md#delete_compliance_template) | **DELETE** /api/compliance/templates/{scope}/{code} | [EARLY ACCESS] DeleteComplianceTemplate: Delete a ComplianceRuleTemplate
  *ComplianceApi* | [**get_compliance_rule**](docs/ComplianceApi.md#get_compliance_rule) | **GET** /api/compliance/rules/{scope}/{code} | [EARLY ACCESS] GetComplianceRule: Get compliance rule.
  *ComplianceApi* | [**get_compliance_rule_result**](docs/ComplianceApi.md#get_compliance_rule_result) | **GET** /api/compliance/runs/summary/{runScope}/{runCode}/{ruleScope}/{ruleCode} | [EARLY ACCESS] GetComplianceRuleResult: Get detailed results for a specific rule within a compliance run.
  *ComplianceApi* | [**get_compliance_template**](docs/ComplianceApi.md#get_compliance_template) | **GET** /api/compliance/templates/{scope}/{code} | [EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template.
  *ComplianceApi* | [**get_decorated_compliance_run_summary**](docs/ComplianceApi.md#get_decorated_compliance_run_summary) | **GET** /api/compliance/runs/summary/{scope}/{code}/$decorate | [EARLY ACCESS] GetDecoratedComplianceRunSummary: Get decorated summary results for a specific compliance run.
  *ComplianceApi* | [**list_compliance_rules**](docs/ComplianceApi.md#list_compliance_rules) | **GET** /api/compliance/rules | [EARLY ACCESS] ListComplianceRules: List compliance rules.
  *ComplianceApi* | [**list_compliance_runs**](docs/ComplianceApi.md#list_compliance_runs) | **GET** /api/compliance/runs | [EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers.
  *ComplianceApi* | [**list_compliance_templates**](docs/ComplianceApi.md#list_compliance_templates) | **GET** /api/compliance/templates | [EARLY ACCESS] ListComplianceTemplates: List compliance templates.
  *ComplianceApi* | [**run_compliance**](docs/ComplianceApi.md#run_compliance) | **POST** /api/compliance/runs | [EARLY ACCESS] RunCompliance: Run a compliance check.
  *ComplianceApi* | [**run_compliance_preview**](docs/ComplianceApi.md#run_compliance_preview) | **POST** /api/compliance/preview/runs | [EARLY ACCESS] RunCompliancePreview: Run a compliance check.
  *ComplianceApi* | [**update_compliance_template**](docs/ComplianceApi.md#update_compliance_template) | **PUT** /api/compliance/templates/{scope}/{code} | [EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate
  *ComplianceApi* | [**upsert_compliance_rule**](docs/ComplianceApi.md#upsert_compliance_rule) | **POST** /api/compliance/rules | [EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule.
  *ComplianceApi* | [**upsert_compliance_run_summary**](docs/ComplianceApi.md#upsert_compliance_run_summary) | **POST** /api/compliance/runs/summary | [EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary.
  *ConfigurationRecipeApi* | [**delete_configuration_recipe**](docs/ConfigurationRecipeApi.md#delete_configuration_recipe) | **DELETE** /api/recipes/{scope}/{code} | DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present.
  *ConfigurationRecipeApi* | [**delete_recipe_composer**](docs/ConfigurationRecipeApi.md#delete_recipe_composer) | **DELETE** /api/recipes/composer/{scope}/{code} | [EXPERIMENTAL] DeleteRecipeComposer: Delete a Recipe Composer, assuming that it is present.
  *ConfigurationRecipeApi* | [**get_configuration_recipe**](docs/ConfigurationRecipeApi.md#get_configuration_recipe) | **GET** /api/recipes/{scope}/{code} | GetConfigurationRecipe: Get Configuration Recipe
  *ConfigurationRecipeApi* | [**get_derived_recipe**](docs/ConfigurationRecipeApi.md#get_derived_recipe) | **GET** /api/recipes/derived/{scope}/{code} | [EXPERIMENTAL] GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer.
  *ConfigurationRecipeApi* | [**get_recipe_composer**](docs/ConfigurationRecipeApi.md#get_recipe_composer) | **GET** /api/recipes/composer/{scope}/{code} | [EXPERIMENTAL] GetRecipeComposer: Get Recipe Composer
  *ConfigurationRecipeApi* | [**get_recipe_composer_resolved_inline**](docs/ConfigurationRecipeApi.md#get_recipe_composer_resolved_inline) | **POST** /api/recipes/composer/resolvedinline$ | [EXPERIMENTAL] GetRecipeComposerResolvedInline: Given a Recipe Composer, this endpoint expands into a Configuration Recipe without persistence. Primarily used for testing purposes.
  *ConfigurationRecipeApi* | [**list_configuration_recipes**](docs/ConfigurationRecipeApi.md#list_configuration_recipes) | **GET** /api/recipes | ListConfigurationRecipes: List the set of Configuration Recipes
  *ConfigurationRecipeApi* | [**list_derived_recipes**](docs/ConfigurationRecipeApi.md#list_derived_recipes) | **GET** /api/recipes/derived | [EXPERIMENTAL] ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers.
  *ConfigurationRecipeApi* | [**list_recipe_composers**](docs/ConfigurationRecipeApi.md#list_recipe_composers) | **GET** /api/recipes/composer | [EXPERIMENTAL] ListRecipeComposers: List the set of Recipe Composers
  *ConfigurationRecipeApi* | [**upsert_configuration_recipe**](docs/ConfigurationRecipeApi.md#upsert_configuration_recipe) | **POST** /api/recipes | UpsertConfigurationRecipe: Upsert a Configuration Recipe. This creates or updates the data in Lusid.
  *ConfigurationRecipeApi* | [**upsert_recipe_composer**](docs/ConfigurationRecipeApi.md#upsert_recipe_composer) | **POST** /api/recipes/composer | [EXPERIMENTAL] UpsertRecipeComposer: Upsert a Recipe Composer. This creates or updates the data in Lusid.
  *ConventionsApi* | [**delete_cds_flow_conventions**](docs/ConventionsApi.md#delete_cds_flow_conventions) | **DELETE** /api/conventions/credit/conventions/{scope}/{code} | [BETA] DeleteCdsFlowConventions: Delete the CDS Flow Conventions of given scope and code, assuming that it is present.
  *ConventionsApi* | [**delete_flow_conventions**](docs/ConventionsApi.md#delete_flow_conventions) | **DELETE** /api/conventions/rates/flowconventions/{scope}/{code} | [BETA] DeleteFlowConventions: Delete the Flow Conventions of given scope and code, assuming that it is present.
  *ConventionsApi* | [**delete_index_convention**](docs/ConventionsApi.md#delete_index_convention) | **DELETE** /api/conventions/rates/indexconventions/{scope}/{code} | [BETA] DeleteIndexConvention: Delete the Index Convention of given scope and code, assuming that it is present.
  *ConventionsApi* | [**get_cds_flow_conventions**](docs/ConventionsApi.md#get_cds_flow_conventions) | **GET** /api/conventions/credit/conventions/{scope}/{code} | [BETA] GetCdsFlowConventions: Get CDS Flow Conventions
  *ConventionsApi* | [**get_flow_conventions**](docs/ConventionsApi.md#get_flow_conventions) | **GET** /api/conventions/rates/flowconventions/{scope}/{code} | [BETA] GetFlowConventions: Get Flow Conventions
  *ConventionsApi* | [**get_index_convention**](docs/ConventionsApi.md#get_index_convention) | **GET** /api/conventions/rates/indexconventions/{scope}/{code} | [BETA] GetIndexConvention: Get Index Convention
  *ConventionsApi* | [**list_cds_flow_conventions**](docs/ConventionsApi.md#list_cds_flow_conventions) | **GET** /api/conventions/credit/conventions | [BETA] ListCdsFlowConventions: List the set of CDS Flow Conventions
  *ConventionsApi* | [**list_flow_conventions**](docs/ConventionsApi.md#list_flow_conventions) | **GET** /api/conventions/rates/flowconventions | [BETA] ListFlowConventions: List the set of Flow Conventions
  *ConventionsApi* | [**list_index_convention**](docs/ConventionsApi.md#list_index_convention) | **GET** /api/conventions/rates/indexconventions | [BETA] ListIndexConvention: List the set of Index Conventions
  *ConventionsApi* | [**upsert_cds_flow_conventions**](docs/ConventionsApi.md#upsert_cds_flow_conventions) | **POST** /api/conventions/credit/conventions | [BETA] UpsertCdsFlowConventions: Upsert a set of CDS Flow Conventions. This creates or updates the data in Lusid.
  *ConventionsApi* | [**upsert_flow_conventions**](docs/ConventionsApi.md#upsert_flow_conventions) | **POST** /api/conventions/rates/flowconventions | [BETA] UpsertFlowConventions: Upsert Flow Conventions. This creates or updates the data in Lusid.
  *ConventionsApi* | [**upsert_index_convention**](docs/ConventionsApi.md#upsert_index_convention) | **POST** /api/conventions/rates/indexconventions | [BETA] UpsertIndexConvention: Upsert a set of Index Convention. This creates or updates the data in Lusid.
  *CorporateActionSourcesApi* | [**batch_upsert_corporate_actions**](docs/CorporateActionSourcesApi.md#batch_upsert_corporate_actions) | **POST** /api/corporateactionsources/{scope}/{code}/corporateactions | [EARLY ACCESS] BatchUpsertCorporateActions: Batch upsert corporate actions (instrument transition events) to corporate action source.
  *CorporateActionSourcesApi* | [**create_corporate_action_source**](docs/CorporateActionSourcesApi.md#create_corporate_action_source) | **POST** /api/corporateactionsources | [EARLY ACCESS] CreateCorporateActionSource: Create corporate action source
  *CorporateActionSourcesApi* | [**delete_corporate_action_source**](docs/CorporateActionSourcesApi.md#delete_corporate_action_source) | **DELETE** /api/corporateactionsources/{scope}/{code} | [BETA] DeleteCorporateActionSource: Delete a corporate action source
  *CorporateActionSourcesApi* | [**delete_corporate_actions**](docs/CorporateActionSourcesApi.md#delete_corporate_actions) | **DELETE** /api/corporateactionsources/{scope}/{code}/corporateactions | [EARLY ACCESS] DeleteCorporateActions: Delete corporate actions (instrument transition events) from a corporate action source
  *CorporateActionSourcesApi* | [**delete_instrument_events**](docs/CorporateActionSourcesApi.md#delete_instrument_events) | **DELETE** /api/corporateactionsources/{scope}/{code}/instrumentevents | [EARLY ACCESS] DeleteInstrumentEvents: Delete instrument events from a corporate action source
  *CorporateActionSourcesApi* | [**get_corporate_actions**](docs/CorporateActionSourcesApi.md#get_corporate_actions) | **GET** /api/corporateactionsources/{scope}/{code}/corporateactions | [EARLY ACCESS] GetCorporateActions: List corporate actions (instrument transition events) from the corporate action source.
  *CorporateActionSourcesApi* | [**get_instrument_events**](docs/CorporateActionSourcesApi.md#get_instrument_events) | **GET** /api/corporateactionsources/{scope}/{code}/instrumentevents | [EARLY ACCESS] GetInstrumentEvents: Get extrinsic instrument events out of a given corporate actions source.
  *CorporateActionSourcesApi* | [**list_corporate_action_sources**](docs/CorporateActionSourcesApi.md#list_corporate_action_sources) | **GET** /api/corporateactionsources | [EARLY ACCESS] ListCorporateActionSources: List corporate action sources
  *CorporateActionSourcesApi* | [**upsert_instrument_events**](docs/CorporateActionSourcesApi.md#upsert_instrument_events) | **POST** /api/corporateactionsources/{scope}/{code}/instrumentevents | [EARLY ACCESS] UpsertInstrumentEvents: Upsert instrument events to the provided corporate actions source.
  *CounterpartiesApi* | [**delete_counterparty_agreement**](docs/CounterpartiesApi.md#delete_counterparty_agreement) | **DELETE** /api/counterparties/counterpartyagreements/{scope}/{code} | [EARLY ACCESS] DeleteCounterpartyAgreement: Delete the Counterparty Agreement of given scope and code
  *CounterpartiesApi* | [**delete_credit_support_annex**](docs/CounterpartiesApi.md#delete_credit_support_annex) | **DELETE** /api/counterparties/creditsupportannexes/{scope}/{code} | [EARLY ACCESS] DeleteCreditSupportAnnex: Delete the Credit Support Annex of given scope and code
  *CounterpartiesApi* | [**get_counterparty_agreement**](docs/CounterpartiesApi.md#get_counterparty_agreement) | **GET** /api/counterparties/counterpartyagreements/{scope}/{code} | [EARLY ACCESS] GetCounterpartyAgreement: Get Counterparty Agreement
  *CounterpartiesApi* | [**get_credit_support_annex**](docs/CounterpartiesApi.md#get_credit_support_annex) | **GET** /api/counterparties/creditsupportannexes/{scope}/{code} | [EARLY ACCESS] GetCreditSupportAnnex: Get Credit Support Annex
  *CounterpartiesApi* | [**list_counterparty_agreements**](docs/CounterpartiesApi.md#list_counterparty_agreements) | **GET** /api/counterparties/counterpartyagreements | [EARLY ACCESS] ListCounterpartyAgreements: List the set of Counterparty Agreements
  *CounterpartiesApi* | [**list_credit_support_annexes**](docs/CounterpartiesApi.md#list_credit_support_annexes) | **GET** /api/counterparties/creditsupportannexes | [EARLY ACCESS] ListCreditSupportAnnexes: List the set of Credit Support Annexes
  *CounterpartiesApi* | [**upsert_counterparty_agreement**](docs/CounterpartiesApi.md#upsert_counterparty_agreement) | **POST** /api/counterparties/counterpartyagreements | [EARLY ACCESS] UpsertCounterpartyAgreement: Upsert Counterparty Agreement
  *CounterpartiesApi* | [**upsert_credit_support_annex**](docs/CounterpartiesApi.md#upsert_credit_support_annex) | **POST** /api/counterparties/creditsupportannexes | [EARLY ACCESS] UpsertCreditSupportAnnex: Upsert Credit Support Annex
  *CustomEntitiesApi* | [**delete_custom_entity**](docs/CustomEntitiesApi.md#delete_custom_entity) | **DELETE** /api/customentities/{entityType}/{identifierType}/{identifierValue} | DeleteCustomEntity: Delete a Custom Entity instance.
  *CustomEntitiesApi* | [**delete_custom_entity_access_metadata**](docs/CustomEntitiesApi.md#delete_custom_entity_access_metadata) | **DELETE** /api/customentities/{entityType}/{identifierType}/{identifierValue}/metadata/{metadataKey} | [EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry
  *CustomEntitiesApi* | [**get_all_custom_entity_access_metadata**](docs/CustomEntitiesApi.md#get_all_custom_entity_access_metadata) | **GET** /api/customentities/{entityType}/{identifierType}/{identifierValue}/metadata | [EARLY ACCESS] GetAllCustomEntityAccessMetadata: Get all the Access Metadata rules for a Custom Entity
  *CustomEntitiesApi* | [**get_custom_entity**](docs/CustomEntitiesApi.md#get_custom_entity) | **GET** /api/customentities/{entityType}/{identifierType}/{identifierValue} | GetCustomEntity: Get a Custom Entity instance.
  *CustomEntitiesApi* | [**get_custom_entity_access_metadata_by_key**](docs/CustomEntitiesApi.md#get_custom_entity_access_metadata_by_key) | **GET** /api/customentities/{entityType}/{identifierType}/{identifierValue}/metadata/{metadataKey} | [EARLY ACCESS] GetCustomEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Custom Entity
  *CustomEntitiesApi* | [**get_custom_entity_relationships**](docs/CustomEntitiesApi.md#get_custom_entity_relationships) | **GET** /api/customentities/{entityType}/{identifierType}/{identifierValue}/relationships | [EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity
  *CustomEntitiesApi* | [**list_custom_entities**](docs/CustomEntitiesApi.md#list_custom_entities) | **GET** /api/customentities/{entityType} | ListCustomEntities: List Custom Entities of the specified entityType.
  *CustomEntitiesApi* | [**patch_custom_entity_access_metadata**](docs/CustomEntitiesApi.md#patch_custom_entity_access_metadata) | **PATCH** /api/customentities/{entityType}/{identifierType}/{identifierValue}/metadata | [EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity.
  *CustomEntitiesApi* | [**upsert_custom_entities**](docs/CustomEntitiesApi.md#upsert_custom_entities) | **POST** /api/customentities/{entityType}/$batchUpsert | [EARLY ACCESS] UpsertCustomEntities: Batch upsert instances of Custom Entities
  *CustomEntitiesApi* | [**upsert_custom_entity**](docs/CustomEntitiesApi.md#upsert_custom_entity) | **POST** /api/customentities/{entityType} | UpsertCustomEntity: Upsert a Custom Entity instance
  *CustomEntitiesApi* | [**upsert_custom_entity_access_metadata**](docs/CustomEntitiesApi.md#upsert_custom_entity_access_metadata) | **PUT** /api/customentities/{entityType}/{identifierType}/{identifierValue}/metadata/{metadataKey} | [EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID.
  *CustomEntityDefinitionsApi* | [**create_custom_entity_definition**](docs/CustomEntityDefinitionsApi.md#create_custom_entity_definition) | **POST** /api/customentities/entitytypes | [EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type.
  *CustomEntityDefinitionsApi* | [**get_definition**](docs/CustomEntityDefinitionsApi.md#get_definition) | **GET** /api/customentities/entitytypes/{entityType} | [EARLY ACCESS] GetDefinition: Get a Custom Entity type definition.
  *CustomEntityDefinitionsApi* | [**list_custom_entity_definitions**](docs/CustomEntityDefinitionsApi.md#list_custom_entity_definitions) | **GET** /api/customentities/entitytypes | [EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions
  *CustomEntityDefinitionsApi* | [**update_custom_entity_definition**](docs/CustomEntityDefinitionsApi.md#update_custom_entity_definition) | **PUT** /api/customentities/entitytypes/{entityType} | [EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type.
  *CustomEntityTypesApi* | [**create_custom_entity_type**](docs/CustomEntityTypesApi.md#create_custom_entity_type) | **POST** /api/customentitytypes | [EARLY ACCESS] CreateCustomEntityType: Define a new Custom Entity Type.
  *CustomEntityTypesApi* | [**get_custom_entity_type**](docs/CustomEntityTypesApi.md#get_custom_entity_type) | **GET** /api/customentitytypes/{entityType} | [EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type.
  *CustomEntityTypesApi* | [**list_custom_entity_types**](docs/CustomEntityTypesApi.md#list_custom_entity_types) | **GET** /api/customentitytypes | [EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types.
  *CustomEntityTypesApi* | [**update_custom_entity_type**](docs/CustomEntityTypesApi.md#update_custom_entity_type) | **PUT** /api/customentitytypes/{entityType} | [EARLY ACCESS] UpdateCustomEntityType: Modify an existing Custom Entity Type.
  *CutLabelDefinitionsApi* | [**create_cut_label_definition**](docs/CutLabelDefinitionsApi.md#create_cut_label_definition) | **POST** /api/systemconfiguration/cutlabels | CreateCutLabelDefinition: Create a Cut Label
  *CutLabelDefinitionsApi* | [**delete_cut_label_definition**](docs/CutLabelDefinitionsApi.md#delete_cut_label_definition) | **DELETE** /api/systemconfiguration/cutlabels/{code} | DeleteCutLabelDefinition: Delete a Cut Label
  *CutLabelDefinitionsApi* | [**get_cut_label_definition**](docs/CutLabelDefinitionsApi.md#get_cut_label_definition) | **GET** /api/systemconfiguration/cutlabels/{code} | GetCutLabelDefinition: Get a Cut Label
  *CutLabelDefinitionsApi* | [**list_cut_label_definitions**](docs/CutLabelDefinitionsApi.md#list_cut_label_definitions) | **GET** /api/systemconfiguration/cutlabels | ListCutLabelDefinitions: List Existing Cut Labels
  *CutLabelDefinitionsApi* | [**update_cut_label_definition**](docs/CutLabelDefinitionsApi.md#update_cut_label_definition) | **PUT** /api/systemconfiguration/cutlabels/{code} | UpdateCutLabelDefinition: Update a Cut Label
  *DataTypesApi* | [**create_data_type**](docs/DataTypesApi.md#create_data_type) | **POST** /api/datatypes | [EARLY ACCESS] CreateDataType: Create data type definition
  *DataTypesApi* | [**delete_data_type**](docs/DataTypesApi.md#delete_data_type) | **DELETE** /api/datatypes/{scope}/{code} | DeleteDataType: Delete a data type definition.
  *DataTypesApi* | [**get_data_type**](docs/DataTypesApi.md#get_data_type) | **GET** /api/datatypes/{scope}/{code} | GetDataType: Get data type definition
  *DataTypesApi* | [**get_units_from_data_type**](docs/DataTypesApi.md#get_units_from_data_type) | **GET** /api/datatypes/{scope}/{code}/units | [EARLY ACCESS] GetUnitsFromDataType: Get units from data type
  *DataTypesApi* | [**list_data_type_summaries**](docs/DataTypesApi.md#list_data_type_summaries) | **GET** /api/datatypes | [EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data
  *DataTypesApi* | [**list_data_types**](docs/DataTypesApi.md#list_data_types) | **GET** /api/datatypes/{scope} | ListDataTypes: List data types
  *DataTypesApi* | [**update_data_type**](docs/DataTypesApi.md#update_data_type) | **PUT** /api/datatypes/{scope}/{code} | [EARLY ACCESS] UpdateDataType: Update data type definition
  *DataTypesApi* | [**update_reference_data**](docs/DataTypesApi.md#update_reference_data) | **PUT** /api/datatypes/{scope}/{code}/referencedata | [EARLY ACCESS] UpdateReferenceData: Update all reference data on a data type, includes the reference values, the field definitions, field values
  *DataTypesApi* | [**update_reference_values**](docs/DataTypesApi.md#update_reference_values) | **PUT** /api/datatypes/{scope}/{code}/referencedatavalues | [EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type
  *DerivedTransactionPortfoliosApi* | [**create_derived_portfolio**](docs/DerivedTransactionPortfoliosApi.md#create_derived_portfolio) | **POST** /api/derivedtransactionportfolios/{scope} | CreateDerivedPortfolio: Create derived portfolio
  *DerivedTransactionPortfoliosApi* | [**delete_derived_portfolio_details**](docs/DerivedTransactionPortfoliosApi.md#delete_derived_portfolio_details) | **DELETE** /api/derivedtransactionportfolios/{scope}/{code}/details | [EARLY ACCESS] DeleteDerivedPortfolioDetails: Delete derived portfolio details
  *EntitiesApi* | [**get_custom_entity_by_entity_unique_id**](docs/EntitiesApi.md#get_custom_entity_by_entity_unique_id) | **GET** /api/entities/customentities/{entityUniqueId} | [EXPERIMENTAL] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId
  *EntitiesApi* | [**get_data_type_by_entity_unique_id**](docs/EntitiesApi.md#get_data_type_by_entity_unique_id) | **GET** /api/entities/datatypes/{entityUniqueId} | [EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId
  *EntitiesApi* | [**get_entity_history**](docs/EntitiesApi.md#get_entity_history) | **GET** /api/entities/{entityType}/{entityUniqueId}/history | [EXPERIMENTAL] GetEntityHistory: List an entity's history information
  *EntitiesApi* | [**get_instrument_by_entity_unique_id**](docs/EntitiesApi.md#get_instrument_by_entity_unique_id) | **GET** /api/entities/instruments/{entityUniqueId} | [EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId
  *EntitiesApi* | [**get_portfolio_by_entity_unique_id**](docs/EntitiesApi.md#get_portfolio_by_entity_unique_id) | **GET** /api/entities/portfolios/{entityUniqueId} | [EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId
  *EntitiesApi* | [**get_portfolio_changes**](docs/EntitiesApi.md#get_portfolio_changes) | **GET** /api/entities/changes/portfolios | GetPortfolioChanges: Get the next change to each portfolio in a scope.
  *EntitiesApi* | [**get_property_definition_by_entity_unique_id**](docs/EntitiesApi.md#get_property_definition_by_entity_unique_id) | **GET** /api/entities/propertydefinitions/{entityUniqueId} | [EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId
  *ExecutionsApi* | [**delete_execution**](docs/ExecutionsApi.md#delete_execution) | **DELETE** /api/executions/{scope}/{code} | [EARLY ACCESS] DeleteExecution: Delete execution
  *ExecutionsApi* | [**get_execution**](docs/ExecutionsApi.md#get_execution) | **GET** /api/executions/{scope}/{code} | [EARLY ACCESS] GetExecution: Get Execution
  *ExecutionsApi* | [**list_executions**](docs/ExecutionsApi.md#list_executions) | **GET** /api/executions | ListExecutions: List Executions
  *ExecutionsApi* | [**upsert_executions**](docs/ExecutionsApi.md#upsert_executions) | **POST** /api/executions | UpsertExecutions: Upsert Execution
  *FeeTypesApi* | [**create_fee_type**](docs/FeeTypesApi.md#create_fee_type) | **POST** /api/feetypes/{scope} | [EXPERIMENTAL] CreateFeeType: Create a FeeType.
  *FeeTypesApi* | [**delete_fee_type**](docs/FeeTypesApi.md#delete_fee_type) | **DELETE** /api/feetypes/{scope}/{code} | [EXPERIMENTAL] DeleteFeeType: Delete a FeeType.
  *FeeTypesApi* | [**get_fee_template_specifications**](docs/FeeTypesApi.md#get_fee_template_specifications) | **GET** /api/feetypes/feetransactiontemplatespecification | [EXPERIMENTAL] GetFeeTemplateSpecifications: Get FeeTemplateSpecifications used in the FeeType.
  *FeeTypesApi* | [**get_fee_type**](docs/FeeTypesApi.md#get_fee_type) | **GET** /api/feetypes/{scope}/{code} | [EXPERIMENTAL] GetFeeType: Get a FeeType
  *FeeTypesApi* | [**list_fee_types**](docs/FeeTypesApi.md#list_fee_types) | **GET** /api/feetypes | [EXPERIMENTAL] ListFeeTypes: List FeeTypes
  *FeeTypesApi* | [**update_fee_type**](docs/FeeTypesApi.md#update_fee_type) | **PUT** /api/feetypes/{scope}/{code} | [EXPERIMENTAL] UpdateFeeType: Update a FeeType.
  *FundConfigurationApi* | [**create_fund_configuration**](docs/FundConfigurationApi.md#create_fund_configuration) | **POST** /api/fundconfigurations/{scope} | [EXPERIMENTAL] CreateFundConfiguration: Create a FundConfiguration.
  *FundConfigurationApi* | [**delete_fund_configuration**](docs/FundConfigurationApi.md#delete_fund_configuration) | **DELETE** /api/fundconfigurations/{scope}/{code} | [EXPERIMENTAL] DeleteFundConfiguration: Delete a FundConfiguration.
  *FundConfigurationApi* | [**get_fund_configuration**](docs/FundConfigurationApi.md#get_fund_configuration) | **GET** /api/fundconfigurations/{scope}/{code} | [EXPERIMENTAL] GetFundConfiguration: Get FundConfiguration.
  *FundConfigurationApi* | [**list_fund_configurations**](docs/FundConfigurationApi.md#list_fund_configurations) | **GET** /api/fundconfigurations | [EXPERIMENTAL] ListFundConfigurations: List FundConfiguration.
  *FundConfigurationApi* | [**patch_fund_configuration**](docs/FundConfigurationApi.md#patch_fund_configuration) | **PATCH** /api/fundconfigurations/{scope}/{code} | [EXPERIMENTAL] PatchFundConfiguration: Patch Fund Configuration.
  *FundConfigurationApi* | [**upsert_fund_configuration_properties**](docs/FundConfigurationApi.md#upsert_fund_configuration_properties) | **POST** /api/fundconfigurations/{scope}/{code}/properties/$upsert | [EXPERIMENTAL] UpsertFundConfigurationProperties: Upsert FundConfiguration properties
  *FundsApi* | [**accept_estimate_valuation_point**](docs/FundsApi.md#accept_estimate_valuation_point) | **POST** /api/funds/{scope}/{code}/valuationpoints/$acceptestimate | [EXPERIMENTAL] AcceptEstimateValuationPoint: Accepts an Estimate Valuation Point.
  *FundsApi* | [**create_fee**](docs/FundsApi.md#create_fee) | **POST** /api/funds/{scope}/{code}/fees | [EXPERIMENTAL] CreateFee: Create a Fee.
  *FundsApi* | [**create_fund**](docs/FundsApi.md#create_fund) | **POST** /api/funds/{scope} | [EXPERIMENTAL] CreateFund: Create a Fund.
  *FundsApi* | [**delete_fee**](docs/FundsApi.md#delete_fee) | **DELETE** /api/funds/{scope}/{code}/fees/{feeCode} | [EXPERIMENTAL] DeleteFee: Delete a Fee.
  *FundsApi* | [**delete_fund**](docs/FundsApi.md#delete_fund) | **DELETE** /api/funds/{scope}/{code} | [EXPERIMENTAL] DeleteFund: Delete a Fund.
  *FundsApi* | [**delete_valuation_point**](docs/FundsApi.md#delete_valuation_point) | **DELETE** /api/funds/{scope}/{code}/valuationpoints/{diaryEntryCode} | [EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point.
  *FundsApi* | [**finalise_candidate_valuation_point**](docs/FundsApi.md#finalise_candidate_valuation_point) | **POST** /api/funds/{scope}/{code}/valuationpoints/$finalisecandidate | [EXPERIMENTAL] FinaliseCandidateValuationPoint: Finalise Candidate.
  *FundsApi* | [**get_fee**](docs/FundsApi.md#get_fee) | **GET** /api/funds/{scope}/{code}/fees/{feeCode} | [EXPERIMENTAL] GetFee: Get a Fee for a specified Fund.
  *FundsApi* | [**get_fund**](docs/FundsApi.md#get_fund) | **GET** /api/funds/{scope}/{code} | [EXPERIMENTAL] GetFund: Get a Fund.
  *FundsApi* | [**get_valuation_point_data**](docs/FundsApi.md#get_valuation_point_data) | **POST** /api/funds/{scope}/{code}/valuationpoints/$query | [EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund.
  *FundsApi* | [**get_valuation_point_journal_entry_lines**](docs/FundsApi.md#get_valuation_point_journal_entry_lines) | **POST** /api/funds/{scope}/{code}/valuationpoints/journalentrylines/$query | [EXPERIMENTAL] GetValuationPointJournalEntryLines: Get the Journal Entry lines for the given Fund.
  *FundsApi* | [**get_valuation_point_pnl_summary**](docs/FundsApi.md#get_valuation_point_pnl_summary) | **POST** /api/funds/{scope}/{code}/valuationpoints/pnlsummary/$query | [EXPERIMENTAL] GetValuationPointPnlSummary: Get a PnL summary for the given Valuation Point in the Fund.
  *FundsApi* | [**get_valuation_point_transactions**](docs/FundsApi.md#get_valuation_point_transactions) | **POST** /api/funds/{scope}/{code}/valuationpoints/transactions/$query | [EXPERIMENTAL] GetValuationPointTransactions: Get the Transactions for the given Fund.
  *FundsApi* | [**get_valuation_point_trial_balance**](docs/FundsApi.md#get_valuation_point_trial_balance) | **POST** /api/funds/{scope}/{code}/valuationpoints/trialbalance/$query | [EXPERIMENTAL] GetValuationPointTrialBalance: Get Trial Balance for the given Fund.
  *FundsApi* | [**list_fees**](docs/FundsApi.md#list_fees) | **GET** /api/funds/{scope}/{code}/fees | [EXPERIMENTAL] ListFees: List Fees for a specified Fund.
  *FundsApi* | [**list_funds**](docs/FundsApi.md#list_funds) | **GET** /api/funds | [EXPERIMENTAL] ListFunds: List Funds.
  *FundsApi* | [**list_valuation_point_overview**](docs/FundsApi.md#list_valuation_point_overview) | **GET** /api/funds/{scope}/{code}/valuationPointOverview | [EXPERIMENTAL] ListValuationPointOverview: List Valuation Points Overview for a given Fund.
  *FundsApi* | [**patch_fee**](docs/FundsApi.md#patch_fee) | **PATCH** /api/funds/{scope}/{code}/fees/{feeCode} | [EXPERIMENTAL] PatchFee: Patch Fee.
  *FundsApi* | [**patch_fund**](docs/FundsApi.md#patch_fund) | **PATCH** /api/funds/{scope}/{code} | [EXPERIMENTAL] PatchFund: Patch a Fund.
  *FundsApi* | [**set_share_class_instruments**](docs/FundsApi.md#set_share_class_instruments) | **PUT** /api/funds/{scope}/{code}/shareclasses | [EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund.
  *FundsApi* | [**upsert_diary_entry_type_valuation_point**](docs/FundsApi.md#upsert_diary_entry_type_valuation_point) | **POST** /api/funds/{scope}/{code}/valuationpoints | [EXPERIMENTAL] UpsertDiaryEntryTypeValuationPoint: Upsert Valuation Point.
  *FundsApi* | [**upsert_fee_properties**](docs/FundsApi.md#upsert_fee_properties) | **POST** /api/funds/{scope}/{code}/fees/{feeCode}/properties/$upsert | [EXPERIMENTAL] UpsertFeeProperties: Upsert Fee properties.
  *FundsApi* | [**upsert_fund_properties**](docs/FundsApi.md#upsert_fund_properties) | **POST** /api/funds/{scope}/{code}/properties/$upsert | [EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties.
  *GroupReconciliationsApi* | [**batch_update_comparison_results**](docs/GroupReconciliationsApi.md#batch_update_comparison_results) | **POST** /api/reconciliations/groupreconciliationdefinitions/{scope}/{code}/comparisonresults/$batchReview | [EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition.
  *GroupReconciliationsApi* | [**create_comparison_ruleset**](docs/GroupReconciliationsApi.md#create_comparison_ruleset) | **POST** /api/reconciliations/comparisonrulesets | [EXPERIMENTAL] CreateComparisonRuleset: Create a Group Reconciliation Comparison Ruleset
  *GroupReconciliationsApi* | [**create_group_reconciliation_definition**](docs/GroupReconciliationsApi.md#create_group_reconciliation_definition) | **POST** /api/reconciliations/groupreconciliationdefinitions | [EXPERIMENTAL] CreateGroupReconciliationDefinition: Create Group Reconciliation Definition
  *GroupReconciliationsApi* | [**delete_comparison_ruleset**](docs/GroupReconciliationsApi.md#delete_comparison_ruleset) | **DELETE** /api/reconciliations/comparisonrulesets/{scope}/{code} | [EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset
  *GroupReconciliationsApi* | [**delete_group_reconciliation_definition**](docs/GroupReconciliationsApi.md#delete_group_reconciliation_definition) | **DELETE** /api/reconciliations/groupreconciliationdefinitions/{scope}/{code} | [EXPERIMENTAL] DeleteGroupReconciliationDefinition: Delete Group Reconciliation Definition
  *GroupReconciliationsApi* | [**get_comparison_result**](docs/GroupReconciliationsApi.md#get_comparison_result) | **GET** /api/reconciliations/groupreconciliationdefinitions/{scope}/{code}/{resultId} | [EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code.
  *GroupReconciliationsApi* | [**get_comparison_ruleset**](docs/GroupReconciliationsApi.md#get_comparison_ruleset) | **GET** /api/reconciliations/comparisonrulesets/{scope}/{code} | [EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code.
  *GroupReconciliationsApi* | [**get_group_reconciliation_definition**](docs/GroupReconciliationsApi.md#get_group_reconciliation_definition) | **GET** /api/reconciliations/groupreconciliationdefinitions/{scope}/{code} | [EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition
  *GroupReconciliationsApi* | [**list_comparison_results**](docs/GroupReconciliationsApi.md#list_comparison_results) | **GET** /api/reconciliations/comparisonresults | [EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results.
  *GroupReconciliationsApi* | [**list_comparison_rulesets**](docs/GroupReconciliationsApi.md#list_comparison_rulesets) | **GET** /api/reconciliations/comparisonrulesets | [EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets
  *GroupReconciliationsApi* | [**list_group_reconciliation_definitions**](docs/GroupReconciliationsApi.md#list_group_reconciliation_definitions) | **GET** /api/reconciliations/groupreconciliationdefinitions | [EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions
  *GroupReconciliationsApi* | [**run_reconciliation**](docs/GroupReconciliationsApi.md#run_reconciliation) | **POST** /api/reconciliations/groupreconciliationdefinitions/{scope}/{code}/$run | [EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation
  *GroupReconciliationsApi* | [**update_comparison_ruleset**](docs/GroupReconciliationsApi.md#update_comparison_ruleset) | **PUT** /api/reconciliations/comparisonrulesets/{scope}/{code} | [EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code
  *GroupReconciliationsApi* | [**update_group_reconciliation_definition**](docs/GroupReconciliationsApi.md#update_group_reconciliation_definition) | **PUT** /api/reconciliations/groupreconciliationdefinitions/{scope}/{code} | [EXPERIMENTAL] UpdateGroupReconciliationDefinition: Update group reconciliation definition
  *InstrumentEventTypesApi* | [**create_transaction_template**](docs/InstrumentEventTypesApi.md#create_transaction_template) | **POST** /api/instrumenteventtypes/{instrumentEventType}/transactiontemplates/{instrumentType}/{scope} | [EXPERIMENTAL] CreateTransactionTemplate: Create Transaction Template
  *InstrumentEventTypesApi* | [**delete_transaction_template**](docs/InstrumentEventTypesApi.md#delete_transaction_template) | **DELETE** /api/instrumenteventtypes/{instrumentEventType}/transactiontemplates/{instrumentType}/{scope} | [EXPERIMENTAL] DeleteTransactionTemplate: Delete Transaction Template
  *InstrumentEventTypesApi* | [**get_transaction_template**](docs/InstrumentEventTypesApi.md#get_transaction_template) | **GET** /api/instrumenteventtypes/{instrumentEventType}/transactiontemplates/{instrumentType}/{scope} | [EXPERIMENTAL] GetTransactionTemplate: Get Transaction Template
  *InstrumentEventTypesApi* | [**get_transaction_template_specification**](docs/InstrumentEventTypesApi.md#get_transaction_template_specification) | **GET** /api/instrumenteventtypes/{instrumentEventType}/transactiontemplatespecification | [EXPERIMENTAL] GetTransactionTemplateSpecification: Get Transaction Template Specification.
  *InstrumentEventTypesApi* | [**list_transaction_template_specifications**](docs/InstrumentEventTypesApi.md#list_transaction_template_specifications) | **GET** /api/instrumenteventtypes/transactiontemplatespecifications | [EXPERIMENTAL] ListTransactionTemplateSpecifications: List Transaction Template Specifications.
  *InstrumentEventTypesApi* | [**list_transaction_templates**](docs/InstrumentEventTypesApi.md#list_transaction_templates) | **GET** /api/instrumenteventtypes/transactiontemplates | [EXPERIMENTAL] ListTransactionTemplates: List Transaction Templates
  *InstrumentEventTypesApi* | [**update_transaction_template**](docs/InstrumentEventTypesApi.md#update_transaction_template) | **PUT** /api/instrumenteventtypes/{instrumentEventType}/transactiontemplates/{instrumentType}/{scope} | [EXPERIMENTAL] UpdateTransactionTemplate: Update Transaction Template
  *InstrumentEventsApi* | [**query_applicable_instrument_events**](docs/InstrumentEventsApi.md#query_applicable_instrument_events) | **POST** /api/instrumentevents/$queryApplicableInstrumentEvents | [EXPERIMENTAL] QueryApplicableInstrumentEvents: Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query.
  *InstrumentEventsApi* | [**query_bucketed_cash_flows**](docs/InstrumentEventsApi.md#query_bucketed_cash_flows) | **POST** /api/instrumentevents/$queryBucketedCashFlows | QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query.
  *InstrumentEventsApi* | [**query_cash_flows**](docs/InstrumentEventsApi.md#query_cash_flows) | **POST** /api/instrumentevents/$queryCashFlows | [EXPERIMENTAL] QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query.
  *InstrumentEventsApi* | [**query_instrument_events**](docs/InstrumentEventsApi.md#query_instrument_events) | **POST** /api/instrumentevents/$query | [EARLY ACCESS] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query.
  *InstrumentEventsApi* | [**query_trade_tickets**](docs/InstrumentEventsApi.md#query_trade_tickets) | **POST** /api/instrumentevents/$queryTradeTickets | [EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query.
  *InstrumentsApi* | [**batch_upsert_instrument_properties**](docs/InstrumentsApi.md#batch_upsert_instrument_properties) | **POST** /api/instruments/$batchupsertproperties | BatchUpsertInstrumentProperties: Batch upsert instruments properties
  *InstrumentsApi* | [**calculate_settlement_date**](docs/InstrumentsApi.md#calculate_settlement_date) | **GET** /api/instruments/{identifierType}/{identifier}/settlementdate | [EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument.
  *InstrumentsApi* | [**delete_instrument**](docs/InstrumentsApi.md#delete_instrument) | **DELETE** /api/instruments/{identifierType}/{identifier} | DeleteInstrument: Soft delete a single instrument
  *InstrumentsApi* | [**delete_instrument_properties**](docs/InstrumentsApi.md#delete_instrument_properties) | **POST** /api/instruments/{identifierType}/{identifier}/properties/$delete | [EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties
  *InstrumentsApi* | [**delete_instruments**](docs/InstrumentsApi.md#delete_instruments) | **POST** /api/instruments/$delete | DeleteInstruments: Soft or hard delete multiple instruments
  *InstrumentsApi* | [**get_all_possible_features**](docs/InstrumentsApi.md#get_all_possible_features) | **GET** /api/instruments/{instrumentType}/allfeatures | [EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type.
  *InstrumentsApi* | [**get_existing_instrument_capabilities**](docs/InstrumentsApi.md#get_existing_instrument_capabilities) | **GET** /api/instruments/{identifier}/capabilities | [EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies.  Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies.
  *InstrumentsApi* | [**get_existing_instrument_models**](docs/InstrumentsApi.md#get_existing_instrument_models) | **GET** /api/instruments/{identifier}/models | GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID.
  *InstrumentsApi* | [**get_instrument**](docs/InstrumentsApi.md#get_instrument) | **GET** /api/instruments/{identifierType}/{identifier} | GetInstrument: Get instrument
  *InstrumentsApi* | [**get_instrument_identifier_types**](docs/InstrumentsApi.md#get_instrument_identifier_types) | **GET** /api/instruments/identifierTypes | GetInstrumentIdentifierTypes: Get instrument identifier types
  *InstrumentsApi* | [**get_instrument_payment_diary**](docs/InstrumentsApi.md#get_instrument_payment_diary) | **GET** /api/instruments/{identifierType}/{identifier}/paymentdiary | [EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary
  *InstrumentsApi* | [**get_instrument_properties**](docs/InstrumentsApi.md#get_instrument_properties) | **GET** /api/instruments/{identifierType}/{identifier}/properties | GetInstrumentProperties: Get instrument properties
  *InstrumentsApi* | [**get_instrument_property_time_series**](docs/InstrumentsApi.md#get_instrument_property_time_series) | **GET** /api/instruments/{identifierType}/{identifier}/properties/time-series | GetInstrumentPropertyTimeSeries: Get instrument property time series
  *InstrumentsApi* | [**get_instrument_relationships**](docs/InstrumentsApi.md#get_instrument_relationships) | **GET** /api/instruments/{identifierType}/{identifier}/relationships | [EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships
  *InstrumentsApi* | [**get_instruments**](docs/InstrumentsApi.md#get_instruments) | **POST** /api/instruments/$get | GetInstruments: Get instruments
  *InstrumentsApi* | [**list_instrument_properties**](docs/InstrumentsApi.md#list_instrument_properties) | **GET** /api/instruments/{identifierType}/{identifier}/properties/list | [EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination)
  *InstrumentsApi* | [**list_instruments**](docs/InstrumentsApi.md#list_instruments) | **GET** /api/instruments | ListInstruments: List instruments
  *InstrumentsApi* | [**query_instrument_capabilities**](docs/InstrumentsApi.md#query_instrument_capabilities) | **POST** /api/instruments/capabilities | [EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies.
  *InstrumentsApi* | [**update_instrument_identifier**](docs/InstrumentsApi.md#update_instrument_identifier) | **POST** /api/instruments/{identifierType}/{identifier} | UpdateInstrumentIdentifier: Update instrument identifier
  *InstrumentsApi* | [**upsert_instruments**](docs/InstrumentsApi.md#upsert_instruments) | **POST** /api/instruments | UpsertInstruments: Upsert instruments
  *InstrumentsApi* | [**upsert_instruments_properties**](docs/InstrumentsApi.md#upsert_instruments_properties) | **POST** /api/instruments/$upsertproperties | UpsertInstrumentsProperties: Upsert instruments properties
  *LegacyComplianceApi* | [**delete_legacy_compliance_rule**](docs/LegacyComplianceApi.md#delete_legacy_compliance_rule) | **DELETE** /api/legacy/compliance/rules/{scope}/{code} | [EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule.
  *LegacyComplianceApi* | [**get_legacy_breached_orders_info**](docs/LegacyComplianceApi.md#get_legacy_breached_orders_info) | **GET** /api/legacy/compliance/runs/breached/{runId} | [EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it.
  *LegacyComplianceApi* | [**get_legacy_compliance_rule**](docs/LegacyComplianceApi.md#get_legacy_compliance_rule) | **GET** /api/legacy/compliance/rules/{scope}/{code} | [EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule.
  *LegacyComplianceApi* | [**get_legacy_compliance_run_results**](docs/LegacyComplianceApi.md#get_legacy_compliance_run_results) | **GET** /api/legacy/compliance/runs/{runId} | [EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run.
  *LegacyComplianceApi* | [**list_legacy_compliance_rules**](docs/LegacyComplianceApi.md#list_legacy_compliance_rules) | **GET** /api/legacy/compliance/rules | [EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering.
  *LegacyComplianceApi* | [**list_legacy_compliance_run_info**](docs/LegacyComplianceApi.md#list_legacy_compliance_run_info) | **GET** /api/legacy/compliance/runs | [EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids.
  *LegacyComplianceApi* | [**run_legacy_compliance**](docs/LegacyComplianceApi.md#run_legacy_compliance) | **POST** /api/legacy/compliance/runs | [EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process
  *LegacyComplianceApi* | [**upsert_legacy_compliance_rules**](docs/LegacyComplianceApi.md#upsert_legacy_compliance_rules) | **POST** /api/legacy/compliance/rules | [EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules.
  *LegalEntitiesApi* | [**delete_legal_entity**](docs/LegalEntitiesApi.md#delete_legal_entity) | **DELETE** /api/legalentities/{idTypeScope}/{idTypeCode}/{code} | DeleteLegalEntity: Delete Legal Entity
  *LegalEntitiesApi* | [**delete_legal_entity_access_metadata**](docs/LegalEntitiesApi.md#delete_legal_entity_access_metadata) | **DELETE** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/metadata/{metadataKey} | DeleteLegalEntityAccessMetadata: Delete a Legal Entity Access Metadata entry
  *LegalEntitiesApi* | [**delete_legal_entity_identifiers**](docs/LegalEntitiesApi.md#delete_legal_entity_identifiers) | **DELETE** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/identifiers | [EARLY ACCESS] DeleteLegalEntityIdentifiers: Delete Legal Entity Identifiers
  *LegalEntitiesApi* | [**delete_legal_entity_properties**](docs/LegalEntitiesApi.md#delete_legal_entity_properties) | **DELETE** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/properties | [EARLY ACCESS] DeleteLegalEntityProperties: Delete Legal Entity Properties
  *LegalEntitiesApi* | [**get_all_legal_entity_access_metadata**](docs/LegalEntitiesApi.md#get_all_legal_entity_access_metadata) | **GET** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/metadata | GetAllLegalEntityAccessMetadata: Get Access Metadata rules for a Legal Entity
  *LegalEntitiesApi* | [**get_legal_entity**](docs/LegalEntitiesApi.md#get_legal_entity) | **GET** /api/legalentities/{idTypeScope}/{idTypeCode}/{code} | GetLegalEntity: Get Legal Entity
  *LegalEntitiesApi* | [**get_legal_entity_access_metadata_by_key**](docs/LegalEntitiesApi.md#get_legal_entity_access_metadata_by_key) | **GET** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/metadata/{metadataKey} | [EARLY ACCESS] GetLegalEntityAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Legal Entity
  *LegalEntitiesApi* | [**get_legal_entity_property_time_series**](docs/LegalEntitiesApi.md#get_legal_entity_property_time_series) | **GET** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/properties/time-series | GetLegalEntityPropertyTimeSeries: Get Legal Entity Property Time Series
  *LegalEntitiesApi* | [**get_legal_entity_relations**](docs/LegalEntitiesApi.md#get_legal_entity_relations) | **GET** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/relations | GetLegalEntityRelations: Get Relations for Legal Entity
  *LegalEntitiesApi* | [**get_legal_entity_relationships**](docs/LegalEntitiesApi.md#get_legal_entity_relationships) | **GET** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/relationships | GetLegalEntityRelationships: Get Relationships for Legal Entity
  *LegalEntitiesApi* | [**list_all_legal_entities**](docs/LegalEntitiesApi.md#list_all_legal_entities) | **GET** /api/legalentities | ListAllLegalEntities: List Legal Entities
  *LegalEntitiesApi* | [**list_legal_entities**](docs/LegalEntitiesApi.md#list_legal_entities) | **GET** /api/legalentities/{idTypeScope}/{idTypeCode} | ListLegalEntities: List Legal Entities
  *LegalEntitiesApi* | [**patch_legal_entity_access_metadata**](docs/LegalEntitiesApi.md#patch_legal_entity_access_metadata) | **PATCH** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/metadata | [EARLY ACCESS] PatchLegalEntityAccessMetadata: Patch Access Metadata rules for a Legal Entity.
  *LegalEntitiesApi* | [**set_legal_entity_identifiers**](docs/LegalEntitiesApi.md#set_legal_entity_identifiers) | **POST** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/identifiers | [EARLY ACCESS] SetLegalEntityIdentifiers: Set Legal Entity Identifiers
  *LegalEntitiesApi* | [**set_legal_entity_properties**](docs/LegalEntitiesApi.md#set_legal_entity_properties) | **POST** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/properties | SetLegalEntityProperties: Set Legal Entity Properties
  *LegalEntitiesApi* | [**upsert_legal_entities**](docs/LegalEntitiesApi.md#upsert_legal_entities) | **POST** /api/legalentities/$batchUpsert | [EARLY ACCESS] UpsertLegalEntities: Pluralised upsert of Legal Entities
  *LegalEntitiesApi* | [**upsert_legal_entity**](docs/LegalEntitiesApi.md#upsert_legal_entity) | **POST** /api/legalentities | UpsertLegalEntity: Upsert Legal Entity
  *LegalEntitiesApi* | [**upsert_legal_entity_access_metadata**](docs/LegalEntitiesApi.md#upsert_legal_entity_access_metadata) | **PUT** /api/legalentities/{idTypeScope}/{idTypeCode}/{code}/metadata/{metadataKey} | UpsertLegalEntityAccessMetadata: Upsert a Legal Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID.
  *OrderGraphApi* | [**list_order_graph_blocks**](docs/OrderGraphApi.md#list_order_graph_blocks) | **GET** /api/ordergraph/blocks | ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities.
  *OrderGraphApi* | [**list_order_graph_placement_children**](docs/OrderGraphApi.md#list_order_graph_placement_children) | **GET** /api/ordergraph/placementchildren/{scope}/{code} | [EARLY ACCESS] ListOrderGraphPlacementChildren: Lists all placements for the parent placement specified by the scope and code, and builds a summary picture of the state of their associated order entities.
  *OrderGraphApi* | [**list_order_graph_placements**](docs/OrderGraphApi.md#list_order_graph_placements) | **GET** /api/ordergraph/placements | ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities.
  *OrderInstructionsApi* | [**delete_order_instruction**](docs/OrderInstructionsApi.md#delete_order_instruction) | **DELETE** /api/orderinstructions/{scope}/{code} | [EXPERIMENTAL] DeleteOrderInstruction: Delete orderInstruction
  *OrderInstructionsApi* | [**get_order_instruction**](docs/OrderInstructionsApi.md#get_order_instruction) | **GET** /api/orderinstructions/{scope}/{code} | [EXPERIMENTAL] GetOrderInstruction: Get OrderInstruction
  *OrderInstructionsApi* | [**list_order_instructions**](docs/OrderInstructionsApi.md#list_order_instructions) | **GET** /api/orderinstructions | [EXPERIMENTAL] ListOrderInstructions: List OrderInstructions
  *OrderInstructionsApi* | [**upsert_order_instructions**](docs/OrderInstructionsApi.md#upsert_order_instructions) | **POST** /api/orderinstructions | [EXPERIMENTAL] UpsertOrderInstructions: Upsert OrderInstruction
  *OrderManagementApi* | [**book_transactions**](docs/OrderManagementApi.md#book_transactions) | **POST** /api/ordermanagement/booktransactions | [EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source.
  *OrderManagementApi* | [**cancel_orders**](docs/OrderManagementApi.md#cancel_orders) | **POST** /api/ordermanagement/cancelorders | [EARLY ACCESS] CancelOrders: Cancel existing orders
  *OrderManagementApi* | [**cancel_orders_and_move_remaining**](docs/OrderManagementApi.md#cancel_orders_and_move_remaining) | **POST** /api/ordermanagement/cancelordersandmoveremaining | [EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks
  *OrderManagementApi* | [**cancel_placements**](docs/OrderManagementApi.md#cancel_placements) | **POST** /api/ordermanagement/$cancelplacements | [EARLY ACCESS] CancelPlacements: Cancel existing placements
  *OrderManagementApi* | [**create_orders**](docs/OrderManagementApi.md#create_orders) | **POST** /api/ordermanagement/createorders | [EARLY ACCESS] CreateOrders: Upsert a Block and associated orders
  *OrderManagementApi* | [**get_order_history**](docs/OrderManagementApi.md#get_order_history) | **GET** /api/ordermanagement/order/{scope}/{code}/$history | [EXPERIMENTAL] GetOrderHistory: Get the history of an order and related entity changes
  *OrderManagementApi* | [**move_orders**](docs/OrderManagementApi.md#move_orders) | **POST** /api/ordermanagement/moveorders | [EARLY ACCESS] MoveOrders: Move orders to new or existing block
  *OrderManagementApi* | [**place_blocks**](docs/OrderManagementApi.md#place_blocks) | **POST** /api/ordermanagement/placeblocks | [EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests.
  *OrderManagementApi* | [**run_allocation_service**](docs/OrderManagementApi.md#run_allocation_service) | **POST** /api/ordermanagement/allocate | [EXPERIMENTAL] RunAllocationService: Runs the Allocation Service
  *OrderManagementApi* | [**update_orders**](docs/OrderManagementApi.md#update_orders) | **POST** /api/ordermanagement/updateorders | [EARLY ACCESS] UpdateOrders: Update existing orders
  *OrderManagementApi* | [**update_placements**](docs/OrderManagementApi.md#update_placements) | **POST** /api/ordermanagement/$updateplacements | [EARLY ACCESS] UpdatePlacements: Update existing placements
  *OrdersApi* | [**delete_order**](docs/OrdersApi.md#delete_order) | **DELETE** /api/orders/{scope}/{code} | [EARLY ACCESS] DeleteOrder: Delete order
  *OrdersApi* | [**get_order**](docs/OrdersApi.md#get_order) | **GET** /api/orders/{scope}/{code} | [EARLY ACCESS] GetOrder: Get Order
  *OrdersApi* | [**list_orders**](docs/OrdersApi.md#list_orders) | **GET** /api/orders | ListOrders: List Orders
  *OrdersApi* | [**upsert_orders**](docs/OrdersApi.md#upsert_orders) | **POST** /api/orders | UpsertOrders: Upsert Order
  *PackagesApi* | [**delete_package**](docs/PackagesApi.md#delete_package) | **DELETE** /api/packages/{scope}/{code} | [EXPERIMENTAL] DeletePackage: Delete package
  *PackagesApi* | [**get_package**](docs/PackagesApi.md#get_package) | **GET** /api/packages/{scope}/{code} | [EXPERIMENTAL] GetPackage: Get Package
  *PackagesApi* | [**list_packages**](docs/PackagesApi.md#list_packages) | **GET** /api/packages | [EXPERIMENTAL] ListPackages: List Packages
  *PackagesApi* | [**upsert_packages**](docs/PackagesApi.md#upsert_packages) | **POST** /api/packages | [EXPERIMENTAL] UpsertPackages: Upsert Package
  *ParticipationsApi* | [**delete_participation**](docs/ParticipationsApi.md#delete_participation) | **DELETE** /api/participations/{scope}/{code} | [EARLY ACCESS] DeleteParticipation: Delete participation
  *ParticipationsApi* | [**get_participation**](docs/ParticipationsApi.md#get_participation) | **GET** /api/participations/{scope}/{code} | [EARLY ACCESS] GetParticipation: Get Participation
  *ParticipationsApi* | [**list_participations**](docs/ParticipationsApi.md#list_participations) | **GET** /api/participations | [EARLY ACCESS] ListParticipations: List Participations
  *ParticipationsApi* | [**upsert_participations**](docs/ParticipationsApi.md#upsert_participations) | **POST** /api/participations | [EARLY ACCESS] UpsertParticipations: Upsert Participation
  *PersonsApi* | [**delete_person**](docs/PersonsApi.md#delete_person) | **DELETE** /api/persons/{idTypeScope}/{idTypeCode}/{code} | DeletePerson: Delete person
  *PersonsApi* | [**delete_person_access_metadata**](docs/PersonsApi.md#delete_person_access_metadata) | **DELETE** /api/persons/{idTypeScope}/{idTypeCode}/{code}/metadata/{metadataKey} | [EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry
  *PersonsApi* | [**delete_person_identifiers**](docs/PersonsApi.md#delete_person_identifiers) | **DELETE** /api/persons/{idTypeScope}/{idTypeCode}/{code}/identifiers | [EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers
  *PersonsApi* | [**delete_person_properties**](docs/PersonsApi.md#delete_person_properties) | **DELETE** /api/persons/{idTypeScope}/{idTypeCode}/{code}/properties | [EARLY ACCESS] DeletePersonProperties: Delete Person Properties
  *PersonsApi* | [**get_all_person_access_metadata**](docs/PersonsApi.md#get_all_person_access_metadata) | **GET** /api/persons/{idTypeScope}/{idTypeCode}/{code}/metadata | [EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person
  *PersonsApi* | [**get_person**](docs/PersonsApi.md#get_person) | **GET** /api/persons/{idTypeScope}/{idTypeCode}/{code} | [EARLY ACCESS] GetPerson: Get Person
  *PersonsApi* | [**get_person_access_metadata_by_key**](docs/PersonsApi.md#get_person_access_metadata_by_key) | **GET** /api/persons/{idTypeScope}/{idTypeCode}/{code}/metadata/{metadataKey} | [EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person
  *PersonsApi* | [**get_person_property_time_series**](docs/PersonsApi.md#get_person_property_time_series) | **GET** /api/persons/{idTypeScope}/{idTypeCode}/{code}/properties/time-series | [EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series
  *PersonsApi* | [**get_person_relations**](docs/PersonsApi.md#get_person_relations) | **GET** /api/persons/{idTypeScope}/{idTypeCode}/{code}/relations | [EARLY ACCESS] GetPersonRelations: Get Relations for Person
  *PersonsApi* | [**get_person_relationships**](docs/PersonsApi.md#get_person_relationships) | **GET** /api/persons/{idTypeScope}/{idTypeCode}/{code}/relationships | [EARLY ACCESS] GetPersonRelationships: Get Relationships for Person
  *PersonsApi* | [**list_all_persons**](docs/PersonsApi.md#list_all_persons) | **GET** /api/persons | [EARLY ACCESS] ListAllPersons: List All Persons
  *PersonsApi* | [**list_persons**](docs/PersonsApi.md#list_persons) | **GET** /api/persons/{idTypeScope}/{idTypeCode} | [EARLY ACCESS] ListPersons: List Persons
  *PersonsApi* | [**patch_person_access_metadata**](docs/PersonsApi.md#patch_person_access_metadata) | **PATCH** /api/persons/{idTypeScope}/{idTypeCode}/{code}/metadata | [EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person.
  *PersonsApi* | [**set_person_identifiers**](docs/PersonsApi.md#set_person_identifiers) | **POST** /api/persons/{idTypeScope}/{idTypeCode}/{code}/identifiers | [EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers
  *PersonsApi* | [**set_person_properties**](docs/PersonsApi.md#set_person_properties) | **POST** /api/persons/{idTypeScope}/{idTypeCode}/{code}/properties | [EARLY ACCESS] SetPersonProperties: Set Person Properties
  *PersonsApi* | [**upsert_person**](docs/PersonsApi.md#upsert_person) | **POST** /api/persons | UpsertPerson: Upsert Person
  *PersonsApi* | [**upsert_person_access_metadata**](docs/PersonsApi.md#upsert_person_access_metadata) | **PUT** /api/persons/{idTypeScope}/{idTypeCode}/{code}/metadata/{metadataKey} | [EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID.
  *PersonsApi* | [**upsert_persons**](docs/PersonsApi.md#upsert_persons) | **POST** /api/persons/$batchUpsert | [EARLY ACCESS] UpsertPersons: Pluralised Upsert of Persons
  *PlacementsApi* | [**delete_placement**](docs/PlacementsApi.md#delete_placement) | **DELETE** /api/placements/{scope}/{code} | [EARLY ACCESS] DeletePlacement: Delete placement
  *PlacementsApi* | [**get_placement**](docs/PlacementsApi.md#get_placement) | **GET** /api/placements/{scope}/{code} | [EARLY ACCESS] GetPlacement: Get Placement
  *PlacementsApi* | [**list_placements**](docs/PlacementsApi.md#list_placements) | **GET** /api/placements | [EARLY ACCESS] ListPlacements: List Placements
  *PlacementsApi* | [**upsert_placements**](docs/PlacementsApi.md#upsert_placements) | **POST** /api/placements | [EARLY ACCESS] UpsertPlacements: Upsert Placement
  *PortfolioGroupsApi* | [**add_portfolio_to_group**](docs/PortfolioGroupsApi.md#add_portfolio_to_group) | **POST** /api/portfoliogroups/{scope}/{code}/portfolios | [EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group
  *PortfolioGroupsApi* | [**add_sub_group_to_group**](docs/PortfolioGroupsApi.md#add_sub_group_to_group) | **POST** /api/portfoliogroups/{scope}/{code}/subgroups | [EARLY ACCESS] AddSubGroupToGroup: Add sub group to group
  *PortfolioGroupsApi* | [**build_transactions_for_portfolio_group**](docs/PortfolioGroupsApi.md#build_transactions_for_portfolio_group) | **POST** /api/portfoliogroups/{scope}/{code}/transactions/$build | BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group
  *PortfolioGroupsApi* | [**create_portfolio_group**](docs/PortfolioGroupsApi.md#create_portfolio_group) | **POST** /api/portfoliogroups/{scope} | CreatePortfolioGroup: Create portfolio group
  *PortfolioGroupsApi* | [**delete_group_properties**](docs/PortfolioGroupsApi.md#delete_group_properties) | **POST** /api/portfoliogroups/{scope}/{code}/properties/$delete | [EARLY ACCESS] DeleteGroupProperties: Delete group properties
  *PortfolioGroupsApi* | [**delete_key_from_portfolio_group_access_metadata**](docs/PortfolioGroupsApi.md#delete_key_from_portfolio_group_access_metadata) | **DELETE** /api/portfoliogroups/{scope}/{code}/metadata/{metadataKey} | [EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry
  *PortfolioGroupsApi* | [**delete_portfolio_from_group**](docs/PortfolioGroupsApi.md#delete_portfolio_from_group) | **DELETE** /api/portfoliogroups/{scope}/{code}/portfolios/{portfolioScope}/{portfolioCode} | [EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group
  *PortfolioGroupsApi* | [**delete_portfolio_group**](docs/PortfolioGroupsApi.md#delete_portfolio_group) | **DELETE** /api/portfoliogroups/{scope}/{code} | [EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group
  *PortfolioGroupsApi* | [**delete_sub_group_from_group**](docs/PortfolioGroupsApi.md#delete_sub_group_from_group) | **DELETE** /api/portfoliogroups/{scope}/{code}/subgroups/{subgroupScope}/{subgroupCode} | [EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group
  *PortfolioGroupsApi* | [**get_a2_b_data_for_portfolio_group**](docs/PortfolioGroupsApi.md#get_a2_b_data_for_portfolio_group) | **GET** /api/portfoliogroups/{scope}/{code}/a2b | [EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group
  *PortfolioGroupsApi* | [**get_group_properties**](docs/PortfolioGroupsApi.md#get_group_properties) | **GET** /api/portfoliogroups/{scope}/{code}/properties | [EARLY ACCESS] GetGroupProperties: Get group properties
  *PortfolioGroupsApi* | [**get_holdings_for_portfolio_group**](docs/PortfolioGroupsApi.md#get_holdings_for_portfolio_group) | **GET** /api/portfoliogroups/{scope}/{code}/holdings | GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group
  *PortfolioGroupsApi* | [**get_portfolio_group**](docs/PortfolioGroupsApi.md#get_portfolio_group) | **GET** /api/portfoliogroups/{scope}/{code} | GetPortfolioGroup: Get portfolio group
  *PortfolioGroupsApi* | [**get_portfolio_group_access_metadata_by_key**](docs/PortfolioGroupsApi.md#get_portfolio_group_access_metadata_by_key) | **GET** /api/portfoliogroups/{scope}/{code}/metadata/{metadataKey} | [EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group
  *PortfolioGroupsApi* | [**get_portfolio_group_commands**](docs/PortfolioGroupsApi.md#get_portfolio_group_commands) | **GET** /api/portfoliogroups/{scope}/{code}/commands | GetPortfolioGroupCommands: Get portfolio group commands
  *PortfolioGroupsApi* | [**get_portfolio_group_expansion**](docs/PortfolioGroupsApi.md#get_portfolio_group_expansion) | **GET** /api/portfoliogroups/{scope}/{code}/expansion | [EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion
  *PortfolioGroupsApi* | [**get_portfolio_group_metadata**](docs/PortfolioGroupsApi.md#get_portfolio_group_metadata) | **GET** /api/portfoliogroups/{scope}/{code}/metadata | [EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group
  *PortfolioGroupsApi* | [**get_portfolio_group_property_time_series**](docs/PortfolioGroupsApi.md#get_portfolio_group_property_time_series) | **GET** /api/portfoliogroups/{scope}/{code}/properties/time-series | [EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property
  *PortfolioGroupsApi* | [**get_portfolio_group_relations**](docs/PortfolioGroupsApi.md#get_portfolio_group_relations) | **GET** /api/portfoliogroups/{scope}/{code}/relations | [EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group
  *PortfolioGroupsApi* | [**get_portfolio_group_relationships**](docs/PortfolioGroupsApi.md#get_portfolio_group_relationships) | **GET** /api/portfoliogroups/{scope}/{code}/relationships | [EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group
  *PortfolioGroupsApi* | [**get_transactions_for_portfolio_group**](docs/PortfolioGroupsApi.md#get_transactions_for_portfolio_group) | **GET** /api/portfoliogroups/{scope}/{code}/transactions | GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group
  *PortfolioGroupsApi* | [**list_portfolio_groups**](docs/PortfolioGroupsApi.md#list_portfolio_groups) | **GET** /api/portfoliogroups/{scope} | ListPortfolioGroups: List portfolio groups
  *PortfolioGroupsApi* | [**patch_portfolio_group_access_metadata**](docs/PortfolioGroupsApi.md#patch_portfolio_group_access_metadata) | **PATCH** /api/portfoliogroups/{scope}/{code}/metadata | [EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group.
  *PortfolioGroupsApi* | [**update_portfolio_group**](docs/PortfolioGroupsApi.md#update_portfolio_group) | **PUT** /api/portfoliogroups/{scope}/{code} | [EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group
  *PortfolioGroupsApi* | [**upsert_group_properties**](docs/PortfolioGroupsApi.md#upsert_group_properties) | **POST** /api/portfoliogroups/{scope}/{code}/properties/$upsert | [EARLY ACCESS] UpsertGroupProperties: Upsert group properties
  *PortfolioGroupsApi* | [**upsert_portfolio_group_access_metadata**](docs/PortfolioGroupsApi.md#upsert_portfolio_group_access_metadata) | **PUT** /api/portfoliogroups/{scope}/{code}/metadata/{metadataKey} | UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID.
  *PortfoliosApi* | [**batch_upsert_portfolio_access_metadata**](docs/PortfoliosApi.md#batch_upsert_portfolio_access_metadata) | **PUT** /api/portfolios/metadata | [EARLY ACCESS] BatchUpsertPortfolioAccessMetadata: Upsert multiple Portfolio Access Metadata Rules to multiple Portfolios
  *PortfoliosApi* | [**delete_instrument_event_instruction**](docs/PortfoliosApi.md#delete_instrument_event_instruction) | **DELETE** /api/portfolios/{scope}/{code}/instrumenteventinstructions/{instrumentEventInstructionId} | [EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction
  *PortfoliosApi* | [**delete_key_from_portfolio_access_metadata**](docs/PortfoliosApi.md#delete_key_from_portfolio_access_metadata) | **DELETE** /api/portfolios/{scope}/{code}/metadata/{metadataKey} | DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule
  *PortfoliosApi* | [**delete_portfolio**](docs/PortfoliosApi.md#delete_portfolio) | **DELETE** /api/portfolios/{scope}/{code} | DeletePortfolio: Delete portfolio
  *PortfoliosApi* | [**delete_portfolio_properties**](docs/PortfoliosApi.md#delete_portfolio_properties) | **DELETE** /api/portfolios/{scope}/{code}/properties | DeletePortfolioProperties: Delete portfolio properties
  *PortfoliosApi* | [**delete_portfolio_returns**](docs/PortfoliosApi.md#delete_portfolio_returns) | **DELETE** /api/portfolios/{scope}/{code}/returns/{returnScope}/{returnCode}/$delete | [EARLY ACCESS] DeletePortfolioReturns: Delete Returns
  *PortfoliosApi* | [**get_aggregated_returns_dispersion_metrics**](docs/PortfoliosApi.md#get_aggregated_returns_dispersion_metrics) | **POST** /api/portfolios/{scope}/{code}/returns/dispersion/$aggregated | [EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric
  *PortfoliosApi* | [**get_composite_breakdown**](docs/PortfoliosApi.md#get_composite_breakdown) | **POST** /api/portfolios/{scope}/{code}/returns/breakdown | [EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated
  *PortfoliosApi* | [**get_instrument_event_instruction**](docs/PortfoliosApi.md#get_instrument_event_instruction) | **GET** /api/portfolios/{scope}/{code}/instrumenteventinstructions/{instrumentEventInstructionId} | [EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction
  *PortfoliosApi* | [**get_portfolio**](docs/PortfoliosApi.md#get_portfolio) | **GET** /api/portfolios/{scope}/{code} | GetPortfolio: Get portfolio
  *PortfoliosApi* | [**get_portfolio_aggregate_returns**](docs/PortfoliosApi.md#get_portfolio_aggregate_returns) | **GET** /api/portfolios/{scope}/{code}/returns/{returnScope}/{returnCode}/aggregated | [DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint).
  *PortfoliosApi* | [**get_portfolio_aggregated_returns**](docs/PortfoliosApi.md#get_portfolio_aggregated_returns) | **POST** /api/portfolios/{scope}/{code}/returns/$aggregated | GetPortfolioAggregatedReturns: Aggregated Returns
  *PortfoliosApi* | [**get_portfolio_commands**](docs/PortfoliosApi.md#get_portfolio_commands) | **GET** /api/portfolios/{scope}/{code}/commands | GetPortfolioCommands: Get portfolio commands
  *PortfoliosApi* | [**get_portfolio_metadata**](docs/PortfoliosApi.md#get_portfolio_metadata) | **GET** /api/portfolios/{scope}/{code}/metadata | GetPortfolioMetadata: Get access metadata rules for a portfolio
  *PortfoliosApi* | [**get_portfolio_properties**](docs/PortfoliosApi.md#get_portfolio_properties) | **GET** /api/portfolios/{scope}/{code}/properties | GetPortfolioProperties: Get portfolio properties
  *PortfoliosApi* | [**get_portfolio_property_time_series**](docs/PortfoliosApi.md#get_portfolio_property_time_series) | **GET** /api/portfolios/{scope}/{code}/properties/time-series | GetPortfolioPropertyTimeSeries: Get portfolio property time series
  *PortfoliosApi* | [**get_portfolio_relations**](docs/PortfoliosApi.md#get_portfolio_relations) | **GET** /api/portfolios/{scope}/{code}/relations | [EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations
  *PortfoliosApi* | [**get_portfolio_relationships**](docs/PortfoliosApi.md#get_portfolio_relationships) | **GET** /api/portfolios/{scope}/{code}/relationships | GetPortfolioRelationships: Get portfolio relationships
  *PortfoliosApi* | [**get_portfolio_returns**](docs/PortfoliosApi.md#get_portfolio_returns) | **GET** /api/portfolios/{scope}/{code}/returns/{returnScope}/{returnCode} | GetPortfolioReturns: Get Returns
  *PortfoliosApi* | [**get_portfolios_access_metadata_by_key**](docs/PortfoliosApi.md#get_portfolios_access_metadata_by_key) | **GET** /api/portfolios/{scope}/{code}/metadata/{metadataKey} | [EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object
  *PortfoliosApi* | [**list_instrument_event_instructions**](docs/PortfoliosApi.md#list_instrument_event_instructions) | **GET** /api/portfolios/{scope}/{code}/instrumenteventinstructions | [EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions
  *PortfoliosApi* | [**list_portfolio_properties**](docs/PortfoliosApi.md#list_portfolio_properties) | **GET** /api/portfolios/{scope}/{code}/properties/list | [EARLY ACCESS] ListPortfolioProperties: Get portfolio properties
  *PortfoliosApi* | [**list_portfolios**](docs/PortfoliosApi.md#list_portfolios) | **GET** /api/portfolios | ListPortfolios: List portfolios
  *PortfoliosApi* | [**list_portfolios_for_scope**](docs/PortfoliosApi.md#list_portfolios_for_scope) | **GET** /api/portfolios/{scope} | ListPortfoliosForScope: List portfolios for scope
  *PortfoliosApi* | [**patch_portfolio**](docs/PortfoliosApi.md#patch_portfolio) | **PATCH** /api/portfolios/{scope}/{code} | PatchPortfolio: Patch portfolio.
  *PortfoliosApi* | [**patch_portfolio_access_metadata**](docs/PortfoliosApi.md#patch_portfolio_access_metadata) | **PATCH** /api/portfolios/{scope}/{code}/metadata | [EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio.
  *PortfoliosApi* | [**update_portfolio**](docs/PortfoliosApi.md#update_portfolio) | **PUT** /api/portfolios/{scope}/{code} | UpdatePortfolio: Update portfolio
  *PortfoliosApi* | [**upsert_instrument_event_instructions**](docs/PortfoliosApi.md#upsert_instrument_event_instructions) | **POST** /api/portfolios/{scope}/{code}/instrumenteventinstructions | [EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions
  *PortfoliosApi* | [**upsert_portfolio_access_metadata**](docs/PortfoliosApi.md#upsert_portfolio_access_metadata) | **PUT** /api/portfolios/{scope}/{code}/metadata/{metadataKey} | UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID.
  *PortfoliosApi* | [**upsert_portfolio_properties**](docs/PortfoliosApi.md#upsert_portfolio_properties) | **POST** /api/portfolios/{scope}/{code}/properties | UpsertPortfolioProperties: Upsert portfolio properties
  *PortfoliosApi* | [**upsert_portfolio_returns**](docs/PortfoliosApi.md#upsert_portfolio_returns) | **POST** /api/portfolios/{scope}/{code}/returns/{returnScope}/{returnCode} | UpsertPortfolioReturns: Upsert Returns
  *PropertyDefinitionsApi* | [**create_derived_property_definition**](docs/PropertyDefinitionsApi.md#create_derived_property_definition) | **POST** /api/propertydefinitions/derived | [EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition
  *PropertyDefinitionsApi* | [**create_property_definition**](docs/PropertyDefinitionsApi.md#create_property_definition) | **POST** /api/propertydefinitions | CreatePropertyDefinition: Create property definition
  *PropertyDefinitionsApi* | [**delete_property_definition**](docs/PropertyDefinitionsApi.md#delete_property_definition) | **DELETE** /api/propertydefinitions/{domain}/{scope}/{code} | DeletePropertyDefinition: Delete property definition
  *PropertyDefinitionsApi* | [**delete_property_definition_properties**](docs/PropertyDefinitionsApi.md#delete_property_definition_properties) | **POST** /api/propertydefinitions/{domain}/{scope}/{code}/properties/$delete | [EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties
  *PropertyDefinitionsApi* | [**get_multiple_property_definitions**](docs/PropertyDefinitionsApi.md#get_multiple_property_definitions) | **GET** /api/propertydefinitions | GetMultiplePropertyDefinitions: Get multiple property definitions
  *PropertyDefinitionsApi* | [**get_property_definition**](docs/PropertyDefinitionsApi.md#get_property_definition) | **GET** /api/propertydefinitions/{domain}/{scope}/{code} | GetPropertyDefinition: Get property definition
  *PropertyDefinitionsApi* | [**get_property_definition_property_time_series**](docs/PropertyDefinitionsApi.md#get_property_definition_property_time_series) | **GET** /api/propertydefinitions/{domain}/{scope}/{code}/properties/time-series | [EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series
  *PropertyDefinitionsApi* | [**list_property_definitions**](docs/PropertyDefinitionsApi.md#list_property_definitions) | **GET** /api/propertydefinitions/$list | ListPropertyDefinitions: List property definitions
  *PropertyDefinitionsApi* | [**update_derived_property_definition**](docs/PropertyDefinitionsApi.md#update_derived_property_definition) | **PUT** /api/propertydefinitions/derived/{domain}/{scope}/{code} | [EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition
  *PropertyDefinitionsApi* | [**update_property_definition**](docs/PropertyDefinitionsApi.md#update_property_definition) | **PUT** /api/propertydefinitions/{domain}/{scope}/{code} | UpdatePropertyDefinition: Update property definition
  *PropertyDefinitionsApi* | [**upsert_property_definition_properties**](docs/PropertyDefinitionsApi.md#upsert_property_definition_properties) | **POST** /api/propertydefinitions/{domain}/{scope}/{code}/properties | UpsertPropertyDefinitionProperties: Upsert properties to a property definition
  *QueryableKeysApi* | [**get_all_queryable_keys**](docs/QueryableKeysApi.md#get_all_queryable_keys) | **GET** /api/queryablekeys | [EARLY ACCESS] GetAllQueryableKeys: Query the set of supported \"addresses\" that can be queried from all endpoints.
  *QuotesApi* | [**delete_quote_access_metadata_rule**](docs/QuotesApi.md#delete_quote_access_metadata_rule) | **DELETE** /api/metadata/quotes/rules/{scope} | [EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule
  *QuotesApi* | [**delete_quotes**](docs/QuotesApi.md#delete_quotes) | **POST** /api/quotes/{scope}/$delete | DeleteQuotes: Delete quotes
  *QuotesApi* | [**get_quotes**](docs/QuotesApi.md#get_quotes) | **POST** /api/quotes/{scope}/$get | GetQuotes: Get quotes
  *QuotesApi* | [**get_quotes_access_metadata_rule**](docs/QuotesApi.md#get_quotes_access_metadata_rule) | **GET** /api/metadata/quotes/rules | [EXPERIMENTAL] GetQuotesAccessMetadataRule: Get a quote access metadata rule
  *QuotesApi* | [**list_quotes**](docs/QuotesApi.md#list_quotes) | **GET** /api/quotes/{scope}/$deprecated | [DEPRECATED] ListQuotes: List quotes
  *QuotesApi* | [**list_quotes_access_metadata_rules**](docs/QuotesApi.md#list_quotes_access_metadata_rules) | **GET** /api/metadata/quotes/rules/{scope} | [EXPERIMENTAL] ListQuotesAccessMetadataRules: List all quote access metadata rules in a scope
  *QuotesApi* | [**list_quotes_for_scope**](docs/QuotesApi.md#list_quotes_for_scope) | **GET** /api/quotes/{scope} | ListQuotesForScope: List quotes for scope
  *QuotesApi* | [**upsert_quote_access_metadata_rule**](docs/QuotesApi.md#upsert_quote_access_metadata_rule) | **POST** /api/metadata/quotes/rules/{scope} | [EXPERIMENTAL] UpsertQuoteAccessMetadataRule: Upsert a Quote Access Metadata Rule. This creates or updates the data in LUSID.
  *QuotesApi* | [**upsert_quotes**](docs/QuotesApi.md#upsert_quotes) | **POST** /api/quotes/{scope} | UpsertQuotes: Upsert quotes
  *ReconciliationsApi* | [**create_scheduled_reconciliation**](docs/ReconciliationsApi.md#create_scheduled_reconciliation) | **POST** /api/portfolios/$scheduledReconciliations/{scope} | [EXPERIMENTAL] CreateScheduledReconciliation: Create a scheduled reconciliation
  *ReconciliationsApi* | [**delete_reconciliation**](docs/ReconciliationsApi.md#delete_reconciliation) | **DELETE** /api/portfolios/$scheduledReconciliations/{scope}/{code} | [EXPERIMENTAL] DeleteReconciliation: Delete scheduled reconciliation
  *ReconciliationsApi* | [**delete_reconciliation_mapping**](docs/ReconciliationsApi.md#delete_reconciliation_mapping) | **DELETE** /api/portfolios/mapping/{scope}/{code} | [EARLY ACCESS] DeleteReconciliationMapping: Delete a mapping
  *ReconciliationsApi* | [**get_reconciliation**](docs/ReconciliationsApi.md#get_reconciliation) | **GET** /api/portfolios/$scheduledReconciliations/{scope}/{code} | [EXPERIMENTAL] GetReconciliation: Get scheduled reconciliation
  *ReconciliationsApi* | [**get_reconciliation_mapping**](docs/ReconciliationsApi.md#get_reconciliation_mapping) | **GET** /api/portfolios/mapping/{scope}/{code} | [EARLY ACCESS] GetReconciliationMapping: Get a mapping
  *ReconciliationsApi* | [**list_reconciliation_mappings**](docs/ReconciliationsApi.md#list_reconciliation_mappings) | **GET** /api/portfolios/mapping | [EARLY ACCESS] ListReconciliationMappings: List the reconciliation mappings
  *ReconciliationsApi* | [**list_reconciliations**](docs/ReconciliationsApi.md#list_reconciliations) | **GET** /api/portfolios/$scheduledReconciliations | [EXPERIMENTAL] ListReconciliations: List scheduled reconciliations
  *ReconciliationsApi* | [**reconcile_generic**](docs/ReconciliationsApi.md#reconcile_generic) | **POST** /api/portfolios/$reconcileGeneric | ReconcileGeneric: Reconcile either holdings or valuations performed on one or two sets of holdings using one or two configuration recipes.                The output is configurable for various types of comparisons, to allow tolerances on numerical and date-time data or case-insensitivity on strings,  and elision of resulting differences where they are 'empty' or null or zero.
  *ReconciliationsApi* | [**reconcile_holdings**](docs/ReconciliationsApi.md#reconcile_holdings) | **POST** /api/portfolios/$reconcileholdings | [EARLY ACCESS] ReconcileHoldings: Reconcile portfolio holdings
  *ReconciliationsApi* | [**reconcile_inline**](docs/ReconciliationsApi.md#reconcile_inline) | **POST** /api/portfolios/$reconcileInline | ReconcileInline: Reconcile valuations performed on one or two sets of inline instruments using one or two configuration recipes.
  *ReconciliationsApi* | [**reconcile_transactions**](docs/ReconciliationsApi.md#reconcile_transactions) | **POST** /api/portfolios/$reconcileTransactions | [EARLY ACCESS] ReconcileTransactions: Perform a Transactions Reconciliation.
  *ReconciliationsApi* | [**reconcile_transactions_v2**](docs/ReconciliationsApi.md#reconcile_transactions_v2) | **POST** /api/portfolios/$reconcileTransactionsV2 | [EXPERIMENTAL] ReconcileTransactionsV2: Perform a Transactions Reconciliation.
  *ReconciliationsApi* | [**reconcile_valuation**](docs/ReconciliationsApi.md#reconcile_valuation) | **POST** /api/portfolios/$reconcileValuation | ReconcileValuation: Reconcile valuations performed on one or two sets of holdings using one or two configuration recipes.
  *ReconciliationsApi* | [**update_reconciliation**](docs/ReconciliationsApi.md#update_reconciliation) | **POST** /api/portfolios/$scheduledReconciliations/{scope}/{code} | [EXPERIMENTAL] UpdateReconciliation: Update scheduled reconciliation
  *ReconciliationsApi* | [**upsert_reconciliation_mapping**](docs/ReconciliationsApi.md#upsert_reconciliation_mapping) | **POST** /api/portfolios/mapping | [EARLY ACCESS] UpsertReconciliationMapping: Create or update a mapping
  *ReferenceListsApi* | [**delete_reference_list**](docs/ReferenceListsApi.md#delete_reference_list) | **DELETE** /api/referencelists/{scope}/{code} | [EARLY ACCESS] DeleteReferenceList: Delete Reference List
  *ReferenceListsApi* | [**get_reference_list**](docs/ReferenceListsApi.md#get_reference_list) | **GET** /api/referencelists/{scope}/{code} | GetReferenceList: Get Reference List
  *ReferenceListsApi* | [**list_reference_lists**](docs/ReferenceListsApi.md#list_reference_lists) | **GET** /api/referencelists | [EARLY ACCESS] ListReferenceLists: List Reference Lists
  *ReferenceListsApi* | [**upsert_reference_list**](docs/ReferenceListsApi.md#upsert_reference_list) | **POST** /api/referencelists | [EARLY ACCESS] UpsertReferenceList: Upsert Reference List
  *ReferencePortfolioApi* | [**create_reference_portfolio**](docs/ReferencePortfolioApi.md#create_reference_portfolio) | **POST** /api/referenceportfolios/{scope} | CreateReferencePortfolio: Create reference portfolio
  *ReferencePortfolioApi* | [**get_reference_portfolio_constituents**](docs/ReferencePortfolioApi.md#get_reference_portfolio_constituents) | **GET** /api/referenceportfolios/{scope}/{code}/constituents | GetReferencePortfolioConstituents: Get reference portfolio constituents
  *ReferencePortfolioApi* | [**list_constituents_adjustments**](docs/ReferencePortfolioApi.md#list_constituents_adjustments) | **GET** /api/referenceportfolios/{scope}/{code}/constituentsadjustments | ListConstituentsAdjustments: List constituents adjustments
  *ReferencePortfolioApi* | [**upsert_reference_portfolio_constituent_properties**](docs/ReferencePortfolioApi.md#upsert_reference_portfolio_constituent_properties) | **POST** /api/referenceportfolios/{scope}/{code}/constituents/properties | [EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties
  *ReferencePortfolioApi* | [**upsert_reference_portfolio_constituents**](docs/ReferencePortfolioApi.md#upsert_reference_portfolio_constituents) | **POST** /api/referenceportfolios/{scope}/{code}/constituents | UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents
  *RelationDefinitionsApi* | [**create_relation_definition**](docs/RelationDefinitionsApi.md#create_relation_definition) | **POST** /api/relationdefinitions | [EXPERIMENTAL] CreateRelationDefinition: Create a relation definition
  *RelationDefinitionsApi* | [**delete_relation_definition**](docs/RelationDefinitionsApi.md#delete_relation_definition) | **DELETE** /api/relationdefinitions/{scope}/{code} | [EXPERIMENTAL] DeleteRelationDefinition: Delete relation definition
  *RelationDefinitionsApi* | [**get_relation_definition**](docs/RelationDefinitionsApi.md#get_relation_definition) | **GET** /api/relationdefinitions/{scope}/{code} | [EXPERIMENTAL] GetRelationDefinition: Get relation definition
  *RelationsApi* | [**create_relation**](docs/RelationsApi.md#create_relation) | **POST** /api/relations/{scope}/{code} | [EXPERIMENTAL] CreateRelation: Create Relation
  *RelationsApi* | [**delete_relation**](docs/RelationsApi.md#delete_relation) | **POST** /api/relations/{scope}/{code}/$delete | [EXPERIMENTAL] DeleteRelation: Delete a relation
  *RelationshipDefinitionsApi* | [**create_relationship_definition**](docs/RelationshipDefinitionsApi.md#create_relationship_definition) | **POST** /api/relationshipdefinitions | [EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition
  *RelationshipDefinitionsApi* | [**delete_relationship_definition**](docs/RelationshipDefinitionsApi.md#delete_relationship_definition) | **DELETE** /api/relationshipdefinitions/{scope}/{code} | [EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition
  *RelationshipDefinitionsApi* | [**get_relationship_definition**](docs/RelationshipDefinitionsApi.md#get_relationship_definition) | **GET** /api/relationshipdefinitions/{scope}/{code} | [EARLY ACCESS] GetRelationshipDefinition: Get relationship definition
  *RelationshipDefinitionsApi* | [**list_relationship_definitions**](docs/RelationshipDefinitionsApi.md#list_relationship_definitions) | **GET** /api/relationshipdefinitions | [EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions
  *RelationshipDefinitionsApi* | [**update_relationship_definition**](docs/RelationshipDefinitionsApi.md#update_relationship_definition) | **PUT** /api/relationshipdefinitions/{scope}/{code} | [EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition
  *RelationshipsApi* | [**create_relationship**](docs/RelationshipsApi.md#create_relationship) | **POST** /api/relationshipdefinitions/{scope}/{code}/relationships | CreateRelationship: Create Relationship
  *RelationshipsApi* | [**delete_relationship**](docs/RelationshipsApi.md#delete_relationship) | **POST** /api/relationshipdefinitions/{scope}/{code}/relationships/$delete | [EARLY ACCESS] DeleteRelationship: Delete Relationship
  *SchemasApi* | [**get_entity_schema**](docs/SchemasApi.md#get_entity_schema) | **GET** /api/schemas/entities/{entity} | [EARLY ACCESS] GetEntitySchema: Get schema
  *SchemasApi* | [**get_property_schema**](docs/SchemasApi.md#get_property_schema) | **GET** /api/schemas/properties | [EARLY ACCESS] GetPropertySchema: Get property schema
  *SchemasApi* | [**get_value_types**](docs/SchemasApi.md#get_value_types) | **GET** /api/schemas/types | [EARLY ACCESS] GetValueTypes: Get value types
  *SchemasApi* | [**list_entities**](docs/SchemasApi.md#list_entities) | **GET** /api/schemas/entities | [EARLY ACCESS] ListEntities: List entities
  *ScopesApi* | [**list_entity_scopes**](docs/ScopesApi.md#list_entity_scopes) | **GET** /api/scopes/{entityType} | ListEntityScopes: List Entity Scopes
  *ScopesApi* | [**list_scopes**](docs/ScopesApi.md#list_scopes) | **GET** /api/scopes | ListScopes: List Scopes
  *ScriptedTranslationApi* | [**get_translation_dialect**](docs/ScriptedTranslationApi.md#get_translation_dialect) | **GET** /api/scriptedtranslation/dialects/{scope}/{vendor}/{sourceSystem}/{entityType}/{serialisationFormat}/{version} | [EARLY ACCESS] GetTranslationDialect: Get a dialect.
  *ScriptedTranslationApi* | [**get_translation_script**](docs/ScriptedTranslationApi.md#get_translation_script) | **GET** /api/scriptedtranslation/scripts/{scope}/{code}/{version} | [EARLY ACCESS] GetTranslationScript: Retrieve a translation script by its identifier.
  *ScriptedTranslationApi* | [**list_dialect_ids**](docs/ScriptedTranslationApi.md#list_dialect_ids) | **GET** /api/scriptedtranslation/dialects/ids | [EARLY ACCESS] ListDialectIds: List dialect identifiers matching an optional filter.
  *ScriptedTranslationApi* | [**list_translation_script_ids**](docs/ScriptedTranslationApi.md#list_translation_script_ids) | **GET** /api/scriptedtranslation/scripts/ids | [EARLY ACCESS] ListTranslationScriptIds: List translation script identifiers.
  *ScriptedTranslationApi* | [**translate_entities**](docs/ScriptedTranslationApi.md#translate_entities) | **POST** /api/scriptedtranslation/translateentities | [EARLY ACCESS] TranslateEntities: Translate a collection of entities with a specified translation script.
  *ScriptedTranslationApi* | [**translate_entities_inlined**](docs/ScriptedTranslationApi.md#translate_entities_inlined) | **POST** /api/scriptedtranslation/translateentitiesinlined | [EARLY ACCESS] TranslateEntitiesInlined: Translate a collection of entities, inlining the body of the translation script.
  *ScriptedTranslationApi* | [**upsert_translation_dialect**](docs/ScriptedTranslationApi.md#upsert_translation_dialect) | **POST** /api/scriptedtranslation/dialects | [EARLY ACCESS] UpsertTranslationDialect: Upsert a Dialect.
  *ScriptedTranslationApi* | [**upsert_translation_script**](docs/ScriptedTranslationApi.md#upsert_translation_script) | **POST** /api/scriptedtranslation/scripts | [EARLY ACCESS] UpsertTranslationScript: Upsert a translation script.
  *SearchApi* | [**instruments_search**](docs/SearchApi.md#instruments_search) | **POST** /api/search/instruments | [EARLY ACCESS] InstrumentsSearch: Instruments search
  *SearchApi* | [**search_portfolio_groups**](docs/SearchApi.md#search_portfolio_groups) | **GET** /api/search/portfoliogroups | SearchPortfolioGroups: Search Portfolio Groups
  *SearchApi* | [**search_portfolios**](docs/SearchApi.md#search_portfolios) | **GET** /api/search/portfolios | SearchPortfolios: Search Portfolios
  *SearchApi* | [**search_properties**](docs/SearchApi.md#search_properties) | **GET** /api/search/propertydefinitions | SearchProperties: Search Property Definitions
  *SequencesApi* | [**create_sequence**](docs/SequencesApi.md#create_sequence) | **POST** /api/sequences/{scope} | [EARLY ACCESS] CreateSequence: Create a new sequence
  *SequencesApi* | [**get_sequence**](docs/SequencesApi.md#get_sequence) | **GET** /api/sequences/{scope}/{code} | [EARLY ACCESS] GetSequence: Get a specified sequence
  *SequencesApi* | [**list_sequences**](docs/SequencesApi.md#list_sequences) | **GET** /api/sequences | [EARLY ACCESS] ListSequences: List Sequences
  *SequencesApi* | [**next**](docs/SequencesApi.md#next) | **GET** /api/sequences/{scope}/{code}/next | [EARLY ACCESS] Next: Get next values from sequence
  *StagedModificationsApi* | [**add_decision**](docs/StagedModificationsApi.md#add_decision) | **POST** /api/stagedmodifications/{id}/decision | [EXPERIMENTAL] AddDecision: AddDecision
  *StagedModificationsApi* | [**get_staged_modification**](docs/StagedModificationsApi.md#get_staged_modification) | **GET** /api/stagedmodifications/{id} | [EXPERIMENTAL] GetStagedModification: GetStagedModification
  *StagedModificationsApi* | [**list_requested_changes**](docs/StagedModificationsApi.md#list_requested_changes) | **GET** /api/stagedmodifications/{id}/requestedChanges | [EXPERIMENTAL] ListRequestedChanges: ListRequestedChanges
  *StagedModificationsApi* | [**list_staged_modifications**](docs/StagedModificationsApi.md#list_staged_modifications) | **GET** /api/stagedmodifications | [EXPERIMENTAL] ListStagedModifications: ListStagedModifications
  *StagingRuleSetApi* | [**create_staging_rule_set**](docs/StagingRuleSetApi.md#create_staging_rule_set) | **POST** /api/stagingrulesets/{entityType} | [EXPERIMENTAL] CreateStagingRuleSet: Create a StagingRuleSet
  *StagingRuleSetApi* | [**delete_staging_rule_set**](docs/StagingRuleSetApi.md#delete_staging_rule_set) | **DELETE** /api/stagingrulesets/{entityType} | [EXPERIMENTAL] DeleteStagingRuleSet: Delete a StagingRuleSet
  *StagingRuleSetApi* | [**get_staging_rule_set**](docs/StagingRuleSetApi.md#get_staging_rule_set) | **GET** /api/stagingrulesets/{entityType} | [EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet
  *StagingRuleSetApi* | [**list_staging_rule_sets**](docs/StagingRuleSetApi.md#list_staging_rule_sets) | **GET** /api/stagingrulesets | [EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets
  *StagingRuleSetApi* | [**update_staging_rule_set**](docs/StagingRuleSetApi.md#update_staging_rule_set) | **PUT** /api/stagingrulesets/{entityType} | [EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet
  *StructuredResultDataApi* | [**create_data_map**](docs/StructuredResultDataApi.md#create_data_map) | **POST** /api/unitresults/datamap/{scope} | CreateDataMap: Create data map
  *StructuredResultDataApi* | [**delete_structured_result_data**](docs/StructuredResultDataApi.md#delete_structured_result_data) | **POST** /api/unitresults/{scope}/$delete | [EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data
  *StructuredResultDataApi* | [**get_address_key_definitions_for_document**](docs/StructuredResultDataApi.md#get_address_key_definitions_for_document) | **GET** /api/unitresults/virtualdocument/{scope}/{code}/{source}/{resultType}/addresskeydefinitions | [EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document.
  *StructuredResultDataApi* | [**get_data_map**](docs/StructuredResultDataApi.md#get_data_map) | **POST** /api/unitresults/datamap/{scope}/$get | [EXPERIMENTAL] GetDataMap: Get data map
  *StructuredResultDataApi* | [**get_structured_result_data**](docs/StructuredResultDataApi.md#get_structured_result_data) | **POST** /api/unitresults/{scope}/$get | GetStructuredResultData: Get structured result data
  *StructuredResultDataApi* | [**get_virtual_document**](docs/StructuredResultDataApi.md#get_virtual_document) | **POST** /api/unitresults/virtualdocument/{scope}/$get | [EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents
  *StructuredResultDataApi* | [**get_virtual_document_rows**](docs/StructuredResultDataApi.md#get_virtual_document_rows) | **GET** /api/unitresults/virtualdocument/{scope}/{code}/{source}/{resultType} | [EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows
  *StructuredResultDataApi* | [**upsert_result_value**](docs/StructuredResultDataApi.md#upsert_result_value) | **POST** /api/unitresults/resultvalue/{scope} | [EXPERIMENTAL] UpsertResultValue: Upsert result value
  *StructuredResultDataApi* | [**upsert_structured_result_data**](docs/StructuredResultDataApi.md#upsert_structured_result_data) | **POST** /api/unitresults/{scope} | UpsertStructuredResultData: Upsert structured result data
  *SystemConfigurationApi* | [**create_configuration_transaction_type**](docs/SystemConfigurationApi.md#create_configuration_transaction_type) | **POST** /api/systemconfiguration/transactions/type | [EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type
  *SystemConfigurationApi* | [**create_side_definition**](docs/SystemConfigurationApi.md#create_side_definition) | **POST** /api/systemconfiguration/transactions/side | [EXPERIMENTAL] CreateSideDefinition: Create side definition
  *SystemConfigurationApi* | [**delete_transaction_configuration_source**](docs/SystemConfigurationApi.md#delete_transaction_configuration_source) | **DELETE** /api/systemconfiguration/transactions/type/{source} | [EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source
  *SystemConfigurationApi* | [**get_transaction_configuration_source**](docs/SystemConfigurationApi.md#get_transaction_configuration_source) | **GET** /api/systemconfiguration/transactions/type/{source} | [EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source
  *SystemConfigurationApi* | [**list_configuration_transaction_types**](docs/SystemConfigurationApi.md#list_configuration_transaction_types) | **GET** /api/systemconfiguration/transactions | [EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types
  *SystemConfigurationApi* | [**set_configuration_transaction_types**](docs/SystemConfigurationApi.md#set_configuration_transaction_types) | **PUT** /api/systemconfiguration/transactions | [EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types
  *SystemConfigurationApi* | [**set_transaction_configuration_source**](docs/SystemConfigurationApi.md#set_transaction_configuration_source) | **PUT** /api/systemconfiguration/transactions/type/{source} | [EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source
  *TaxRuleSetsApi* | [**create_tax_rule_set**](docs/TaxRuleSetsApi.md#create_tax_rule_set) | **POST** /api/tax/rulesets | [EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set.
  *TaxRuleSetsApi* | [**delete_tax_rule_set**](docs/TaxRuleSetsApi.md#delete_tax_rule_set) | **DELETE** /api/tax/rulesets/{scope}/{code} | [EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set.
  *TaxRuleSetsApi* | [**get_tax_rule_set**](docs/TaxRuleSetsApi.md#get_tax_rule_set) | **GET** /api/tax/rulesets/{scope}/{code} | [EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set.
  *TaxRuleSetsApi* | [**list_tax_rule_sets**](docs/TaxRuleSetsApi.md#list_tax_rule_sets) | **GET** /api/tax/rulesets | [EXPERIMENTAL] ListTaxRuleSets: List tax rule sets.
  *TaxRuleSetsApi* | [**update_tax_rule_set**](docs/TaxRuleSetsApi.md#update_tax_rule_set) | **PUT** /api/tax/rulesets/{scope}/{code} | [EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set.
  *TimelinesApi* | [**create_closed_period**](docs/TimelinesApi.md#create_closed_period) | **POST** /api/timelines/{scope}/{code}/closedperiods | [EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity
  *TimelinesApi* | [**create_timeline**](docs/TimelinesApi.md#create_timeline) | **POST** /api/timelines | [EXPERIMENTAL] CreateTimeline: Create a Timeline
  *TimelinesApi* | [**delete_timeline**](docs/TimelinesApi.md#delete_timeline) | **DELETE** /api/timelines/{scope}/{code} | [EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline
  *TimelinesApi* | [**get_closed_period**](docs/TimelinesApi.md#get_closed_period) | **GET** /api/timelines/{scope}/{code}/closedperiods/{closedPeriodId} | [EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity.
  *TimelinesApi* | [**get_timeline**](docs/TimelinesApi.md#get_timeline) | **GET** /api/timelines/{scope}/{code} | [EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code.
  *TimelinesApi* | [**update_timeline**](docs/TimelinesApi.md#update_timeline) | **PUT** /api/timelines/{scope}/{code} | [EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code
  *TransactionConfigurationApi* | [**delete_side_definition**](docs/TransactionConfigurationApi.md#delete_side_definition) | **DELETE** /api/transactionconfiguration/sides/{side}/$delete | DeleteSideDefinition: Delete the given side definition
  *TransactionConfigurationApi* | [**delete_transaction_type**](docs/TransactionConfigurationApi.md#delete_transaction_type) | **DELETE** /api/transactionconfiguration/types/{source}/{type} | DeleteTransactionType: Delete a transaction type
  *TransactionConfigurationApi* | [**delete_transaction_type_source**](docs/TransactionConfigurationApi.md#delete_transaction_type_source) | **DELETE** /api/transactionconfiguration/types/{source}/$delete | DeleteTransactionTypeSource: Delete all transaction types for the given source and scope
  *TransactionConfigurationApi* | [**get_side_definition**](docs/TransactionConfigurationApi.md#get_side_definition) | **GET** /api/transactionconfiguration/sides/{side} | GetSideDefinition: Get the side definition for a given side name( or label)
  *TransactionConfigurationApi* | [**get_transaction_type**](docs/TransactionConfigurationApi.md#get_transaction_type) | **GET** /api/transactionconfiguration/types/{source}/{type} | GetTransactionType: Get a single transaction configuration type
  *TransactionConfigurationApi* | [**list_side_definitions**](docs/TransactionConfigurationApi.md#list_side_definitions) | **GET** /api/transactionconfiguration/sides | ListSideDefinitions: List the side definitions
  *TransactionConfigurationApi* | [**list_transaction_types**](docs/TransactionConfigurationApi.md#list_transaction_types) | **GET** /api/transactionconfiguration/types | ListTransactionTypes: List transaction types
  *TransactionConfigurationApi* | [**set_side_definition**](docs/TransactionConfigurationApi.md#set_side_definition) | **PUT** /api/transactionconfiguration/sides/{side} | SetSideDefinition: Set a side definition
  *TransactionConfigurationApi* | [**set_side_definitions**](docs/TransactionConfigurationApi.md#set_side_definitions) | **PUT** /api/transactionconfiguration/sides | SetSideDefinitions: Set the given side definitions
  *TransactionConfigurationApi* | [**set_transaction_type**](docs/TransactionConfigurationApi.md#set_transaction_type) | **PUT** /api/transactionconfiguration/types/{source}/{type} | SetTransactionType: Set a specific transaction type
  *TransactionConfigurationApi* | [**set_transaction_type_source**](docs/TransactionConfigurationApi.md#set_transaction_type_source) | **PUT** /api/transactionconfiguration/types/{source} | SetTransactionTypeSource: Set the transaction types for the given source and scope
  *TransactionFeesApi* | [**delete_transaction_fee_rule**](docs/TransactionFeesApi.md#delete_transaction_fee_rule) | **DELETE** /api/transactions/fees/rules/{code} | [EXPERIMENTAL] DeleteTransactionFeeRule: Deletes a fee rule.
  *TransactionFeesApi* | [**get_applicable_transaction_fees**](docs/TransactionFeesApi.md#get_applicable_transaction_fees) | **POST** /api/transactions/fees/$GetApplicableFees | [EXPERIMENTAL] GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction.
  *TransactionFeesApi* | [**get_transaction_fee_rule**](docs/TransactionFeesApi.md#get_transaction_fee_rule) | **GET** /api/transactions/fees/rules/{code} | [EXPERIMENTAL] GetTransactionFeeRule: Retrieve the definition of single fee rule.
  *TransactionFeesApi* | [**list_transaction_fee_rules**](docs/TransactionFeesApi.md#list_transaction_fee_rules) | **GET** /api/transactions/fees/rules | [EXPERIMENTAL] ListTransactionFeeRules: List fee rules, with optional filtering.
  *TransactionFeesApi* | [**upsert_transaction_fee_rules**](docs/TransactionFeesApi.md#upsert_transaction_fee_rules) | **POST** /api/transactions/fees/rules | [EXPERIMENTAL] UpsertTransactionFeeRules: Upsert fee rules.
  *TransactionPortfoliosApi* | [**adjust_holdings**](docs/TransactionPortfoliosApi.md#adjust_holdings) | **POST** /api/transactionportfolios/{scope}/{code}/holdings | AdjustHoldings: Adjust holdings
  *TransactionPortfoliosApi* | [**batch_adjust_holdings**](docs/TransactionPortfoliosApi.md#batch_adjust_holdings) | **POST** /api/transactionportfolios/{scope}/{code}/holdings/$batchAdjust | [EARLY ACCESS] BatchAdjustHoldings: Batch adjust holdings
  *TransactionPortfoliosApi* | [**batch_create_trade_tickets**](docs/TransactionPortfoliosApi.md#batch_create_trade_tickets) | **POST** /api/transactionportfolios/{scope}/{code}/$batchtradetickets | [EARLY ACCESS] BatchCreateTradeTickets: Batch Create Trade Tickets
  *TransactionPortfoliosApi* | [**batch_set_holdings**](docs/TransactionPortfoliosApi.md#batch_set_holdings) | **POST** /api/transactionportfolios/{scope}/{code}/holdings/$batchSet | [EARLY ACCESS] BatchSetHoldings: Batch set holdings
  *TransactionPortfoliosApi* | [**batch_upsert_transactions**](docs/TransactionPortfoliosApi.md#batch_upsert_transactions) | **POST** /api/transactionportfolios/{scope}/{code}/transactions/$batchUpsert | [EARLY ACCESS] BatchUpsertTransactions: Batch upsert transactions
  *TransactionPortfoliosApi* | [**build_transactions**](docs/TransactionPortfoliosApi.md#build_transactions) | **POST** /api/transactionportfolios/{scope}/{code}/transactions/$build | BuildTransactions: Build transactions
  *TransactionPortfoliosApi* | [**cancel_adjust_holdings**](docs/TransactionPortfoliosApi.md#cancel_adjust_holdings) | **DELETE** /api/transactionportfolios/{scope}/{code}/holdings | CancelAdjustHoldings: Cancel adjust holdings
  *TransactionPortfoliosApi* | [**cancel_single_adjust_holding**](docs/TransactionPortfoliosApi.md#cancel_single_adjust_holding) | **POST** /api/transactionportfolios/{scope}/{code}/holdings/$cancelAdjustment | [EARLY ACCESS] CancelSingleAdjustHolding: Cancel single holding adjustment.
  *TransactionPortfoliosApi* | [**cancel_transactions**](docs/TransactionPortfoliosApi.md#cancel_transactions) | **DELETE** /api/transactionportfolios/{scope}/{code}/transactions | CancelTransactions: Cancel transactions
  *TransactionPortfoliosApi* | [**create_portfolio**](docs/TransactionPortfoliosApi.md#create_portfolio) | **POST** /api/transactionportfolios/{scope} | CreatePortfolio: Create portfolio
  *TransactionPortfoliosApi* | [**create_trade_ticket**](docs/TransactionPortfoliosApi.md#create_trade_ticket) | **POST** /api/transactionportfolios/{scope}/{code}/$tradeticket | [EARLY ACCESS] CreateTradeTicket: Create Trade Ticket
  *TransactionPortfoliosApi* | [**delete_custodian_accounts**](docs/TransactionPortfoliosApi.md#delete_custodian_accounts) | **POST** /api/transactionportfolios/{scope}/{code}/custodianaccounts/$delete | [EXPERIMENTAL] DeleteCustodianAccounts: Soft or hard delete multiple custodian accounts
  *TransactionPortfoliosApi* | [**delete_properties_from_transaction**](docs/TransactionPortfoliosApi.md#delete_properties_from_transaction) | **DELETE** /api/transactionportfolios/{scope}/{code}/transactions/{transactionId}/properties | DeletePropertiesFromTransaction: Delete properties from transaction
  *TransactionPortfoliosApi* | [**get_a2_b_data**](docs/TransactionPortfoliosApi.md#get_a2_b_data) | **GET** /api/transactionportfolios/{scope}/{code}/a2b | GetA2BData: Get A2B data
  *TransactionPortfoliosApi* | [**get_a2_b_movements**](docs/TransactionPortfoliosApi.md#get_a2_b_movements) | **GET** /api/transactionportfolios/{scope}/{code}/a2bmovements | GetA2BMovements: Get an A2B report at the movement level for the given portfolio.
  *TransactionPortfoliosApi* | [**get_bucketed_cash_flows**](docs/TransactionPortfoliosApi.md#get_bucketed_cash_flows) | **POST** /api/transactionportfolios/{scope}/{code}/bucketedCashFlows | [EXPERIMENTAL] GetBucketedCashFlows: Get bucketed cash flows from a list of portfolios
  *TransactionPortfoliosApi* | [**get_custodian_account**](docs/TransactionPortfoliosApi.md#get_custodian_account) | **GET** /api/transactionportfolios/{scope}/{code}/custodianaccounts/{custodianAccountScope}/{custodianAccountCode} | [EXPERIMENTAL] GetCustodianAccount: Get Custodian Account
  *TransactionPortfoliosApi* | [**get_details**](docs/TransactionPortfoliosApi.md#get_details) | **GET** /api/transactionportfolios/{scope}/{code}/details | GetDetails: Get details
  *TransactionPortfoliosApi* | [**get_holding_contributors**](docs/TransactionPortfoliosApi.md#get_holding_contributors) | **GET** /api/transactionportfolios/{scope}/{code}/holdings/{holdingId}/contributors | [EARLY ACCESS] GetHoldingContributors: Get Holdings Contributors
  *TransactionPortfoliosApi* | [**get_holdings**](docs/TransactionPortfoliosApi.md#get_holdings) | **GET** /api/transactionportfolios/{scope}/{code}/holdings | GetHoldings: Get holdings
  *TransactionPortfoliosApi* | [**get_holdings_adjustment**](docs/TransactionPortfoliosApi.md#get_holdings_adjustment) | **GET** /api/transactionportfolios/{scope}/{code}/holdingsadjustments/{effectiveAt} | GetHoldingsAdjustment: Get holdings adjustment
  *TransactionPortfoliosApi* | [**get_holdings_with_orders**](docs/TransactionPortfoliosApi.md#get_holdings_with_orders) | **GET** /api/transactionportfolios/{scope}/{code}/holdingsWithOrders | [EXPERIMENTAL] GetHoldingsWithOrders: Get holdings with orders
  *TransactionPortfoliosApi* | [**get_multiple_holding_contributors**](docs/TransactionPortfoliosApi.md#get_multiple_holding_contributors) | **POST** /api/transactionportfolios/{scope}/{code}/holdings/contributors/$get | [EARLY ACCESS] GetMultipleHoldingContributors: Get Multiple Holding Contributors
  *TransactionPortfoliosApi* | [**get_portfolio_cash_flows**](docs/TransactionPortfoliosApi.md#get_portfolio_cash_flows) | **GET** /api/transactionportfolios/{scope}/{code}/cashflows | GetPortfolioCashFlows: Get portfolio cash flows
  *TransactionPortfoliosApi* | [**get_portfolio_cash_ladder**](docs/TransactionPortfoliosApi.md#get_portfolio_cash_ladder) | **GET** /api/transactionportfolios/{scope}/{code}/cashladder | GetPortfolioCashLadder: Get portfolio cash ladder
  *TransactionPortfoliosApi* | [**get_portfolio_cash_statement**](docs/TransactionPortfoliosApi.md#get_portfolio_cash_statement) | **GET** /api/transactionportfolios/{scope}/{code}/cashstatement | GetPortfolioCashStatement: Get portfolio cash statement
  *TransactionPortfoliosApi* | [**get_transaction_history**](docs/TransactionPortfoliosApi.md#get_transaction_history) | **GET** /api/transactionportfolios/{scope}/{code}/transactions/{transactionId}/history | GetTransactionHistory: Get the history of a transaction
  *TransactionPortfoliosApi* | [**get_transactions**](docs/TransactionPortfoliosApi.md#get_transactions) | **GET** /api/transactionportfolios/{scope}/{code}/transactions | GetTransactions: Get transactions
  *TransactionPortfoliosApi* | [**get_upsertable_portfolio_cash_flows**](docs/TransactionPortfoliosApi.md#get_upsertable_portfolio_cash_flows) | **GET** /api/transactionportfolios/{scope}/{code}/upsertablecashflows | GetUpsertablePortfolioCashFlows: Get upsertable portfolio cash flows.
  *TransactionPortfoliosApi* | [**list_custodian_accounts**](docs/TransactionPortfoliosApi.md#list_custodian_accounts) | **GET** /api/transactionportfolios/{scope}/{code}/custodianaccounts | [EXPERIMENTAL] ListCustodianAccounts: List Custodian Accounts
  *TransactionPortfoliosApi* | [**list_holdings_adjustments**](docs/TransactionPortfoliosApi.md#list_holdings_adjustments) | **GET** /api/transactionportfolios/{scope}/{code}/holdingsadjustments | ListHoldingsAdjustments: List holdings adjustments
  *TransactionPortfoliosApi* | [**patch_portfolio_details**](docs/TransactionPortfoliosApi.md#patch_portfolio_details) | **PATCH** /api/transactionportfolios/{scope}/{code}/details | PatchPortfolioDetails: Patch portfolio details
  *TransactionPortfoliosApi* | [**preview_transaction**](docs/TransactionPortfoliosApi.md#preview_transaction) | **POST** /api/transactionportfolios/{scope}/{code}/previewTransaction | [EARLY ACCESS] PreviewTransaction: Preview a transaction
  *TransactionPortfoliosApi* | [**resolve_instrument**](docs/TransactionPortfoliosApi.md#resolve_instrument) | **POST** /api/transactionportfolios/{scope}/{code}/$resolve | ResolveInstrument: Resolve instrument
  *TransactionPortfoliosApi* | [**set_holdings**](docs/TransactionPortfoliosApi.md#set_holdings) | **PUT** /api/transactionportfolios/{scope}/{code}/holdings | SetHoldings: Set holdings
  *TransactionPortfoliosApi* | [**upsert_custodian_accounts**](docs/TransactionPortfoliosApi.md#upsert_custodian_accounts) | **POST** /api/transactionportfolios/{scope}/{code}/custodianaccounts | [EXPERIMENTAL] UpsertCustodianAccounts: Upsert Custodian Accounts
  *TransactionPortfoliosApi* | [**upsert_custodian_accounts_properties**](docs/TransactionPortfoliosApi.md#upsert_custodian_accounts_properties) | **POST** /api/transactionportfolios/{scope}/{code}/custodianaccounts/{custodianAccountScope}/{custodianAccountCode}/properties/$upsert | [EXPERIMENTAL] UpsertCustodianAccountsProperties: Upsert custodian accounts properties
  *TransactionPortfoliosApi* | [**upsert_portfolio_details**](docs/TransactionPortfoliosApi.md#upsert_portfolio_details) | **POST** /api/transactionportfolios/{scope}/{code}/details | UpsertPortfolioDetails: Upsert portfolio details
  *TransactionPortfoliosApi* | [**upsert_transaction_properties**](docs/TransactionPortfoliosApi.md#upsert_transaction_properties) | **POST** /api/transactionportfolios/{scope}/{code}/transactions/{transactionId}/properties | UpsertTransactionProperties: Upsert transaction properties
  *TransactionPortfoliosApi* | [**upsert_transactions**](docs/TransactionPortfoliosApi.md#upsert_transactions) | **POST** /api/transactionportfolios/{scope}/{code}/transactions | UpsertTransactions: Upsert transactions
  *TranslationApi* | [**translate_instrument_definitions**](docs/TranslationApi.md#translate_instrument_definitions) | **POST** /api/translation/instrumentdefinitions | [EXPERIMENTAL] TranslateInstrumentDefinitions: Translate instruments
  *TranslationApi* | [**translate_trade_tickets**](docs/TranslationApi.md#translate_trade_tickets) | **POST** /api/translation/tradetickets | [EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket
  *WorkspaceApi* | [**create_personal_item**](docs/WorkspaceApi.md#create_personal_item) | **POST** /api/workspaces/personal/{workspaceName}/items | [EXPERIMENTAL] CreatePersonalItem: Create a new item in a personal workspace.
  *WorkspaceApi* | [**create_personal_workspace**](docs/WorkspaceApi.md#create_personal_workspace) | **POST** /api/workspaces/personal | [EXPERIMENTAL] CreatePersonalWorkspace: Create a new personal workspace.
  *WorkspaceApi* | [**create_shared_item**](docs/WorkspaceApi.md#create_shared_item) | **POST** /api/workspaces/shared/{workspaceName}/items | [EXPERIMENTAL] CreateSharedItem: Create a new item in a shared workspace.
  *WorkspaceApi* | [**create_shared_workspace**](docs/WorkspaceApi.md#create_shared_workspace) | **POST** /api/workspaces/shared | [EXPERIMENTAL] CreateSharedWorkspace: Create a new shared workspace.
  *WorkspaceApi* | [**delete_personal_item**](docs/WorkspaceApi.md#delete_personal_item) | **DELETE** /api/workspaces/personal/{workspaceName}/items/{groupName}/{itemName} | [EXPERIMENTAL] DeletePersonalItem: Delete an item from a personal workspace.
  *WorkspaceApi* | [**delete_personal_workspace**](docs/WorkspaceApi.md#delete_personal_workspace) | **DELETE** /api/workspaces/personal/{workspaceName} | [EXPERIMENTAL] DeletePersonalWorkspace: Delete a personal workspace.
  *WorkspaceApi* | [**delete_shared_item**](docs/WorkspaceApi.md#delete_shared_item) | **DELETE** /api/workspaces/shared/{workspaceName}/items/{groupName}/{itemName} | [EXPERIMENTAL] DeleteSharedItem: Delete an item from a shared workspace.
  *WorkspaceApi* | [**delete_shared_workspace**](docs/WorkspaceApi.md#delete_shared_workspace) | **DELETE** /api/workspaces/shared/{workspaceName} | [EXPERIMENTAL] DeleteSharedWorkspace: Delete a shared workspace.
  *WorkspaceApi* | [**get_personal_item**](docs/WorkspaceApi.md#get_personal_item) | **GET** /api/workspaces/personal/{workspaceName}/items/{groupName}/{itemName} | [EXPERIMENTAL] GetPersonalItem: Get a single personal workspace item.
  *WorkspaceApi* | [**get_personal_workspace**](docs/WorkspaceApi.md#get_personal_workspace) | **GET** /api/workspaces/personal/{workspaceName} | [EXPERIMENTAL] GetPersonalWorkspace: Get a personal workspace.
  *WorkspaceApi* | [**get_shared_item**](docs/WorkspaceApi.md#get_shared_item) | **GET** /api/workspaces/shared/{workspaceName}/items/{groupName}/{itemName} | [EXPERIMENTAL] GetSharedItem: Get a single shared workspace item.
  *WorkspaceApi* | [**get_shared_workspace**](docs/WorkspaceApi.md#get_shared_workspace) | **GET** /api/workspaces/shared/{workspaceName} | [EXPERIMENTAL] GetSharedWorkspace: Get a shared workspace.
  *WorkspaceApi* | [**list_personal_items**](docs/WorkspaceApi.md#list_personal_items) | **GET** /api/workspaces/personal/{workspaceName}/items | [EXPERIMENTAL] ListPersonalItems: List the items in a personal workspace.
  *WorkspaceApi* | [**list_personal_workspaces**](docs/WorkspaceApi.md#list_personal_workspaces) | **GET** /api/workspaces/personal | [EXPERIMENTAL] ListPersonalWorkspaces: List personal workspaces.
  *WorkspaceApi* | [**list_shared_items**](docs/WorkspaceApi.md#list_shared_items) | **GET** /api/workspaces/shared/{workspaceName}/items | [EXPERIMENTAL] ListSharedItems: List the items in a shared workspace.
  *WorkspaceApi* | [**list_shared_workspaces**](docs/WorkspaceApi.md#list_shared_workspaces) | **GET** /api/workspaces/shared | [EXPERIMENTAL] ListSharedWorkspaces: List shared workspaces.
  *WorkspaceApi* | [**update_personal_item**](docs/WorkspaceApi.md#update_personal_item) | **PUT** /api/workspaces/personal/{workspaceName}/items/{groupName}/{itemName} | [EXPERIMENTAL] UpdatePersonalItem: Update an item in a personal workspace.
  *WorkspaceApi* | [**update_personal_workspace**](docs/WorkspaceApi.md#update_personal_workspace) | **PUT** /api/workspaces/personal/{workspaceName} | [EXPERIMENTAL] UpdatePersonalWorkspace: Update a personal workspace.
  *WorkspaceApi* | [**update_shared_item**](docs/WorkspaceApi.md#update_shared_item) | **PUT** /api/workspaces/shared/{workspaceName}/items/{groupName}/{itemName} | [EXPERIMENTAL] UpdateSharedItem: Update an item in a shared workspace.
  *WorkspaceApi* | [**update_shared_workspace**](docs/WorkspaceApi.md#update_shared_workspace) | **PUT** /api/workspaces/shared/{workspaceName} | [EXPERIMENTAL] UpdateSharedWorkspace: Update a shared workspace.
  <a id="documentation-for-models"></a>

   - [A2BBreakdown](docs/A2BBreakdown.md)
   - [A2BCategory](docs/A2BCategory.md)
   - [A2BDataRecord](docs/A2BDataRecord.md)
   - [A2BMovementRecord](docs/A2BMovementRecord.md)
   - [Abor](docs/Abor.md)
   - [AborConfiguration](docs/AborConfiguration.md)
   - [AborConfigurationProperties](docs/AborConfigurationProperties.md)
   - [AborConfigurationRequest](docs/AborConfigurationRequest.md)
   - [AborProperties](docs/AborProperties.md)
   - [AborRequest](docs/AborRequest.md)
   - [AcceptEstimateValuationPointResponse](docs/AcceptEstimateValuationPointResponse.md)
   - [AccessControlledAction](docs/AccessControlledAction.md)
   - [AccessControlledResource](docs/AccessControlledResource.md)
   - [AccessMetadataOperation](docs/AccessMetadataOperation.md)
   - [AccessMetadataValue](docs/AccessMetadataValue.md)
   - [Account](docs/Account.md)
   - [AccountProperties](docs/AccountProperties.md)
   - [AccountedTransaction](docs/AccountedTransaction.md)
   - [AccountingMethod](docs/AccountingMethod.md)
   - [AccountsUpsertResponse](docs/AccountsUpsertResponse.md)
   - [AccumulationEvent](docs/AccumulationEvent.md)
   - [ActionId](docs/ActionId.md)
   - [AddBusinessDaysToDateRequest](docs/AddBusinessDaysToDateRequest.md)
   - [AddBusinessDaysToDateResponse](docs/AddBusinessDaysToDateResponse.md)
   - [AdditionalPayment](docs/AdditionalPayment.md)
   - [AddressDefinition](docs/AddressDefinition.md)
   - [AddressKeyComplianceParameter](docs/AddressKeyComplianceParameter.md)
   - [AddressKeyDefinition](docs/AddressKeyDefinition.md)
   - [AddressKeyFilter](docs/AddressKeyFilter.md)
   - [AddressKeyList](docs/AddressKeyList.md)
   - [AddressKeyListComplianceParameter](docs/AddressKeyListComplianceParameter.md)
   - [AddressKeyOptionDefinition](docs/AddressKeyOptionDefinition.md)
   - [AdjustGlobalCommitmentEvent](docs/AdjustGlobalCommitmentEvent.md)
   - [AdjustHolding](docs/AdjustHolding.md)
   - [AdjustHoldingForDateRequest](docs/AdjustHoldingForDateRequest.md)
   - [AdjustHoldingRequest](docs/AdjustHoldingRequest.md)
   - [AggregateSpec](docs/AggregateSpec.md)
   - [AggregatedReturn](docs/AggregatedReturn.md)
   - [AggregatedReturnsDispersionRequest](docs/AggregatedReturnsDispersionRequest.md)
   - [AggregatedReturnsRequest](docs/AggregatedReturnsRequest.md)
   - [AggregatedReturnsResponse](docs/AggregatedReturnsResponse.md)
   - [AggregatedTransactionsRequest](docs/AggregatedTransactionsRequest.md)
   - [AggregationContext](docs/AggregationContext.md)
   - [AggregationMeasureFailureDetail](docs/AggregationMeasureFailureDetail.md)
   - [AggregationOp](docs/AggregationOp.md)
   - [AggregationOptions](docs/AggregationOptions.md)
   - [AggregationQuery](docs/AggregationQuery.md)
   - [AggregationType](docs/AggregationType.md)
   - [Allocation](docs/Allocation.md)
   - [AllocationRequest](docs/AllocationRequest.md)
   - [AllocationServiceRunResponse](docs/AllocationServiceRunResponse.md)
   - [AllocationSetRequest](docs/AllocationSetRequest.md)
   - [AmortisationEvent](docs/AmortisationEvent.md)
   - [AmortisationRule](docs/AmortisationRule.md)
   - [AmortisationRuleSet](docs/AmortisationRuleSet.md)
   - [Amount](docs/Amount.md)
   - [AnnulQuotesResponse](docs/AnnulQuotesResponse.md)
   - [AnnulSingleStructuredDataResponse](docs/AnnulSingleStructuredDataResponse.md)
   - [AnnulStructuredDataResponse](docs/AnnulStructuredDataResponse.md)
   - [ApplicableInstrumentEvent](docs/ApplicableInstrumentEvent.md)
   - [AssetClass](docs/AssetClass.md)
   - [AssetLeg](docs/AssetLeg.md)
   - [Barrier](docs/Barrier.md)
   - [Basket](docs/Basket.md)
   - [BasketIdentifier](docs/BasketIdentifier.md)
   - [BatchAdjustHoldingsResponse](docs/BatchAdjustHoldingsResponse.md)
   - [BatchUpdateUserReviewForComparisonResultRequest](docs/BatchUpdateUserReviewForComparisonResultRequest.md)
   - [BatchUpdateUserReviewForComparisonResultResponse](docs/BatchUpdateUserReviewForComparisonResultResponse.md)
   - [BatchUpsertDatesForCalendarResponse](docs/BatchUpsertDatesForCalendarResponse.md)
   - [BatchUpsertInstrumentPropertiesResponse](docs/BatchUpsertInstrumentPropertiesResponse.md)
   - [BatchUpsertPortfolioAccessMetadataRequest](docs/BatchUpsertPortfolioAccessMetadataRequest.md)
   - [BatchUpsertPortfolioAccessMetadataResponse](docs/BatchUpsertPortfolioAccessMetadataResponse.md)
   - [BatchUpsertPortfolioAccessMetadataResponseItem](docs/BatchUpsertPortfolioAccessMetadataResponseItem.md)
   - [BatchUpsertPortfolioTransactionsResponse](docs/BatchUpsertPortfolioTransactionsResponse.md)
   - [BatchUpsertPropertyDefinitionPropertiesResponse](docs/BatchUpsertPropertyDefinitionPropertiesResponse.md)
   - [Block](docs/Block.md)
   - [BlockAndOrderIdRequest](docs/BlockAndOrderIdRequest.md)
   - [BlockAndOrders](docs/BlockAndOrders.md)
   - [BlockAndOrdersCreateRequest](docs/BlockAndOrdersCreateRequest.md)
   - [BlockAndOrdersRequest](docs/BlockAndOrdersRequest.md)
   - [BlockRequest](docs/BlockRequest.md)
   - [BlockSetRequest](docs/BlockSetRequest.md)
   - [BlockedOrderRequest](docs/BlockedOrderRequest.md)
   - [Bond](docs/Bond.md)
   - [BondConversionEntry](docs/BondConversionEntry.md)
   - [BondConversionSchedule](docs/BondConversionSchedule.md)
   - [BondCouponEvent](docs/BondCouponEvent.md)
   - [BondDefaultEvent](docs/BondDefaultEvent.md)
   - [BondPrincipalEvent](docs/BondPrincipalEvent.md)
   - [BonusIssueEvent](docs/BonusIssueEvent.md)
   - [BookTransactionsRequest](docs/BookTransactionsRequest.md)
   - [BookTransactionsResponse](docs/BookTransactionsResponse.md)
   - [BoolComplianceParameter](docs/BoolComplianceParameter.md)
   - [BoolListComplianceParameter](docs/BoolListComplianceParameter.md)
   - [BranchStep](docs/BranchStep.md)
   - [BranchStepRequest](docs/BranchStepRequest.md)
   - [BreakCodeSource](docs/BreakCodeSource.md)
   - [BucketedCashFlowRequest](docs/BucketedCashFlowRequest.md)
   - [BucketedCashFlowResponse](docs/BucketedCashFlowResponse.md)
   - [BucketingSchedule](docs/BucketingSchedule.md)
   - [CalculationInfo](docs/CalculationInfo.md)
   - [Calendar](docs/Calendar.md)
   - [CalendarDate](docs/CalendarDate.md)
   - [CalendarDependency](docs/CalendarDependency.md)
   - [CallOnIntermediateSecuritiesEvent](docs/CallOnIntermediateSecuritiesEvent.md)
   - [CancelOrderAndMoveRemainingResult](docs/CancelOrderAndMoveRemainingResult.md)
   - [CancelOrdersAndMoveRemainingRequest](docs/CancelOrdersAndMoveRemainingRequest.md)
   - [CancelOrdersAndMoveRemainingResponse](docs/CancelOrdersAndMoveRemainingResponse.md)
   - [CancelOrdersResponse](docs/CancelOrdersResponse.md)
   - [CancelPlacementsResponse](docs/CancelPlacementsResponse.md)
   - [CancelSingleHoldingAdjustmentRequest](docs/CancelSingleHoldingAdjustmentRequest.md)
   - [CancelledOrderResult](docs/CancelledOrderResult.md)
   - [CancelledPlacementResult](docs/CancelledPlacementResult.md)
   - [CapFloor](docs/CapFloor.md)
   - [CapitalDistributionEvent](docs/CapitalDistributionEvent.md)
   - [Cash](docs/Cash.md)
   - [CashAndSecurityOfferElection](docs/CashAndSecurityOfferElection.md)
   - [CashDependency](docs/CashDependency.md)
   - [CashDividendEvent](docs/CashDividendEvent.md)
   - [CashElection](docs/CashElection.md)
   - [CashFlowEvent](docs/CashFlowEvent.md)
   - [CashFlowLineage](docs/CashFlowLineage.md)
   - [CashFlowValue](docs/CashFlowValue.md)
   - [CashFlowValueSet](docs/CashFlowValueSet.md)
   - [CashLadderRecord](docs/CashLadderRecord.md)
   - [CashOfferElection](docs/CashOfferElection.md)
   - [CashPerpetual](docs/CashPerpetual.md)
   - [CdsCreditEvent](docs/CdsCreditEvent.md)
   - [CdsFlowConventions](docs/CdsFlowConventions.md)
   - [CdsIndex](docs/CdsIndex.md)
   - [CdsProtectionDetailSpecification](docs/CdsProtectionDetailSpecification.md)
   - [CdxCreditEvent](docs/CdxCreditEvent.md)
   - [Change](docs/Change.md)
   - [ChangeHistory](docs/ChangeHistory.md)
   - [ChangeHistoryAction](docs/ChangeHistoryAction.md)
   - [ChangeInterval](docs/ChangeInterval.md)
   - [ChangeIntervalWithOrderManagementDetail](docs/ChangeIntervalWithOrderManagementDetail.md)
   - [ChangeItem](docs/ChangeItem.md)
   - [ChartOfAccounts](docs/ChartOfAccounts.md)
   - [ChartOfAccountsProperties](docs/ChartOfAccountsProperties.md)
   - [ChartOfAccountsRequest](docs/ChartOfAccountsRequest.md)
   - [CheckStep](docs/CheckStep.md)
   - [CheckStepRequest](docs/CheckStepRequest.md)
   - [CleardownModuleDetails](docs/CleardownModuleDetails.md)
   - [CleardownModuleRequest](docs/CleardownModuleRequest.md)
   - [CleardownModuleResponse](docs/CleardownModuleResponse.md)
   - [CleardownModuleRule](docs/CleardownModuleRule.md)
   - [CleardownModuleRulesUpdatedResponse](docs/CleardownModuleRulesUpdatedResponse.md)
   - [Client](docs/Client.md)
   - [CloseEvent](docs/CloseEvent.md)
   - [ClosePeriodDiaryEntryRequest](docs/ClosePeriodDiaryEntryRequest.md)
   - [ClosedPeriod](docs/ClosedPeriod.md)
   - [ComparisonAttributeValuePair](docs/ComparisonAttributeValuePair.md)
   - [CompletePortfolio](docs/CompletePortfolio.md)
   - [CompleteRelation](docs/CompleteRelation.md)
   - [CompleteRelationship](docs/CompleteRelationship.md)
   - [ComplexBond](docs/ComplexBond.md)
   - [ComplexMarketData](docs/ComplexMarketData.md)
   - [ComplexMarketDataId](docs/ComplexMarketDataId.md)
   - [ComplianceBreachedOrderInfo](docs/ComplianceBreachedOrderInfo.md)
   - [ComplianceParameter](docs/ComplianceParameter.md)
   - [ComplianceParameterType](docs/ComplianceParameterType.md)
   - [ComplianceRule](docs/ComplianceRule.md)
   - [ComplianceRuleBreakdown](docs/ComplianceRuleBreakdown.md)
   - [ComplianceRuleBreakdownRequest](docs/ComplianceRuleBreakdownRequest.md)
   - [ComplianceRuleResponse](docs/ComplianceRuleResponse.md)
   - [ComplianceRuleResult](docs/ComplianceRuleResult.md)
   - [ComplianceRuleResultDetail](docs/ComplianceRuleResultDetail.md)
   - [ComplianceRuleResultPortfolioDetail](docs/ComplianceRuleResultPortfolioDetail.md)
   - [ComplianceRuleResultV2](docs/ComplianceRuleResultV2.md)
   - [ComplianceRuleTemplate](docs/ComplianceRuleTemplate.md)
   - [ComplianceRuleUpsertRequest](docs/ComplianceRuleUpsertRequest.md)
   - [ComplianceRuleUpsertResponse](docs/ComplianceRuleUpsertResponse.md)
   - [ComplianceRunConfiguration](docs/ComplianceRunConfiguration.md)
   - [ComplianceRunInfo](docs/ComplianceRunInfo.md)
   - [ComplianceRunInfoV2](docs/ComplianceRunInfoV2.md)
   - [ComplianceStep](docs/ComplianceStep.md)
   - [ComplianceStepRequest](docs/ComplianceStepRequest.md)
   - [ComplianceStepType](docs/ComplianceStepType.md)
   - [ComplianceStepTypeRequest](docs/ComplianceStepTypeRequest.md)
   - [ComplianceSummaryRuleResult](docs/ComplianceSummaryRuleResult.md)
   - [ComplianceSummaryRuleResultRequest](docs/ComplianceSummaryRuleResultRequest.md)
   - [ComplianceTemplate](docs/ComplianceTemplate.md)
   - [ComplianceTemplateParameter](docs/ComplianceTemplateParameter.md)
   - [ComplianceTemplateVariation](docs/ComplianceTemplateVariation.md)
   - [ComplianceTemplateVariationDto](docs/ComplianceTemplateVariationDto.md)
   - [ComplianceTemplateVariationRequest](docs/ComplianceTemplateVariationRequest.md)
   - [ComponentFilter](docs/ComponentFilter.md)
   - [ComponentTransaction](docs/ComponentTransaction.md)
   - [CompositeBreakdown](docs/CompositeBreakdown.md)
   - [CompositeBreakdownRequest](docs/CompositeBreakdownRequest.md)
   - [CompositeBreakdownResponse](docs/CompositeBreakdownResponse.md)
   - [CompositeDispersion](docs/CompositeDispersion.md)
   - [CompositeDispersionResponse](docs/CompositeDispersionResponse.md)
   - [Compounding](docs/Compounding.md)
   - [ConfigurationRecipe](docs/ConfigurationRecipe.md)
   - [ConstantVolatilitySurface](docs/ConstantVolatilitySurface.md)
   - [ConstituentsAdjustmentHeader](docs/ConstituentsAdjustmentHeader.md)
   - [ContractDetails](docs/ContractDetails.md)
   - [ContractForDifference](docs/ContractForDifference.md)
   - [ContractInitialisationEvent](docs/ContractInitialisationEvent.md)
   - [ContributionToNonPassingRuleDetail](docs/ContributionToNonPassingRuleDetail.md)
   - [CorporateAction](docs/CorporateAction.md)
   - [CorporateActionSource](docs/CorporateActionSource.md)
   - [CorporateActionTransition](docs/CorporateActionTransition.md)
   - [CorporateActionTransitionComponent](docs/CorporateActionTransitionComponent.md)
   - [CorporateActionTransitionComponentRequest](docs/CorporateActionTransitionComponentRequest.md)
   - [CorporateActionTransitionRequest](docs/CorporateActionTransitionRequest.md)
   - [CounterpartyAgreement](docs/CounterpartyAgreement.md)
   - [CounterpartyRiskInformation](docs/CounterpartyRiskInformation.md)
   - [CounterpartySignatory](docs/CounterpartySignatory.md)
   - [CreateAddressKeyDefinitionRequest](docs/CreateAddressKeyDefinitionRequest.md)
   - [CreateAmortisationRuleSetRequest](docs/CreateAmortisationRuleSetRequest.md)
   - [CreateCalendarRequest](docs/CreateCalendarRequest.md)
   - [CreateClosedPeriodRequest](docs/CreateClosedPeriodRequest.md)
   - [CreateComplianceTemplateRequest](docs/CreateComplianceTemplateRequest.md)
   - [CreateCorporateActionSourceRequest](docs/CreateCorporateActionSourceRequest.md)
   - [CreateCustomEntityTypeRequest](docs/CreateCustomEntityTypeRequest.md)
   - [CreateCutLabelDefinitionRequest](docs/CreateCutLabelDefinitionRequest.md)
   - [CreateDataMapRequest](docs/CreateDataMapRequest.md)
   - [CreateDataTypeRequest](docs/CreateDataTypeRequest.md)
   - [CreateDateRequest](docs/CreateDateRequest.md)
   - [CreateDerivedPropertyDefinitionRequest](docs/CreateDerivedPropertyDefinitionRequest.md)
   - [CreateDerivedTransactionPortfolioRequest](docs/CreateDerivedTransactionPortfolioRequest.md)
   - [CreateGroupReconciliationComparisonRulesetRequest](docs/CreateGroupReconciliationComparisonRulesetRequest.md)
   - [CreateGroupReconciliationDefinitionRequest](docs/CreateGroupReconciliationDefinitionRequest.md)
   - [CreatePortfolioDetails](docs/CreatePortfolioDetails.md)
   - [CreatePortfolioGroupRequest](docs/CreatePortfolioGroupRequest.md)
   - [CreatePropertyDefinitionRequest](docs/CreatePropertyDefinitionRequest.md)
   - [CreateRecipeRequest](docs/CreateRecipeRequest.md)
   - [CreateReconciliationRequest](docs/CreateReconciliationRequest.md)
   - [CreateReferencePortfolioRequest](docs/CreateReferencePortfolioRequest.md)
   - [CreateRelationDefinitionRequest](docs/CreateRelationDefinitionRequest.md)
   - [CreateRelationRequest](docs/CreateRelationRequest.md)
   - [CreateRelationshipDefinitionRequest](docs/CreateRelationshipDefinitionRequest.md)
   - [CreateRelationshipRequest](docs/CreateRelationshipRequest.md)
   - [CreateSequenceRequest](docs/CreateSequenceRequest.md)
   - [CreateStagingRuleSetRequest](docs/CreateStagingRuleSetRequest.md)
   - [CreateTaxRuleSetRequest](docs/CreateTaxRuleSetRequest.md)
   - [CreateTimelineRequest](docs/CreateTimelineRequest.md)
   - [CreateTradeTicketsResponse](docs/CreateTradeTicketsResponse.md)
   - [CreateTransactionPortfolioRequest](docs/CreateTransactionPortfolioRequest.md)
   - [CreateUnitDefinition](docs/CreateUnitDefinition.md)
   - [CreditDefaultSwap](docs/CreditDefaultSwap.md)
   - [CreditPremiumCashFlowEvent](docs/CreditPremiumCashFlowEvent.md)
   - [CreditRating](docs/CreditRating.md)
   - [CreditSpreadCurveData](docs/CreditSpreadCurveData.md)
   - [CreditSupportAnnex](docs/CreditSupportAnnex.md)
   - [CriterionType](docs/CriterionType.md)
   - [CurrencyAndAmount](docs/CurrencyAndAmount.md)
   - [CurveOptions](docs/CurveOptions.md)
   - [CustodianAccount](docs/CustodianAccount.md)
   - [CustodianAccountProperties](docs/CustodianAccountProperties.md)
   - [CustodianAccountRequest](docs/CustodianAccountRequest.md)
   - [CustodianAccountsUpsertResponse](docs/CustodianAccountsUpsertResponse.md)
   - [CustomEntityDefinition](docs/CustomEntityDefinition.md)
   - [CustomEntityDefinitionRequest](docs/CustomEntityDefinitionRequest.md)
   - [CustomEntityEntity](docs/CustomEntityEntity.md)
   - [CustomEntityField](docs/CustomEntityField.md)
   - [CustomEntityFieldDefinition](docs/CustomEntityFieldDefinition.md)
   - [CustomEntityId](docs/CustomEntityId.md)
   - [CustomEntityRequest](docs/CustomEntityRequest.md)
   - [CustomEntityResponse](docs/CustomEntityResponse.md)
   - [CustomEntityType](docs/CustomEntityType.md)
   - [CutLabelDefinition](docs/CutLabelDefinition.md)
   - [CutLocalTime](docs/CutLocalTime.md)
   - [DataDefinition](docs/DataDefinition.md)
   - [DataMapKey](docs/DataMapKey.md)
   - [DataMapping](docs/DataMapping.md)
   - [DataScope](docs/DataScope.md)
   - [DataType](docs/DataType.md)
   - [DataTypeEntity](docs/DataTypeEntity.md)
   - [DataTypeSummary](docs/DataTypeSummary.md)
   - [DataTypeValueRange](docs/DataTypeValueRange.md)
   - [DateAttributes](docs/DateAttributes.md)
   - [DateOrDiaryEntry](docs/DateOrDiaryEntry.md)
   - [DateRange](docs/DateRange.md)
   - [DateTimeComparisonType](docs/DateTimeComparisonType.md)
   - [DateTimeComplianceParameter](docs/DateTimeComplianceParameter.md)
   - [DateTimeListComplianceParameter](docs/DateTimeListComplianceParameter.md)
   - [DayMonth](docs/DayMonth.md)
   - [DayOfWeek](docs/DayOfWeek.md)
   - [DecimalComplianceParameter](docs/DecimalComplianceParameter.md)
   - [DecimalList](docs/DecimalList.md)
   - [DecimalListComplianceParameter](docs/DecimalListComplianceParameter.md)
   - [DecoratedComplianceRunSummary](docs/DecoratedComplianceRunSummary.md)
   - [DeleteAccountsResponse](docs/DeleteAccountsResponse.md)
   - [DeleteCustodianAccountsResponse](docs/DeleteCustodianAccountsResponse.md)
   - [DeleteInstrumentPropertiesResponse](docs/DeleteInstrumentPropertiesResponse.md)
   - [DeleteInstrumentResponse](docs/DeleteInstrumentResponse.md)
   - [DeleteInstrumentsResponse](docs/DeleteInstrumentsResponse.md)
   - [DeleteModes](docs/DeleteModes.md)
   - [DeleteRelationRequest](docs/DeleteRelationRequest.md)
   - [DeleteRelationshipRequest](docs/DeleteRelationshipRequest.md)
   - [DeletedEntityResponse](docs/DeletedEntityResponse.md)
   - [DependencySourceFilter](docs/DependencySourceFilter.md)
   - [DescribedAddressKey](docs/DescribedAddressKey.md)
   - [Dialect](docs/Dialect.md)
   - [DialectId](docs/DialectId.md)
   - [DialectSchema](docs/DialectSchema.md)
   - [DiaryEntry](docs/DiaryEntry.md)
   - [DiaryEntryRequest](docs/DiaryEntryRequest.md)
   - [DiscountFactorCurveData](docs/DiscountFactorCurveData.md)
   - [DiscountingDependency](docs/DiscountingDependency.md)
   - [DiscountingMethod](docs/DiscountingMethod.md)
   - [DividendOptionEvent](docs/DividendOptionEvent.md)
   - [DividendReinvestmentEvent](docs/DividendReinvestmentEvent.md)
   - [DrawdownEvent](docs/DrawdownEvent.md)
   - [EarlyRedemptionElection](docs/EarlyRedemptionElection.md)
   - [EarlyRedemptionEvent](docs/EarlyRedemptionEvent.md)
   - [EconomicDependency](docs/EconomicDependency.md)
   - [EconomicDependencyType](docs/EconomicDependencyType.md)
   - [EconomicDependencyWithComplexMarketData](docs/EconomicDependencyWithComplexMarketData.md)
   - [EconomicDependencyWithQuote](docs/EconomicDependencyWithQuote.md)
   - [EffectiveRange](docs/EffectiveRange.md)
   - [ElectionSpecification](docs/ElectionSpecification.md)
   - [EligibilityCalculation](docs/EligibilityCalculation.md)
   - [EmptyModelOptions](docs/EmptyModelOptions.md)
   - [EntityIdentifier](docs/EntityIdentifier.md)
   - [Equity](docs/Equity.md)
   - [EquityAllOfIdentifiers](docs/EquityAllOfIdentifiers.md)
   - [EquityCurveByPricesData](docs/EquityCurveByPricesData.md)
   - [EquityCurveDependency](docs/EquityCurveDependency.md)
   - [EquityModelOptions](docs/EquityModelOptions.md)
   - [EquityOption](docs/EquityOption.md)
   - [EquitySwap](docs/EquitySwap.md)
   - [EquityVolDependency](docs/EquityVolDependency.md)
   - [EquityVolSurfaceData](docs/EquityVolSurfaceData.md)
   - [ErrorDetail](docs/ErrorDetail.md)
   - [EventDateRange](docs/EventDateRange.md)
   - [ExDividendConfiguration](docs/ExDividendConfiguration.md)
   - [ExchangeTradedOption](docs/ExchangeTradedOption.md)
   - [ExchangeTradedOptionContractDetails](docs/ExchangeTradedOptionContractDetails.md)
   - [Execution](docs/Execution.md)
   - [ExecutionRequest](docs/ExecutionRequest.md)
   - [ExecutionSetRequest](docs/ExecutionSetRequest.md)
   - [ExerciseEvent](docs/ExerciseEvent.md)
   - [ExoticInstrument](docs/ExoticInstrument.md)
   - [ExpandedGroup](docs/ExpandedGroup.md)
   - [ExpiryEvent](docs/ExpiryEvent.md)
   - [ExternalFeeComponentFilter](docs/ExternalFeeComponentFilter.md)
   - [Fee](docs/Fee.md)
   - [FeeAccrual](docs/FeeAccrual.md)
   - [FeeProperties](docs/FeeProperties.md)
   - [FeeRequest](docs/FeeRequest.md)
   - [FeeRule](docs/FeeRule.md)
   - [FeeRuleUpsertRequest](docs/FeeRuleUpsertRequest.md)
   - [FeeRuleUpsertResponse](docs/FeeRuleUpsertResponse.md)
   - [FeeTransactionTemplateSpecification](docs/FeeTransactionTemplateSpecification.md)
   - [FeeType](docs/FeeType.md)
   - [FeeTypeRequest](docs/FeeTypeRequest.md)
   - [FieldDefinition](docs/FieldDefinition.md)
   - [FieldSchema](docs/FieldSchema.md)
   - [FieldValue](docs/FieldValue.md)
   - [FileResponse](docs/FileResponse.md)
   - [FilterPredicateComplianceParameter](docs/FilterPredicateComplianceParameter.md)
   - [FilterStep](docs/FilterStep.md)
   - [FilterStepRequest](docs/FilterStepRequest.md)
   - [FixedLeg](docs/FixedLeg.md)
   - [FixedLegAllOfOverrides](docs/FixedLegAllOfOverrides.md)
   - [FixedSchedule](docs/FixedSchedule.md)
   - [FlexibleDeposit](docs/FlexibleDeposit.md)
   - [FlexibleLoan](docs/FlexibleLoan.md)
   - [FloatSchedule](docs/FloatSchedule.md)
   - [FloatingLeg](docs/FloatingLeg.md)
   - [FlowConventionName](docs/FlowConventionName.md)
   - [FlowConventions](docs/FlowConventions.md)
   - [ForwardRateAgreement](docs/ForwardRateAgreement.md)
   - [FromRecipe](docs/FromRecipe.md)
   - [Fund](docs/Fund.md)
   - [FundAmount](docs/FundAmount.md)
   - [FundConfiguration](docs/FundConfiguration.md)
   - [FundConfigurationProperties](docs/FundConfigurationProperties.md)
   - [FundConfigurationRequest](docs/FundConfigurationRequest.md)
   - [FundDetails](docs/FundDetails.md)
   - [FundIdList](docs/FundIdList.md)
   - [FundPnlBreakdown](docs/FundPnlBreakdown.md)
   - [FundPreviousNAV](docs/FundPreviousNAV.md)
   - [FundProperties](docs/FundProperties.md)
   - [FundRequest](docs/FundRequest.md)
   - [FundShareClass](docs/FundShareClass.md)
   - [FundValuationPointData](docs/FundValuationPointData.md)
   - [FundingLeg](docs/FundingLeg.md)
   - [FundingLegOptions](docs/FundingLegOptions.md)
   - [Future](docs/Future.md)
   - [FutureExpiryEvent](docs/FutureExpiryEvent.md)
   - [FutureMarkToMarketEvent](docs/FutureMarkToMarketEvent.md)
   - [FuturesContractDetails](docs/FuturesContractDetails.md)
   - [FxConventions](docs/FxConventions.md)
   - [FxDependency](docs/FxDependency.md)
   - [FxForward](docs/FxForward.md)
   - [FxForwardCurveByQuoteReference](docs/FxForwardCurveByQuoteReference.md)
   - [FxForwardCurveData](docs/FxForwardCurveData.md)
   - [FxForwardModelOptions](docs/FxForwardModelOptions.md)
   - [FxForwardPipsCurveData](docs/FxForwardPipsCurveData.md)
   - [FxForwardSettlementEvent](docs/FxForwardSettlementEvent.md)
   - [FxForwardTenorCurveData](docs/FxForwardTenorCurveData.md)
   - [FxForwardTenorPipsCurveData](docs/FxForwardTenorPipsCurveData.md)
   - [FxForwardsDependency](docs/FxForwardsDependency.md)
   - [FxLinkedNotionalSchedule](docs/FxLinkedNotionalSchedule.md)
   - [FxOption](docs/FxOption.md)
   - [FxRateSchedule](docs/FxRateSchedule.md)
   - [FxSwap](docs/FxSwap.md)
   - [FxTenorConvention](docs/FxTenorConvention.md)
   - [FxVolDependency](docs/FxVolDependency.md)
   - [FxVolSurfaceData](docs/FxVolSurfaceData.md)
   - [GeneralLedgerProfileMapping](docs/GeneralLedgerProfileMapping.md)
   - [GeneralLedgerProfileRequest](docs/GeneralLedgerProfileRequest.md)
   - [GeneralLedgerProfileResponse](docs/GeneralLedgerProfileResponse.md)
   - [GeneratedEventDiagnostics](docs/GeneratedEventDiagnostics.md)
   - [GetCdsFlowConventionsResponse](docs/GetCdsFlowConventionsResponse.md)
   - [GetComplexMarketDataResponse](docs/GetComplexMarketDataResponse.md)
   - [GetCounterpartyAgreementResponse](docs/GetCounterpartyAgreementResponse.md)
   - [GetCreditSupportAnnexResponse](docs/GetCreditSupportAnnexResponse.md)
   - [GetDataMapResponse](docs/GetDataMapResponse.md)
   - [GetFlowConventionsResponse](docs/GetFlowConventionsResponse.md)
   - [GetIndexConventionResponse](docs/GetIndexConventionResponse.md)
   - [GetInstrumentsResponse](docs/GetInstrumentsResponse.md)
   - [GetQuotesResponse](docs/GetQuotesResponse.md)
   - [GetRecipeComposerResponse](docs/GetRecipeComposerResponse.md)
   - [GetRecipeResponse](docs/GetRecipeResponse.md)
   - [GetReferencePortfolioConstituentsResponse](docs/GetReferencePortfolioConstituentsResponse.md)
   - [GetStructuredResultDataResponse](docs/GetStructuredResultDataResponse.md)
   - [GetVirtualDocumentResponse](docs/GetVirtualDocumentResponse.md)
   - [GroupBySelectorComplianceParameter](docs/GroupBySelectorComplianceParameter.md)
   - [GroupByStep](docs/GroupByStep.md)
   - [GroupByStepRequest](docs/GroupByStepRequest.md)
   - [GroupCalculationComplianceParameter](docs/GroupCalculationComplianceParameter.md)
   - [GroupFilterPredicateComplianceParameter](docs/GroupFilterPredicateComplianceParameter.md)
   - [GroupFilterStep](docs/GroupFilterStep.md)
   - [GroupFilterStepRequest](docs/GroupFilterStepRequest.md)
   - [GroupOfMarketDataKeyRules](docs/GroupOfMarketDataKeyRules.md)
   - [GroupReconciliationAggregateAttributeRule](docs/GroupReconciliationAggregateAttributeRule.md)
   - [GroupReconciliationAggregateAttributeValues](docs/GroupReconciliationAggregateAttributeValues.md)
   - [GroupReconciliationAggregateComparisonRuleOperand](docs/GroupReconciliationAggregateComparisonRuleOperand.md)
   - [GroupReconciliationComparisonResult](docs/GroupReconciliationComparisonResult.md)
   - [GroupReconciliationComparisonRuleStringValueMap](docs/GroupReconciliationComparisonRuleStringValueMap.md)
   - [GroupReconciliationComparisonRuleTolerance](docs/GroupReconciliationComparisonRuleTolerance.md)
   - [GroupReconciliationComparisonRuleset](docs/GroupReconciliationComparisonRuleset.md)
   - [GroupReconciliationCoreAttributeRule](docs/GroupReconciliationCoreAttributeRule.md)
   - [GroupReconciliationCoreAttributeValues](docs/GroupReconciliationCoreAttributeValues.md)
   - [GroupReconciliationCoreComparisonRuleOperand](docs/GroupReconciliationCoreComparisonRuleOperand.md)
   - [GroupReconciliationDatePair](docs/GroupReconciliationDatePair.md)
   - [GroupReconciliationDates](docs/GroupReconciliationDates.md)
   - [GroupReconciliationDefinition](docs/GroupReconciliationDefinition.md)
   - [GroupReconciliationDefinitionComparisonRulesetIds](docs/GroupReconciliationDefinitionComparisonRulesetIds.md)
   - [GroupReconciliationDefinitionCurrencies](docs/GroupReconciliationDefinitionCurrencies.md)
   - [GroupReconciliationDefinitionPortfolioEntityIds](docs/GroupReconciliationDefinitionPortfolioEntityIds.md)
   - [GroupReconciliationDefinitionRecipeIds](docs/GroupReconciliationDefinitionRecipeIds.md)
   - [GroupReconciliationInstanceId](docs/GroupReconciliationInstanceId.md)
   - [GroupReconciliationResultStatuses](docs/GroupReconciliationResultStatuses.md)
   - [GroupReconciliationResultTypes](docs/GroupReconciliationResultTypes.md)
   - [GroupReconciliationReviewStatuses](docs/GroupReconciliationReviewStatuses.md)
   - [GroupReconciliationRunDetails](docs/GroupReconciliationRunDetails.md)
   - [GroupReconciliationRunRequest](docs/GroupReconciliationRunRequest.md)
   - [GroupReconciliationRunResponse](docs/GroupReconciliationRunResponse.md)
   - [GroupReconciliationSummary](docs/GroupReconciliationSummary.md)
   - [GroupReconciliationUserReview](docs/GroupReconciliationUserReview.md)
   - [GroupReconciliationUserReviewAdd](docs/GroupReconciliationUserReviewAdd.md)
   - [GroupReconciliationUserReviewBreakCode](docs/GroupReconciliationUserReviewBreakCode.md)
   - [GroupReconciliationUserReviewComment](docs/GroupReconciliationUserReviewComment.md)
   - [GroupReconciliationUserReviewMatchKey](docs/GroupReconciliationUserReviewMatchKey.md)
   - [GroupReconciliationUserReviewRemove](docs/GroupReconciliationUserReviewRemove.md)
   - [GroupedResultOfAddressKey](docs/GroupedResultOfAddressKey.md)
   - [HoldingAdjustment](docs/HoldingAdjustment.md)
   - [HoldingAdjustmentWithDate](docs/HoldingAdjustmentWithDate.md)
   - [HoldingContext](docs/HoldingContext.md)
   - [HoldingContributor](docs/HoldingContributor.md)
   - [HoldingIdsRequest](docs/HoldingIdsRequest.md)
   - [HoldingPricingInfo](docs/HoldingPricingInfo.md)
   - [HoldingsAdjustment](docs/HoldingsAdjustment.md)
   - [HoldingsAdjustmentHeader](docs/HoldingsAdjustmentHeader.md)
   - [IUnitDefinitionDto](docs/IUnitDefinitionDto.md)
   - [IdSelectorDefinition](docs/IdSelectorDefinition.md)
   - [IdentifierPartSchema](docs/IdentifierPartSchema.md)
   - [IndexConvention](docs/IndexConvention.md)
   - [IndexModelOptions](docs/IndexModelOptions.md)
   - [IndexProjectionDependency](docs/IndexProjectionDependency.md)
   - [IndustryClassifier](docs/IndustryClassifier.md)
   - [InflationFixingDependency](docs/InflationFixingDependency.md)
   - [InflationIndexConventions](docs/InflationIndexConventions.md)
   - [InflationLeg](docs/InflationLeg.md)
   - [InflationLinkedBond](docs/InflationLinkedBond.md)
   - [InflationSwap](docs/InflationSwap.md)
   - [InformationalErrorEvent](docs/InformationalErrorEvent.md)
   - [InformationalEvent](docs/InformationalEvent.md)
   - [InlineValuationRequest](docs/InlineValuationRequest.md)
   - [InlineValuationsReconciliationRequest](docs/InlineValuationsReconciliationRequest.md)
   - [InputTransition](docs/InputTransition.md)
   - [Instrument](docs/Instrument.md)
   - [InstrumentCapabilities](docs/InstrumentCapabilities.md)
   - [InstrumentCashFlow](docs/InstrumentCashFlow.md)
   - [InstrumentDefinition](docs/InstrumentDefinition.md)
   - [InstrumentDefinitionFormat](docs/InstrumentDefinitionFormat.md)
   - [InstrumentDeleteModes](docs/InstrumentDeleteModes.md)
   - [InstrumentEntity](docs/InstrumentEntity.md)
   - [InstrumentEvent](docs/InstrumentEvent.md)
   - [InstrumentEventConfiguration](docs/InstrumentEventConfiguration.md)
   - [InstrumentEventHolder](docs/InstrumentEventHolder.md)
   - [InstrumentEventInstruction](docs/InstrumentEventInstruction.md)
   - [InstrumentEventInstructionRequest](docs/InstrumentEventInstructionRequest.md)
   - [InstrumentEventInstructionsResponse](docs/InstrumentEventInstructionsResponse.md)
   - [InstrumentEventType](docs/InstrumentEventType.md)
   - [InstrumentIdTypeDescriptor](docs/InstrumentIdTypeDescriptor.md)
   - [InstrumentIdValue](docs/InstrumentIdValue.md)
   - [InstrumentLeg](docs/InstrumentLeg.md)
   - [InstrumentList](docs/InstrumentList.md)
   - [InstrumentListComplianceParameter](docs/InstrumentListComplianceParameter.md)
   - [InstrumentMatch](docs/InstrumentMatch.md)
   - [InstrumentModels](docs/InstrumentModels.md)
   - [InstrumentPaymentDiary](docs/InstrumentPaymentDiary.md)
   - [InstrumentPaymentDiaryLeg](docs/InstrumentPaymentDiaryLeg.md)
   - [InstrumentPaymentDiaryRow](docs/InstrumentPaymentDiaryRow.md)
   - [InstrumentProperties](docs/InstrumentProperties.md)
   - [InstrumentResolutionDetail](docs/InstrumentResolutionDetail.md)
   - [InstrumentSearchProperty](docs/InstrumentSearchProperty.md)
   - [InstrumentType](docs/InstrumentType.md)
   - [InterestRateSwap](docs/InterestRateSwap.md)
   - [InterestRateSwaption](docs/InterestRateSwaption.md)
   - [IntermediateComplianceStep](docs/IntermediateComplianceStep.md)
   - [IntermediateComplianceStepRequest](docs/IntermediateComplianceStepRequest.md)
   - [IntermediateSecuritiesDistributionEvent](docs/IntermediateSecuritiesDistributionEvent.md)
   - [IrVolCubeData](docs/IrVolCubeData.md)
   - [IrVolDependency](docs/IrVolDependency.md)
   - [IsBusinessDayResponse](docs/IsBusinessDayResponse.md)
   - [JournalEntryLine](docs/JournalEntryLine.md)
   - [JournalEntryLinesQueryParameters](docs/JournalEntryLinesQueryParameters.md)
   - [LabelValueSet](docs/LabelValueSet.md)
   - [LapseElection](docs/LapseElection.md)
   - [LegDefinition](docs/LegDefinition.md)
   - [LegalEntity](docs/LegalEntity.md)
   - [LevelStep](docs/LevelStep.md)
   - [LifeCycleEventLineage](docs/LifeCycleEventLineage.md)
   - [LifeCycleEventValue](docs/LifeCycleEventValue.md)
   - [LineageMember](docs/LineageMember.md)
   - [Link](docs/Link.md)
   - [ListAggregationReconciliation](docs/ListAggregationReconciliation.md)
   - [ListAggregationResponse](docs/ListAggregationResponse.md)
   - [ListComplexMarketDataWithMetaDataResponse](docs/ListComplexMarketDataWithMetaDataResponse.md)
   - [LoanFacility](docs/LoanFacility.md)
   - [LoanInterestRepaymentEvent](docs/LoanInterestRepaymentEvent.md)
   - [LoanPeriod](docs/LoanPeriod.md)
   - [LockPeriodDiaryEntryRequest](docs/LockPeriodDiaryEntryRequest.md)
   - [LusidInstrument](docs/LusidInstrument.md)
   - [LusidProblemDetails](docs/LusidProblemDetails.md)
   - [LusidTradeTicket](docs/LusidTradeTicket.md)
   - [LusidUniqueId](docs/LusidUniqueId.md)
   - [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)
   - [MappedString](docs/MappedString.md)
   - [Mapping](docs/Mapping.md)
   - [MappingRule](docs/MappingRule.md)
   - [MarkToMarketConventions](docs/MarkToMarketConventions.md)
   - [MarketContext](docs/MarketContext.md)
   - [MarketContextSuppliers](docs/MarketContextSuppliers.md)
   - [MarketDataKeyRule](docs/MarketDataKeyRule.md)
   - [MarketDataOptions](docs/MarketDataOptions.md)
   - [MarketDataOptionsType](docs/MarketDataOptionsType.md)
   - [MarketDataOverrides](docs/MarketDataOverrides.md)
   - [MarketDataSpecificRule](docs/MarketDataSpecificRule.md)
   - [MarketDataType](docs/MarketDataType.md)
   - [MarketObservableType](docs/MarketObservableType.md)
   - [MarketOptions](docs/MarketOptions.md)
   - [MarketQuote](docs/MarketQuote.md)
   - [MasteredInstrument](docs/MasteredInstrument.md)
   - [MatchCriterion](docs/MatchCriterion.md)
   - [MaturityEvent](docs/MaturityEvent.md)
   - [MbsCouponEvent](docs/MbsCouponEvent.md)
   - [MbsInterestDeferralEvent](docs/MbsInterestDeferralEvent.md)
   - [MbsInterestShortfallEvent](docs/MbsInterestShortfallEvent.md)
   - [MbsPrincipalEvent](docs/MbsPrincipalEvent.md)
   - [MbsPrincipalWriteOffEvent](docs/MbsPrincipalWriteOffEvent.md)
   - [MergerEvent](docs/MergerEvent.md)
   - [MetricValue](docs/MetricValue.md)
   - [ModelOptions](docs/ModelOptions.md)
   - [ModelOptionsType](docs/ModelOptionsType.md)
   - [ModelProperty](docs/ModelProperty.md)
   - [ModelSchema](docs/ModelSchema.md)
   - [ModelSelection](docs/ModelSelection.md)
   - [MoveOrdersToDifferentBlocksRequest](docs/MoveOrdersToDifferentBlocksRequest.md)
   - [MovedOrderToDifferentBlockResponse](docs/MovedOrderToDifferentBlockResponse.md)
   - [MovementType](docs/MovementType.md)
   - [MultiCurrencyAmounts](docs/MultiCurrencyAmounts.md)
   - [NewInstrument](docs/NewInstrument.md)
   - [NextValueInSequenceResponse](docs/NextValueInSequenceResponse.md)
   - [NumericComparisonType](docs/NumericComparisonType.md)
   - [OpaqueDependency](docs/OpaqueDependency.md)
   - [OpaqueMarketData](docs/OpaqueMarketData.md)
   - [OpaqueModelOptions](docs/OpaqueModelOptions.md)
   - [OpenEvent](docs/OpenEvent.md)
   - [OperandType](docs/OperandType.md)
   - [Operation](docs/Operation.md)
   - [OperationType](docs/OperationType.md)
   - [Operator](docs/Operator.md)
   - [OptionEntry](docs/OptionEntry.md)
   - [OptionExerciseCashEvent](docs/OptionExerciseCashEvent.md)
   - [OptionExerciseElection](docs/OptionExerciseElection.md)
   - [OptionExercisePhysicalEvent](docs/OptionExercisePhysicalEvent.md)
   - [OptionalitySchedule](docs/OptionalitySchedule.md)
   - [Order](docs/Order.md)
   - [OrderBySpec](docs/OrderBySpec.md)
   - [OrderFlowConfiguration](docs/OrderFlowConfiguration.md)
   - [OrderGraphBlock](docs/OrderGraphBlock.md)
   - [OrderGraphBlockAllocationDetail](docs/OrderGraphBlockAllocationDetail.md)
   - [OrderGraphBlockAllocationSynopsis](docs/OrderGraphBlockAllocationSynopsis.md)
   - [OrderGraphBlockExecutionDetail](docs/OrderGraphBlockExecutionDetail.md)
   - [OrderGraphBlockExecutionSynopsis](docs/OrderGraphBlockExecutionSynopsis.md)
   - [OrderGraphBlockOrderDetail](docs/OrderGraphBlockOrderDetail.md)
   - [OrderGraphBlockOrderSynopsis](docs/OrderGraphBlockOrderSynopsis.md)
   - [OrderGraphBlockPlacementDetail](docs/OrderGraphBlockPlacementDetail.md)
   - [OrderGraphBlockPlacementSynopsis](docs/OrderGraphBlockPlacementSynopsis.md)
   - [OrderGraphBlockTransactionDetail](docs/OrderGraphBlockTransactionDetail.md)
   - [OrderGraphBlockTransactionSynopsis](docs/OrderGraphBlockTransactionSynopsis.md)
   - [OrderGraphPlacement](docs/OrderGraphPlacement.md)
   - [OrderGraphPlacementAllocationDetail](docs/OrderGraphPlacementAllocationDetail.md)
   - [OrderGraphPlacementAllocationSynopsis](docs/OrderGraphPlacementAllocationSynopsis.md)
   - [OrderGraphPlacementChildPlacementDetail](docs/OrderGraphPlacementChildPlacementDetail.md)
   - [OrderGraphPlacementExecutionDetail](docs/OrderGraphPlacementExecutionDetail.md)
   - [OrderGraphPlacementExecutionSynopsis](docs/OrderGraphPlacementExecutionSynopsis.md)
   - [OrderGraphPlacementOrderDetail](docs/OrderGraphPlacementOrderDetail.md)
   - [OrderGraphPlacementOrderSynopsis](docs/OrderGraphPlacementOrderSynopsis.md)
   - [OrderGraphPlacementPlacementSynopsis](docs/OrderGraphPlacementPlacementSynopsis.md)
   - [OrderInstruction](docs/OrderInstruction.md)
   - [OrderInstructionRequest](docs/OrderInstructionRequest.md)
   - [OrderInstructionSetRequest](docs/OrderInstructionSetRequest.md)
   - [OrderRequest](docs/OrderRequest.md)
   - [OrderSetRequest](docs/OrderSetRequest.md)
   - [OrderUpdateRequest](docs/OrderUpdateRequest.md)
   - [OtcConfirmation](docs/OtcConfirmation.md)
   - [OutputTransaction](docs/OutputTransaction.md)
   - [OutputTransition](docs/OutputTransition.md)
   - [Package](docs/Package.md)
   - [PackageRequest](docs/PackageRequest.md)
   - [PackageSetRequest](docs/PackageSetRequest.md)
   - [PagedResourceListOfAbor](docs/PagedResourceListOfAbor.md)
   - [PagedResourceListOfAborConfiguration](docs/PagedResourceListOfAborConfiguration.md)
   - [PagedResourceListOfAccount](docs/PagedResourceListOfAccount.md)
   - [PagedResourceListOfAddressKeyDefinition](docs/PagedResourceListOfAddressKeyDefinition.md)
   - [PagedResourceListOfAllocation](docs/PagedResourceListOfAllocation.md)
   - [PagedResourceListOfAmortisationRuleSet](docs/PagedResourceListOfAmortisationRuleSet.md)
   - [PagedResourceListOfBlock](docs/PagedResourceListOfBlock.md)
   - [PagedResourceListOfCalendar](docs/PagedResourceListOfCalendar.md)
   - [PagedResourceListOfChartOfAccounts](docs/PagedResourceListOfChartOfAccounts.md)
   - [PagedResourceListOfCleardownModuleResponse](docs/PagedResourceListOfCleardownModuleResponse.md)
   - [PagedResourceListOfCleardownModuleRule](docs/PagedResourceListOfCleardownModuleRule.md)
   - [PagedResourceListOfComplianceRuleResponse](docs/PagedResourceListOfComplianceRuleResponse.md)
   - [PagedResourceListOfComplianceRunInfoV2](docs/PagedResourceListOfComplianceRunInfoV2.md)
   - [PagedResourceListOfComplianceTemplate](docs/PagedResourceListOfComplianceTemplate.md)
   - [PagedResourceListOfCorporateActionSource](docs/PagedResourceListOfCorporateActionSource.md)
   - [PagedResourceListOfCustodianAccount](docs/PagedResourceListOfCustodianAccount.md)
   - [PagedResourceListOfCustomEntityDefinition](docs/PagedResourceListOfCustomEntityDefinition.md)
   - [PagedResourceListOfCustomEntityResponse](docs/PagedResourceListOfCustomEntityResponse.md)
   - [PagedResourceListOfCustomEntityType](docs/PagedResourceListOfCustomEntityType.md)
   - [PagedResourceListOfCutLabelDefinition](docs/PagedResourceListOfCutLabelDefinition.md)
   - [PagedResourceListOfDataTypeSummary](docs/PagedResourceListOfDataTypeSummary.md)
   - [PagedResourceListOfDialectId](docs/PagedResourceListOfDialectId.md)
   - [PagedResourceListOfDiaryEntry](docs/PagedResourceListOfDiaryEntry.md)
   - [PagedResourceListOfExecution](docs/PagedResourceListOfExecution.md)
   - [PagedResourceListOfFee](docs/PagedResourceListOfFee.md)
   - [PagedResourceListOfFeeType](docs/PagedResourceListOfFeeType.md)
   - [PagedResourceListOfFund](docs/PagedResourceListOfFund.md)
   - [PagedResourceListOfFundConfiguration](docs/PagedResourceListOfFundConfiguration.md)
   - [PagedResourceListOfGeneralLedgerProfileResponse](docs/PagedResourceListOfGeneralLedgerProfileResponse.md)
   - [PagedResourceListOfGroupReconciliationComparisonResult](docs/PagedResourceListOfGroupReconciliationComparisonResult.md)
   - [PagedResourceListOfGroupReconciliationComparisonRuleset](docs/PagedResourceListOfGroupReconciliationComparisonRuleset.md)
   - [PagedResourceListOfGroupReconciliationDefinition](docs/PagedResourceListOfGroupReconciliationDefinition.md)
   - [PagedResourceListOfInstrument](docs/PagedResourceListOfInstrument.md)
   - [PagedResourceListOfInstrumentEventHolder](docs/PagedResourceListOfInstrumentEventHolder.md)
   - [PagedResourceListOfInstrumentEventInstruction](docs/PagedResourceListOfInstrumentEventInstruction.md)
   - [PagedResourceListOfLegalEntity](docs/PagedResourceListOfLegalEntity.md)
   - [PagedResourceListOfOrder](docs/PagedResourceListOfOrder.md)
   - [PagedResourceListOfOrderGraphBlock](docs/PagedResourceListOfOrderGraphBlock.md)
   - [PagedResourceListOfOrderGraphPlacement](docs/PagedResourceListOfOrderGraphPlacement.md)
   - [PagedResourceListOfOrderInstruction](docs/PagedResourceListOfOrderInstruction.md)
   - [PagedResourceListOfPackage](docs/PagedResourceListOfPackage.md)
   - [PagedResourceListOfParticipation](docs/PagedResourceListOfParticipation.md)
   - [PagedResourceListOfPerson](docs/PagedResourceListOfPerson.md)
   - [PagedResourceListOfPlacement](docs/PagedResourceListOfPlacement.md)
   - [PagedResourceListOfPortfolioGroup](docs/PagedResourceListOfPortfolioGroup.md)
   - [PagedResourceListOfPortfolioGroupSearchResult](docs/PagedResourceListOfPortfolioGroupSearchResult.md)
   - [PagedResourceListOfPortfolioSearchResult](docs/PagedResourceListOfPortfolioSearchResult.md)
   - [PagedResourceListOfPostingModuleResponse](docs/PagedResourceListOfPostingModuleResponse.md)
   - [PagedResourceListOfPostingModuleRule](docs/PagedResourceListOfPostingModuleRule.md)
   - [PagedResourceListOfPropertyDefinition](docs/PagedResourceListOfPropertyDefinition.md)
   - [PagedResourceListOfPropertyDefinitionSearchResult](docs/PagedResourceListOfPropertyDefinitionSearchResult.md)
   - [PagedResourceListOfReconciliation](docs/PagedResourceListOfReconciliation.md)
   - [PagedResourceListOfReferenceListResponse](docs/PagedResourceListOfReferenceListResponse.md)
   - [PagedResourceListOfRelationshipDefinition](docs/PagedResourceListOfRelationshipDefinition.md)
   - [PagedResourceListOfSequenceDefinition](docs/PagedResourceListOfSequenceDefinition.md)
   - [PagedResourceListOfStagedModification](docs/PagedResourceListOfStagedModification.md)
   - [PagedResourceListOfStagedModificationsRequestedChangeInterval](docs/PagedResourceListOfStagedModificationsRequestedChangeInterval.md)
   - [PagedResourceListOfStagingRuleSet](docs/PagedResourceListOfStagingRuleSet.md)
   - [PagedResourceListOfTransactionTemplate](docs/PagedResourceListOfTransactionTemplate.md)
   - [PagedResourceListOfTransactionTemplateSpecification](docs/PagedResourceListOfTransactionTemplateSpecification.md)
   - [PagedResourceListOfTranslationScriptId](docs/PagedResourceListOfTranslationScriptId.md)
   - [PagedResourceListOfValuationPointOverview](docs/PagedResourceListOfValuationPointOverview.md)
   - [PagedResourceListOfVirtualRow](docs/PagedResourceListOfVirtualRow.md)
   - [PagedResourceListOfWorkspace](docs/PagedResourceListOfWorkspace.md)
   - [PagedResourceListOfWorkspaceItem](docs/PagedResourceListOfWorkspaceItem.md)
   - [Participation](docs/Participation.md)
   - [ParticipationRequest](docs/ParticipationRequest.md)
   - [ParticipationSetRequest](docs/ParticipationSetRequest.md)
   - [PercentCheckStep](docs/PercentCheckStep.md)
   - [PercentCheckStepRequest](docs/PercentCheckStepRequest.md)
   - [PerformanceReturn](docs/PerformanceReturn.md)
   - [PerformanceReturnsMetric](docs/PerformanceReturnsMetric.md)
   - [PeriodDiaryEntriesReopenedResponse](docs/PeriodDiaryEntriesReopenedResponse.md)
   - [PeriodType](docs/PeriodType.md)
   - [PerpetualEntityState](docs/PerpetualEntityState.md)
   - [PerpetualProperty](docs/PerpetualProperty.md)
   - [Person](docs/Person.md)
   - [PlaceBlocksRequest](docs/PlaceBlocksRequest.md)
   - [Placement](docs/Placement.md)
   - [PlacementRequest](docs/PlacementRequest.md)
   - [PlacementSetRequest](docs/PlacementSetRequest.md)
   - [PlacementUpdateRequest](docs/PlacementUpdateRequest.md)
   - [PnlJournalEntryLine](docs/PnlJournalEntryLine.md)
   - [Portfolio](docs/Portfolio.md)
   - [PortfolioCashFlow](docs/PortfolioCashFlow.md)
   - [PortfolioCashLadder](docs/PortfolioCashLadder.md)
   - [PortfolioDetails](docs/PortfolioDetails.md)
   - [PortfolioEntity](docs/PortfolioEntity.md)
   - [PortfolioEntityId](docs/PortfolioEntityId.md)
   - [PortfolioGroup](docs/PortfolioGroup.md)
   - [PortfolioGroupIdComplianceParameter](docs/PortfolioGroupIdComplianceParameter.md)
   - [PortfolioGroupIdList](docs/PortfolioGroupIdList.md)
   - [PortfolioGroupIdListComplianceParameter](docs/PortfolioGroupIdListComplianceParameter.md)
   - [PortfolioGroupProperties](docs/PortfolioGroupProperties.md)
   - [PortfolioGroupSearchResult](docs/PortfolioGroupSearchResult.md)
   - [PortfolioHolding](docs/PortfolioHolding.md)
   - [PortfolioId](docs/PortfolioId.md)
   - [PortfolioIdComplianceParameter](docs/PortfolioIdComplianceParameter.md)
   - [PortfolioIdList](docs/PortfolioIdList.md)
   - [PortfolioIdListComplianceParameter](docs/PortfolioIdListComplianceParameter.md)
   - [PortfolioProperties](docs/PortfolioProperties.md)
   - [PortfolioReconciliationRequest](docs/PortfolioReconciliationRequest.md)
   - [PortfolioResultDataKeyRule](docs/PortfolioResultDataKeyRule.md)
   - [PortfolioReturnBreakdown](docs/PortfolioReturnBreakdown.md)
   - [PortfolioSearchResult](docs/PortfolioSearchResult.md)
   - [PortfolioTradeTicket](docs/PortfolioTradeTicket.md)
   - [PortfolioType](docs/PortfolioType.md)
   - [PortfolioWithoutHref](docs/PortfolioWithoutHref.md)
   - [PortfoliosReconciliationRequest](docs/PortfoliosReconciliationRequest.md)
   - [PostingModuleDetails](docs/PostingModuleDetails.md)
   - [PostingModuleRequest](docs/PostingModuleRequest.md)
   - [PostingModuleResponse](docs/PostingModuleResponse.md)
   - [PostingModuleRule](docs/PostingModuleRule.md)
   - [PostingModuleRulesUpdatedResponse](docs/PostingModuleRulesUpdatedResponse.md)
   - [PreTradeConfiguration](docs/PreTradeConfiguration.md)
   - [Premium](docs/Premium.md)
   - [PreviousFundValuationPointData](docs/PreviousFundValuationPointData.md)
   - [PreviousNAV](docs/PreviousNAV.md)
   - [PreviousShareClassBreakdown](docs/PreviousShareClassBreakdown.md)
   - [PricingContext](docs/PricingContext.md)
   - [PricingModel](docs/PricingModel.md)
   - [PricingOptions](docs/PricingOptions.md)
   - [ProcessedCommand](docs/ProcessedCommand.md)
   - [PropertyDefinition](docs/PropertyDefinition.md)
   - [PropertyDefinitionEntity](docs/PropertyDefinitionEntity.md)
   - [PropertyDefinitionSearchResult](docs/PropertyDefinitionSearchResult.md)
   - [PropertyDefinitionType](docs/PropertyDefinitionType.md)
   - [PropertyDomain](docs/PropertyDomain.md)
   - [PropertyFilter](docs/PropertyFilter.md)
   - [PropertyInterval](docs/PropertyInterval.md)
   - [PropertyKeyComplianceParameter](docs/PropertyKeyComplianceParameter.md)
   - [PropertyKeyListComplianceParameter](docs/PropertyKeyListComplianceParameter.md)
   - [PropertyLifeTime](docs/PropertyLifeTime.md)
   - [PropertyList](docs/PropertyList.md)
   - [PropertyListComplianceParameter](docs/PropertyListComplianceParameter.md)
   - [PropertySchema](docs/PropertySchema.md)
   - [PropertyType](docs/PropertyType.md)
   - [PropertyValue](docs/PropertyValue.md)
   - [PropertyValueEquals](docs/PropertyValueEquals.md)
   - [PropertyValueIn](docs/PropertyValueIn.md)
   - [ProtectionPayoutCashFlowEvent](docs/ProtectionPayoutCashFlowEvent.md)
   - [QueryApplicableInstrumentEventsRequest](docs/QueryApplicableInstrumentEventsRequest.md)
   - [QueryBucketedCashFlowsRequest](docs/QueryBucketedCashFlowsRequest.md)
   - [QueryCashFlowsRequest](docs/QueryCashFlowsRequest.md)
   - [QueryInstrumentEventsRequest](docs/QueryInstrumentEventsRequest.md)
   - [QueryTradeTicketsRequest](docs/QueryTradeTicketsRequest.md)
   - [QueryableKey](docs/QueryableKey.md)
   - [Quote](docs/Quote.md)
   - [QuoteAccessMetadataRule](docs/QuoteAccessMetadataRule.md)
   - [QuoteAccessMetadataRuleId](docs/QuoteAccessMetadataRuleId.md)
   - [QuoteDependency](docs/QuoteDependency.md)
   - [QuoteId](docs/QuoteId.md)
   - [QuoteInstrumentIdType](docs/QuoteInstrumentIdType.md)
   - [QuoteSeriesId](docs/QuoteSeriesId.md)
   - [QuoteType](docs/QuoteType.md)
   - [RawVendorEvent](docs/RawVendorEvent.md)
   - [ReOpenPeriodDiaryEntryRequest](docs/ReOpenPeriodDiaryEntryRequest.md)
   - [RealisedGainLoss](docs/RealisedGainLoss.md)
   - [RecipeBlock](docs/RecipeBlock.md)
   - [RecipeComposer](docs/RecipeComposer.md)
   - [RecipeValue](docs/RecipeValue.md)
   - [RecombineStep](docs/RecombineStep.md)
   - [ReconcileDateTimeRule](docs/ReconcileDateTimeRule.md)
   - [ReconcileNumericRule](docs/ReconcileNumericRule.md)
   - [ReconcileStringRule](docs/ReconcileStringRule.md)
   - [ReconciledTransaction](docs/ReconciledTransaction.md)
   - [Reconciliation](docs/Reconciliation.md)
   - [ReconciliationBreak](docs/ReconciliationBreak.md)
   - [ReconciliationConfiguration](docs/ReconciliationConfiguration.md)
   - [ReconciliationId](docs/ReconciliationId.md)
   - [ReconciliationLeftRightAddressKeyPair](docs/ReconciliationLeftRightAddressKeyPair.md)
   - [ReconciliationLine](docs/ReconciliationLine.md)
   - [ReconciliationRequest](docs/ReconciliationRequest.md)
   - [ReconciliationResponse](docs/ReconciliationResponse.md)
   - [ReconciliationRule](docs/ReconciliationRule.md)
   - [ReconciliationRuleType](docs/ReconciliationRuleType.md)
   - [ReconciliationSideConfiguration](docs/ReconciliationSideConfiguration.md)
   - [ReconciliationTransactions](docs/ReconciliationTransactions.md)
   - [ReferenceData](docs/ReferenceData.md)
   - [ReferenceInstrument](docs/ReferenceInstrument.md)
   - [ReferenceList](docs/ReferenceList.md)
   - [ReferenceListRequest](docs/ReferenceListRequest.md)
   - [ReferenceListResponse](docs/ReferenceListResponse.md)
   - [ReferenceListType](docs/ReferenceListType.md)
   - [ReferencePortfolioConstituent](docs/ReferencePortfolioConstituent.md)
   - [ReferencePortfolioConstituentRequest](docs/ReferencePortfolioConstituentRequest.md)
   - [ReferencePortfolioWeightType](docs/ReferencePortfolioWeightType.md)
   - [RelatedEntity](docs/RelatedEntity.md)
   - [Relation](docs/Relation.md)
   - [RelationDefinition](docs/RelationDefinition.md)
   - [Relationship](docs/Relationship.md)
   - [RelationshipDefinition](docs/RelationshipDefinition.md)
   - [RelativeDateOffset](docs/RelativeDateOffset.md)
   - [Repo](docs/Repo.md)
   - [RequestedChanges](docs/RequestedChanges.md)
   - [ResetEvent](docs/ResetEvent.md)
   - [ResourceId](docs/ResourceId.md)
   - [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)
   - [ResourceListOfAccessMetadataValueOf](docs/ResourceListOfAccessMetadataValueOf.md)
   - [ResourceListOfAddressKeyDefinition](docs/ResourceListOfAddressKeyDefinition.md)
   - [ResourceListOfAggregatedReturn](docs/ResourceListOfAggregatedReturn.md)
   - [ResourceListOfAggregationQuery](docs/ResourceListOfAggregationQuery.md)
   - [ResourceListOfAllocation](docs/ResourceListOfAllocation.md)
   - [ResourceListOfApplicableInstrumentEvent](docs/ResourceListOfApplicableInstrumentEvent.md)
   - [ResourceListOfBlock](docs/ResourceListOfBlock.md)
   - [ResourceListOfBlockAndOrders](docs/ResourceListOfBlockAndOrders.md)
   - [ResourceListOfCalendarDate](docs/ResourceListOfCalendarDate.md)
   - [ResourceListOfChange](docs/ResourceListOfChange.md)
   - [ResourceListOfChangeHistory](docs/ResourceListOfChangeHistory.md)
   - [ResourceListOfChangeInterval](docs/ResourceListOfChangeInterval.md)
   - [ResourceListOfChangeIntervalWithOrderManagementDetail](docs/ResourceListOfChangeIntervalWithOrderManagementDetail.md)
   - [ResourceListOfComplianceBreachedOrderInfo](docs/ResourceListOfComplianceBreachedOrderInfo.md)
   - [ResourceListOfComplianceRule](docs/ResourceListOfComplianceRule.md)
   - [ResourceListOfComplianceRuleResult](docs/ResourceListOfComplianceRuleResult.md)
   - [ResourceListOfComplianceRunInfo](docs/ResourceListOfComplianceRunInfo.md)
   - [ResourceListOfConstituentsAdjustmentHeader](docs/ResourceListOfConstituentsAdjustmentHeader.md)
   - [ResourceListOfCorporateAction](docs/ResourceListOfCorporateAction.md)
   - [ResourceListOfDataType](docs/ResourceListOfDataType.md)
   - [ResourceListOfExecution](docs/ResourceListOfExecution.md)
   - [ResourceListOfFeeRule](docs/ResourceListOfFeeRule.md)
   - [ResourceListOfGetCdsFlowConventionsResponse](docs/ResourceListOfGetCdsFlowConventionsResponse.md)
   - [ResourceListOfGetCounterpartyAgreementResponse](docs/ResourceListOfGetCounterpartyAgreementResponse.md)
   - [ResourceListOfGetCreditSupportAnnexResponse](docs/ResourceListOfGetCreditSupportAnnexResponse.md)
   - [ResourceListOfGetFlowConventionsResponse](docs/ResourceListOfGetFlowConventionsResponse.md)
   - [ResourceListOfGetIndexConventionResponse](docs/ResourceListOfGetIndexConventionResponse.md)
   - [ResourceListOfGetRecipeComposerResponse](docs/ResourceListOfGetRecipeComposerResponse.md)
   - [ResourceListOfGetRecipeResponse](docs/ResourceListOfGetRecipeResponse.md)
   - [ResourceListOfHoldingsAdjustmentHeader](docs/ResourceListOfHoldingsAdjustmentHeader.md)
   - [ResourceListOfIUnitDefinitionDto](docs/ResourceListOfIUnitDefinitionDto.md)
   - [ResourceListOfInstrumentCashFlow](docs/ResourceListOfInstrumentCashFlow.md)
   - [ResourceListOfInstrumentEventHolder](docs/ResourceListOfInstrumentEventHolder.md)
   - [ResourceListOfInstrumentIdTypeDescriptor](docs/ResourceListOfInstrumentIdTypeDescriptor.md)
   - [ResourceListOfLegalEntity](docs/ResourceListOfLegalEntity.md)
   - [ResourceListOfListComplexMarketDataWithMetaDataResponse](docs/ResourceListOfListComplexMarketDataWithMetaDataResponse.md)
   - [ResourceListOfMapping](docs/ResourceListOfMapping.md)
   - [ResourceListOfMovedOrderToDifferentBlockResponse](docs/ResourceListOfMovedOrderToDifferentBlockResponse.md)
   - [ResourceListOfOrder](docs/ResourceListOfOrder.md)
   - [ResourceListOfOrderInstruction](docs/ResourceListOfOrderInstruction.md)
   - [ResourceListOfOutputTransaction](docs/ResourceListOfOutputTransaction.md)
   - [ResourceListOfPackage](docs/ResourceListOfPackage.md)
   - [ResourceListOfParticipation](docs/ResourceListOfParticipation.md)
   - [ResourceListOfPerformanceReturn](docs/ResourceListOfPerformanceReturn.md)
   - [ResourceListOfPerson](docs/ResourceListOfPerson.md)
   - [ResourceListOfPlacement](docs/ResourceListOfPlacement.md)
   - [ResourceListOfPortfolio](docs/ResourceListOfPortfolio.md)
   - [ResourceListOfPortfolioCashFlow](docs/ResourceListOfPortfolioCashFlow.md)
   - [ResourceListOfPortfolioCashLadder](docs/ResourceListOfPortfolioCashLadder.md)
   - [ResourceListOfPortfolioTradeTicket](docs/ResourceListOfPortfolioTradeTicket.md)
   - [ResourceListOfProcessedCommand](docs/ResourceListOfProcessedCommand.md)
   - [ResourceListOfProperty](docs/ResourceListOfProperty.md)
   - [ResourceListOfPropertyDefinition](docs/ResourceListOfPropertyDefinition.md)
   - [ResourceListOfPropertyInterval](docs/ResourceListOfPropertyInterval.md)
   - [ResourceListOfQueryableKey](docs/ResourceListOfQueryableKey.md)
   - [ResourceListOfQuote](docs/ResourceListOfQuote.md)
   - [ResourceListOfQuoteAccessMetadataRule](docs/ResourceListOfQuoteAccessMetadataRule.md)
   - [ResourceListOfReconciliationBreak](docs/ResourceListOfReconciliationBreak.md)
   - [ResourceListOfRelation](docs/ResourceListOfRelation.md)
   - [ResourceListOfRelationship](docs/ResourceListOfRelationship.md)
   - [ResourceListOfScopeDefinition](docs/ResourceListOfScopeDefinition.md)
   - [ResourceListOfSideDefinition](docs/ResourceListOfSideDefinition.md)
   - [ResourceListOfString](docs/ResourceListOfString.md)
   - [ResourceListOfTaxRuleSet](docs/ResourceListOfTaxRuleSet.md)
   - [ResourceListOfTransaction](docs/ResourceListOfTransaction.md)
   - [ResourceListOfTransactionType](docs/ResourceListOfTransactionType.md)
   - [ResourceListOfValueType](docs/ResourceListOfValueType.md)
   - [ResponseMetaData](docs/ResponseMetaData.md)
   - [ResultDataKeyRule](docs/ResultDataKeyRule.md)
   - [ResultDataSchema](docs/ResultDataSchema.md)
   - [ResultKeyRule](docs/ResultKeyRule.md)
   - [ResultKeyRuleType](docs/ResultKeyRuleType.md)
   - [ResultValue](docs/ResultValue.md)
   - [ResultValue0D](docs/ResultValue0D.md)
   - [ResultValueBool](docs/ResultValueBool.md)
   - [ResultValueCurrency](docs/ResultValueCurrency.md)
   - [ResultValueDateTimeOffset](docs/ResultValueDateTimeOffset.md)
   - [ResultValueDecimal](docs/ResultValueDecimal.md)
   - [ResultValueDictionary](docs/ResultValueDictionary.md)
   - [ResultValueInt](docs/ResultValueInt.md)
   - [ResultValueString](docs/ResultValueString.md)
   - [ResultValueType](docs/ResultValueType.md)
   - [ReturnZeroPvOptions](docs/ReturnZeroPvOptions.md)
   - [ReverseStockSplitEvent](docs/ReverseStockSplitEvent.md)
   - [RoundingConfiguration](docs/RoundingConfiguration.md)
   - [RoundingConfigurationComponent](docs/RoundingConfigurationComponent.md)
   - [RoundingConvention](docs/RoundingConvention.md)
   - [RulesInterval](docs/RulesInterval.md)
   - [ScalingMethodology](docs/ScalingMethodology.md)
   - [Schedule](docs/Schedule.md)
   - [ScheduleType](docs/ScheduleType.md)
   - [ScopeDefinition](docs/ScopeDefinition.md)
   - [ScripDividendEvent](docs/ScripDividendEvent.md)
   - [ScriptMapReference](docs/ScriptMapReference.md)
   - [SecurityElection](docs/SecurityElection.md)
   - [SecurityOfferElection](docs/SecurityOfferElection.md)
   - [SequenceDefinition](docs/SequenceDefinition.md)
   - [SetAmortisationRulesRequest](docs/SetAmortisationRulesRequest.md)
   - [SetLegalEntityIdentifiersRequest](docs/SetLegalEntityIdentifiersRequest.md)
   - [SetLegalEntityPropertiesRequest](docs/SetLegalEntityPropertiesRequest.md)
   - [SetPersonIdentifiersRequest](docs/SetPersonIdentifiersRequest.md)
   - [SetPersonPropertiesRequest](docs/SetPersonPropertiesRequest.md)
   - [SetShareClassInstrumentsRequest](docs/SetShareClassInstrumentsRequest.md)
   - [SetTransactionConfigurationAlias](docs/SetTransactionConfigurationAlias.md)
   - [SetTransactionConfigurationSourceRequest](docs/SetTransactionConfigurationSourceRequest.md)
   - [SettlementCycle](docs/SettlementCycle.md)
   - [SettlementSchedule](docs/SettlementSchedule.md)
   - [ShareClassAmount](docs/ShareClassAmount.md)
   - [ShareClassBreakdown](docs/ShareClassBreakdown.md)
   - [ShareClassData](docs/ShareClassData.md)
   - [ShareClassDealingBreakdown](docs/ShareClassDealingBreakdown.md)
   - [ShareClassDetails](docs/ShareClassDetails.md)
   - [ShareClassPnlBreakdown](docs/ShareClassPnlBreakdown.md)
   - [SideConfigurationData](docs/SideConfigurationData.md)
   - [SideConfigurationDataRequest](docs/SideConfigurationDataRequest.md)
   - [SideDefinition](docs/SideDefinition.md)
   - [SideDefinitionRequest](docs/SideDefinitionRequest.md)
   - [SidesDefinitionRequest](docs/SidesDefinitionRequest.md)
   - [SimpleCashFlowLoan](docs/SimpleCashFlowLoan.md)
   - [SimpleInstrument](docs/SimpleInstrument.md)
   - [SimpleRoundingConvention](docs/SimpleRoundingConvention.md)
   - [SortOrder](docs/SortOrder.md)
   - [SpecificHoldingPricingInfo](docs/SpecificHoldingPricingInfo.md)
   - [SpinOffEvent](docs/SpinOffEvent.md)
   - [StagedModification](docs/StagedModification.md)
   - [StagedModificationDecision](docs/StagedModificationDecision.md)
   - [StagedModificationDecisionRequest](docs/StagedModificationDecisionRequest.md)
   - [StagedModificationEffectiveRange](docs/StagedModificationEffectiveRange.md)
   - [StagedModificationStagingRule](docs/StagedModificationStagingRule.md)
   - [StagedModificationsEntityHrefs](docs/StagedModificationsEntityHrefs.md)
   - [StagedModificationsInfo](docs/StagedModificationsInfo.md)
   - [StagedModificationsRequestedChangeInterval](docs/StagedModificationsRequestedChangeInterval.md)
   - [StagingRule](docs/StagingRule.md)
   - [StagingRuleApprovalCriteria](docs/StagingRuleApprovalCriteria.md)
   - [StagingRuleMatchCriteria](docs/StagingRuleMatchCriteria.md)
   - [StagingRuleSet](docs/StagingRuleSet.md)
   - [StepSchedule](docs/StepSchedule.md)
   - [StockDividendEvent](docs/StockDividendEvent.md)
   - [StockSplitEvent](docs/StockSplitEvent.md)
   - [Strategy](docs/Strategy.md)
   - [Stream](docs/Stream.md)
   - [StringComparisonType](docs/StringComparisonType.md)
   - [StringComplianceParameter](docs/StringComplianceParameter.md)
   - [StringList](docs/StringList.md)
   - [StringListComplianceParameter](docs/StringListComplianceParameter.md)
   - [StructuredResultData](docs/StructuredResultData.md)
   - [StructuredResultDataId](docs/StructuredResultDataId.md)
   - [SubHoldingKeyValueEquals](docs/SubHoldingKeyValueEquals.md)
   - [SwapCashFlowEvent](docs/SwapCashFlowEvent.md)
   - [SwapPrincipalEvent](docs/SwapPrincipalEvent.md)
   - [TargetTaxLot](docs/TargetTaxLot.md)
   - [TargetTaxLotRequest](docs/TargetTaxLotRequest.md)
   - [TaxRule](docs/TaxRule.md)
   - [TaxRuleSet](docs/TaxRuleSet.md)
   - [TemplateField](docs/TemplateField.md)
   - [TenderEvent](docs/TenderEvent.md)
   - [TermDeposit](docs/TermDeposit.md)
   - [TermDepositInterestEvent](docs/TermDepositInterestEvent.md)
   - [TermDepositPrincipalEvent](docs/TermDepositPrincipalEvent.md)
   - [Timeline](docs/Timeline.md)
   - [TotalReturnSwap](docs/TotalReturnSwap.md)
   - [Touch](docs/Touch.md)
   - [TradeTicket](docs/TradeTicket.md)
   - [TradeTicketType](docs/TradeTicketType.md)
   - [TradingConventions](docs/TradingConventions.md)
   - [Transaction](docs/Transaction.md)
   - [TransactionConfigurationData](docs/TransactionConfigurationData.md)
   - [TransactionConfigurationDataRequest](docs/TransactionConfigurationDataRequest.md)
   - [TransactionConfigurationMovementData](docs/TransactionConfigurationMovementData.md)
   - [TransactionConfigurationMovementDataRequest](docs/TransactionConfigurationMovementDataRequest.md)
   - [TransactionConfigurationTypeAlias](docs/TransactionConfigurationTypeAlias.md)
   - [TransactionCurrencyAndAmount](docs/TransactionCurrencyAndAmount.md)
   - [TransactionDateWindows](docs/TransactionDateWindows.md)
   - [TransactionDiagnostics](docs/TransactionDiagnostics.md)
   - [TransactionFieldMap](docs/TransactionFieldMap.md)
   - [TransactionPrice](docs/TransactionPrice.md)
   - [TransactionPriceAndType](docs/TransactionPriceAndType.md)
   - [TransactionPriceType](docs/TransactionPriceType.md)
   - [TransactionPropertyMap](docs/TransactionPropertyMap.md)
   - [TransactionPropertyMapping](docs/TransactionPropertyMapping.md)
   - [TransactionPropertyMappingRequest](docs/TransactionPropertyMappingRequest.md)
   - [TransactionQueryMode](docs/TransactionQueryMode.md)
   - [TransactionQueryParameters](docs/TransactionQueryParameters.md)
   - [TransactionReconciliationRequest](docs/TransactionReconciliationRequest.md)
   - [TransactionReconciliationRequestV2](docs/TransactionReconciliationRequestV2.md)
   - [TransactionRequest](docs/TransactionRequest.md)
   - [TransactionRoles](docs/TransactionRoles.md)
   - [TransactionSetConfigurationData](docs/TransactionSetConfigurationData.md)
   - [TransactionSetConfigurationDataRequest](docs/TransactionSetConfigurationDataRequest.md)
   - [TransactionStatus](docs/TransactionStatus.md)
   - [TransactionTemplate](docs/TransactionTemplate.md)
   - [TransactionTemplateRequest](docs/TransactionTemplateRequest.md)
   - [TransactionTemplateSpecification](docs/TransactionTemplateSpecification.md)
   - [TransactionType](docs/TransactionType.md)
   - [TransactionTypeAlias](docs/TransactionTypeAlias.md)
   - [TransactionTypeCalculation](docs/TransactionTypeCalculation.md)
   - [TransactionTypeDetails](docs/TransactionTypeDetails.md)
   - [TransactionTypeMovement](docs/TransactionTypeMovement.md)
   - [TransactionTypePropertyMapping](docs/TransactionTypePropertyMapping.md)
   - [TransactionTypeRequest](docs/TransactionTypeRequest.md)
   - [TransactionsReconciliationsResponse](docs/TransactionsReconciliationsResponse.md)
   - [TransitionEvent](docs/TransitionEvent.md)
   - [TranslateEntitiesInlinedRequest](docs/TranslateEntitiesInlinedRequest.md)
   - [TranslateEntitiesRequest](docs/TranslateEntitiesRequest.md)
   - [TranslateEntitiesResponse](docs/TranslateEntitiesResponse.md)
   - [TranslateInstrumentDefinitionsRequest](docs/TranslateInstrumentDefinitionsRequest.md)
   - [TranslateInstrumentDefinitionsResponse](docs/TranslateInstrumentDefinitionsResponse.md)
   - [TranslateTradeTicketRequest](docs/TranslateTradeTicketRequest.md)
   - [TranslateTradeTicketsResponse](docs/TranslateTradeTicketsResponse.md)
   - [TranslationContext](docs/TranslationContext.md)
   - [TranslationInput](docs/TranslationInput.md)
   - [TranslationResult](docs/TranslationResult.md)
   - [TranslationScript](docs/TranslationScript.md)
   - [TranslationScriptId](docs/TranslationScriptId.md)
   - [TrialBalance](docs/TrialBalance.md)
   - [TrialBalanceQueryParameters](docs/TrialBalanceQueryParameters.md)
   - [TriggerEvent](docs/TriggerEvent.md)
   - [TypedResourceId](docs/TypedResourceId.md)
   - [UnitSchema](docs/UnitSchema.md)
   - [UnitisationData](docs/UnitisationData.md)
   - [UnitsRatio](docs/UnitsRatio.md)
   - [UnmatchedHoldingMethod](docs/UnmatchedHoldingMethod.md)
   - [UpdateAmortisationRuleSetDetailsRequest](docs/UpdateAmortisationRuleSetDetailsRequest.md)
   - [UpdateCalendarRequest](docs/UpdateCalendarRequest.md)
   - [UpdateComplianceTemplateRequest](docs/UpdateComplianceTemplateRequest.md)
   - [UpdateCustomEntityDefinitionRequest](docs/UpdateCustomEntityDefinitionRequest.md)
   - [UpdateCustomEntityTypeRequest](docs/UpdateCustomEntityTypeRequest.md)
   - [UpdateCutLabelDefinitionRequest](docs/UpdateCutLabelDefinitionRequest.md)
   - [UpdateDataTypeRequest](docs/UpdateDataTypeRequest.md)
   - [UpdateDerivedPropertyDefinitionRequest](docs/UpdateDerivedPropertyDefinitionRequest.md)
   - [UpdateFeeTypeRequest](docs/UpdateFeeTypeRequest.md)
   - [UpdateGroupReconciliationComparisonRulesetRequest](docs/UpdateGroupReconciliationComparisonRulesetRequest.md)
   - [UpdateGroupReconciliationDefinitionRequest](docs/UpdateGroupReconciliationDefinitionRequest.md)
   - [UpdateInstrumentIdentifierRequest](docs/UpdateInstrumentIdentifierRequest.md)
   - [UpdateOrdersResponse](docs/UpdateOrdersResponse.md)
   - [UpdatePlacementsResponse](docs/UpdatePlacementsResponse.md)
   - [UpdatePortfolioGroupRequest](docs/UpdatePortfolioGroupRequest.md)
   - [UpdatePortfolioRequest](docs/UpdatePortfolioRequest.md)
   - [UpdatePropertyDefinitionRequest](docs/UpdatePropertyDefinitionRequest.md)
   - [UpdateReconciliationRequest](docs/UpdateReconciliationRequest.md)
   - [UpdateReferenceDataRequest](docs/UpdateReferenceDataRequest.md)
   - [UpdateRelationshipDefinitionRequest](docs/UpdateRelationshipDefinitionRequest.md)
   - [UpdateStagingRuleSetRequest](docs/UpdateStagingRuleSetRequest.md)
   - [UpdateTaxRuleSetRequest](docs/UpdateTaxRuleSetRequest.md)
   - [UpdateTimelineRequest](docs/UpdateTimelineRequest.md)
   - [UpdateUnitRequest](docs/UpdateUnitRequest.md)
   - [UpsertCdsFlowConventionsRequest](docs/UpsertCdsFlowConventionsRequest.md)
   - [UpsertComplexMarketDataRequest](docs/UpsertComplexMarketDataRequest.md)
   - [UpsertComplianceRuleRequest](docs/UpsertComplianceRuleRequest.md)
   - [UpsertComplianceRunSummaryRequest](docs/UpsertComplianceRunSummaryRequest.md)
   - [UpsertComplianceRunSummaryResult](docs/UpsertComplianceRunSummaryResult.md)
   - [UpsertCorporateActionRequest](docs/UpsertCorporateActionRequest.md)
   - [UpsertCorporateActionsResponse](docs/UpsertCorporateActionsResponse.md)
   - [UpsertCounterpartyAgreementRequest](docs/UpsertCounterpartyAgreementRequest.md)
   - [UpsertCreditSupportAnnexRequest](docs/UpsertCreditSupportAnnexRequest.md)
   - [UpsertCustomEntitiesResponse](docs/UpsertCustomEntitiesResponse.md)
   - [UpsertCustomEntityAccessMetadataRequest](docs/UpsertCustomEntityAccessMetadataRequest.md)
   - [UpsertDialectRequest](docs/UpsertDialectRequest.md)
   - [UpsertFlowConventionsRequest](docs/UpsertFlowConventionsRequest.md)
   - [UpsertIndexConventionRequest](docs/UpsertIndexConventionRequest.md)
   - [UpsertInstrumentEventRequest](docs/UpsertInstrumentEventRequest.md)
   - [UpsertInstrumentEventsResponse](docs/UpsertInstrumentEventsResponse.md)
   - [UpsertInstrumentPropertiesResponse](docs/UpsertInstrumentPropertiesResponse.md)
   - [UpsertInstrumentPropertyRequest](docs/UpsertInstrumentPropertyRequest.md)
   - [UpsertInstrumentsResponse](docs/UpsertInstrumentsResponse.md)
   - [UpsertLegalEntitiesResponse](docs/UpsertLegalEntitiesResponse.md)
   - [UpsertLegalEntityAccessMetadataRequest](docs/UpsertLegalEntityAccessMetadataRequest.md)
   - [UpsertLegalEntityRequest](docs/UpsertLegalEntityRequest.md)
   - [UpsertPersonAccessMetadataRequest](docs/UpsertPersonAccessMetadataRequest.md)
   - [UpsertPersonRequest](docs/UpsertPersonRequest.md)
   - [UpsertPersonsResponse](docs/UpsertPersonsResponse.md)
   - [UpsertPortfolioAccessMetadataRequest](docs/UpsertPortfolioAccessMetadataRequest.md)
   - [UpsertPortfolioGroupAccessMetadataRequest](docs/UpsertPortfolioGroupAccessMetadataRequest.md)
   - [UpsertPortfolioTransactionsResponse](docs/UpsertPortfolioTransactionsResponse.md)
   - [UpsertQuoteAccessMetadataRuleRequest](docs/UpsertQuoteAccessMetadataRuleRequest.md)
   - [UpsertQuoteRequest](docs/UpsertQuoteRequest.md)
   - [UpsertQuotesResponse](docs/UpsertQuotesResponse.md)
   - [UpsertRecipeComposerRequest](docs/UpsertRecipeComposerRequest.md)
   - [UpsertRecipeRequest](docs/UpsertRecipeRequest.md)
   - [UpsertReferencePortfolioConstituentPropertiesRequest](docs/UpsertReferencePortfolioConstituentPropertiesRequest.md)
   - [UpsertReferencePortfolioConstituentPropertiesResponse](docs/UpsertReferencePortfolioConstituentPropertiesResponse.md)
   - [UpsertReferencePortfolioConstituentsRequest](docs/UpsertReferencePortfolioConstituentsRequest.md)
   - [UpsertReferencePortfolioConstituentsResponse](docs/UpsertReferencePortfolioConstituentsResponse.md)
   - [UpsertResultValuesDataRequest](docs/UpsertResultValuesDataRequest.md)
   - [UpsertReturnsResponse](docs/UpsertReturnsResponse.md)
   - [UpsertSingleStructuredDataResponse](docs/UpsertSingleStructuredDataResponse.md)
   - [UpsertStructuredDataResponse](docs/UpsertStructuredDataResponse.md)
   - [UpsertStructuredResultDataRequest](docs/UpsertStructuredResultDataRequest.md)
   - [UpsertTransactionPropertiesResponse](docs/UpsertTransactionPropertiesResponse.md)
   - [UpsertTranslationScriptRequest](docs/UpsertTranslationScriptRequest.md)
   - [UpsertValuationPointRequest](docs/UpsertValuationPointRequest.md)
   - [User](docs/User.md)
   - [ValuationPointDataQueryParameters](docs/ValuationPointDataQueryParameters.md)
   - [ValuationPointDataRequest](docs/ValuationPointDataRequest.md)
   - [ValuationPointDataResponse](docs/ValuationPointDataResponse.md)
   - [ValuationPointOverview](docs/ValuationPointOverview.md)
   - [ValuationPointResourceListOfAccountedTransaction](docs/ValuationPointResourceListOfAccountedTransaction.md)
   - [ValuationPointResourceListOfJournalEntryLine](docs/ValuationPointResourceListOfJournalEntryLine.md)
   - [ValuationPointResourceListOfPnlJournalEntryLine](docs/ValuationPointResourceListOfPnlJournalEntryLine.md)
   - [ValuationPointResourceListOfTrialBalance](docs/ValuationPointResourceListOfTrialBalance.md)
   - [ValuationRequest](docs/ValuationRequest.md)
   - [ValuationSchedule](docs/ValuationSchedule.md)
   - [ValuationsReconciliationRequest](docs/ValuationsReconciliationRequest.md)
   - [ValueType](docs/ValueType.md)
   - [VendorDependency](docs/VendorDependency.md)
   - [VendorLibrary](docs/VendorLibrary.md)
   - [VendorModelRule](docs/VendorModelRule.md)
   - [Version](docs/Version.md)
   - [VersionSummaryDto](docs/VersionSummaryDto.md)
   - [VersionedResourceListOfA2BDataRecord](docs/VersionedResourceListOfA2BDataRecord.md)
   - [VersionedResourceListOfA2BMovementRecord](docs/VersionedResourceListOfA2BMovementRecord.md)
   - [VersionedResourceListOfHoldingContributor](docs/VersionedResourceListOfHoldingContributor.md)
   - [VersionedResourceListOfJournalEntryLine](docs/VersionedResourceListOfJournalEntryLine.md)
   - [VersionedResourceListOfOutputTransaction](docs/VersionedResourceListOfOutputTransaction.md)
   - [VersionedResourceListOfPortfolioHolding](docs/VersionedResourceListOfPortfolioHolding.md)
   - [VersionedResourceListOfTransaction](docs/VersionedResourceListOfTransaction.md)
   - [VersionedResourceListOfTrialBalance](docs/VersionedResourceListOfTrialBalance.md)
   - [VersionedResourceListWithWarningsOfPortfolioHolding](docs/VersionedResourceListWithWarningsOfPortfolioHolding.md)
   - [VirtualDocument](docs/VirtualDocument.md)
   - [VirtualDocumentRow](docs/VirtualDocumentRow.md)
   - [VirtualRow](docs/VirtualRow.md)
   - [Warning](docs/Warning.md)
   - [WeekendMask](docs/WeekendMask.md)
   - [WeightedInstrument](docs/WeightedInstrument.md)
   - [WeightedInstrumentInLineLookupIdentifiers](docs/WeightedInstrumentInLineLookupIdentifiers.md)
   - [WeightedInstruments](docs/WeightedInstruments.md)
   - [Workspace](docs/Workspace.md)
   - [WorkspaceCreationRequest](docs/WorkspaceCreationRequest.md)
   - [WorkspaceItem](docs/WorkspaceItem.md)
   - [WorkspaceItemCreationRequest](docs/WorkspaceItemCreationRequest.md)
   - [WorkspaceItemUpdateRequest](docs/WorkspaceItemUpdateRequest.md)
   - [WorkspaceUpdateRequest](docs/WorkspaceUpdateRequest.md)
   - [YieldCurveData](docs/YieldCurveData.md)


