ddswitch-api-client 0.1.0

DDSwitch

ddswitch-python-client

Connect your data anywhere

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

• API version: 0.1.0
• Package version: 0.1.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

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

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 ddswitch_api_client

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 ddswitch_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ddswitch_api_client
from ddswitch_api_client.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 = ddswitch_api_client.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 HTTP basic authorization: basicAuth
configuration = ddswitch_api_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwtAuth
configuration = ddswitch_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with ddswitch_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ddswitch_api_client.AApi(api_client)
    provider = 'provider_example' # str | 
    team_slug = 'team_slug_example' # str | 

    try:
        api_instance.a_connection_oauth2_start_retrieve(provider, team_slug)
    except ApiException as e:
        print("Exception when calling AApi->a_connection_oauth2_start_retrieve: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AApi	a_connection_oauth2_start_retrieve	GET /a/{team_slug}/connection/oauth2/start/{provider}/
AApi	a_connection_public_embeddings_retrieve	GET /a/{team_slug}/connection/public/embeddings/{share_token}/
ApiApi	api_auth_login_create	POST /api/auth/login/
ApiApi	api_auth_logout_create	POST /api/auth/logout/
ApiApi	api_auth_logout_retrieve	GET /api/auth/logout/
ApiApi	api_auth_password_change_create	POST /api/auth/password/change/
ApiApi	api_auth_register_create	POST /api/auth/register/
ApiApi	api_auth_token_refresh_create	POST /api/auth/token/refresh/
ApiApi	api_auth_token_verify_create	POST /api/auth/token/verify/
ApiApi	api_auth_user_partial_update	PATCH /api/auth/user/
ApiApi	api_auth_user_retrieve	GET /api/auth/user/
ApiApi	api_auth_user_update	PUT /api/auth/user/
ApiApi	api_auth_verify_otp_create	POST /api/auth/verify-otp/
ApiApi	api_connection_api_connection_connections_logs_retrieve	GET /api/connection/api/connection/{team_slug}/connections/{connection_id}/logs/
ApiApi	api_connection_api_connection_oauth2_providers_retrieve	GET /api/connection/api/connection/{team_slug}/oauth2/providers/
ApiApi	api_connection_connection_connections_list	GET /api/connection/{team_slug}/connection/connections/
ApiApi	api_connection_connection_connectors_retrieve	GET /api/connection/{team_slug}/connection/connectors/
ApiApi	api_connection_connection_delete_destroy	DELETE /api/connection/{team_slug}/connection/{connection_id}/delete/
ApiApi	api_connection_connection_deleted_connections_retrieve	GET /api/connection/{team_slug}/connection/deleted-connections/
ApiApi	api_connection_connections_embeddings_create_create	POST /api/connection/{team_slug}/connections/{connection_id}/embeddings/create/
ApiApi	api_connection_connections_embeddings_revoke_create	POST /api/connection/{team_slug}/connections/{connection_id}/embeddings/revoke/
ApiApi	api_connection_connections_restore_create	POST /api/connection/{team_slug}/connections/{connection_id}/restore/
ApiApi	api_connection_connections_streams_configure_create	POST /api/connection/{team_slug}/connections/{connection_id}/streams/configure/
ApiApi	api_connection_connections_streams_retrieve	GET /api/connection/{team_slug}/connections/{connection_id}/streams/
ApiApi	api_connection_connectors_retrieve	GET /api/connection/{team_slug}/connectors/{connector_id}/
ApiApi	api_connection_connectors_save_edit_update	PUT /api/connection/{team_slug}/connectors/{connector_id}/save_edit/
ApiApi	api_connection_create_connection_create	POST /api/connection/{team_slug}/create-connection/
ApiApi	api_connection_create_connector_create	POST /api/connection/{team_slug}/create-connector/
ApiApi	api_connection_get_connection_retrieve	GET /api/connection/{team_slug}/get-connection/
ApiApi	api_connection_get_connector_spec_retrieve	GET /api/connection/{team_slug}/get-connector-spec/{connector_id}/
ApiApi	api_connection_get_connector_status_summary_retrieve	GET /api/connection/{team_slug}/get-connector-status-summary/
ApiApi	api_connection_get_filtered_connectors_retrieve	GET /api/connection/{team_slug}/get-filtered-connectors/
ApiApi	api_connection_get_integrations_retrieve	GET /api/connection/{team_slug}/get-integrations/
ApiApi	api_connection_get_spec_retrieve	GET /api/connection/{team_slug}/get-spec/
ApiApi	api_connection_save_connector_config_create	POST /api/connection/{team_slug}/save-connector-config/{connector_id}/
ApiApi	api_connection_teams_connections_manage_scheduled_sync_create	POST /api/connection/teams/{team_slug}/connections/{connection_id}/manage-scheduled-sync/
ApiApi	api_connection_teams_connections_sync_now_create	POST /api/connection/teams/{team_slug}/connections/{connection_id}/sync-now/
ApiApi	api_connection_trigger_connection_create	POST /api/connection/{team_slug}/trigger-connection/{connection_id}/
DashboardApi	dashboard_api_user_signups_list	GET /dashboard/api/user-signups/
TeamsApi	invitations_create	POST /a/{team_slug}/team/api/invitations/
TeamsApi	invitations_destroy	DELETE /a/{team_slug}/team/api/invitations/{id}/
TeamsApi	invitations_list	GET /a/{team_slug}/team/api/invitations/
TeamsApi	invitations_partial_update	PATCH /a/{team_slug}/team/api/invitations/{id}/
TeamsApi	invitations_retrieve	GET /a/{team_slug}/team/api/invitations/{id}/
TeamsApi	invitations_update	PUT /a/{team_slug}/team/api/invitations/{id}/
TeamsApi	teams_create	POST /teams/api/teams/
TeamsApi	teams_destroy	DELETE /teams/api/teams/{id}/
TeamsApi	teams_list	GET /teams/api/teams/
TeamsApi	teams_partial_update	PATCH /teams/api/teams/{id}/
TeamsApi	teams_retrieve	GET /teams/api/teams/{id}/
TeamsApi	teams_update	PUT /teams/api/teams/{id}/

Documentation For Models

• ApiConnectionConnectionsEmbeddingsCreateCreateRequest
• ApiConnectionConnectionsStreamsConfigureCreateRequest
• ApiConnectionConnectionsStreamsConfigureCreateRequestStreamsInner
• ApiConnectionConnectionsStreamsConfigureCreateRequestStreamsInnerConfig
• ApiConnectionConnectorsSaveEditUpdateRequest
• ApiConnectionCreateConnectionCreateRequest
• ApiConnectionCreateConnectorCreateRequest
• ApiConnectionSaveConnectorConfigCreateRequest
• ApiConnectionTeamsConnectionsManageScheduledSyncCreateRequest
• ApiConnectionTriggerConnectionCreateRequest
• BlankEnum
• Connection
• ConnectionLastSyncStatus
• ConnectionLogsResponse
• ConnectionStatusEnum
• CustomUser
• ErrorMessage
• Invitation
• JWT
• LastSyncStatusEnum
• Login
• LoginResponse
• Membership
• NullEnum
• OtpRequest
• PaginatedConnectionList
• PaginatedInvitationList
• PaginatedTeamList
• PasswordChange
• PatchedCustomUser
• PatchedInvitation
• PatchedTeam
• Price
• Register
• RestAuthDetail
• RoleEnum
• Subscription
• SubscriptionItem
• SubscriptionStatusEnum
• SyncFrequencyEnum
• SyncLog
• Team
• TokenRefresh
• TokenVerify
• UserSignupStats

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

basicAuth

• Type: HTTP basic authentication

cookieAuth

• Type: API key
• API key parameter name: sessionid
• Location:

jwtAuth

• Type: Bearer authentication (JWT)

Author