Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generated SDK version 0.0.7 #11

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# NOTE: This file is auto generated by OpenAPI Generator.
# URL: https://openapi-generator.tech
#
# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: visier.sdk.api.consolidated_analytics Python package

on: [push, pull_request]

jobs:
build:

runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]

steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install flake8 pytest
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
if [ -f test-requirements.txt ]; then pip install -r test-requirements.txt; fi
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pytest
66 changes: 66 additions & 0 deletions src/visier.sdk.api.consolidated_analytics/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/
venv/
.venv/
.python-version
.pytest_cache

# Translations
*.mo
*.pot

# Django stuff:
*.log

# Sphinx documentation
docs/_build/

# PyBuilder
target/

#Ipython Notebook
.ipynb_checkpoints
31 changes: 31 additions & 0 deletions src/visier.sdk.api.consolidated_analytics/.gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# NOTE: This file is auto generated by OpenAPI Generator.
# URL: https://openapi-generator.tech
#
# ref: https://docs.gitlab.com/ee/ci/README.html
# ref: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Python.gitlab-ci.yml

stages:
- test

.pytest:
stage: test
script:
- pip install -r requirements.txt
- pip install -r test-requirements.txt
- pytest --cov=visier.sdk.api.consolidated_analytics

pytest-3.7:
extends: .pytest
image: python:3.7-alpine
pytest-3.8:
extends: .pytest
image: python:3.8-alpine
pytest-3.9:
extends: .pytest
image: python:3.9-alpine
pytest-3.10:
extends: .pytest
image: python:3.10-alpine
pytest-3.11:
extends: .pytest
image: python:3.11-alpine
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
59 changes: 59 additions & 0 deletions src/visier.sdk.api.consolidated_analytics/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
.github/workflows/python.yml
.gitignore
.gitlab-ci.yml
.openapi-generator-ignore
.travis.yml
README.md
docs/ConsolidatedAnalyticsAPIExcludedSourceListDTO.md
docs/ConsolidatedAnalyticsAPISourceTenantListDTO.md
docs/ConsolidatedAnalyticsAPITenantCreateRequestDTO.md
docs/ConsolidatedAnalyticsAPITenantListResponseDTO.md
docs/ConsolidatedAnalyticsAPITenantWithDetails.md
docs/ConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO.md
docs/ConsolidatedAnalyticsV1AlphaApi.md
docs/ExcludedSourcesBody.md
docs/GoogleProtobufAny.md
docs/Status.md
docs/TenantCodeBody.md
git_push.sh
pyproject.toml
requirements.txt
setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_consolidated_analytics_api_excluded_source_list_dto.py
test/test_consolidated_analytics_api_source_tenant_list_dto.py
test/test_consolidated_analytics_api_tenant_create_request_dto.py
test/test_consolidated_analytics_api_tenant_list_response_dto.py
test/test_consolidated_analytics_api_tenant_with_details.py
test/test_consolidated_analytics_api_tenant_with_details_list_response_dto.py
test/test_consolidated_analytics_v1_alpha_api.py
test/test_excluded_sources_body.py
test/test_google_protobuf_any.py
test/test_status.py
test/test_tenant_code_body.py
tox.ini
visier/__init__.py
visier/sdk/__init__.py
visier/sdk/api/__init__.py
visier/sdk/api/consolidated_analytics/__init__.py
visier/sdk/api/consolidated_analytics/api/__init__.py
visier/sdk/api/consolidated_analytics/api/consolidated_analytics_v1_alpha_api.py
visier/sdk/api/consolidated_analytics/api_client.py
visier/sdk/api/consolidated_analytics/api_response.py
visier/sdk/api/consolidated_analytics/configuration.py
visier/sdk/api/consolidated_analytics/exceptions.py
visier/sdk/api/consolidated_analytics/models/__init__.py
visier/sdk/api/consolidated_analytics/models/consolidated_analytics_api_excluded_source_list_dto.py
visier/sdk/api/consolidated_analytics/models/consolidated_analytics_api_source_tenant_list_dto.py
visier/sdk/api/consolidated_analytics/models/consolidated_analytics_api_tenant_create_request_dto.py
visier/sdk/api/consolidated_analytics/models/consolidated_analytics_api_tenant_list_response_dto.py
visier/sdk/api/consolidated_analytics/models/consolidated_analytics_api_tenant_with_details.py
visier/sdk/api/consolidated_analytics/models/consolidated_analytics_api_tenant_with_details_list_response_dto.py
visier/sdk/api/consolidated_analytics/models/excluded_sources_body.py
visier/sdk/api/consolidated_analytics/models/google_protobuf_any.py
visier/sdk/api/consolidated_analytics/models/status.py
visier/sdk/api/consolidated_analytics/models/tenant_code_body.py
visier/sdk/api/consolidated_analytics/py.typed
visier/sdk/api/consolidated_analytics/rest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
7.7.0
17 changes: 17 additions & 0 deletions src/visier.sdk.api.consolidated_analytics/.travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# ref: https://docs.travis-ci.com/user/languages/python
language: python
python:
- "3.7"
- "3.8"
- "3.9"
- "3.10"
- "3.11"
# uncomment the following if needed
#- "3.11-dev" # 3.11 development branch
#- "nightly" # nightly build
# command to install dependencies
install:
- "pip install -r requirements.txt"
- "pip install -r test-requirements.txt"
# command to run tests
script: pytest --cov=visier.sdk.api.consolidated_analytics
126 changes: 126 additions & 0 deletions src/visier.sdk.api.consolidated_analytics/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# visier.sdk.api.consolidated-analytics
Visier APIs for managing consolidated analytics (CA) tenants.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 22222222.99201.1411
- Package version: 0.0.7
- Generator version: 7.7.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import visier.sdk.api.consolidated_analytics
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import visier.sdk.api.consolidated_analytics
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import visier.sdk.api.consolidated_analytics
from visier.sdk.api.consolidated_analytics.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = visier.sdk.api.consolidated_analytics.Configuration(
host = "http://localhost"
)



