Skip to content

Latest commit

 

History

History
475 lines (435 loc) · 36.1 KB

OPENAPI_README.md

File metadata and controls

475 lines (435 loc) · 36.1 KB

canopy.openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

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

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:

import canopy.openapi

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import canopy.openapi

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import canopy.openapi
from canopy.openapi.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 = canopy.openapi.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: Bearer
configuration = canopy.openapi.Configuration(
    host = "http://localhost"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Enter a context with an instance of the API client
with canopy.openapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = canopy.openapi.AccountSettingsApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
user_id = 'user_id_example' # str | 

    try:
        api_response = api_instance.account_settings_get(tenant_id, user_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountSettingsApi->account_settings_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AccountSettingsApi account_settings_get GET /account-settings/{tenantId}/{userId}
AccountSettingsApi account_settings_put PUT /account-settings/{tenantId}/{userId}
AvailabilityApi availability_get GET /availability
AvailabilityApi availability_head HEAD /availability
ConfigApi config_decrypt POST /configs/decrypt
ConfigApi config_decrypt_with_metadata POST /configs/decryptWithMetadata
ConfigApi config_delete_config DELETE /configs/{tenantId}/{configId}
ConfigApi config_delete_config_deprecated DELETE /configs/{tenantId}/{userId}/{configId}
ConfigApi config_encrypt POST /configs/encrypt
ConfigApi config_encrypt_with_metadata POST /configs/encryptWithMetadata
ConfigApi config_get_config GET /configs/{tenantId}/{configId}
ConfigApi config_get_config_deprecated GET /configs/{tenantId}/{userId}/{configId}
ConfigApi config_get_config_names GET /configs/{tenantId}/names
ConfigApi config_get_config_versions GET /configs/{tenantId}/{configId}/versions
ConfigApi config_get_config_versions_deprecated GET /configs/{tenantId}/{userId}/{configId}/versions
ConfigApi config_get_config_without_user_id_deprecated GET /configs/{tenantId}/auto/{configId}
ConfigApi config_get_configs GET /configs/{tenantId}
ConfigApi config_post_config POST /configs/{tenantId}
ConfigApi config_post_config_deprecated POST /configs/{tenantId}/{userId}
ConfigApi config_post_configs POST /configs/{tenantId}/batch
ConfigApi config_post_configs_deprecated POST /configs/{tenantId}/{userId}/batch
ConfigApi config_put_config PUT /configs/{tenantId}/{configId}
ConfigApi config_put_config_deprecated PUT /configs/{tenantId}/{userId}/{configId}
ConfigApi config_put_config_owner PUT /configs/{tenantId}/{configId}/owner
ConfigApi config_upgrade_config POST /configs/upgrade/{tenantId}/{targetSimVersion}
ConfigApi config_upgrade_config_deprecated POST /configs/upgrade/{targetSimVersion}
EndToEndTestInboxApi end_to_end_test_inbox_get_latest_message_and_clear_mailbox GET /test-mailboxes/{mailboxName}
ListFilterApi list_filter_upgrade_list_filter GET /list-filters/upgrade
MembershipApi membership_delete_refresh_tokens DELETE /membership/refresh-tokens/{tenantId}/{userId}
MembershipApi membership_get_password_reset_token_validity GET /membership/password-reset-tokens/{userId}
MembershipApi membership_get_upvoty_token GET /membership/upvoty-token/{tenantId}/{userId}
MembershipApi membership_get_user_roles GET /membership/roles/{tenantId}/{userId}
MembershipApi membership_get_zendesk_token GET /membership/zendesk-token/{tenantId}/{userId}
MembershipApi membership_post_email_confirmation POST /membership/email-confirmations
MembershipApi membership_post_email_confirmation_request POST /membership/email-confirmation-requests/{tenantId}/{userId}
MembershipApi membership_post_identified_user POST /membership/identified-users
MembershipApi membership_post_initialize POST /membership/initialize
MembershipApi membership_post_password_reset_confirmation POST /membership/password-reset-confirmations
MembershipApi membership_post_password_reset_request POST /membership/password-reset-requests
MembershipApi membership_post_registration POST /membership/registrations
MembershipApi membership_put_user_role PUT /membership/roles/{tenantId}/{userId}
PoolApi pool_get_pool_status GET /pools/{tenantId}
PoolApi pool_get_pools GET /pools
PoolApi pool_get_test_auto_scale_formula GET /pools/{tenantId}/autoscale/test
SimVersionApi sim_version_get_document GET /sim-versions/{simVersion}/documents/{documentPath}
SimVersionApi sim_version_get_documents GET /sim-versions/{simVersion}/documents
SimVersionApi sim_version_get_downloads GET /sim-versions/{simVersion}/downloads
SimVersionApi sim_version_get_sim_version GET /sim-versions/current
SimVersionApi sim_version_get_wiki_document GET /sim-versions/{wikiVersion}/wiki/{documentPath}
SimVersionApi sim_version_post_sim_version POST /sim-versions/current
StudyApi study_delete_study DELETE /studies/{tenantId}/{studyId}
StudyApi study_delete_study_deprecated DELETE /studies/{tenantId}/{userId}/{studyId}
StudyApi study_get_all_tenants_study_statistics GET /studies/statistics
StudyApi study_get_sim_type GET /studies/types/sims/{simType}
StudyApi study_get_studies GET /studies/{tenantId}
StudyApi study_get_study GET /studies/{tenantId}/{studyId}
StudyApi study_get_study_deprecated GET /studies/{tenantId}/{userId}/{studyId}
StudyApi study_get_study_download GET /studies/{tenantId}/{studyId}/download
StudyApi study_get_study_download_deprecated GET /studies/{tenantId}/{userId}/{studyId}/download
StudyApi study_get_study_download_url GET /studies/{tenantId}/{studyId}/download-url
StudyApi study_get_study_download_url_deprecated GET /studies/{tenantId}/{userId}/{studyId}/download-url
StudyApi study_get_study_job GET /studies/{tenantId}/{studyId}/jobs/{jobId}
StudyApi study_get_study_job_deprecated GET /studies/{tenantId}/{userId}/{studyId}/jobs/{jobId}
StudyApi study_get_study_job_download GET /studies/{tenantId}/{studyId}/jobs/{jobId}/download
StudyApi study_get_study_job_download_deprecated GET /studies/{tenantId}/{userId}/{studyId}/jobs/{jobId}/download
StudyApi study_get_study_job_metadata GET /studies/{tenantId}/{studyId}/jobs/{jobId}/metadata
StudyApi study_get_study_job_metadata_deprecated GET /studies/{tenantId}/{userId}/{studyId}/jobs/{jobId}/metadata
StudyApi study_get_study_jobs GET /studies/{tenantId}/{studyId}/jobs
StudyApi study_get_study_jobs_deprecated GET /studies/{tenantId}/{userId}/{studyId}/jobs
StudyApi study_get_study_metadata GET /studies/{tenantId}/{studyId}/metadata
StudyApi study_get_study_metadata_deprecated GET /studies/{tenantId}/{userId}/{studyId}/metadata
StudyApi study_get_study_metadata_without_user_id_deprecated GET /studies/{tenantId}/auto/{studyId}/metadata
StudyApi study_get_study_type GET /studies/types/{studyType}
StudyApi study_get_study_types GET /studies/types
StudyApi study_get_study_without_user_id_deprecated GET /studies/{tenantId}/auto/{studyId}
StudyApi study_get_tenant_access_information GET /studies/{tenantId}/access
StudyApi study_get_tenant_billable_stored_simulation_count GET /studies/statistics/stored/{tenantId}
StudyApi study_get_tenant_study_statistics GET /studies/statistics/{tenantId}
StudyApi study_merge_study PATCH /studies/{tenantId}/{studyId}/merge
StudyApi study_merge_study_deprecated PATCH /studies/{tenantId}/{userId}/{studyId}/merge
StudyApi study_post_study POST /studies/{tenantId}
StudyApi study_post_study_deprecated POST /studies/{tenantId}/{userId}
StudyApi study_put_study PUT /studies/{tenantId}/{studyId}
StudyApi study_put_study_deprecated PUT /studies/{tenantId}/{userId}/{studyId}
StudyApi study_put_study_owner PUT /studies/{tenantId}/{studyId}/owner
SupportSessionApi support_session_get_all_support_sessions GET /support-sessions/all
SupportSessionApi support_session_get_support_session GET /support-sessions/{tenantId}/{documentId}
SupportSessionApi support_session_get_support_session_deprecated GET /support-sessions/{tenantId}/{userId}/{documentId}
SupportSessionApi support_session_put_support_session PUT /support-sessions/{tenantId}/{documentId}
SupportSessionApi support_session_put_support_session_deprecated PUT /support-sessions/{tenantId}/{userId}/{documentId}
TenancyApi tenancy_delete_tenant DELETE /tenants/{tenantId}
TenancyApi tenancy_get_tenant GET /tenants/{tenantId}
TenancyApi tenancy_get_tenant_users GET /tenants/{tenantId}/users
TenancyApi tenancy_get_tenants GET /tenants
TenancyApi tenancy_post_tenant POST /tenants
TenancyApi tenancy_put_tenant PUT /tenants/{tenantId}
TenantSettingsApi tenant_settings_get_admin_tenant_settings GET /tenant-settings/admin/{tenantId}
TenantSettingsApi tenant_settings_get_tenant_channel_import_mappings GET /tenant-settings/channel-import-mappings/{tenantId}
TenantSettingsApi tenant_settings_get_tenant_channel_whitelists GET /tenant-settings/channel-whitelists/{tenantId}
TenantSettingsApi tenant_settings_get_tenant_default_custom_property_names GET /tenant-settings/default-custom-property-names/{tenantId}
TenantSettingsApi tenant_settings_get_tenant_settings_sim_version GET /tenant-settings/sim-version/{tenantId}
TenantSettingsApi tenant_settings_get_tenant_worksheet_label_definitions GET /tenant-settings/worksheet-label-definitions/{tenantId}
TenantSettingsApi tenant_settings_put_admin_tenant_settings PUT /tenant-settings/admin/{tenantId}
TenantSettingsApi tenant_settings_put_tenant_channel_import_mappings PUT /tenant-settings/channel-import-mappings/{tenantId}
TenantSettingsApi tenant_settings_put_tenant_channel_whitelists PUT /tenant-settings/channel-whitelists/{tenantId}
TenantSettingsApi tenant_settings_put_tenant_default_custom_property_names PUT /tenant-settings/default-custom-property-names/{tenantId}
TenantSettingsApi tenant_settings_put_tenant_settings_sim_version PUT /tenant-settings/sim-version/{tenantId}
TenantSettingsApi tenant_settings_put_tenant_worksheet_label_definitions PUT /tenant-settings/worksheet-label-definitions/{tenantId}
TokenApi token_post_token POST /token
UserSettingsApi user_settings_get_user_settings GET /user-settings/{tenantId}/{userId}
UserSettingsApi user_settings_put_user_settings PUT /user-settings/{tenantId}/{userId}
WorksheetApi worksheet_get_worksheet GET /worksheets/{tenantId}/{worksheetId}
WorksheetApi worksheet_post_duplicate_configs POST /worksheets/{tenantId}/{worksheetId}/duplicate
WorksheetApi worksheet_post_worksheet POST /worksheets/{tenantId}
WorksheetApi worksheet_put_worksheet PUT /worksheets/{tenantId}/{worksheetId}

Documentation For Models

Documentation For Authorization

Bearer

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes: N/A

Author