lusid-configuration-sdk


Namelusid-configuration-sdk JSON
Version 2.1.45 PyPI version JSON
download
home_pagehttps://github.com/finbourne/configuration-sdk-python
SummaryFINBOURNE ConfigurationService API
upload_time2024-12-03 14:32:10
maintainerNone
docs_urlNone
authorFINBOURNE Technology
requires_python<4.0,>=3.8
licenseMIT
keywords openapi openapi-generator finbourne configurationservice api lusid-configuration-sdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <a id="documentation-for-api-endpoints"></a>
## Documentation for API Endpoints

All URIs are relative to *https://fbn-prd.lusid.com/configuration*

Class | Method | HTTP request | 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>
## Documentation for Models

 - [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)


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/finbourne/configuration-sdk-python",
    "name": "lusid-configuration-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "OpenAPI, OpenAPI-Generator, FINBOURNE ConfigurationService API, lusid-configuration-sdk",
    "author": "FINBOURNE Technology",
    "author_email": "info@finbourne.com",
    "download_url": "https://files.pythonhosted.org/packages/b3/de/f9ab453fc87525fbedabe8e56ee62b6177019d6cd95fb6b8a15e1c45d1b3/lusid_configuration_sdk-2.1.45.tar.gz",
    "platform": null,
    "description": "<a id=\"documentation-for-api-endpoints\"></a>\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://fbn-prd.lusid.com/configuration*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*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\n*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\n*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\n*ConfigurationSetsApi* | [**create_configuration_set**](docs/ConfigurationSetsApi.md#create_configuration_set) | **POST** /api/sets | [EARLY ACCESS] CreateConfigurationSet: Create a configuration set\n*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\n*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\n*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\n*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\n*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\n*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\n*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\n*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\n*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)\n*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\n*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\n\n\n<a id=\"documentation-for-models\"></a>\n## Documentation for Models\n\n - [AccessControlledAction](docs/AccessControlledAction.md)\n - [AccessControlledResource](docs/AccessControlledResource.md)\n - [ActionId](docs/ActionId.md)\n - [ConfigurationItem](docs/ConfigurationItem.md)\n - [ConfigurationItemSummary](docs/ConfigurationItemSummary.md)\n - [ConfigurationSet](docs/ConfigurationSet.md)\n - [ConfigurationSetSummary](docs/ConfigurationSetSummary.md)\n - [CreateConfigurationItem](docs/CreateConfigurationItem.md)\n - [CreateConfigurationSet](docs/CreateConfigurationSet.md)\n - [IdSelectorDefinition](docs/IdSelectorDefinition.md)\n - [IdentifierPartSchema](docs/IdentifierPartSchema.md)\n - [Link](docs/Link.md)\n - [LusidProblemDetails](docs/LusidProblemDetails.md)\n - [LusidValidationProblemDetails](docs/LusidValidationProblemDetails.md)\n - [PersonalAccessToken](docs/PersonalAccessToken.md)\n - [ResourceId](docs/ResourceId.md)\n - [ResourceListOfAccessControlledResource](docs/ResourceListOfAccessControlledResource.md)\n - [ResourceListOfConfigurationItem](docs/ResourceListOfConfigurationItem.md)\n - [ResourceListOfConfigurationSet](docs/ResourceListOfConfigurationSet.md)\n - [ResourceListOfConfigurationSetSummary](docs/ResourceListOfConfigurationSetSummary.md)\n - [UpdateConfigurationItem](docs/UpdateConfigurationItem.md)\n - [UpdateConfigurationSet](docs/UpdateConfigurationSet.md)\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "FINBOURNE ConfigurationService API",
    "version": "2.1.45",
    "project_urls": {
        "Homepage": "https://github.com/finbourne/configuration-sdk-python",
        "Repository": "https://github.com/finbourne/configuration-sdk-python"
    },
    "split_keywords": [
        "openapi",
        " openapi-generator",
        " finbourne configurationservice api",
        " lusid-configuration-sdk"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4a1d4700effb36495aeee4c306986ce2c75649c2254363a41d1eb75b1eb8855e",
                "md5": "8075647881fa74b2cf04f443aa7a1984",
                "sha256": "b64f4677178a7fa0c2355956e39521ce51eadc31e82be37b7270d0fb0aadc52f"
            },
            "downloads": -1,
            "filename": "lusid_configuration_sdk-2.1.45-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8075647881fa74b2cf04f443aa7a1984",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 87925,
            "upload_time": "2024-12-03T14:32:08",
            "upload_time_iso_8601": "2024-12-03T14:32:08.835538Z",
            "url": "https://files.pythonhosted.org/packages/4a/1d/4700effb36495aeee4c306986ce2c75649c2254363a41d1eb75b1eb8855e/lusid_configuration_sdk-2.1.45-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b3def9ab453fc87525fbedabe8e56ee62b6177019d6cd95fb6b8a15e1c45d1b3",
                "md5": "62c0e39d0a016a14945c82a4248a5516",
                "sha256": "aa9e074f89e2dcd4df570789482147a9193fedcc0da8a898b9f78c94f749deec"
            },
            "downloads": -1,
            "filename": "lusid_configuration_sdk-2.1.45.tar.gz",
            "has_sig": false,
            "md5_digest": "62c0e39d0a016a14945c82a4248a5516",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 52755,
            "upload_time": "2024-12-03T14:32:10",
            "upload_time_iso_8601": "2024-12-03T14:32:10.324096Z",
            "url": "https://files.pythonhosted.org/packages/b3/de/f9ab453fc87525fbedabe8e56ee62b6177019d6cd95fb6b8a15e1c45d1b3/lusid_configuration_sdk-2.1.45.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-03 14:32:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "finbourne",
    "github_project": "configuration-sdk-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "lusid-configuration-sdk"
}
        
Elapsed time: 4.61984s