# Enter a context with an instance of the API client
with visier.sdk.api.consolidated_analytics.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = visier.sdk.api.consolidated_analytics.ConsolidatedAnalyticsV1AlphaApi(api_client)
tenant_id = 'tenant_id_example' # str | The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.
excluded_sources_body = visier.sdk.api.consolidated_analytics.ExcludedSourcesBody() # ExcludedSourcesBody |

try:
# Add excluded sources to a consolidated analytics tenant
api_response = api_instance.add_excluded_sources(tenant_id, excluded_sources_body)
print("The response of ConsolidatedAnalyticsV1AlphaApi->add_excluded_sources:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ConsolidatedAnalyticsV1AlphaApi->add_excluded_sources: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ConsolidatedAnalyticsV1AlphaApi* | [**add_excluded_sources**](docs/ConsolidatedAnalyticsV1AlphaApi.md#add_excluded_sources) | **PATCH** /v1alpha/admin/consolidated-analytics/tenants/{tenantId}/excluded-sources | Add excluded sources to a consolidated analytics tenant
*ConsolidatedAnalyticsV1AlphaApi* | [**add_source_tenants**](docs/ConsolidatedAnalyticsV1AlphaApi.md#add_source_tenants) | **PATCH** /v1alpha/admin/consolidated-analytics/tenants/{tenantId}/source-tenants | Add source tenants to a consolidated analytics tenant
*ConsolidatedAnalyticsV1AlphaApi* | [**create_tenant**](docs/ConsolidatedAnalyticsV1AlphaApi.md#create_tenant) | **POST** /v1alpha/admin/consolidated-analytics/tenants | Create a consolidated analytics tenant
*ConsolidatedAnalyticsV1AlphaApi* | [**list_excluded_sources**](docs/ConsolidatedAnalyticsV1AlphaApi.md#list_excluded_sources) | **GET** /v1alpha/admin/consolidated-analytics/tenants/{tenantId}/excluded-sources | Retrieve a consolidated analytics tenant's excluded sources
*ConsolidatedAnalyticsV1AlphaApi* | [**list_source_tenants**](docs/ConsolidatedAnalyticsV1AlphaApi.md#list_source_tenants) | **GET** /v1alpha/admin/consolidated-analytics/tenants/{tenantId}/source-tenants | Retrieve a consolidated analytics tenant's source tenants
*ConsolidatedAnalyticsV1AlphaApi* | [**list_tenants**](docs/ConsolidatedAnalyticsV1AlphaApi.md#list_tenants) | **GET** /v1alpha/admin/consolidated-analytics/tenants | Retrieve a list of all consolidated analytics tenants
*ConsolidatedAnalyticsV1AlphaApi* | [**list_tenants_with_details**](docs/ConsolidatedAnalyticsV1AlphaApi.md#list_tenants_with_details) | **GET** /v1alpha/admin/consolidated-analytics/tenants-with-details | Retrieve the details of all consolidated analytics tenants
*ConsolidatedAnalyticsV1AlphaApi* | [**remove_excluded_sources**](docs/ConsolidatedAnalyticsV1AlphaApi.md#remove_excluded_sources) | **DELETE** /v1alpha/admin/consolidated-analytics/tenants/{tenantId}/excluded-sources | Remove excluded sources from a consolidated analytics tenants
*ConsolidatedAnalyticsV1AlphaApi* | [**remove_source_tenants**](docs/ConsolidatedAnalyticsV1AlphaApi.md#remove_source_tenants) | **DELETE** /v1alpha/admin/consolidated-analytics/tenants/{tenantId}/source-tenants | Remove source tenants from a consolidated analytics tenants
*ConsolidatedAnalyticsV1AlphaApi* | [**set_excluded_sources**](docs/ConsolidatedAnalyticsV1AlphaApi.md#set_excluded_sources) | **PUT** /v1alpha/admin/consolidated-analytics/tenants/{tenantId}/excluded-sources | Set a consolidated analytics tenant's excluded sources
*ConsolidatedAnalyticsV1AlphaApi* | [**set_source_tenants**](docs/ConsolidatedAnalyticsV1AlphaApi.md#set_source_tenants) | **PUT** /v1alpha/admin/consolidated-analytics/tenants/{tenantId}/source-tenants | Set a consolidated analytics tenant's source tenants


## Documentation For Models

- [ConsolidatedAnalyticsAPIExcludedSourceListDTO](docs/ConsolidatedAnalyticsAPIExcludedSourceListDTO.md)
- [ConsolidatedAnalyticsAPISourceTenantListDTO](docs/ConsolidatedAnalyticsAPISourceTenantListDTO.md)
- [ConsolidatedAnalyticsAPITenantCreateRequestDTO](docs/ConsolidatedAnalyticsAPITenantCreateRequestDTO.md)
- [ConsolidatedAnalyticsAPITenantListResponseDTO](docs/ConsolidatedAnalyticsAPITenantListResponseDTO.md)
- [ConsolidatedAnalyticsAPITenantWithDetails](docs/ConsolidatedAnalyticsAPITenantWithDetails.md)
- [ConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO](docs/ConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO.md)
- [ExcludedSourcesBody](docs/ExcludedSourcesBody.md)
- [GoogleProtobufAny](docs/GoogleProtobufAny.md)
- [Status](docs/Status.md)
- [TenantCodeBody](docs/TenantCodeBody.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author




Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ConsolidatedAnalyticsAPIExcludedSourceListDTO


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**excluded_sources** | **List[str]** | A list of the CA tenant&#39;s excluded sources. | [optional]

## Example

```python
from visier.sdk.api.consolidated_analytics.models.consolidated_analytics_api_excluded_source_list_dto import ConsolidatedAnalyticsAPIExcludedSourceListDTO

# TODO update the JSON string below
json = "{}"
# create an instance of ConsolidatedAnalyticsAPIExcludedSourceListDTO from a JSON string
consolidated_analytics_api_excluded_source_list_dto_instance = ConsolidatedAnalyticsAPIExcludedSourceListDTO.from_json(json)
# print the JSON string representation of the object
print(ConsolidatedAnalyticsAPIExcludedSourceListDTO.to_json())

# convert the object into a dict
consolidated_analytics_api_excluded_source_list_dto_dict = consolidated_analytics_api_excluded_source_list_dto_instance.to_dict()
# create an instance of ConsolidatedAnalyticsAPIExcludedSourceListDTO from a dict
consolidated_analytics_api_excluded_source_list_dto_from_dict = ConsolidatedAnalyticsAPIExcludedSourceListDTO.from_dict(consolidated_analytics_api_excluded_source_list_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading
Loading